get-automation-execution¶

Description¶

Get detailed information about a particular Automation execution.

Synopsis¶

  get-automation-execution
--automation-execution-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--automation-execution-id (string)

The unique identifier for an existing automation execution to examine. The execution ID is returned by StartAutomationExecution when the execution of an Automation document is initiated.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To display details about an automation execution

The following get-automation-execution example displays detailed information about an Automation execution.

aws ssm get-automation-execution \
    --automation-execution-id 73c8eef8-f4ee-4a05-820c-e354fEXAMPLE

Output:

{
    "AutomationExecution": {
        "AutomationExecutionId": "73c8eef8-f4ee-4a05-820c-e354fEXAMPLE",
        "DocumentName": "AWS-StartEC2Instance",
        "DocumentVersion": "1",
        "ExecutionStartTime": 1583737233.748,
        "ExecutionEndTime": 1583737234.719,
        "AutomationExecutionStatus": "Success",
        "StepExecutions": [
            {
                "StepName": "startInstances",
                "Action": "aws:changeInstanceState",
                "ExecutionStartTime": 1583737234.134,
                "ExecutionEndTime": 1583737234.672,
                "StepStatus": "Success",
                "Inputs": {
                    "DesiredState": "\"running\"",
                    "InstanceIds": "[\"i-0cb99161f6EXAMPLE\"]"
                },
                "Outputs": {
                    "InstanceStates": [
                        "running"
                    ]
                },
                "StepExecutionId": "95e70479-cf20-4d80-8018-7e4e2EXAMPLE",
                "OverriddenParameters": {}
            }
        ],
        "StepExecutionsTruncated": false,
        "Parameters": {
            "AutomationAssumeRole": [
                ""
            ],
            "InstanceId": [
                "i-0cb99161f6EXAMPLE"
            ]
        },
        "Outputs": {},
        "Mode": "Auto",
        "ExecutedBy": "arn:aws:sts::29884EXAMPLE:assumed-role/mw_service_role/OrchestrationService",
        "Targets": [],
        "ResolvedTargets": {
            "ParameterValues": [],
            "Truncated": false
        }
    }
}

For more information, see Walkthrough: Patch a Linux AMI (AWS CLI) in the AWS Systems Manager User Guide.

Output¶

AutomationExecution -> (structure)

Detailed information about the current state of an automation execution.

AutomationExecutionId -> (string)

The execution ID.

DocumentName -> (string)

The name of the Automation document used during the execution.

DocumentVersion -> (string)

The version of the document to use during execution.

ExecutionStartTime -> (timestamp)

The time the execution started.

ExecutionEndTime -> (timestamp)

The time the execution finished.

AutomationExecutionStatus -> (string)

The execution status of the Automation.

StepExecutions -> (list)

A list of details about the current state of all steps that comprise an execution. An Automation document contains a list of steps that are run in order.

(structure)

Detailed information about an the execution state of an Automation step.

StepName -> (string)

The name of this execution step.

Action -> (string)

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

TimeoutSeconds -> (long)

The timeout seconds of the step.

OnFailure -> (string)

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

MaxAttempts -> (integer)

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

ExecutionStartTime -> (timestamp)

If a step has begun execution, this contains the time the step started. If the step is in Pending status, this field is not populated.

ExecutionEndTime -> (timestamp)

If a step has finished execution, this contains the time the execution ended. If the step has not yet concluded, this field is not populated.

StepStatus -> (string)

The execution status for this step.

ResponseCode -> (string)

The response code returned by the execution of the step.

Inputs -> (map)

Fully-resolved values passed into the step before execution.

key -> (string)

value -> (string)

Outputs -> (map)

Returned values from the execution of the step.

key -> (string)

value -> (list)

(string)

Response -> (string)

A message associated with the response code for an execution.

FailureMessage -> (string)

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

FailureDetails -> (structure)

Information about the Automation failure.

FailureStage -> (string)

The stage of the Automation execution when the failure occurred. The stages include the following: InputValidation, PreVerification, Invocation, PostVerification.

FailureType -> (string)

The type of Automation failure. Failure types include the following: Action, Permission, Throttling, Verification, Internal.

Details -> (map)

Detailed information about the Automation step failure.

key -> (string)

value -> (list)

(string)

StepExecutionId -> (string)

The unique ID of a step execution.

OverriddenParameters -> (map)

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

key -> (string)

value -> (list)

(string)

IsEnd -> (boolean)

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

