list_buckets Method

Lists all buckets in the account.

Syntax

def list_buckets() -> None: ...

Remarks

This method lists all buckets in the account.

Calling this method will fire the on_bucket_list event once for each bucket, and will also populate the Bucket* properties. If the ListWithMetadata configuration setting is enabled, the on_metadata_list event will also be fired, once for each metadata item associated with each bucket.

If the currently-authenticated application key is restricted to a specific bucket (indicated by the account_allowed_bucket_id property being non-empty), the results will only include information for that bucket.

The currently-authenticated application key must have the listBuckets capability to call this method successfully, otherwise the server will return an error. Refer to the account_capabilities property for more information.