S3Control / Client / get_multi_region_access_point

get_multi_region_access_point

S3Control.Client.get_multi_region_access_point(**kwargs)

Note

This operation is not supported by directory buckets.

Returns configuration information about 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 GetMultiRegionAccessPoint:

• CreateMultiRegionAccessPoint

• DeleteMultiRegionAccessPoint

• DescribeMultiRegionAccessPointOperation

• ListMultiRegionAccessPoints

See also: AWS API Documentation

Request Syntax

response = client.get_multi_region_access_point(
    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]

  The name of the Multi-Region Access Point whose configuration information you want to receive. 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

{
    'AccessPoint': {
        'Name': 'string',
        'Alias': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'PublicAccessBlock': {
            'BlockPublicAcls': True|False,
            'IgnorePublicAcls': True|False,
            'BlockPublicPolicy': True|False,
            'RestrictPublicBuckets': True|False
        },
        'Status': 'READY'|'INCONSISTENT_ACROSS_REGIONS'|'CREATING'|'PARTIALLY_CREATED'|'PARTIALLY_DELETED'|'DELETING',
        'Regions': [
            {
                'Bucket': 'string',
                'Region': 'string',
                'BucketAccountId': 'string'
            },
        ]
    }
}

Response Structure

• (dict) –

  • AccessPoint (dict) –

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

    • Name (string) –

      The name of the Multi-Region Access Point.

    • Alias (string) –

      The alias for the Multi-Region Access Point. 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.

    • CreatedAt (datetime) –

      When the Multi-Region Access Point create request was received.

    • 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.

    • Status (string) –

      The current status of the Multi-Region Access Point.

      CREATING and DELETING are temporary states that exist while the request is propagating and being completed. If a Multi-Region Access Point has a status of PARTIALLY_CREATED, you can retry creation or send a request to delete the Multi-Region Access Point. If a Multi-Region Access Point has a status of PARTIALLY_DELETED, you can retry a delete request to finish the deletion of the Multi-Region Access Point.

    • Regions (list) –

      A collection of the Regions and buckets associated with the Multi-Region Access Point.

      • (dict) –

        A combination of a bucket and Region that’s part of a Multi-Region Access Point.

        • Bucket (string) –

          The name of the bucket.

        • Region (string) –

          The name of 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.