S3Control / Client / put_multi_region_access_point_policy

put_multi_region_access_point_policy

S3Control.Client.put_multi_region_access_point_policy(**kwargs)

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:

Warning

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.

See also: AWS API Documentation

Request Syntax

response = client.put_multi_region_access_point_policy(
    AccountId='string',
    ClientToken='string',
    Details={
        'Name': 'string',
        'Policy': 'string'
    }
)
Parameters:

  • AccountId (string) –

    [REQUIRED]

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

  • ClientToken (string) –

    [REQUIRED]

    An idempotency token used to identify the request and guarantee that requests are unique.

    This field is autopopulated if not provided.

  • Details (dict) –

    [REQUIRED]

    A container element containing the details of the policy for the Multi-Region Access Point.

    • Name (string) – [REQUIRED]

      The name of the Multi-Region Access Point associated with the request.

    • Policy (string) – [REQUIRED]

      The policy details for the PutMultiRegionAccessPoint request.

Return type:

dict

Returns:

Response Syntax

{
    'RequestTokenARN': 'string'
}

Response Structure

  • (dict) –

    • RequestTokenARN (string) –

      The request token associated with the request. You can use this token with DescribeMultiRegionAccessPointOperation to determine the status of asynchronous requests.