ARCZonalShift / Paginator / ListAutoshifts

ListAutoshifts#

class ARCZonalShift.Paginator.ListAutoshifts#
paginator = client.get_paginator('list_autoshifts')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from ARCZonalShift.Client.list_autoshifts().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    status='ACTIVE'|'COMPLETED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • status (string) – The status of the autoshift.

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'awayFrom': 'string',
            'endTime': datetime(2015, 1, 1),
            'startTime': datetime(2015, 1, 1),
            'status': 'ACTIVE'|'COMPLETED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • items (list) –

      The items in the response list.

      • (dict) –

        Information about an autoshift. Amazon Web Services starts an autoshift to temporarily move traffic for a resource away from an Availability Zone in an Amazon Web Services Region when Amazon Web Services determines that there’s an issue in the Availability Zone that could potentially affect customers. You can configure zonal autoshift in Route 53 ARC for managed resources in your Amazon Web Services account in a Region. Supported Amazon Web Services resources are automatically registered with Route 53 ARC.

        Autoshifts are temporary. When the Availability Zone recovers, Amazon Web Services ends the autoshift, and traffic for the resource is no longer directed to the other Availability Zones in the Region.

        You can stop an autoshift for a resource by disabling zonal autoshift.

        • awayFrom (string) –

          The Availability Zone that traffic is shifted away from for a resource when Amazon Web Services starts an autoshift. Until the autoshift ends, traffic for the resource is instead directed to other Availability Zones in the Amazon Web Services Region. An autoshift can end for a resource, for example, when Amazon Web Services ends the autoshift for the Availability Zone or when you disable zonal autoshift for the resource.

        • endTime (datetime) –

          The time (in UTC) when the autoshift ended.

        • startTime (datetime) –

          The time (in UTC) when the autoshift started.

        • status (string) –

          The status for an autoshift.

    • NextToken (string) –

      A token to resume pagination.