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()#
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()
- 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()
- 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()
- Return type:
list(
s3.Bucket)- Returns:
A list of Bucket resources