S3 / Paginator / ListBuckets

ListBuckets

class S3.Paginator.ListBuckets

paginator = client.get_paginator('list_buckets')

paginate(**kwargs)

Creates an iterator that will paginate through responses from S3.Client.list_buckets().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Prefix='string',
    BucketRegion='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• 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.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'Buckets': [
        {
            'Name': 'string',
            'CreationDate': datetime(2015, 1, 1),
            'BucketRegion': 'string'
        },
    ],
    'Owner': {
        'DisplayName': 'string',
        'ID': 'string'
    },
    'Prefix': 'string',
    'NextToken': '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.

  • 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.

  • NextToken (string) –

    A token to resume pagination.