Cette page n'est pas encore disponible en français, sa traduction est en cours. Si vous avez des questions ou des retours sur notre projet de traduction actuel, n'hésitez pas à nous contacter.
Provide details about all active and terminated automation executions.
Inputs
Expand All
Champ
Type
Description
region [required]
enum
default: us-east-1
filters
[object]
One or more filters to return a more specific list of results.
Key [required]
string
One or more keys to limit the results.
Values [required]
[string]
The values used to limit the execution information associated with the filter's key.
Outputs
Expand All
Champ
Type
Description
automationExecutions [required]
[object]
AutomationExecutionId
string
The execution ID.
DocumentName
string
The name of the Automation runbook used during execution.
DocumentVersion
string
The document version used during the execution.
AutomationExecutionStatus
string
The status of the execution.
ExecutionStartTime
date-time
The time the execution started.
ExecutionEndTime
date-time
The time the execution finished. This isn't 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
object
The list of execution outputs as defined in the Automation runbook.
Mode
string
The Automation execution mode.
ParentAutomationExecutionId
string
The execution ID 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 runbook.
TargetParameterName
string
The list of execution outputs as defined in the Automation runbook.
Targets
[object]
The targets defined by the user when starting the automation.
Key
string
User-defined criteria for sending commands that target managed nodes that meet the criteria.
Values
[string]
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. Depending on the type of target, the maximum number of values for a key might be lower than the global maximum of 50.
TargetMaps
[object]
The specified key-value mapping of document parameters to target resources.
ResolvedTargets
object
A list of targets that resolved during the execution.
ParameterValues
[string]
A list of parameter values sent to targets that resolved during the Automation execution.
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 runbook.
AutomationType
string
Use this filter with DescribeAutomationExecutions. Specify either Local or CrossAccount. CrossAccount is an Automation that runs in multiple Amazon Web Services Regions and Amazon Web Services accounts. For more information, see Running Automation workflows in multiple Amazon Web Services Regions and accounts in the Amazon Web Services Systems Manager User Guide.
AlarmConfiguration
object
The details for the CloudWatch alarm applied to your automation.
IgnorePollAlarmFailure
boolean
When this value is true, your automation or command continues to run in cases where we can’t retrieve alarm status information from CloudWatch. In cases where we successfully retrieve an alarm status of OK or INSUFFICIENT_DATA, the automation or command continues to run, regardless of this value. Default is false.
Alarms [required]
[object]
The name of the CloudWatch alarm specified in the configuration.
Name [required]
string
The name of your CloudWatch alarm.
TriggeredAlarms
[object]
The CloudWatch alarm that was invoked by the automation.
Name [required]
string
The name of your CloudWatch alarm.
State [required]
string
The state of your CloudWatch alarm.
AutomationSubtype
string
The subtype of the Automation operation. Currently, the only supported value is ChangeRequest.
ScheduledTime
date-time
The date and time the Automation operation is scheduled to start.
Runbooks
[object]
Information about the Automation runbooks that are run during a runbook workflow in Change Manager. The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.
DocumentName [required]
string
The name of the Automation runbook used in a runbook workflow.
DocumentVersion
string
The version of the Automation runbook used in a runbook workflow.
Parameters
object
The key-value map of execution parameters, which were supplied when calling StartChangeRequestExecution.
TargetParameterName
string
The name of the parameter used as the target resource for the rate-controlled runbook workflow. Required if you specify Targets.
Targets
[object]
A key-value mapping to target resources that the runbook operation performs tasks on. Required if you specify TargetParameterName.
Key
string
User-defined criteria for sending commands that target managed nodes that meet the criteria.
Values
[string]
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. Depending on the type of target, the maximum number of values for a key might be lower than the global maximum of 50.
TargetMaps
[object]
A key-value mapping of runbook parameters to target resources. Both Targets and TargetMaps can't be specified together.
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
[object]
Information about the Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Runbook operation.
Accounts
[string]
The Amazon Web Services accounts targeted by the current Automation execution.
Regions
[string]
The Amazon Web Services Regions targeted by the current Automation execution.
TargetLocationMaxConcurrency
string
The maximum number of Amazon Web Services Regions and Amazon Web Services accounts 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.
TargetLocationAlarmConfiguration
object
IgnorePollAlarmFailure
boolean
When this value is true, your automation or command continues to run in cases where we can’t retrieve alarm status information from CloudWatch. In cases where we successfully retrieve an alarm status of OK or INSUFFICIENT_DATA, the automation or command continues to run, regardless of this value. Default is false.
Alarms [required]
[object]
The name of the CloudWatch alarm specified in the configuration.
Name [required]
string
The name of your CloudWatch alarm.
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.
