ARCZonalShift / Client / start_zonal_shift

start_zonal_shift#

ARCZonalShift.Client.start_zonal_shift(**kwargs)#

You start a zonal shift to temporarily move load balancer traffic away from an Availability Zone in a AWS Region, to help 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. Resources are automatically registered with Route 53 ARC by AWS services.

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.

When you start a zonal shift, traffic for the resource is no longer routed to the Availability Zone. The zonal shift is created immediately in Route 53 ARC. However, it can take a short time, typically up to a few minutes, for existing, in-progress connections in the Availability Zone to complete.

For more information, see Zonal shift in the Amazon Route 53 Application Recovery Controller Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.start_zonal_shift(
    awayFrom='string',
    comment='string',
    expiresIn='string',
    resourceIdentifier='string'
)
Parameters:

  • awayFrom (string) –

    [REQUIRED]

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

    [REQUIRED]

    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.

  • expiresIn (string) –

    [REQUIRED]

    The length of time that you want a zonal shift to be active, which Route 53 ARC converts to an expiry time (expiration time). Zonal shifts are temporary. You can set a zonal shift to be active initially for up to three days (72 hours).

    If you want to still keep traffic away from an Availability Zone, you can update the zonal shift and set a new expiration. You can also cancel a zonal shift, before it expires, for example, if you’re ready to restore traffic to the Availability Zone.

    To set a length of time for a zonal shift to be active, specify a whole number, and then one of the following, with no space:

    `` <ul> <li> <p> <b>A lowercase letter m:</b> To specify that the value is in minutes.</p> </li> <li> <p> <b>A lowercase letter h:</b> To specify that the value is in hours.</p> </li> </ul> <p>For example: <code>20h</code> means the zonal shift expires in 20 hours. <code>120m</code> means the zonal shift expires in 120 minutes (2 hours).</p> ``

  • resourceIdentifier (string) –

    [REQUIRED]

    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.

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