NextStep -> (string)

The next step after the step succeeds.

IsCritical -> (boolean)

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

ValidNextSteps -> (list)

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.

(string)

Targets -> (list)

The targets for the step execution.

(structure)

An array of search criteria that targets instances using a Key,Value combination that you specify.

Note

One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, AWS Lambda, and AWS Step Functions). For more information about running tasks that do not specify targets, see Registering maintenance window tasks without targets in the AWS Systems Manager User Guide .

Supported formats include the following.

``Key=InstanceIds,Values=*instance-id-1* ,*instance-id-2* ,*instance-id-3* ``

``Key=tag:my-tag-key ,Values=*my-tag-value-1* ,*my-tag-value-2* ``

``Key=tag-key,Values=*my-tag-key-1* ,*my-tag-key-2* ``

Run Command and Maintenance window targets only : ``Key=resource-groups:Name,Values=*resource-group-name* ``

Maintenance window targets only : ``Key=resource-groups:ResourceTypeFilters,Values=*resource-type-1* ,*resource-type-2* ``

Automation targets only : ``Key=ResourceGroup;Values=*resource-group-name* ``

For example:

Key=InstanceIds,Values=i-02573cafcfEXAMPLE,i-0471e04240EXAMPLE,i-07782c72faEXAMPLE

Key=tag:CostCenter,Values=CostCenter1,CostCenter2,CostCenter3

Key=tag-key,Values=Name,Instance-Type,CostCenter

Run Command and Maintenance window targets only : Key=resource-groups:Name,Values=ProductionResourceGroup This example demonstrates how to target all resources in the resource group ProductionResourceGroup in your maintenance window.

Maintenance window targets only : ``Key=resource-groups:ResourceTypeFilters,Values=*AWS::EC2::INSTANCE* ,*AWS::EC2::VPC* `` This example demonstrates how to target only EC2 instances and VPCs in your maintenance window.

Automation targets only : Key=ResourceGroup,Values=MyResourceGroup

State Manager association targets only : Key=InstanceIds,Values=* This example demonstrates how to target all managed instances in the AWS Region where the association was created.

For more information about how to send commands that target instances using Key,Value parameters, see Targeting multiple instances in the AWS Systems Manager User Guide .

Key -> (string)

User-defined criteria for sending commands that target instances that meet the criteria.

Values -> (list)

User-defined criteria that maps to Key . For example, if you specified tag:ServerRole , you could specify value:WebServer to run a command on instances that include EC2 tags of ServerRole,WebServer .

(string)

TargetLocation -> (structure)

The combination of AWS Regions and accounts targeted by the current Automation execution.

Accounts -> (list)

The AWS accounts targeted by the current Automation execution.

(string)

Regions -> (list)

The AWS Regions targeted by the current Automation execution.

(string)

TargetLocationMaxConcurrency -> (string)

The maximum number of AWS accounts and AWS regions allowed to run the Automation concurrently.

TargetLocationMaxErrors -> (string)

The maximum number of errors allowed before the system stops queueing additional Automation executions for the currently running Automation.

ExecutionRoleName -> (string)

The Automation execution role used by the currently running Automation. If not specified, the default value is AWS-SystemsManager-AutomationExecutionRole .

StepExecutionsTruncated -> (boolean)

A boolean value that indicates if the response contains the full list of the Automation step executions. If true, use the DescribeAutomationStepExecutions API action to get the full list of step executions.

Parameters -> (map)

The key-value map of execution parameters, which were supplied when calling StartAutomationExecution.

key -> (string)

value -> (list)

(string)

Outputs -> (map)

The list of execution outputs as defined in the automation document.

key -> (string)

value -> (list)

(string)

FailureMessage -> (string)

A message describing why an execution has failed, if the status is set to Failed.

Mode -> (string)

The automation execution mode.

ParentAutomationExecutionId -> (string)

The AutomationExecutionId of the parent automation.

ExecutedBy -> (string)

The Amazon Resource Name (ARN) of the user who ran the automation.

CurrentStepName -> (string)

The name of the step that is currently running.

CurrentAction -> (string)

The action of the step that is currently running.

TargetParameterName -> (string)

The parameter name.

Targets -> (list)

The specified targets.

(structure)

An array of search criteria that targets instances using a Key,Value combination that you specify.

Note

One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, AWS Lambda, and AWS Step Functions). For more information about running tasks that do not specify targets, see Registering maintenance window tasks without targets in the AWS Systems Manager User Guide .

