GetMultiRegionAccessPoint
Note
This operation is not supported by directory buckets.
Returns configuration information about the specified Multi-Region Access Point.
This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point restrictions and limitations in the Amazon S3 User Guide.
The following actions are related to GetMultiRegionAccessPoint:
Important
You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.
Request Syntax
GET /v20180820/mrap/instances/name+ HTTP/1.1
Host: s3-control.amazonaws.com.cn
x-amz-account-id: AccountId
URI Request Parameters
The request uses the following URI parameters.
- name
-
The name of the Multi-Region Access Point whose configuration information you want to receive. The name of the Multi-Region Access Point is different from the alias. For more information about the distinction between the name and the alias of an Multi-Region Access Point, see Rules for naming Amazon S3 Multi-Region Access Points in the Amazon S3 User Guide.
Length Constraints: Maximum length of 50.
Pattern:
^[a-z0-9][-a-z0-9]{1,48}[a-z0-9]$Required: Yes
- x-amz-account-id
-
The Amazon 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"?>
<GetMultiRegionAccessPointResult>
<AccessPoint>
<Alias>string</Alias>
<CreatedAt>timestamp</CreatedAt>
<Name>string</Name>
<PublicAccessBlock>
<BlockPublicAcls>boolean</BlockPublicAcls>
<BlockPublicPolicy>boolean</BlockPublicPolicy>
<IgnorePublicAcls>boolean</IgnorePublicAcls>
<RestrictPublicBuckets>boolean</RestrictPublicBuckets>
</PublicAccessBlock>
<Regions>
<Region>
<Bucket>string</Bucket>
<BucketAccountId>string</BucketAccountId>
<Region>string</Region>
</Region>
</Regions>
<Status>string</Status>
</AccessPoint>
</GetMultiRegionAccessPointResult>
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.
- GetMultiRegionAccessPointResult
-
Root level tag for the GetMultiRegionAccessPointResult parameters.
Required: Yes
- AccessPoint
-
A container element containing the details of the requested Multi-Region Access Point.
Type: MultiRegionAccessPointReport data type
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: