S3Control / Client / create_multi_region_access_point

create_multi_region_access_point

S3Control.Client.create_multi_region_access_point(**kwargs)

Note

This operation is not supported by directory buckets.

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 working with Multi-Region Access Points, see Multi-Region Access Point restrictions and limitations 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:

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.create_multi_region_access_point(
    AccountId='string',
    ClientToken='string',
    Details={
        'Name': 'string',
        'PublicAccessBlock': {
            'BlockPublicAcls': True|False,
            'IgnorePublicAcls': True|False,
            'BlockPublicPolicy': True|False,
            'RestrictPublicBuckets': True|False
        },
        'Regions': [
            {
                'Bucket': 'string',
                'BucketAccountId': 'string'
            },
        ]
    }
)
Parameters:

  • AccountId (string) –

    [REQUIRED]

    The Amazon Web Services 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.

  • 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 details about the Multi-Region Access Point.

    • Name (string) – [REQUIRED]

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

    • PublicAccessBlock (dict) –

      The PublicAccessBlock configuration that you want to apply to this Amazon S3 account. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of “Public” in the Amazon S3 User Guide.

      This data type is not supported for Amazon S3 on Outposts.

      • BlockPublicAcls (boolean) –

        Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to TRUE causes the following behavior:

        • PutBucketAcl and PutObjectAcl calls fail if the specified ACL is public.

        • PUT Object calls fail if the request includes a public ACL.

        • PUT Bucket calls fail if the request includes a public ACL.

        Enabling this setting doesn’t affect existing policies or ACLs.

        This property is not supported for Amazon S3 on Outposts.

      • IgnorePublicAcls (boolean) –

        Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain.

        Enabling this setting doesn’t affect the persistence of any existing ACLs and doesn’t prevent new public ACLs from being set.

        This property is not supported for Amazon S3 on Outposts.

      • BlockPublicPolicy (boolean) –

        Specifies whether Amazon S3 should block public bucket policies for buckets in this account. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access.

        Enabling this setting doesn’t affect existing bucket policies.

        This property is not supported for Amazon S3 on Outposts.

      • RestrictPublicBuckets (boolean) –

        Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. Setting this element to TRUE restricts access to buckets with public policies to only Amazon Web Services service principals and authorized users within this account.

        Enabling this setting doesn’t affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.

        This property is not supported for Amazon S3 on Outposts.

    • Regions (list) – [REQUIRED]

      The buckets in different Regions that are associated with the Multi-Region Access Point.

      • (dict) –

        A Region that supports a Multi-Region Access Point as well as the associated bucket for the Region.

        • Bucket (string) – [REQUIRED]

          The name of the associated bucket for the Region.

        • BucketAccountId (string) –

          The Amazon Web Services account ID that owns the Amazon S3 bucket that’s associated with this Multi-Region Access Point.

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.