ARCZonalShift / Client / list_zonal_shifts

list_zonal_shifts#

ARCZonalShift.Client.list_zonal_shifts(**kwargs)#

Lists all the active zonal shifts in Amazon Route 53 Application Recovery Controller in your AWS account in this AWS Region.

See also: AWS API Documentation

Request Syntax

response = client.list_zonal_shifts(
    maxResults=123,
    nextToken='string',
    status='ACTIVE'|'EXPIRED'|'CANCELED'
)
Parameters:

  • maxResults (integer) – The number of objects that you want to return with this call.

  • nextToken (string) – 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.

  • status (string) –

    A status for a zonal shift.

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

    • ACTIVE: The zonal shift is started and active.

    • EXPIRED: The zonal shift has expired (the expiry time was exceeded).

    • CANCELED: The zonal shift was canceled.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'awayFrom': 'string',
            'comment': 'string',
            'expiryTime': datetime(2015, 1, 1),
            'resourceIdentifier': 'string',
            'startTime': datetime(2015, 1, 1),
            'status': 'ACTIVE'|'EXPIRED'|'CANCELED',
            'zonalShiftId': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • items (list) –

      The items in the response list.

      • (dict) –

        You start a zonal shift to temporarily move load balancer traffic away from an Availability Zone in a AWS Region. A zonal shift helps your application recover immediately, for example, from a developer’s bad code deployment or from an AWS infrastructure failure in a single Availability Zone. You can start a zonal shift in Route 53 ARC only for managed resources in your account in an AWS Region. Supported AWS resources are automatically registered with Route 53 ARC.

        Zonal shifts are temporary. A zonal shift can be active for up to three days (72 hours).

        When you start a zonal shift, you specify how long you want it to be active, which Amazon Route 53 Application Recovery Controller converts to an expiry time (expiration time). You can cancel a zonal shift, for example, if you’re ready to restore traffic to the Availability Zone. Or you can extend the zonal shift by updating the expiration so the zonal shift is active longer.

        • awayFrom (string) –

          The Availability Zone that traffic is moved away from for a resource when you start a zonal shift. Until the zonal shift expires or you cancel it, traffic for the resource is instead moved to other Availability Zones in the AWS Region.

        • comment (string) –

          A comment that you enter about the zonal shift. Only the latest comment is retained; no comment history is maintained. That is, a new comment overwrites any existing comment string.

        • expiryTime (datetime) –

          The expiry time (expiration time) for the zonal shift. A zonal shift is temporary and must be set to expire when you start the zonal shift. You can initially set a zonal shift to expire in a maximum of three days (72 hours). However, you can update a zonal shift to set a new expiration at any time.

          When you start a zonal shift, you specify how long you want it to be active, which Route 53 ARC converts to an expiry time (expiration time). You can cancel a zonal shift, for example, if you’re ready to restore traffic to the Availability Zone. Or you can update the zonal shift to specify another length of time to expire in.

        • resourceIdentifier (string) –

          The identifier for the resource to include in a zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource.

          At this time, you can only start a zonal shift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.

        • startTime (datetime) –

          The time (UTC) when the zonal shift is started.

        • status (string) –

          A status for a zonal shift.

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

          • ACTIVE: The zonal shift is started and active.

          • EXPIRED: The zonal shift has expired (the expiry time was exceeded).

          • CANCELED: The zonal shift was canceled.

        • zonalShiftId (string) –

          The identifier of a zonal shift.

    • nextToken (string) –

      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.

Exceptions

  • ARCZonalShift.Client.exceptions.InternalServerException

  • ARCZonalShift.Client.exceptions.ThrottlingException

  • ARCZonalShift.Client.exceptions.ValidationException

  • ARCZonalShift.Client.exceptions.AccessDeniedException