Class DescribeBucketCommandProtected

Retrieve an existing bucket.

Example

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

import { BucketsClient, DescribeBucketCommand } from "@stedi/sdk-client-buckets"; // ES Modules import
// const { BucketsClient, DescribeBucketCommand } = require("@stedi/sdk-client-buckets"); // CommonJS import
const client = new BucketsClient(config);
const input = { // DescribeBucketInput
  bucketName: "STRING_VALUE", // required
};
const command = new DescribeBucketCommand(input);
const response = await client.send(command);
// { // DescribeBucketOutput
//   bucketName: "STRING_VALUE", // required
//   resourceDetail: { // DescribeResourceDetail
//     status: "AVAILABLE" || "UNDER_CHANGE" || "CHANGE_FAILED" || "ERROR" || "CREATE_FAILED", // required
//     detailedStatus: "AVAILABLE_UPDATE_FAILED" || "UPDATE_FAILED" || "DELETE_FAILED",
//     statusMessage: "STRING_VALUE",
//     idempotencyKey: "STRING_VALUE", // required
//     createdAt: new Date("TIMESTAMP"), // required
//     updatedAt: new Date("TIMESTAMP"), // required
//   },
// };

Param

DescribeBucketCommandInput

Returns

DescribeBucketCommandOutput

See

• DescribeBucketCommandInput for command's input shape.
• DescribeBucketCommandOutput for command's response shape.
• config for BucketsClient's config shape.

Throws

NoSuchBucketException (client fault)

Throws

NoSuchKeyException (client fault)

Throws

AccessDeniedException (client fault)

Throws

ProductUnavailableException (client fault)

Throws

ResourceAlreadyExistsException (client fault)

Throws

ResourceNotFoundException (client fault)

Throws

ResourceUnderChangeException (client fault)

Throws

ServiceException (server fault)

Throws

BucketsServiceException

Base exception class for all service exceptions from Buckets service.