Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

DescribeAutomationExecutions

Provides details about all active and terminated Automation executions.

Request Syntax


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

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.

Filters

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

Type: Array of AutomationExecutionFilter objects

Array Members: Minimum number of 1 item. Maximum number of 10 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

Response Syntax


{
   "AutomationExecutionMetadataList": [ 
      { 
         "AlarmConfiguration": { 
            "Alarms": [ 
               { 
                  "Name": "string"
               }
            ],
            "IgnorePollAlarmFailure": boolean
         },
         "AssociationId": "string",
         "AutomationExecutionId": "string",
         "AutomationExecutionStatus": "string",
         "AutomationSubtype": "string",
         "AutomationType": "string",
         "ChangeRequestName": "string",
         "CurrentAction": "string",
         "CurrentStepName": "string",
         "DocumentName": "string",
         "DocumentVersion": "string",
         "ExecutedBy": "string",
         "ExecutionEndTime": number,
         "ExecutionStartTime": number,
         "FailureMessage": "string",
         "LogFile": "string",
         "MaxConcurrency": "string",
         "MaxErrors": "string",
         "Mode": "string",
         "OpsItemId": "string",
         "Outputs": { 
            "string" : [ "string" ]
         },
         "ParentAutomationExecutionId": "string",
         "ResolvedTargets": { 
            "ParameterValues": [ "string" ],
            "Truncated": boolean
         },
         "Runbooks": [ 
            { 
               "DocumentName": "string",
               "DocumentVersion": "string",
               "MaxConcurrency": "string",
               "MaxErrors": "string",
               "Parameters": { 
                  "string" : [ "string" ]
               },
               "TargetLocations": [ 
                  { 
                     "Accounts": [ "string" ],
                     "ExecutionRoleName": "string",
                     "Regions": [ "string" ],
                     "TargetLocationAlarmConfiguration": { 
                        "Alarms": [ 
                           { 
                              "Name": "string"
                           }
                        ],
                        "IgnorePollAlarmFailure": boolean
                     },
                     "TargetLocationMaxConcurrency": "string",
                     "TargetLocationMaxErrors": "string"
                  }
               ],
               "TargetMaps": [ 
                  { 
                     "string" : [ "string" ]
                  }
               ],
               "TargetParameterName": "string",
               "Targets": [ 
                  { 
                     "Key": "string",
                     "Values": [ "string" ]
                  }
               ]
            }
         ],
         "ScheduledTime": number,
         "Target": "string",
         "TargetMaps": [ 
            { 
               "string" : [ "string" ]
            }
         ],
         "TargetParameterName": "string",
         "Targets": [ 
            { 
               "Key": "string",
               "Values": [ "string" ]
            }
         ],
         "TriggeredAlarms": [ 
            { 
               "Name": "string",
               "State": "string"
            }
         ]
      }
   ],
   "NextToken": "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.

AutomationExecutionMetadataList

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

Type: Array of AutomationExecutionMetadata objects

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

Errors

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

InternalServerError

An error occurred on the server side.

HTTP Status Code: 500

InvalidFilterKey

The specified key isn't valid.

HTTP Status Code: 400

InvalidFilterValue

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

HTTP Status Code: 400

InvalidNextToken

The specified token isn't valid.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of DescribeAutomationExecutions.

Sample Request


POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.DescribeAutomationExecutions
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: 20200324T173011Z
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: 2

Sample Response


{
    "AutomationExecutionMetadataList": [
        {
            "AutomationExecutionId": "8a5f5be8-5d93-437a-adbb-394f7EXAMPLE",
            "AutomationExecutionStatus": "Success",
            "AutomationType": "Local",
            "DocumentName": "Example",
            "DocumentVersion": "1",
            "ExecutedBy": "arn:aws:sts::111122223333:assumed-role/Example",
            "ExecutionEndTime": 1585062669.053,
            "ExecutionStartTime": 1585061570.827,
            "LogFile": "",
            "Mode": "Auto",
            "Outputs": {},
            "ResolvedTargets": {
                "ParameterValues": [],
                "Truncated": false
            },
            "Targets": []
        }
    ]
}