S3Control / Client / describe_multi_region_access_point_operation

describe_multi_region_access_point_operation

S3Control.Client.describe_multi_region_access_point_operation(**kwargs)

Note

This operation is not supported by directory buckets.

Retrieves the status of an asynchronous request to manage a Multi-Region Access Point. For more information about managing Multi-Region Access Points and how asynchronous requests work, see Managing Multi-Region Access Points in the Amazon S3 User Guide.

The following actions are related to GetMultiRegionAccessPoint:

• CreateMultiRegionAccessPoint

• DeleteMultiRegionAccessPoint

• GetMultiRegionAccessPoint

• ListMultiRegionAccessPoints

See also: AWS API Documentation

Request Syntax

response = client.describe_multi_region_access_point_operation(
    AccountId='string',
    RequestTokenARN='string'
)

Parameters:

• AccountId (string) –

  [REQUIRED]

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

• RequestTokenARN (string) –

  [REQUIRED]

  The request token associated with the request you want to know about. This request token is returned as part of the response when you make an asynchronous request. You provide this token to query about the status of the asynchronous action.

Return type:

dict

Returns:

Response Syntax

{
    'AsyncOperation': {
        'CreationTime': datetime(2015, 1, 1),
        'Operation': 'CreateMultiRegionAccessPoint'|'DeleteMultiRegionAccessPoint'|'PutMultiRegionAccessPointPolicy',
        'RequestTokenARN': 'string',
        'RequestParameters': {
            'CreateMultiRegionAccessPointRequest': {
                'Name': 'string',
                'PublicAccessBlock': {
                    'BlockPublicAcls': True|False,
                    'IgnorePublicAcls': True|False,
                    'BlockPublicPolicy': True|False,
                    'RestrictPublicBuckets': True|False
                },
                'Regions': [
                    {
                        'Bucket': 'string',
                        'BucketAccountId': 'string'
                    },
                ]
            },
            'DeleteMultiRegionAccessPointRequest': {
                'Name': 'string'
            },
            'PutMultiRegionAccessPointPolicyRequest': {
                'Name': 'string',
                'Policy': 'string'
            }
        },
        'RequestStatus': 'string',
        'ResponseDetails': {
            'MultiRegionAccessPointDetails': {
                'Regions': [
                    {
                        'Name': 'string',
                        'RequestStatus': 'string'
                    },
                ]
            },
            'ErrorDetails': {
                'Code': 'string',
                'Message': 'string',
                'Resource': 'string',
                'RequestId': 'string'
            }
        }
    }
}

Response Structure

• (dict) –

  • AsyncOperation (dict) –

    A container element containing the details of the asynchronous operation.

    • CreationTime (datetime) –

      The time that the request was sent to the service.

    • Operation (string) –

      The specific operation for the asynchronous request.

    • RequestTokenARN (string) –

      The request token associated with the request.

    • RequestParameters (dict) –

      The parameters associated with the request.

      • CreateMultiRegionAccessPointRequest (dict) –

        A container of the parameters for a CreateMultiRegionAccessPoint request.

        • Name (string) –

          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 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) –

          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) –

              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.

      • DeleteMultiRegionAccessPointRequest (dict) –

        A container of the parameters for a DeleteMultiRegionAccessPoint request.

        • Name (string) –

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

      • PutMultiRegionAccessPointPolicyRequest (dict) –

        A container of the parameters for a PutMultiRegionAccessPoint request.

        • Name (string) –

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

        • Policy (string) –

          The policy details for the PutMultiRegionAccessPoint request.

    • RequestStatus (string) –

      The current status of the request.

    • ResponseDetails (dict) –

      The details of the response.

      • MultiRegionAccessPointDetails (dict) –

        The details for the Multi-Region Access Point.

        • Regions (list) –

          A collection of status information for the different Regions that a Multi-Region Access Point supports.

          • (dict) –

            Status information for a single Multi-Region Access Point Region.

            • Name (string) –

              The name of the Region in the Multi-Region Access Point.

            • RequestStatus (string) –

              The current status of the Multi-Region Access Point in this Region.

      • ErrorDetails (dict) –

        Error details for an asynchronous request.

        • Code (string) –

          A string that uniquely identifies the error condition.

        • Message (string) –

          A generic description of the error condition in English.

        • Resource (string) –

          The identifier of the resource associated with the error.

        • RequestId (string) –

          The ID of the request associated with the error.