Class ListBucketsCommand

Example

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

import { S3Client, ListBucketsCommand } from "ibm-cos-sdk-v2"; // ES Modules import
// const { S3Client, ListBucketsCommand } = require("ibm-cos-sdk-v2"); // CommonJS import
// import type { S3ClientConfig } from "ibm-cos-sdk-v2";
const config = {}; // type is S3ClientConfig
const client = new S3Client(config);
const input = { // ListBucketsRequest
  IBMServiceInstanceId: "STRING_VALUE",
  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",
//       BucketArn: "STRING_VALUE",
//     },
//   ],
//   Owner: { // Owner
//     DisplayName: "STRING_VALUE",
//     ID: "STRING_VALUE",
//   },
//   ContinuationToken: "STRING_VALUE",
//   Prefix: "STRING_VALUE",
// };

Copy

Example: To list all buckets

// The following example returns all the buckets owned by the sender of this request.
const input = { /* empty */ };
const command = new ListBucketsCommand(input);
const response = await client.send(command);
/* response is
{
  Buckets: [
    {
      CreationDate: "2012-02-15T21:03:02.000Z",
      Name: "examplebucket"
    },
    {
      CreationDate: "2011-07-24T19:33:50.000Z",
      Name: "examplebucket2"
    },
    {
      CreationDate: "2010-12-17T00:56:49.000Z",
      Name: "examplebucket3"
    }
  ],
  Owner: {
    DisplayName: "own-display-name",
    ID: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31"
  }
}
*/
Copy