AutomationExecution - Amazon Systems Manager
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

AutomationExecution

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

Contents

AssociationId

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

Type: String

Required: No

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 | PendingApproval | Approved | Rejected | Scheduled | RunbookInProgress | PendingChangeCalendarOverride | ChangeCalendarOverrideApproved | ChangeCalendarOverrideRejected | CompletedWithSuccess | CompletedWithFailure

Required: No

AutomationSubtype

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

Type: String

Valid Values: ChangeRequest

Required: No

ChangeRequestName

The name of the Change Manager change request.

Type: String

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

Required: No

CurrentAction

The action of the step that is currently running.

Type: String

Required: No

CurrentStepName

The name of the step that is currently running.

Type: String

Required: No

DocumentName

The name of the Automation runbook 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 ran 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

OpsItemId

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

Type: String

Required: No

Outputs

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

Type: String to array of strings map

Map Entries: Maximum number of 200 items.

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

Array Members: Minimum number of 0 items. Maximum number of 50 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

Map Entries: Maximum number of 200 items.

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

Array Members: Minimum number of 0 items. Maximum number of 50 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

ProgressCounters

An aggregate of step execution statuses displayed in the Amazon Systems Manager console for a multi-Region and multi-account Automation execution.

Type: ProgressCounters object

Required: No

ResolvedTargets

A list of resolved targets in the rate control execution.

Type: ResolvedTargets object

Required: No

Runbooks

Information about the Automation runbooks 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.

Type: Array of Runbook objects

Array Members: Fixed number of 1 item.

Required: No

ScheduledTime

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

Type: Timestamp

Required: No

StepExecutions

A list of details about the current state of all steps that comprise an execution. An Automation runbook contains a list of steps that are run 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 operation to get the full list of step executions.

Type: Boolean

Required: No

Target

The target of the execution.

Type: String

Required: No

TargetLocations

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

Type: Array of TargetLocation objects

Array Members: Minimum number of 1 item. Maximum number of 100 items.

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.

Map Entries: Maximum number of 20 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 parameter name.

Type: String

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

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 Amazon SDKs, see the following: