GetPlanExecution
Retrieves detailed information about a specific plan execution. You must specify the plan ARN and execution ID.
Request Parameters
- executionId
-
The execution identifier of a plan execution.
Type: String
Required: Yes
- maxResults
-
The number of objects that you want to return with this call.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- nextToken
-
Specifies that you want to receive the next page of results. Valid only if you received a
nextTokenresponse in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call'snextTokenresponse to request the next page of results.Type: String
Required: No
- planArn
-
The Amazon Resource Name (ARN) of the plan with the execution to retrieve.
Type: String
Pattern:
arn:aws[a-zA-Z-]*:arc-region-switch::[0-9]{12}:plan/([a-zA-Z0-9](?:[a-zA-Z0-9-]{0,30}[a-zA-Z0-9])?):([a-z0-9]{6})Required: Yes
Response Elements
The following elements are returned by the service.
- actualRecoveryTime
-
The actual recovery time that Region switch calculates for a plan execution. Actual recovery time includes the time for the plan to run added to the time elapsed until the application health alarms that you've specified are healthy again.
Type: String
Pattern:
P(?!$)(\d+Y)?(\d+M)?(\d+D)?(T(?=\d)(\d+H)?(\d+M)?(\d+S)?)? - comment
-
A comment included on the plan execution.
Type: String
- endTime
-
The time (UTC) when the plan execution ended.
Type: Timestamp
- executionAction
-
The plan execution action. Valid values are
Activate, to activate an AWS Region, orDeactivate, to deactivate a Region.Type: String
Valid Values:
activate | deactivate - executionId
-
The execution identifier of a plan execution.
Type: String
- executionRegion
-
The AWS Region for a plan execution.
Type: String
- executionState
-
The plan execution state. Provides the state of a plan execution, for example, In Progress or Paused by Operator.
Type: String
Valid Values:
inProgress | pausedByFailedStep | pausedByOperator | completed | completedWithExceptions | canceled | planExecutionTimedOut | pendingManualApproval | failed | pending | completedMonitoringApplicationHealth - mode
-
The plan execution mode. Valid values are
Practice, for testing without making actual changes, orRecovery, for actual traffic shifting and application recovery.Type: String
Valid Values:
graceful | ungraceful - nextToken
-
Specifies that you want to receive the next page of results. Valid only if you received a
nextTokenresponse in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call'snextTokenresponse to request the next page of results.Type: String
- plan
-
The details of the Region switch plan.
Type: Plan object
- planArn
-
The Amazon Resource Name (ARN) of the plan.
Type: String
Pattern:
arn:aws[a-zA-Z-]*:arc-region-switch::[0-9]{12}:plan/([a-zA-Z0-9](?:[a-zA-Z0-9-]{0,30}[a-zA-Z0-9])?):([a-z0-9]{6}) - startTime
-
The time (UTC) when the plan execution started.
Type: Timestamp
- stepStates
-
The states of the steps in the plan execution.
Type: Array of StepState objects
- updatedAt
-
The timestamp when the plan execution was last updated.
Type: Timestamp
- version
-
The version for the plan.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
HTTP Status Code: 403
- ResourceNotFoundException
-
The specified resource was not found.
HTTP Status Code: 404
HTTP Status Code: 404
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
