Skip to content

ListBucketsOutput

Source code in docs_src/capo_s3/types/list_buckets_output.py 
16
17
18
19
20
21
22
23
24
class ListBucketsOutput(TypedDict, closed=True):
    buckets: NotRequired["capo_s3.types.buckets.Buckets"]
    """<p>The list of buckets owned by the requester.</p>"""
    owner: NotRequired["capo_s3.types.owner.Owner"]
    """<p>The owner of the buckets listed.</p>"""
    continuation_token: NotRequired["capo_s3.types.next_token.NextToken"]
    """<p> <code>ContinuationToken</code> is included in the response when there are more buckets that can be listed with pagination. The next <code>ListBuckets</code> request to Amazon S3 can be continued with this <code>ContinuationToken</code>. <code>ContinuationToken</code> is obfuscated and is not a real bucket.</p>"""
    prefix: NotRequired["capo_s3.types.prefix.Prefix"]
    """<p>If <code>Prefix</code> was sent with the request, it is included in the response.</p> <p>All bucket names in the response begin with the specified bucket name prefix.</p>"""

buckets instance-attribute 

buckets: NotRequired[Buckets]

The list of buckets owned by the requester.

continuation_token instance-attribute 

continuation_token: NotRequired[NextToken]

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.

owner instance-attribute 

owner: NotRequired[Owner]

The owner of the buckets listed.

prefix instance-attribute 

prefix: NotRequired[Prefix]

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.