AWS Systems Manager
API Reference (API Version 2014-11-06)

AutomationExecutionMetadata

Details about a specific Automation execution.

Contents

AutomationExecutionId

The execution ID.

Type: String

Length Constraints: Fixed length of 36.

Required: No

AutomationExecutionStatus

The status of the execution. Valid values include: Running, Succeeded, Failed, Timed out, or Cancelled.

Type: String

Valid Values: Pending | InProgress | Waiting | Success | TimedOut | Cancelling | Cancelled | Failed

Required: No

AutomationType

Use this filter with DescribeAutomationExecutions. Specify either Local or CrossAccount. CrossAccount is an Automation that executes in multiple AWS Regions and accounts. For more information, see Concurrently Executing Automations in Multiple AWS Regions and Accounts in the AWS Systems Manager User Guide.

Type: String

Valid Values: CrossAccount | Local

Required: No

CurrentAction

The action of the currently executing step.

Type: String

Required: No

CurrentStepName

The name of the currently executing step.

Type: String

Required: No

DocumentName

The name of the Automation document used during execution.

Type: String

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

Required: No

DocumentVersion

The document version used during the execution.

Type: String

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

Required: No

ExecutedBy

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

Type: String

Required: No

ExecutionEndTime

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

Type: Timestamp

Required: No

ExecutionStartTime

The time the execution started.>

Type: Timestamp

Required: No

FailureMessage

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

Type: String

Required: No

LogFile

An Amazon S3 bucket where execution information is stored.

Type: String

Required: No

MaxConcurrency

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 7.

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

Required: No

MaxErrors

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 7.

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

Required: No

Mode

The Automation execution mode.

Type: String

Valid Values: Auto | Interactive

Required: No

Outputs

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

Type: String to array of strings map

Key Length Constraints: Minimum length of 1. Maximum length of 30.

Array Members: Minimum number of 0 items. Maximum number of 10 items.

Length Constraints: Minimum length of 1. Maximum length of 512.

Required: No

ParentAutomationExecutionId

The ExecutionId of the parent Automation.

Type: String

Length Constraints: Fixed length of 36.

Required: No

ResolvedTargets

A list of targets that resolved during the execution.

Type: ResolvedTargets object

Required: No

Target

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

Type: String

Required: No

TargetMaps

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

Type: Array of string to array of strings maps

Array Members: Minimum number of 0 items. Maximum number of 300 items.

Key Length Constraints: Minimum length of 1. Maximum length of 50.

Array Members: Minimum number of 0 items. Maximum number of 25 items.

Length Constraints: Minimum length of 1. Maximum length of 50.

Required: No

TargetParameterName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 30.

Required: No

Targets

The targets defined by the user when starting the Automation.

Type: Array of Target objects

Array Members: Minimum number of 0 items. Maximum number of 5 items.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: