GetAutomationExecution
Get detailed information about a particular Automation execution.
Request Syntax
{
"AutomationExecutionId": "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.
- AutomationExecutionId
-
The unique identifier for an existing automation execution to examine. The execution ID is returned by StartAutomationExecution when the execution of an Automation runbook is initiated.
Type: String
Length Constraints: Fixed length of 36.
Required: Yes
Response Syntax
{
"AutomationExecution": {
"AlarmConfiguration": {
"Alarms": [
{
"Name": "string"
}
],
"IgnorePollAlarmFailure": boolean
},
"AssociationId": "string",
"AutomationExecutionId": "string",
"AutomationExecutionStatus": "string",
"AutomationSubtype": "string",
"ChangeRequestName": "string",
"CurrentAction": "string",
"CurrentStepName": "string",
"DocumentName": "string",
"DocumentVersion": "string",
"ExecutedBy": "string",
"ExecutionEndTime": number,
"ExecutionStartTime": number,
"FailureMessage": "string",
"MaxConcurrency": "string",
"MaxErrors": "string",
"Mode": "string",
"OpsItemId": "string",
"Outputs": {
"string" : [ "string" ]
},
"Parameters": {
"string" : [ "string" ]
},
"ParentAutomationExecutionId": "string",
"ProgressCounters": {
"CancelledSteps": number,
"FailedSteps": number,
"SuccessSteps": number,
"TimedOutSteps": number,
"TotalSteps": number
},
"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,
"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" ]
}
],
"StepExecutionsTruncated": boolean,
"Target": "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" ]
}
],
"TriggeredAlarms": [
{
"Name": "string",
"State": "string"
}
],
"Variables": {
"string" : [ "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.
- AutomationExecution
-
Detailed information about the current state of an automation execution.
Type: AutomationExecution object
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: 500
Examples
Example
This example illustrates one usage of GetAutomationExecution.
Sample Request
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.GetAutomationExecution
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: 20200324T185532Z
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
{
"AutomationExecution": {
"AutomationExecutionId": "8a5f5be8-5d93-437a-adbb-394f7EXAMPLE",
"AutomationExecutionStatus": "Success",
"DocumentName": "CreateImage",
"DocumentVersion": "1",
"ExecutedBy": "arn:aws:sts::111122223333:assumed-role/Example",
"ExecutionEndTime": 1585062669.053,
"ExecutionStartTime": 1585061570.827,
"Mode": "Auto",
"Outputs": {},
"Parameters": {
"InstanceId": [
"i-02573cafcfEXAMPLE"
]
},
"ResolvedTargets": {
"ParameterValues": [],
"Truncated": false
},
"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"
}
],
"StepExecutionsTruncated": false,
"Targets": []
}
}See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: