ARCZonalShift / Client / list_autoshifts

list_autoshifts#

ARCZonalShift.Client.list_autoshifts(**kwargs)#

Returns the active autoshifts for a specified resource.

See also: AWS API Documentation

Request Syntax

response = client.list_autoshifts(
    maxResults=123,
    nextToken='string',
    status='ACTIVE'|'COMPLETED'
)
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) – The status of the autoshift.

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) –

      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