Supported formats include the following.

``Key=InstanceIds,Values=*instance-id-1* ,*instance-id-2* ,*instance-id-3* ``

``Key=tag:my-tag-key ,Values=*my-tag-value-1* ,*my-tag-value-2* ``

``Key=tag-key,Values=*my-tag-key-1* ,*my-tag-key-2* ``

Run Command and Maintenance window targets only : ``Key=resource-groups:Name,Values=*resource-group-name* ``

Maintenance window targets only : ``Key=resource-groups:ResourceTypeFilters,Values=*resource-type-1* ,*resource-type-2* ``

Automation targets only : ``Key=ResourceGroup;Values=*resource-group-name* ``

For example:

Key=InstanceIds,Values=i-02573cafcfEXAMPLE,i-0471e04240EXAMPLE,i-07782c72faEXAMPLE

Key=tag:CostCenter,Values=CostCenter1,CostCenter2,CostCenter3

Key=tag-key,Values=Name,Instance-Type,CostCenter

Run Command and Maintenance window targets only : Key=resource-groups:Name,Values=ProductionResourceGroup This example demonstrates how to target all resources in the resource group ProductionResourceGroup in your maintenance window.

Maintenance window targets only : ``Key=resource-groups:ResourceTypeFilters,Values=*AWS::EC2::INSTANCE* ,*AWS::EC2::VPC* `` This example demonstrates how to target only EC2 instances and VPCs in your maintenance window.

Automation targets only : Key=ResourceGroup,Values=MyResourceGroup

State Manager association targets only : Key=InstanceIds,Values=* This example demonstrates how to target all managed instances in the AWS Region where the association was created.

For more information about how to send commands that target instances using Key,Value parameters, see Targeting multiple instances in the AWS Systems Manager User Guide .

Key -> (string)

User-defined criteria for sending commands that target instances that meet the criteria.

Values -> (list)

User-defined criteria that maps to Key . For example, if you specified tag:ServerRole , you could specify value:WebServer to run a command on instances that include EC2 tags of ServerRole,WebServer .

(string)

TargetMaps -> (list)

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

(map)

key -> (string)

value -> (list)

(string)

ResolvedTargets -> (structure)

A list of resolved targets in the rate control execution.

ParameterValues -> (list)

A list of parameter values sent to targets that resolved during the Automation execution.

(string)

Truncated -> (boolean)

A boolean value indicating whether the resolved target list is truncated.

MaxConcurrency -> (string)

The MaxConcurrency value specified by the user when the execution started.

MaxErrors -> (string)

The MaxErrors value specified by the user when the execution started.

Target -> (string)

The target of the execution.

TargetLocations -> (list)

The combination of AWS Regions and/or AWS accounts where you want to run the Automation.

(structure)

The combination of AWS Regions and accounts targeted by the current Automation execution.

Accounts -> (list)

The AWS accounts targeted by the current Automation execution.

(string)

Regions -> (list)

The AWS Regions targeted by the current Automation execution.

(string)

TargetLocationMaxConcurrency -> (string)

The maximum number of AWS accounts and AWS regions allowed to run the Automation concurrently.

TargetLocationMaxErrors -> (string)

The maximum number of errors allowed before the system stops queueing additional Automation executions for the currently running Automation.

ExecutionRoleName -> (string)

The Automation execution role used by the currently running Automation. If not specified, the default value is AWS-SystemsManager-AutomationExecutionRole .

ProgressCounters -> (structure)

An aggregate of step execution statuses displayed in the AWS Console for a multi-Region and multi-account Automation execution.

TotalSteps -> (integer)

The total number of steps run in all specified AWS Regions and accounts for the current Automation execution.

SuccessSteps -> (integer)

The total number of steps that successfully completed in all specified AWS Regions and accounts for the current Automation execution.

FailedSteps -> (integer)

The total number of steps that failed to run in all specified AWS Regions and accounts for the current Automation execution.

CancelledSteps -> (integer)

The total number of steps that the system cancelled in all specified AWS Regions and accounts for the current Automation execution.

TimedOutSteps -> (integer)

The total number of steps that timed out in all specified AWS Regions and accounts for the current Automation execution.

AutomationSubtype -> (string)

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

ScheduledTime -> (timestamp)

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

Runbooks -> (list)

Information about the Automation runbooks (Automation documents) that are run as part of a runbook workflow.

Note

The Automation runbooks specified for the runbook workflow can’t run until all required approvals for the change request have been received.

