automation_step_executions

Creates, updates, deletes, gets or lists an automation_step_executions resource.

Overview

Name	automation_step_executions
Type	Resource
Id	aws.ssm.automation_step_executions

Fields

The following fields are returned by SELECT queries:

describe_automation_step_executions

Name	Datatype	Description
action	string	The action this step performs. The action determines the behavior of the step. (pattern: <code>^aws:[a-zA-Z]{3,25}$</code>)
execution_end_time	string (date-time)	If a step has finished execution, this contains the time the execution ended. If the step hasn't yet concluded, this field isn't populated.
execution_start_time	string (date-time)	If a step has begun execution, this contains the time the step started. If the step is in Pending status, this field isn't populated.
failure_details	object	Information about the Automation failure.
failure_message	string	If a step failed, this message explains why the execution failed.
inputs	object	Fully-resolved values passed into the step before execution.
is_critical	boolean	The flag which can be used to help decide whether the failure of current step leads to the Automation failure.
is_end	boolean	The flag which can be used to end automation no matter whether the step succeeds or fails.
max_attempts	integer	The maximum number of tries to run the action of the step. The default value is 1.
next_step	string	The next step after the step succeeds.
on_failure	string	The action to take if the step fails. The default value is Abort.
outputs	object	Returned values from the execution of the step.
overridden_parameters	object	A user-specified list of parameters to override when running a step.
parent_step_details	object	Information about the parent step.
response	string	A message associated with the response code for an execution.
response_code	string	The response code returned by the execution of the step.
step_execution_id	string	The unique ID of a step execution.
step_name	string	The name of this execution step.
step_status	string	The execution status for this step. (Pending, InProgress, Waiting, Success, TimedOut, Cancelling, Cancelled, Failed, PendingApproval, Approved, Rejected, Scheduled, RunbookInProgress, PendingChangeCalendarOverride, ChangeCalendarOverrideApproved, ChangeCalendarOverrideRejected, CompletedWithSuccess, CompletedWithFailure, Exited)
target_location	object	The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Automation execution.
targets	array	The targets for the step execution.
timeout_seconds	integer (int64)	The timeout seconds of the step.
triggered_alarms	array	The CloudWatch alarms that were invoked by the automation.
valid_next_steps	array	Strategies used when step fails, we support Continue and Abort. Abort will fail the automation when the step fails. Continue will ignore the failure of current step and allow automation to run the next step. With conditional branching, we add step:stepName to support the automation to go to another specific step.
warning_message	string	A message that describes a non-critical issue that occurred during the step execution. Present only if the step status includes a warning.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_automation_step_executions	select	region		Information about all active and terminated step executions in an Automation workflow.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_automation_step_executions

Information about all active and terminated step executions in an Automation workflow.

SELECT
action,
execution_end_time,
execution_start_time,
failure_details,
failure_message,
inputs,
is_critical,
is_end,
max_attempts,
next_step,
on_failure,
outputs,
overridden_parameters,
parent_step_details,
response,
response_code,
step_execution_id,
step_name,
step_status,
target_location,
targets,
timeout_seconds,
triggered_alarms,
valid_next_steps,
warning_message
FROM aws.ssm.automation_step_executions
WHERE region = '{{ region }}' -- required
;