AutomationExecutionMetadata
Details about a specific Automation execution.
Contents
- AlarmConfiguration
-
The details for the CloudWatch alarm applied to your automation.
Type: AlarmConfiguration object
Required: No
- 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 status of the execution.
Type: String
Valid Values:
Pending | InProgress | Waiting | Success | TimedOut | Cancelling | Cancelled | Failed | PendingApproval | Approved | Rejected | Scheduled | RunbookInProgress | PendingChangeCalendarOverride | ChangeCalendarOverrideApproved | ChangeCalendarOverrideRejected | CompletedWithSuccess | CompletedWithFailure | Exited
Required: No
- AutomationSubtype
-
The subtype of the Automation operation. Currently, the only supported value is
ChangeRequest
.Type: String
Valid Values:
ChangeRequest
Required: No
- AutomationType
-
Use this filter with DescribeAutomationExecutions. Specify either Local or CrossAccount. CrossAccount is an Automation that runs in multiple AWS Regions and AWS accounts. For more information, see Running automations in multiple AWS Regions and accounts in the AWS Systems Manager User Guide.
Type: String
Valid Values:
CrossAccount | Local
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 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 ran the automation.
Type: String
Required: No
- ExecutionEndTime
-
The time the execution finished. This isn't 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 runbook.
Type: String
Required: No
- LogFile
-
An 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
- 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
- ParentAutomationExecutionId
-
The execution ID 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
- Runbooks
-
Information about the Automation runbooks 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.
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
- Target
-
The list of execution outputs as defined in the Automation runbook.
Type: String
Required: No
- TargetLocationsURL
-
A publicly accessible URL for a file that contains the
TargetLocations
body. Currently, only files in presigned Amazon S3 buckets are supportedType: String
Pattern:
^https:\/\/[-a-zA-Z0-9@:%._\+~#=]{1,253}\.s3(\.[a-z\d-]{9,16})?\.amazonaws\.com\/.{1,2000}
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 list of execution outputs as defined in the Automation runbook.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
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
- TriggeredAlarms
-
The CloudWatch alarm that was invoked by the automation.
Type: Array of AlarmStateInformation objects
Array Members: Fixed number of 1 item.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: