/ - Amazon Simple Systems Manager (SSM)

Provides details about all active and terminated Automation executions.

curl --location -g --request POST 'http://ssm.{region}.amazonaws.com/' \ --header 'X-Amz-Target;' \ --header 'Content-Type: application/json' \ --data-raw '{ "Filters": [], "MaxResults": 0, "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

Filters

array[object (AutomationExecutionFilter) {2}]

optional

Filters used to limit the scope of executions that are requested.

>= 1 items<= 10 items

Key

enum<string>

required

One or more keys to limit the results.

Allowed values:

DocumentNamePrefixExecutionStatusExecutionIdParentExecutionIdCurrentActionStartTimeBeforeStartTimeAfterAutomationTypeTagKeyTargetResourceGroupAutomationSubtypeOpsItemId

Values

array[string]

required

The values used to limit the execution information associated with the filter's key.

>= 1 items<= 10 items

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

NextToken

string

optional

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

Examples

Responses

🟢200Success

application/json

Body

AutomationExecutionMetadataList

array[object (AutomationExecutionMetadata) {30}]

optional

The list of details about each automation execution which has occurred which matches the filter specification, if any.

AutomationExecutionId

string

optional

The execution ID.

>= 36 characters<= 36 characters

DocumentName

string

optional

The name of the Automation runbook used during execution.

Match pattern:

^[a-zA-Z0-9_\-.]{3,128}$

DocumentVersion

string

optional

The document version used during the execution.

Match pattern:

([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)

AutomationExecutionStatus

enum<string>

optional

The status of the execution.

Allowed values:

PendingInProgressWaitingSuccessTimedOutCancellingCancelledFailedPendingApprovalApprovedRejectedScheduledRunbookInProgressPendingChangeCalendarOverrideChangeCalendarOverrideApprovedChangeCalendarOverrideRejectedCompletedWithSuccessCompletedWithFailure

ExecutionStartTime

string <date-time>

optional

The time the execution started.

ExecutionEndTime

string <date-time>

optional

The time the execution finished. This isn't populated if the execution is still in progress.

ExecutedBy

string

optional

The IAM role ARN of the user who ran the automation.

LogFile

string

optional

An S3 bucket where execution information is stored.

Outputs

object

optional

The list of execution outputs as defined in the Automation runbook.

Mode

enum<string>

optional

The Automation execution mode.

Allowed values:

AutoInteractive

ParentAutomationExecutionId

string

optional

The execution ID of the parent automation.

>= 36 characters<= 36 characters

CurrentStepName

string

optional

The name of the step that is currently running.

CurrentAction

string

optional

The action of the step that is currently running.

FailureMessage

string

optional

The list of execution outputs as defined in the Automation runbook.

TargetParameterName

string

optional

The list of execution outputs as defined in the Automation runbook.

>= 1 characters<= 50 characters

Targets

array [object]

optional

The targets defined by the user when starting the automation.

>= 0 items<= 5 items

TargetMaps

array[object (TargetMap)]

optional

The specified key-value mapping of document parameters to target resources.

>= 0 items<= 300 items

ResolvedTargets

object

optional

A list of targets that resolved during the execution.

MaxConcurrency

string

optional

The MaxConcurrency value specified by the user when starting the automation.

>= 1 characters<= 7 characters

Match pattern:

^([1-9][0-9]*|[1-9][0-9]%|[1-9]%|100%)$

MaxErrors

string

optional

The MaxErrors value specified by the user when starting the automation.

>= 1 characters<= 7 characters

Match pattern:

^([1-9][0-9]*|[0]|[1-9][0-9]%|[0-9]%|100%)$

Target

string

optional

The list of execution outputs as defined in the Automation runbook.

AutomationType

enum<string>

optional

Use this filter with DescribeAutomationExecutions. Specify either Local or CrossAccount. CrossAccount is an Automation that runs in multiple Amazon Web Services Regions and Amazon Web Services accounts. For more information, see Running Automation workflows in multiple Amazon Web Services Regions and accounts in the Amazon Web Services Systems Manager User Guide.

Allowed values:

CrossAccountLocal

AlarmConfiguration

object

optional

The details for the CloudWatch alarm applied to your automation.

TriggeredAlarms

array[object (AlarmStateInformation) {2}]

optional

The CloudWatch alarm that was invoked by the automation.

>= 1 items<= 1 items

AutomationSubtype

enum<string>

optional

The subtype of the Automation operation. Currently, the only supported value is ChangeRequest.

Allowed value:

ChangeRequest

ScheduledTime

string <date-time>

optional

The date and time the Automation operation is scheduled to start.

Runbooks

array[object (Runbook) {9}]

optional

Information about the Automation runbooks that are run during a runbook workflow in Change Manager.

>= 1 items<= 1 items

OpsItemId

string

optional

The ID of an OpsItem that is created to represent a Change Manager change request.

AssociationId

string

optional

The ID of a State Manager association used in the Automation operation.

ChangeRequestName

string

optional

The name of the Change Manager change request.

>= 1 characters<= 1024 characters

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.

🟠480InvalidFilterKey

🟠481InvalidFilterValue

🟠482InvalidNextToken

🟠483InternalServerError