(structure)

Information about an Automation runbook (Automation document) used in a runbook workflow in Change Manager.

Note

The Automation runbooks specified for the runbook workflow can’t run until all required approvals for the change request have been received.

DocumentName -> (string)

The name of the Automation runbook (Automation document) used in a runbook workflow.

DocumentVersion -> (string)

The version of the Automation runbook (Automation document) used in a runbook workflow.

Parameters -> (map)

The key-value map of execution parameters, which were supplied when calling StartChangeRequestExecution .

key -> (string)

value -> (list)

(string)

TargetParameterName -> (string)

The name of the parameter used as the target resource for the rate-controlled runbook workflow. Required if you specify Targets .

Targets -> (list)

A key-value mapping to target resources that the Runbook operation performs tasks on. Required if you specify TargetParameterName .

(structure)

An array of search criteria that targets instances using a Key,Value combination that you specify.

Note

One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, AWS Lambda, and AWS Step Functions). For more information about running tasks that do not specify targets, see Registering maintenance window tasks without targets in the AWS Systems Manager User Guide .

Supported formats include the following.

``Key=InstanceIds,Values=*instance-id-1* ,*instance-id-2* ,*instance-id-3* ``

``Key=tag:my-tag-key ,Values=*my-tag-value-1* ,*my-tag-value-2* ``

``Key=tag-key,Values=*my-tag-key-1* ,*my-tag-key-2* ``

Run Command and Maintenance window targets only : ``Key=resource-groups:Name,Values=*resource-group-name* ``

Maintenance window targets only : ``Key=resource-groups:ResourceTypeFilters,Values=*resource-type-1* ,*resource-type-2* ``

Automation targets only : ``Key=ResourceGroup;Values=*resource-group-name* ``

For example:

Key=InstanceIds,Values=i-02573cafcfEXAMPLE,i-0471e04240EXAMPLE,i-07782c72faEXAMPLE

Key=tag:CostCenter,Values=CostCenter1,CostCenter2,CostCenter3

Key=tag-key,Values=Name,Instance-Type,CostCenter

Run Command and Maintenance window targets only : Key=resource-groups:Name,Values=ProductionResourceGroup This example demonstrates how to target all resources in the resource group ProductionResourceGroup in your maintenance window.

Maintenance window targets only : ``Key=resource-groups:ResourceTypeFilters,Values=*AWS::EC2::INSTANCE* ,*AWS::EC2::VPC* `` This example demonstrates how to target only EC2 instances and VPCs in your maintenance window.

Automation targets only : Key=ResourceGroup,Values=MyResourceGroup

State Manager association targets only : Key=InstanceIds,Values=* This example demonstrates how to target all managed instances in the AWS Region where the association was created.

For more information about how to send commands that target instances using Key,Value parameters, see Targeting multiple instances in the AWS Systems Manager User Guide .

Key -> (string)

User-defined criteria for sending commands that target instances that meet the criteria.

Values -> (list)

User-defined criteria that maps to Key . For example, if you specified tag:ServerRole , you could specify value:WebServer to run a command on instances that include EC2 tags of ServerRole,WebServer .

(string)

MaxConcurrency -> (string)

The MaxConcurrency value specified by the user when the operation started, indicating the maximum number of resources that the runbook operation can run on at the same time.

MaxErrors -> (string)

The MaxErrors value specified by the user when the execution started, indicating the maximum number of errors that can occur during the operation before the updates are stopped or rolled back.

TargetLocations -> (list)

Information about the AWS Regions and accounts targeted by the current Runbook operation.

(structure)

The combination of AWS Regions and accounts targeted by the current Automation execution.

Accounts -> (list)

The AWS accounts targeted by the current Automation execution.

(string)

Regions -> (list)

The AWS Regions targeted by the current Automation execution.

(string)

TargetLocationMaxConcurrency -> (string)

The maximum number of AWS accounts and AWS regions allowed to run the Automation concurrently.

TargetLocationMaxErrors -> (string)

The maximum number of errors allowed before the system stops queueing additional Automation executions for the currently running Automation.

ExecutionRoleName -> (string)

The Automation execution role used by the currently running Automation. If not specified, the default value is AWS-SystemsManager-AutomationExecutionRole .

OpsItemId -> (string)

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

AssociationId -> (string)

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

ChangeRequestName -> (string)

The name of the Change Manager change request.

Table of Contents

Feedback

User Guide