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

AutomationExecution

Detailed information about the current state of an individual Automation execution.

Contents

AutomationExecutionId

The execution ID.

Type: String

Length Constraints: Fixed length of 36.

Required: No

AutomationExecutionStatus

The execution status of the Automation.

Type: String

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

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

Type: String

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

Required: No

DocumentVersion

The version of the document to use during execution.

Type: String

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

Required: No

ExecutedBy

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

Type: String

Required: No

ExecutionEndTime

The time the execution finished.

Type: Timestamp

Required: No

ExecutionStartTime

The time the execution started.

Type: Timestamp

Required: No

FailureMessage

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

Type: String

Required: No

MaxConcurrency

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

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 the execution started.

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

Parameters

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

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 AutomationExecutionId of the parent automation.

Type: String

Length Constraints: Fixed length of 36.

Required: No

ResolvedTargets

A list of resolved targets in the rate control execution.

Type: ResolvedTargets object

Required: No

StepExecutions

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 executed in order.

Type: Array of StepExecution objects

Required: No

StepExecutionsTruncated

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.

Type: Boolean

Required: No

Target

The target of the execution.

Type: String

Required: No

TargetParameterName

The parameter name.

Type: String

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

Required: No

Targets

The specified targets.

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: