DescribeAutomationStepExecutions - Amazon Systems Manager
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


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

Request Syntax

{ "AutomationExecutionId": "string", "Filters": [ { "Key": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string", "ReverseOrder": boolean }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.


The Automation execution ID for which you want step execution descriptions.

Type: String

Length Constraints: Fixed length of 36.

Required: Yes


One or more filters to limit the number of step executions returned by the request.

Type: Array of StepExecutionFilter objects

Array Members: Minimum number of 1 item. Maximum number of 6 items.

Required: No


The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: No


The token for the next set of items to return. (You received this token from a previous call.)

Type: String

Required: No


Indicates whether to list step executions in reverse order by start time. The default value is 'false'.

Type: Boolean

Required: No

Response Syntax

{ "NextToken": "string", "StepExecutions": [ { "Action": "string", "ExecutionEndTime": number, "ExecutionStartTime": number, "FailureDetails": { "Details": { "string" : [ "string" ] }, "FailureStage": "string", "FailureType": "string" }, "FailureMessage": "string", "Inputs": { "string" : "string" }, "IsCritical": boolean, "IsEnd": boolean, "MaxAttempts": number, "NextStep": "string", "OnFailure": "string", "Outputs": { "string" : [ "string" ] }, "OverriddenParameters": { "string" : [ "string" ] }, "ParentStepDetails": { "Action": "string", "Iteration": number, "IteratorValue": "string", "StepExecutionId": "string", "StepName": "string" }, "Response": "string", "ResponseCode": "string", "StepExecutionId": "string", "StepName": "string", "StepStatus": "string", "TargetLocation": { "Accounts": [ "string" ], "ExecutionRoleName": "string", "Regions": [ "string" ], "TargetLocationAlarmConfiguration": { "Alarms": [ { "Name": "string" } ], "IgnorePollAlarmFailure": boolean }, "TargetLocationMaxConcurrency": "string", "TargetLocationMaxErrors": "string" }, "Targets": [ { "Key": "string", "Values": [ "string" ] } ], "TimeoutSeconds": number, "TriggeredAlarms": [ { "Name": "string", "State": "string" } ], "ValidNextSteps": [ "string" ] } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Type: String


A list of details about the current state of all steps that make up an execution.

Type: Array of StepExecution objects


For information about the errors that are common to all actions, see Common Errors.


There is no automation execution information for the requested automation execution ID.

HTTP Status Code: 400


An error occurred on the server side.

HTTP Status Code: 500


The specified key isn't valid.

HTTP Status Code: 400


The filter value isn't valid. Verify the value and try again.

HTTP Status Code: 400


The specified token isn't valid.

HTTP Status Code: 400



This example illustrates one usage of DescribeAutomationStepExecutions.

Sample Request

POST / HTTP/1.1 Host: Accept-Encoding: identity X-Amz-Target: AmazonSSM.DescribeAutomationStepExecutions Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20200324T180909Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20200324/us-east-2/ssm/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 65 { "AutomationExecutionId": "8a5f5be8-5d93-437a-adbb-394f7EXAMPLE" }

Sample Response

{ "StepExecutions": [ { "Action": "aws:createImage", "ExecutionEndTime": 1585062668.968, "ExecutionStartTime": 1585061571.144, "Inputs": { "ImageDescription": "\"AMI for i-02573cafcfEXAMPLE created on 2020-03-24_14.52.51\"", "ImageName": "\"i-02573cafcfEXAMPLE-2020-03-24_14.52.51\"", "InstanceId": "\"i-02573cafcfEXAMPLE\"", "NoReboot": "false" }, "OnFailure": "Abort", "Outputs": { "ImageId": [ "ami-0f4706cb37EXAMPLE" ], "ImageState": [ "available" ], "OutputPayload": [ "{\"ImageId\":\"ami-0f4706cb37EXAMPLE\",\"ImageState\":\"available\"}" ] }, "OverriddenParameters": {}, "StepExecutionId": "eff80946-356d-4128-97b2-6a0f5EXAMPLE", "StepName": "createImage", "StepStatus": "Success" } ] }

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: