import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { LightsailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LightsailClient"; import type { GetBucketsRequest, GetBucketsResult } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link GetBucketsCommand}. */ export interface GetBucketsCommandInput extends GetBucketsRequest { } /** * @public * * The output of {@link GetBucketsCommand}. */ export interface GetBucketsCommandOutput extends GetBucketsResult, __MetadataBearer { } declare const GetBucketsCommand_base: { new (input: GetBucketsCommandInput): import("@smithy/smithy-client").CommandImpl; new (...[input]: [] | [GetBucketsCommandInput]): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Returns information about one or more Amazon Lightsail buckets. The information returned * includes the synchronization status of the Amazon Simple Storage Service (Amazon S3) * account-level block public access feature for your Lightsail buckets.

*

For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer * Guide.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { LightsailClient, GetBucketsCommand } from "@aws-sdk/client-lightsail"; // ES Modules import * // const { LightsailClient, GetBucketsCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import * // import type { LightsailClientConfig } from "@aws-sdk/client-lightsail"; * const config = {}; // type is LightsailClientConfig * const client = new LightsailClient(config); * const input = { // GetBucketsRequest * bucketName: "STRING_VALUE", * pageToken: "STRING_VALUE", * includeConnectedResources: true || false, * includeCors: true || false, * }; * const command = new GetBucketsCommand(input); * const response = await client.send(command); * // { // GetBucketsResult * // buckets: [ // BucketList * // { // Bucket * // resourceType: "STRING_VALUE", * // accessRules: { // AccessRules * // getObject: "public" || "private", * // allowPublicOverrides: true || false, * // }, * // arn: "STRING_VALUE", * // bundleId: "STRING_VALUE", * // createdAt: new Date("TIMESTAMP"), * // url: "STRING_VALUE", * // location: { // ResourceLocation * // availabilityZone: "STRING_VALUE", * // regionName: "us-east-1" || "us-east-2" || "us-west-1" || "us-west-2" || "eu-west-1" || "eu-west-2" || "eu-west-3" || "eu-central-1" || "eu-north-1" || "ca-central-1" || "ap-south-1" || "ap-southeast-1" || "ap-southeast-2" || "ap-northeast-1" || "ap-northeast-2" || "ap-southeast-3" || "ap-southeast-5", * // }, * // name: "STRING_VALUE", * // supportCode: "STRING_VALUE", * // tags: [ // TagList * // { // Tag * // key: "STRING_VALUE", * // value: "STRING_VALUE", * // }, * // ], * // objectVersioning: "STRING_VALUE", * // ableToUpdateBundle: true || false, * // readonlyAccessAccounts: [ // PartnerIdList * // "STRING_VALUE", * // ], * // resourcesReceivingAccess: [ // AccessReceiverList * // { // ResourceReceivingAccess * // name: "STRING_VALUE", * // resourceType: "STRING_VALUE", * // }, * // ], * // state: { // BucketState * // code: "STRING_VALUE", * // message: "STRING_VALUE", * // }, * // accessLogConfig: { // BucketAccessLogConfig * // enabled: true || false, // required * // destination: "STRING_VALUE", * // prefix: "STRING_VALUE", * // }, * // cors: { // BucketCorsConfig * // rules: [ // BucketCorsRules * // { // BucketCorsRule * // id: "STRING_VALUE", * // allowedMethods: [ // BucketCorsAllowedMethods // required * // "STRING_VALUE", * // ], * // allowedOrigins: [ // BucketCorsAllowedOrigins // required * // "STRING_VALUE", * // ], * // allowedHeaders: [ // BucketCorsAllowedHeaders * // "STRING_VALUE", * // ], * // exposeHeaders: [ // BucketCorsExposeHeaders * // "STRING_VALUE", * // ], * // maxAgeSeconds: Number("int"), * // }, * // ], * // }, * // }, * // ], * // nextPageToken: "STRING_VALUE", * // accountLevelBpaSync: { // AccountLevelBpaSync * // status: "InSync" || "Failed" || "NeverSynced" || "Defaulted", * // lastSyncedAt: new Date("TIMESTAMP"), * // message: "DEFAULTED_FOR_SLR_MISSING" || "SYNC_ON_HOLD" || "DEFAULTED_FOR_SLR_MISSING_ON_HOLD" || "Unknown", * // bpaImpactsLightsail: true || false, * // }, * // }; * * ``` * * @param GetBucketsCommandInput - {@link GetBucketsCommandInput} * @returns {@link GetBucketsCommandOutput} * @see {@link GetBucketsCommandInput} for command's `input` shape. * @see {@link GetBucketsCommandOutput} for command's `response` shape. * @see {@link LightsailClientResolvedConfig | config} for LightsailClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) *

Lightsail throws this exception when the user cannot be authenticated or uses invalid * credentials to access a resource.

* * @throws {@link InvalidInputException} (client fault) *

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 * (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services * Region configuration to us-east-1 to create, view, or edit these * resources.

*
* * @throws {@link NotFoundException} (client fault) *

Lightsail throws this exception when it cannot find a resource.

* * @throws {@link RegionSetupInProgressException} (client fault) *

Lightsail throws this exception when an operation is performed on resources in an opt-in * Region that is currently being set up.

* * @throws {@link ServiceException} (server fault) *

A general service exception.

* * @throws {@link UnauthenticatedException} (client fault) *

Lightsail throws this exception when the user has not been authenticated.

* * @throws {@link LightsailServiceException} *

Base exception class for all service exceptions from Lightsail service.

* * * @public */ export declare class GetBucketsCommand extends GetBucketsCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: GetBucketsRequest; output: GetBucketsResult; }; sdk: { input: GetBucketsCommandInput; output: GetBucketsCommandOutput; }; }; }