listBuckets
End of support notice: Beginning October 1, 2025, Amazon S3 will stop returning DisplayName
. Update your applications to use canonical IDs (unique identifier for Amazon Web Services accounts), Amazon Web Services account ID (12 digit identifier) or IAM ARNs (full resource naming) as a direct replacement of DisplayName
.
This change affects the following Amazon Web Services Regions: US East (N. Virginia) Region, US West (N. California) Region, US West (Oregon) Region, Asia Pacific (Singapore) Region, Asia Pacific (Sydney) Region, Asia Pacific (Tokyo) Region, Europe (Ireland) Region, and South America (São Paulo) Region.
This operation is not supported for directory buckets.
Returns a list of all buckets owned by the authenticated sender of the request. To grant IAM permission to use this operation, you must add the s3:ListAllMyBuckets
policy action.
For information about Amazon S3 buckets, see Creating, configuring, and working with Amazon S3 buckets.
We strongly recommend using only paginated ListBuckets
requests. Unpaginated ListBuckets
requests are only supported for Amazon Web Services accounts set to the default general purpose bucket quota of 10,000. If you have an approved general purpose bucket quota above 10,000, you must send paginated ListBuckets
requests to list your account’s buckets. All unpaginated ListBuckets
requests will be rejected for Amazon Web Services accounts with a general purpose bucket quota greater than 10,000.
Samples
fun main() {
//sampleStart
// The following example returns all the buckets owned by the sender of this request.
val resp = s3Client.listBuckets()
//sampleEnd
}