describe-automation-executions¶

Description¶

Provides details about all active and terminated Automation executions.

Synopsis¶

  describe-automation-executions
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options¶

--filters (list)

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

(structure)

A filter used to match specific automation executions. This is used to limit the scope of Automation execution information returned.

Key -> (string)

One or more keys to limit the results.

Values -> (list)

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

(string)

Shorthand Syntax:

Key=string,Values=string,string ...

JSON Syntax:

[
  {
    "Key": "DocumentNamePrefix"|"ExecutionStatus"|"ExecutionId"|"ParentExecutionId"|"CurrentAction"|"StartTimeBefore"|"StartTimeAfter"|"AutomationType"|"TagKey"|"TargetResourceGroup"|"AutomationSubtype"|"OpsItemId",
    "Values": ["string", ...]
  }
  ...
]

--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.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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 describe an automation execution

The following describe-automation-executions example displays details about an Automation execution.

aws ssm describe-automation-executions \
    --filters Key=ExecutionId,Values=73c8eef8-f4ee-4a05-820c-e354fEXAMPLE

Output:

{
    "AutomationExecutionMetadataList": [
        {
            "AutomationExecutionId": "73c8eef8-f4ee-4a05-820c-e354fEXAMPLE",
            "DocumentName": "AWS-StartEC2Instance",
            "DocumentVersion": "1",
            "AutomationExecutionStatus": "Success",
            "ExecutionStartTime": 1583737233.748,
            "ExecutionEndTime": 1583737234.719,
            "ExecutedBy": "arn:aws:sts::29884EXAMPLE:assumed-role/mw_service_role/OrchestrationService",
            "LogFile": "",
            "Outputs": {},
            "Mode": "Auto",
            "Targets": [],
            "ResolvedTargets": {
                "ParameterValues": [],
                "Truncated": false
            },
            "AutomationType": "Local"
        }
    ]
}

For more information, see Running a Simple Automation Workflow in the AWS Systems Manager User Guide.

Output¶

AutomationExecutionMetadataList -> (list)

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

(structure)

Details about a specific Automation execution.

AutomationExecutionId -> (string)

The execution ID.

DocumentName -> (string)

The name of the Automation document used during execution.

DocumentVersion -> (string)

The document version used during the execution.

AutomationExecutionStatus -> (string)

The status of the execution.

ExecutionStartTime -> (timestamp)

The time the execution started.

ExecutionEndTime -> (timestamp)

The time the execution finished. This is not populated if the execution is still in progress.

ExecutedBy -> (string)

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

LogFile -> (string)

An S3 bucket where execution information is stored.

Outputs -> (map)

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

key -> (string)

value -> (list)

(string)

Mode -> (string)

The Automation execution mode.

ParentAutomationExecutionId -> (string)

The ExecutionId of the parent Automation.

CurrentStepName -> (string)

The name of the step that is currently running.

CurrentAction -> (string)

The action of the step that is currently running.

FailureMessage -> (string)

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

TargetParameterName -> (string)

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

Targets -> (list)

The targets defined by the user when starting the Automation.

(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 targets that resolved during the 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 starting the Automation.

MaxErrors -> (string)

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

Target -> (string)

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

AutomationType -> (string)

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

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 during 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.

(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.

NextToken -> (string)

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

Table of Contents

Feedback

User Guide

describe-automation-executions¶

Description¶

Synopsis¶

Options¶

Examples¶

Output¶