PutMultiRegionAccessPointPolicy
Note
This operation is not supported by directory buckets.
Associates an access control policy with the specified Multi-Region Access Point. Each Multi-Region Access Point can have only one policy, so a request made to this action replaces any existing policy that is associated with 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
PutMultiRegionAccessPointPolicy:
Request Syntax
POST /v20180820/async-requests/mrap/put-policy HTTP/1.1
Host: s3-control.amazonaws.com
x-amz-account-id: AccountId
<?xml version="1.0" encoding="UTF-8"?>
<PutMultiRegionAccessPointPolicyRequest xmlns="http://awss3control.amazonaws.com/doc/2018-08-20/">
<ClientToken>string</ClientToken>
<Details>
<Name>string</Name>
<Policy>string</Policy>
</Details>
</PutMultiRegionAccessPointPolicyRequest>URI Request Parameters
The request uses the following URI parameters.
- 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 accepts the following data in XML format.
- PutMultiRegionAccessPointPolicyRequest
-
Root level tag for the PutMultiRegionAccessPointPolicyRequest 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 the details of the policy for the Multi-Region Access Point.
Type: PutMultiRegionAccessPointPolicyInput data type
Required: Yes
Response Syntax
HTTP/1.1 200
<?xml version="1.0" encoding="UTF-8"?>
<PutMultiRegionAccessPointPolicyResult>
<RequestTokenARN>string</RequestTokenARN>
</PutMultiRegionAccessPointPolicyResult>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.
- PutMultiRegionAccessPointPolicyResult
-
Root level tag for the PutMultiRegionAccessPointPolicyResult 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 AWS SDKs, see the following:
