S3 / Client / list_buckets

list_buckets#

S3.Client.list_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.

Request Syntax

response = client.list_buckets()

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –
- Buckets (list) –
  
  The list of buckets owned by the requester.
  - (dict) –
    
    In terms of implementation, a Bucket is a resource. An Amazon S3 bucket name is globally unique, and the namespace is shared by all Amazon Web Services accounts.
    - 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.
- 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)
  - ID (string) –
    
    Container for the ID of the owner.