S3Control / Client / put_access_point_scope

put_access_point_scope#

S3Control.Client.put_access_point_scope(**kwargs)#

Creates or replaces the access point scope for a directory bucket. You can use the access point scope to restrict access to specific prefixes, API operations, or a combination of both.

Note

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

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

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

See also: AWS API Documentation

Request Syntax

response = client.put_access_point_scope(
    AccountId='string',
    Name='string',
    Scope={
        'Prefixes': [
            'string',
        ],
        'Permissions': [
            'GetObject'|'GetObjectAttributes'|'ListMultipartUploadParts'|'ListBucket'|'ListBucketMultipartUploads'|'PutObject'|'DeleteObject'|'AbortMultipartUpload',
        ]
    }
)
Parameters:

  • AccountId (string) –

    [REQUIRED]

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

  • Name (string) –

    [REQUIRED]

    The name of the access point with the scope that you want to create or replace.

  • Scope (dict) –

    [REQUIRED]

    Object prefixes, API operations, or a combination of both.

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

Returns:

None