- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
GetBucketBundlesCommand
Returns the bundles that you can apply to a Amazon Lightsail bucket.
The bucket bundle specifies the monthly cost, storage quota, and data transfer quota for a bucket.
Use the UpdateBucketBundle action to update the bundle for a bucket.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { LightsailClient, GetBucketBundlesCommand } from "@aws-sdk/client-lightsail"; // ES Modules import
// const { LightsailClient, GetBucketBundlesCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import
const client = new LightsailClient(config);
const input = { // GetBucketBundlesRequest
includeInactive: true || false,
};
const command = new GetBucketBundlesCommand(input);
const response = await client.send(command);
// { // GetBucketBundlesResult
// bundles: [ // BucketBundleList
// { // BucketBundle
// bundleId: "STRING_VALUE",
// name: "STRING_VALUE",
// price: Number("float"),
// storagePerMonthInGb: Number("int"),
// transferPerMonthInGb: Number("int"),
// isActive: true || false,
// },
// ],
// };
GetBucketBundlesCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
includeInactive | boolean | undefined | A Boolean value that indicates whether to include inactive (unavailable) bundles in the response of your request. |
GetBucketBundlesCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
bundles | BucketBundle[] | undefined | An object that describes bucket bundles. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| AccessDeniedException | client | Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. |
| InvalidInputException | client | Lightsail throws this exception when user input does not conform to the validation rules of an input field. Domain and distribution APIs are only available in the N. Virginia ( |
| ServiceException | server | A general service exception. |
| UnauthenticatedException | client | Lightsail throws this exception when the user has not been authenticated. |
| LightsailServiceException | Base exception class for all service exceptions from Lightsail service. |