ServiceResource / Collection / buckets

buckets#

S3.ServiceResource.buckets#

A collection of Bucket resources.A Bucket Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.

all()#

Creates an iterable of all Bucket resources in the collection.

See also: AWS API Documentation

Request Syntax

bucket_iterator = s3.buckets.all()
Return type:

list(s3.Bucket)

Returns:

A list of Bucket resources

filter(**kwargs)#

Creates an iterable of all Bucket resources in the collection filtered by kwargs passed to method. A Bucket collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.

See also: AWS API Documentation

Request Syntax

bucket_iterator = s3.buckets.filter(
    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.

    Note

    If you specify the bucket-region, prefix, or continuation-token query parameters without using max-buckets to set the maximum number of buckets returned in the response, Amazon S3 applies a default page size of 10,000 and provides a continuation token if there are more buckets.

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

list(s3.Bucket)

Returns:

A list of Bucket resources

limit(**kwargs)#

Creates an iterable up to a specified amount of Bucket resources in the collection.

See also: AWS API Documentation

Request Syntax

bucket_iterator = s3.buckets.limit(
    count=123
)
Parameters:

count (integer) – The limit to the number of resources in the iterable.

Return type:

list(s3.Bucket)

Returns:

A list of Bucket resources

page_size(**kwargs)#

Creates an iterable of all Bucket resources in the collection, but limits the number of items returned by each service call by the specified amount.

See also: AWS API Documentation

Request Syntax

bucket_iterator = s3.buckets.page_size(
    count=123
)
Parameters:

count (integer) – The number of items returned by each service call

Return type:

list(s3.Bucket)

Returns:

A list of Bucket resources