Menu
AWS Systems Manager
API Reference (API Version 2014-11-06)

DescribeAutomationStepExecutions

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.

AutomationExecutionId

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

Type: String

Length Constraints: Fixed length of 36.

Required: Yes

Filters

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

MaxResults

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

NextToken

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

Type: String

Required: No

ReverseOrder

A boolean that 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" 
         },
         "MaxAttempts": number,
         "OnFailure": "string",
         "Outputs": { 
            "string" : [ "string" ]
         },
         "OverriddenParameters": { 
            "string" : [ "string" ]
         },
         "Response": "string",
         "ResponseCode": "string",
         "StepExecutionId": "string",
         "StepName": "string",
         "StepStatus": "string",
         "TimeoutSeconds": number
      }
   ]
}

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.

NextToken

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

StepExecutions

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

Type: Array of StepExecution objects

Errors

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

AutomationExecutionNotFoundException

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

HTTP Status Code: 400

InternalServerError

An error occurred on the server side.

HTTP Status Code: 400

InvalidFilterKey

The specified key is not valid.

HTTP Status Code: 400

InvalidFilterValue

The filter value is not valid. Verify the value and try again.

HTTP Status Code: 400

InvalidNextToken

The specified token is not valid.

HTTP Status Code: 400

See Also

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