S3Control / Client / get_multi_region_access_point_policy

get_multi_region_access_point_policy

S3Control.Client.get_multi_region_access_point_policy(**kwargs)

Note

This operation is not supported by directory buckets.

Returns the access control policy of 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 GetMultiRegionAccessPointPolicy:

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.get_multi_region_access_point_policy(
    AccountId='string',
    Name='string'
)
Parameters:

  • AccountId (string) –

    [REQUIRED]

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

  • Name (string) –

    [REQUIRED]

    Specifies the Multi-Region Access Point. 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.

Return type:

dict

Returns:

Response Syntax

{
    'Policy': {
        'Established': {
            'Policy': 'string'
        },
        'Proposed': {
            'Policy': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • Policy (dict) –

      The policy associated with the specified Multi-Region Access Point.

      • Established (dict) –

        The last established policy for the Multi-Region Access Point.

        • Policy (string) –

          The details of the last established policy.

      • Proposed (dict) –

        The proposed policy for the Multi-Region Access Point.

        • Policy (string) –

          The details of the proposed policy.