S3 / Client / list_buckets

list_buckets#

S3.Client.list_buckets(**kwargs)#

Note

This operation is not supported by directory buckets.

Returns a list of all buckets owned by the authenticated sender of the request. To use this operation, you must have the s3:ListAllMyBuckets permission.

For information about Amazon S3 buckets, see Creating, configuring, and working with Amazon S3 buckets.

See also: AWS API Documentation

Request Syntax

response = client.list_buckets(
    MaxBuckets=123,
    ContinuationToken='string',
    Prefix='string',
    BucketRegion='string'
)
Parameters:

  • MaxBuckets (integer) – Maximum number of buckets to be returned in response. When the number is more than the count of buckets that are owned by an Amazon Web Services account, return all the buckets in response.

  • ContinuationToken (string) –

    ContinuationToken indicates to Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key. You can use this ContinuationToken for pagination of the list results.

    Length Constraints: Minimum length of 0. Maximum length of 1024.

    Required: No.

  • Prefix (string) – Limits the response to bucket names that begin with the specified bucket name prefix.

  • BucketRegion (string) –

    Limits the response to buckets that are located in the specified Amazon Web Services Region. The Amazon Web Services Region must be expressed according to the Amazon Web Services Region code, such as us-west-2 for the US West (Oregon) Region. For a list of the valid values for all of the Amazon Web Services Regions, see Regions and Endpoints.

    Note

    Requests made to a Regional endpoint that is different from the bucket-region parameter are not supported. For example, if you want to limit the response to your buckets in Region us-west-2, the request must be made to an endpoint in Region us-west-2.

Return type:

dict

Returns:

Response Syntax

{
    'Buckets': [
        {
            'Name': 'string',
            'CreationDate': datetime(2015, 1, 1),
            'BucketRegion': 'string'
        },
    ],
    'Owner': {
        'DisplayName': 'string',
        'ID': 'string'
    },
    'ContinuationToken': 'string',
    'Prefix': 'string'
}

Response Structure

  • (dict) –

    • Buckets (list) –

      The list of buckets owned by the requester.

      • (dict) –

        In terms of implementation, a Bucket is a resource.

        • Name (string) –

          The name of the bucket.

        • CreationDate (datetime) –

          Date the bucket was created. This date can change when making changes to your bucket, such as editing its bucket policy.

        • BucketRegion (string) –

          BucketRegion indicates the Amazon Web Services region where the bucket is located. If the request contains at least one valid parameter, it is included in the response.

    • Owner (dict) –

      The owner of the buckets listed.

      • DisplayName (string) –

        Container for the display name of the owner. This value is only supported in the following Amazon Web Services Regions:

        • US East (N. Virginia)

        • US West (N. California)

        • US West (Oregon)

        • Asia Pacific (Singapore)

        • Asia Pacific (Sydney)

        • Asia Pacific (Tokyo)

        • Europe (Ireland)

        • South America (São Paulo)

        Note

        This functionality is not supported for directory buckets.

      • ID (string) –

        Container for the ID of the owner.

    • ContinuationToken (string) –

      ContinuationToken is included in the response when there are more buckets that can be listed with pagination. The next ListBuckets request to Amazon S3 can be continued with this ContinuationToken. ContinuationToken is obfuscated and is not a real bucket.

    • Prefix (string) –

      If Prefix was sent with the request, it is included in the response.

      All bucket names in the response begin with the specified bucket name prefix.