S3Control / Client / get_multi_region_access_point_routes

get_multi_region_access_point_routes#

S3Control.Client.get_multi_region_access_point_routes(**kwargs)#

Note

This operation is not supported by directory buckets.

Returns the routing configuration for a Multi-Region Access Point, indicating which Regions are active or passive.

To obtain routing control changes and failover requests, use the Amazon S3 failover control infrastructure endpoints in these five Amazon Web Services Regions:

  • us-east-1

  • us-west-2

  • ap-southeast-2

  • ap-northeast-1

  • eu-west-1

See also: AWS API Documentation

Request Syntax

response = client.get_multi_region_access_point_routes(
    AccountId='string',
    Mrap='string'
)
Parameters:

  • AccountId (string) –

    [REQUIRED]

    The Amazon Web Services account ID for the owner of the Multi-Region Access Point.

  • Mrap (string) –

    [REQUIRED]

    The Multi-Region Access Point ARN.

Return type:

dict

Returns:

Response Syntax

{
    'Mrap': 'string',
    'Routes': [
        {
            'Bucket': 'string',
            'Region': 'string',
            'TrafficDialPercentage': 123
        },
    ]
}

Response Structure

  • (dict) –

    • Mrap (string) –

      The Multi-Region Access Point ARN.

    • Routes (list) –

      The different routes that make up the route configuration. Active routes return a value of 100, and passive routes return a value of 0.

      • (dict) –

        A structure for a Multi-Region Access Point that indicates where Amazon S3 traffic can be routed. Routes can be either active or passive. Active routes can process Amazon S3 requests through the Multi-Region Access Point, but passive routes are not eligible to process Amazon S3 requests.

        Each route contains the Amazon S3 bucket name and the Amazon Web Services Region that the bucket is located in. The route also includes the TrafficDialPercentage value, which shows whether the bucket and Region are active (indicated by a value of 100) or passive (indicated by a value of 0).

        • Bucket (string) –

          The name of the Amazon S3 bucket for which you’ll submit a routing configuration change. Either the Bucket or the Region value must be provided. If both are provided, the bucket must be in the specified Region.

        • Region (string) –

          The Amazon Web Services Region to which you’ll be submitting a routing configuration change. Either the Bucket or the Region value must be provided. If both are provided, the bucket must be in the specified Region.

        • TrafficDialPercentage (integer) –

          The traffic state for the specified bucket or Amazon Web Services Region.

          A value of 0 indicates a passive state, which means that no new traffic will be routed to the Region.

          A value of 100 indicates an active state, which means that traffic will be routed to the specified Region.

          When the routing configuration for a Region is changed from active to passive, any in-progress operations (uploads, copies, deletes, and so on) to the formerly active Region will continue to run to until a final success or failure status is reached.

          If all Regions in the routing configuration are designated as passive, you’ll receive an InvalidRequest error.