get_managed_resource

ARCZonalShift.Client.get_managed_resource(**kwargs)

Get information about a resource that's been registered for zonal shifts with Amazon Route 53 Application Recovery Controller in this AWS Region. Resources that are registered for zonal shifts are managed resources in Route 53 ARC.

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.

See also: AWS API Documentation

Request Syntax

response = client.get_managed_resource(
    resourceIdentifier='string'
)

Parameters

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

{
    'appliedWeights': {
        'string': ...
    },
    'arn': 'string',
    'name': 'string',
    'zonalShifts': [
        {
            'appliedStatus': 'APPLIED'|'NOT_APPLIED',
            'awayFrom': 'string',
            'comment': 'string',
            'expiryTime': datetime(2015, 1, 1),
            'resourceIdentifier': 'string',
            'startTime': datetime(2015, 1, 1),
            'zonalShiftId': 'string'
        },
    ]
}

Response Structure

• (dict) --
  • appliedWeights (dict) --

    A collection of key-value pairs that indicate whether resources are active in Availability Zones or not. The key name is the Availability Zone where the resource is deployed. The value is 1 or 0.

    • (string) --
      • (float) --
  • arn (string) --

    The Amazon Resource Name (ARN) for the resource.

  • name (string) --

    The name of the resource.

  • zonalShifts (list) --

    The zonal shifts that are currently active for a resource.

    • (dict) --

      A complex structure that lists the zonal shifts for a managed resource and their statuses for the resource.

      • appliedStatus (string) --

        An appliedStatus for a zonal shift for a resource can have one of two values: APPLIED or NOT_APPLIED .

      • 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. That is, 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.

      • zonalShiftId (string) --

        The identifier of a zonal shift.

Exceptions

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