Skip to main content

Navigation Guide
You are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.

ListBucketsCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { S3Client, ListBucketsCommand } from "@aws-sdk/client-s3"; // ES Modules import
// const { S3Client, ListBucketsCommand } = require("@aws-sdk/client-s3"); // CommonJS import
const client = new S3Client(config);
const input = { // ListBucketsRequest
  MaxBuckets: Number("int"),
  ContinuationToken: "STRING_VALUE",
  Prefix: "STRING_VALUE",
  BucketRegion: "STRING_VALUE",
};
const command = new ListBucketsCommand(input);
const response = await client.send(command);
// { // ListBucketsOutput
//   Buckets: [ // Buckets
//     { // Bucket
//       Name: "STRING_VALUE",
//       CreationDate: new Date("TIMESTAMP"),
//       BucketRegion: "STRING_VALUE",
//     },
//   ],
//   Owner: { // Owner
//     DisplayName: "STRING_VALUE",
//     ID: "STRING_VALUE",
//   },
//   ContinuationToken: "STRING_VALUE",
//   Prefix: "STRING_VALUE",
// };

Example Usage

There was an error loading the code editor. Retry

ListBucketsCommand Input

See ListBucketsCommandInput for more details

Parameter	Type	Description
`BucketRegion`	`string \| undefined`	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 . 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`.
`ContinuationToken`	`string \| undefined`	`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. 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.
`MaxBuckets`	`number \| undefined`	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.
`Prefix`	`string \| undefined`	Limits the response to bucket names that begin with the specified bucket name prefix.

ListBucketsCommand Output

See ListBucketsCommandOutput for details

Parameter	Type	Description
`$metadata` Required	`ResponseMetadata`	Metadata pertaining to this request.
`Buckets`	`Bucket[] \| undefined`	The list of buckets owned by the requester.
`ContinuationToken`	`string \| undefined`	`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`	`Owner \| undefined`	The owner of the buckets listed.
`Prefix`	`string \| undefined`	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.

Throws

Name	Fault	Details
S3ServiceException		Base exception class for all service exceptions from S3 service.