GetMultiRegionAccessPointRoutes - Amazon Simple Storage Service

GetMultiRegionAccessPointRoutes

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 AWS Regions:

  • us-east-1

  • us-west-2

  • ap-southeast-2

  • ap-northeast-1

  • eu-west-1

Note

Your Amazon S3 bucket does not need to be in these five Regions.

Request Syntax

GET /v20180820/mrap/instances/mrap+/routes HTTP/1.1 Host: s3-control.amazonaws.com x-amz-account-id: AccountId

URI Request Parameters

The request uses the following URI parameters.

mrap

The Multi-Region Access Point ARN.

Length Constraints: Maximum length of 200.

Pattern: ^[a-zA-Z0-9\:.-]{3,200}$

Required: Yes

x-amz-account-id

The AWS account ID for the owner of the Multi-Region Access Point.

Length Constraints: Maximum length of 64.

Pattern: ^\d{12}$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 <?xml version="1.0" encoding="UTF-8"?> <GetMultiRegionAccessPointRoutesResult> <Mrap>string</Mrap> <Routes> <Route> <Bucket>string</Bucket> <Region>string</Region> <TrafficDialPercentage>integer</TrafficDialPercentage> </Route> </Routes> </GetMultiRegionAccessPointRoutesResult>

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in XML format by the service.

GetMultiRegionAccessPointRoutesResult

Root level tag for the GetMultiRegionAccessPointRoutesResult parameters.

Required: Yes

Mrap

The Multi-Region Access Point ARN.

Type: String

Length Constraints: Maximum length of 200.

Pattern: ^[a-zA-Z0-9\:.-]{3,200}$

Routes

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

Type: Array of MultiRegionAccessPointRoute data types

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: