S3Control / Client / get_access_point_scope

get_access_point_scope#

S3Control.Client.get_access_point_scope(**kwargs)#

Returns the access point scope for a directory bucket.

To use this operation, you must have the permission to perform the s3express:GetAccessPointScope action.

For information about REST API errors, see REST error responses.

See also: AWS API Documentation

Request Syntax

response = client.get_access_point_scope(
    AccountId='string',
    Name='string'
)
Parameters:

  • AccountId (string) –

    [REQUIRED]

    The Amazon Web Services account ID that owns the access point with the scope that you want to retrieve.

  • Name (string) –

    [REQUIRED]

    The name of the access point with the scope you want to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'Scope': {
        'Prefixes': [
            'string',
        ],
        'Permissions': [
            'GetObject'|'GetObjectAttributes'|'ListMultipartUploadParts'|'ListBucket'|'ListBucketMultipartUploads'|'PutObject'|'DeleteObject'|'AbortMultipartUpload',
        ]
    }
}

Response Structure

  • (dict) –

    • Scope (dict) –

      The contents of the access point scope.

      • Prefixes (list) –

        You can specify any amount of prefixes, but the total length of characters of all prefixes must be less than 256 bytes in size.

        • (string) –

      • Permissions (list) –

        You can include one or more API operations as permissions.

        • (string) –