ListPlanExecutions
Lists the executions of a Region switch plan. This operation returns information about both current and historical executions.
Request Parameters
- 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
nextToken
response 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'snextToken
response to request the next page of results.Type: String
Required: No
- planArn
-
The ARN for 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})
Required: Yes
- state
-
The state of the plan execution. For example, the plan execution might be In Progress.
Type: String
Valid Values:
inProgress | pausedByFailedStep | pausedByOperator | completed | completedWithExceptions | canceled | planExecutionTimedOut | pendingManualApproval | failed | pending | completedMonitoringApplicationHealth
Required: No
Response Elements
The following elements are returned by the service.
- items
-
The items in the plan execution to return.
Type: Array of AbbreviatedExecution objects
- nextToken
-
Specifies that you want to receive the next page of results. Valid only if you received a
nextToken
response 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'snextToken
response to request the next page of results.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: