ARCZonalShift / Client / update_zonal_autoshift_configuration

update_zonal_autoshift_configuration#

ARCZonalShift.Client.update_zonal_autoshift_configuration(**kwargs)#

The zonal autoshift configuration for a resource includes the practice run configuration and the status for running autoshifts, zonal autoshift status. When a resource has a practice run configuation, Route 53 ARC starts weekly zonal shifts for the resource, to shift traffic away from an Availability Zone. Weekly practice runs help you to make sure that your application can continue to operate normally with the loss of one Availability Zone.

You can update the zonal autoshift autoshift status to enable or disable zonal autoshift. When zonal autoshift is ENABLED, you authorize Amazon Web Services to shift away resource traffic for an application from an Availability Zone during events, on your behalf, to help reduce time to recovery. Traffic is also shifted away for the required weekly practice runs.

See also: AWS API Documentation

Request Syntax

response = client.update_zonal_autoshift_configuration(
    resourceIdentifier='string',
    zonalAutoshiftStatus='ENABLED'|'DISABLED'
)
Parameters:

  • resourceIdentifier (string) –

    [REQUIRED]

    The identifier for the resource that you want to update the zonal autoshift configuration for. The identifier is the Amazon Resource Name (ARN) for the resource.

  • zonalAutoshiftStatus (string) –

    [REQUIRED]

    The zonal autoshift status for the resource that you want to update the zonal autoshift configuration for. Choose ENABLED to authorize Amazon Web Services to shift away resource traffic for an application from an Availability Zone during events, on your behalf, to help reduce time to recovery.

Return type:

dict

Returns:

Response Syntax

{
    'resourceIdentifier': 'string',
    'zonalAutoshiftStatus': 'ENABLED'|'DISABLED'
}

Response Structure

  • (dict) –

    • resourceIdentifier (string) –

      The identifier for the resource that you updated the zonal autoshift configuration for. The identifier is the Amazon Resource Name (ARN) for the resource.

    • zonalAutoshiftStatus (string) –

      The updated zonal autoshift status for the resource.

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