cancel_zonal_shift

ARCZonalShift.Client.cancel_zonal_shift(**kwargs)

Cancel a zonal shift in Amazon Route 53 Application Recovery Controller that you've started for a resource in your AWS account in an AWS Region.

See also: AWS API Documentation

Request Syntax

response = client.cancel_zonal_shift(
    zonalShiftId='string'
)

Parameters

zonalShiftId (string) --

[REQUIRED]

The internally-generated identifier of a zonal shift.

Return type

dict

Returns

Response Syntax

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

Response Structure

• (dict) --
  • 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. 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.

Exceptions

• ARCZonalShift.Client.exceptions.InternalServerException
• ARCZonalShift.Client.exceptions.ConflictException
• ARCZonalShift.Client.exceptions.ResourceNotFoundException
• ARCZonalShift.Client.exceptions.ThrottlingException
• ARCZonalShift.Client.exceptions.ValidationException
• ARCZonalShift.Client.exceptions.AccessDeniedException