Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListPlanExecutions

Lists the executions of a Region switch plan. This operation returns information about both current and historical executions.

Request Syntax


{
   "maxResults": number,
   "nextToken": "string",
   "planArn": "string",
   "state": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

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's nextToken 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

Required: No

Response Syntax


{
   "items": [ 
      { 
         "actualRecoveryTime": "string",
         "comment": "string",
         "endTime": number,
         "executionAction": "string",
         "executionId": "string",
         "executionRegion": "string",
         "executionState": "string",
         "mode": "string",
         "planArn": "string",
         "recoveryExecutionId": "string",
         "startTime": number,
         "updatedAt": number,
         "version": "string"
      }
   ],
   "nextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

items

The items in the plan execution to return.

Type: Array of AbbreviatedExecution objects

nextToken

Type: String

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404