GetMultiRegionAccessPointRoutesCommand

Suggest an Edit

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { S3ControlClient, GetMultiRegionAccessPointRoutesCommand } from "@aws-sdk/client-s3-control"; // ES Modules import
// const { S3ControlClient, GetMultiRegionAccessPointRoutesCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import
const client = new S3ControlClient(config);
const input = { // GetMultiRegionAccessPointRoutesRequest
  AccountId: "STRING_VALUE",
  Mrap: "STRING_VALUE", // required
};
const command = new GetMultiRegionAccessPointRoutesCommand(input);
const response = await client.send(command);
// { // GetMultiRegionAccessPointRoutesResult
//   Mrap: "STRING_VALUE",
//   Routes: [ // RouteList
//     { // MultiRegionAccessPointRoute
//       Bucket: "STRING_VALUE",
//       Region: "STRING_VALUE",
//       TrafficDialPercentage: Number("int"), // required
//     },
//   ],
// };

GetMultiRegionAccessPointRoutesCommand Input

See GetMultiRegionAccessPointRoutesCommandInput for more details

Parameter
Type
Description
Mrap
Required
string | undefined

The Multi-Region Access Point ARN.

AccountId
string | undefined

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

GetMultiRegionAccessPointRoutesCommand Output

See GetMultiRegionAccessPointRoutesCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Mrap
string | undefined

The Multi-Region Access Point ARN.

Routes
MultiRegionAccessPointRoute[] | undefined

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

Throws

Name
Fault
Details
S3ControlServiceException
Base exception class for all service exceptions from S3Control service.