Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListZonalShifts

Lists all active and completed zonal shifts in Amazon Route 53 Application Recovery Controller in your AWS account in this AWS Region. ListZonalShifts returns customer-initiated zonal shifts, as well as practice run zonal shifts that Route 53 ARC started on your behalf for zonal autoshift.

The ListZonalShifts operation does not list autoshifts. For more information about listing autoshifts, see ">ListAutoshifts.

Request Syntax


GET /zonalshifts?maxResults=maxResults&nextToken=nextToken&resourceIdentifier=resourceIdentifier&status=status HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

The number of objects that you want to return with this call.

Valid Range: Minimum value of 1. Maximum value of 100.

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.

resourceIdentifier

The identifier for the resource that you want to list zonal shifts for. The identifier is the Amazon Resource Name (ARN) for the resource.

Length Constraints: Minimum length of 8. Maximum length of 1024.

status

A status for a zonal shift.

The Status for a zonal shift can have one of the following values:

ACTIVE: The zonal shift has been started and active.
EXPIRED: The zonal shift has expired (the expiry time was exceeded).
CANCELED: The zonal shift was canceled.

Valid Values: ACTIVE | EXPIRED | CANCELED

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "awayFrom": "string",
         "comment": "string",
         "expiryTime": number,
         "practiceRunOutcome": "string",
         "resourceIdentifier": "string",
         "startTime": number,
         "status": "string",
         "zonalShiftId": "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 response list.

Type: Array of ZonalShiftSummary objects

nextToken

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

InternalServerException

There was an internal server error.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400