S3Control / Client / list_regional_buckets

list_regional_buckets#

S3Control.Client.list_regional_buckets(**kwargs)#

Note

This operation is not supported by directory buckets.

Returns a list of all Outposts buckets in an Outpost that are owned by the authenticated sender of the request. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and x-amz-outpost-id in your request, see the Examples section.

See also: AWS API Documentation

Request Syntax

response = client.list_regional_buckets(
    AccountId='string',
    NextToken='string',
    MaxResults=123,
    OutpostId='string'
)
Parameters:

  • AccountId (string) –

    [REQUIRED]

    The Amazon Web Services account ID of the Outposts bucket.

  • NextToken (string) –

  • MaxResults (integer) –

  • OutpostId (string) –

    The ID of the Outposts resource.

    Note

    This ID is required by Amazon S3 on Outposts buckets.

Return type:

dict

Returns:

Response Syntax

{
    'RegionalBucketList': [
        {
            'Bucket': 'string',
            'BucketArn': 'string',
            'PublicAccessBlockEnabled': True|False,
            'CreationDate': datetime(2015, 1, 1),
            'OutpostId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • RegionalBucketList (list) –

      • (dict) –

        The container for the regional bucket.

        • Bucket (string) –

        • BucketArn (string) –

          The Amazon Resource Name (ARN) for the regional bucket.

        • PublicAccessBlockEnabled (boolean) –

        • CreationDate (datetime) –

          The creation date of the regional bucket

        • OutpostId (string) –

          The Outposts ID of the regional bucket.

    • NextToken (string) –

      NextToken is sent when isTruncated is true, which means there are more buckets that can be listed. The next list requests to Amazon S3 can be continued with this NextToken. NextToken is obfuscated and is not a real key.