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.
Get detailed information about an automation execution.
Inputs
Champ
Type
Description
region [required]
enum
default: us-east-1
automationExecutionId [required]
string
The unique identifier for an existing automation execution.
Outputs
Expand All
Champ
Type
Description
automationExecution
object
Detailed information about the current state of an automation execution.
AutomationExecutionId
string
The execution ID.
DocumentName
string
The name of the Automation runbook used during the execution.
DocumentVersion
string
The version of the document to use during execution.
ExecutionStartTime
date-time
The time the execution started.
ExecutionEndTime
date-time
The time the execution finished.
AutomationExecutionStatus
string
The execution status of the Automation.
StepExecutions
[object]
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.
StepName
string
The name of this execution step.
Action
string
The action this step performs. The action determines the behavior of the step.
TimeoutSeconds
number
The timeout seconds of the step.
OnFailure
string
The action to take if the step fails. The default value is Abort.
MaxAttempts
number
The maximum number of tries to run the action of the step. The default value is 1.
ExecutionStartTime
date-time
If a step has begun execution, this contains the time the step started. If the step is in Pending status, this field isn't populated.
ExecutionEndTime
date-time
If a step has finished execution, this contains the time the execution ended. If the step hasn't yet concluded, this field isn't populated.
StepStatus
string
The execution status for this step.
ResponseCode
string
The response code returned by the execution of the step.
Inputs
object
Fully-resolved values passed into the step before execution.
Outputs
object
Returned values from the execution of the step.
Response
string
A message associated with the response code for an execution.
FailureMessage
string
If a step failed, this message explains why the execution failed.
FailureDetails
object
Information about the Automation failure.
FailureStage
string
The stage of the Automation execution when the failure occurred. The stages include the following: InputValidation, PreVerification, Invocation, PostVerification.
FailureType
string
The type of Automation failure. Failure types include the following: Action, Permission, Throttling, Verification, Internal.
Details
object
Detailed information about the Automation step failure.
StepExecutionId
string
The unique ID of a step execution.
OverriddenParameters
object
A user-specified list of parameters to override when running a step.
IsEnd
boolean
The flag which can be used to end automation no matter whether the step succeeds or fails.
NextStep
string
The next step after the step succeeds.
IsCritical
boolean
The flag which can be used to help decide whether the failure of current step leads to the Automation failure.
ValidNextSteps
[string]
Strategies used when step fails, AWS supports Continue and Abort. Abort will fail the automation when the step fails. Continue will ignore the failure of current step and allow automation to run the next step. With conditional branching, AWS adds step:stepName to support the automation to go to another specific step.
Targets
[object]
The targets for the step execution.
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.
TargetLocation
object
The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Automation execution.
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.
TriggeredAlarms
[object]
The CloudWatch alarms that were invoked by the automation.
Name [required]
string
The name of your CloudWatch alarm.
State [required]
string
The state of your CloudWatch alarm.
ParentStepDetails
object
Information about the parent step.
StepExecutionId
string
The unique ID of a step execution.
StepName
string
The name of the step.
Action
string
The name of the automation action.
Iteration
number
The current repetition of the loop represented by an integer.
IteratorValue
string
The current value of the specified iterator in the loop.
StepExecutionsTruncated
boolean
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.
Parameters
object
The key-value map of execution parameters, which were supplied when calling StartAutomationExecution.
Outputs
object
The list of execution outputs as defined in the Automation runbook.
FailureMessage
string
A message describing why an execution has failed, if the status is set to Failed.
Mode
string
The automation execution mode.
ParentAutomationExecutionId
string
The AutomationExecutionId of the parent automation.
ExecutedBy
string
The Amazon Resource Name (ARN) of the user who ran the automation.
CurrentStepName
string
The name of the step that is currently running.
CurrentAction
string
The action of the step that is currently running.
TargetParameterName
string
The parameter name.
Targets
[object]
The specified targets.
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 resolved targets in the rate control 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 the execution started.
MaxErrors
string
The MaxErrors value specified by the user when the execution started.
Target
string
The target of the execution.
TargetLocations
[object]
The combination of Amazon Web Services Regions and/or Amazon Web Services accounts where you want to run the Automation.
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.
ProgressCounters
object
An aggregate of step execution statuses displayed in the Amazon Web Services Systems Manager console for a multi-Region and multi-account Automation execution.
TotalSteps
number
The total number of steps run in all specified Amazon Web Services Regions and Amazon Web Services accounts for the current Automation execution.
SuccessSteps
number
The total number of steps that successfully completed in all specified Amazon Web Services Regions and Amazon Web Services accounts for the current Automation execution.
FailedSteps
number
The total number of steps that failed to run in all specified Amazon Web Services Regions and Amazon Web Services accounts for the current Automation execution.
CancelledSteps
number
The total number of steps that the system cancelled in all specified Amazon Web Services Regions and Amazon Web Services accounts for the current Automation execution.
TimedOutSteps
number
The total number of steps that timed out in all specified Amazon Web Services Regions and Amazon Web Services accounts for the current Automation execution.
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 as part of a runbook workflow. 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.