/

The Amazon SSM multi-region endpoint

http://ssm.{region}.amazonaws.com

POST

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

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'http://ssm.{region}.amazonaws.com/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "AutomationExecutionId": "string",
    "Filters": [],
    "NextToken": "string",
    "MaxResults": 0,
    "ReverseOrder": true
}'

Response Example

200 - Example 1

{
    "StepExecutions": [],
    "NextToken": "string"
}

Request

Query Params

MaxResults

string

optional

Pagination limit

NextToken

string

optional

Pagination token

Header Params

X-Amz-Target

string

required

Body Params application/json

AutomationExecutionId

string

required

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

>= 36 characters<= 36 characters

Filters

array[object (StepExecutionFilter) {2}]

optional

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

>= 1 items<= 6 items

Key

enum<string>

required

One or more keys to limit the results. Valid filter keys include the following: StepName, Action, StepExecutionId, StepExecutionStatus, StartTimeBefore, StartTimeAfter.

Allowed values:

StartTimeBeforeStartTimeAfterStepExecutionStatusStepExecutionIdStepNameAction

Values

array[string]

required

The values of the filter key.

>= 1 items<= 10 items

NextToken

string

optional

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

MaxResults

integer

optional

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.

>= 1<= 50

ReverseOrder

boolean

optional

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

Examples

Responses

🟢200Success

application/json

Body

StepExecutions

array[object (StepExecution) {23}]

optional

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

StepName

string

optional

The name of this execution step.

Action

string

optional

The action this step performs. The action determines the behavior of the step.

Match pattern:

^aws:[a-zA-Z]{3,25}$

TimeoutSeconds

integer

optional

The timeout seconds of the step.

OnFailure

string

optional

The action to take if the step fails. The default value is Abort.

MaxAttempts

integer

optional

The maximum number of tries to run the action of the step. The default value is 1.

ExecutionStartTime

string <date-time>

optional

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.

ExecutionEndTime

string <date-time>

optional

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.

StepStatus

enum<string>

optional

The execution status for this step.

Allowed values:

PendingInProgressWaitingSuccessTimedOutCancellingCancelledFailedPendingApprovalApprovedRejectedScheduledRunbookInProgressPendingChangeCalendarOverrideChangeCalendarOverrideApprovedChangeCalendarOverrideRejectedCompletedWithSuccessCompletedWithFailure

ResponseCode

string

optional

The response code returned by the execution of the step.

Inputs

object

optional

Fully-resolved values passed into the step before execution.

Outputs

object

optional

Returned values from the execution of the step.

Response

string

optional

A message associated with the response code for an execution.

FailureMessage

string

optional

If a step failed, this message explains why the execution failed.

FailureDetails

object

optional

Information about the Automation failure.

StepExecutionId

string

optional

The unique ID of a step execution.

OverriddenParameters

object

optional

A user-specified list of parameters to override when running a step.

IsEnd

boolean

optional

The flag which can be used to end automation no matter whether the step succeeds or fails.

NextStep

string

optional

The next step after the step succeeds.

IsCritical

boolean

optional

The flag which can be used to help decide whether the failure of current step leads to the Automation failure.

ValidNextSteps

array[string]

optional

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.

Targets

array [object]

optional

The targets for the step execution.

>= 0 items<= 5 items

TargetLocation

object

optional

The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Automation execution.

TriggeredAlarms

array[object (AlarmStateInformation) {2}]

optional

The CloudWatch alarms that were invoked by the automation.

>= 1 items<= 1 items

NextToken

string

optional

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

🟠480AutomationExecutionNotFoundException

🟠481InvalidNextToken

🟠482InvalidFilterKey

🟠483InvalidFilterValue

🟠484InternalServerError