CreateMultiRegionAccessPoint
Creates a Multi-Region Access Point and associates it with the specified buckets. For more information about creating Multi-Region Access Points, see Creating Multi-Region Access Points in the Amazon S3 User Guide.
This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide.
This request is asynchronous, meaning that you might receive a response before the
command has completed. When this request provides a response, it provides a token that you
can use to monitor the status of the request with
DescribeMultiRegionAccessPointOperation.
The following actions are related to CreateMultiRegionAccessPoint:
Request Syntax
POST /v20180820/async-requests/mrap/create HTTP/1.1
Host: s3-control.amazonaws.com.cn
x-amz-account-id: AccountId
<?xml version="1.0" encoding="UTF-8"?>
<CreateMultiRegionAccessPointRequest xmlns="http://awss3control.amazonaws.com/doc/2018-08-20/">
<ClientToken>string</ClientToken>
<Details>
<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>
</Regions>
</Details>
</CreateMultiRegionAccessPointRequest>URI Request Parameters
The request uses the following URI parameters.
- x-amz-account-id
-
The Amazon account ID for the owner of the Multi-Region Access Point. The owner of the Multi-Region Access Point also must own the underlying buckets.
Length Constraints: Maximum length of 64.
Pattern:
^\d{12}$Required: Yes
Request Body
The request accepts the following data in XML format.
- CreateMultiRegionAccessPointRequest
-
Root level tag for the CreateMultiRegionAccessPointRequest parameters.
Required: Yes
- ClientToken
-
An idempotency token used to identify the request and guarantee that requests are unique.
Type: String
Length Constraints: Maximum length of 64.
Pattern:
\S+Required: Yes
- Details
-
A container element containing details about the Multi-Region Access Point.
Type: CreateMultiRegionAccessPointInput data type
Required: Yes
Response Syntax
HTTP/1.1 200
<?xml version="1.0" encoding="UTF-8"?>
<CreateMultiRegionAccessPointResult>
<RequestTokenARN>string</RequestTokenARN>
</CreateMultiRegionAccessPointResult>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.
- CreateMultiRegionAccessPointResult
-
Root level tag for the CreateMultiRegionAccessPointResult parameters.
Required: Yes
- RequestTokenARN
-
The request token associated with the request. You can use this token with DescribeMultiRegionAccessPointOperation to determine the status of asynchronous requests.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
arn:.+
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: