import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { GetBucketAccelerateConfigurationOutput, GetBucketAccelerateConfigurationRequest } from "../models/models_0"; import type { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link GetBucketAccelerateConfigurationCommand}. */ export interface GetBucketAccelerateConfigurationCommandInput extends GetBucketAccelerateConfigurationRequest { } /** * @public * * The output of {@link GetBucketAccelerateConfigurationCommand}. */ export interface GetBucketAccelerateConfigurationCommandOutput extends GetBucketAccelerateConfigurationOutput, __MetadataBearer { } declare const GetBucketAccelerateConfigurationCommand_base: { new (input: GetBucketAccelerateConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: GetBucketAccelerateConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** * *

This operation is not supported for directory buckets.

*
*

This implementation of the GET action uses the accelerate subresource to return the * Transfer Acceleration state of a bucket, which is either Enabled or Suspended. * Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers * to and from Amazon S3.

*

To use this operation, you must have permission to perform the * s3:GetAccelerateConfiguration action. The bucket owner has this permission by default. * The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to your Amazon S3 * Resources in the Amazon S3 User Guide.

*

You set the Transfer Acceleration state of an existing bucket to Enabled or * Suspended by using the PutBucketAccelerateConfiguration operation.

*

A GET accelerate request does not return a state value for a bucket that has no * transfer acceleration state. A bucket has no Transfer Acceleration state if a state has never been set * on the bucket.

*

For more information about transfer acceleration, see Transfer Acceleration in the * Amazon S3 User Guide.

*

The following operations are related to GetBucketAccelerateConfiguration:

* * *

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

*
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { S3Client, GetBucketAccelerateConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import * // const { S3Client, GetBucketAccelerateConfigurationCommand } = require("@aws-sdk/client-s3"); // CommonJS import * // import type { S3ClientConfig } from "@aws-sdk/client-s3"; * const config = {}; // type is S3ClientConfig * const client = new S3Client(config); * const input = { // GetBucketAccelerateConfigurationRequest * Bucket: "STRING_VALUE", // required * ExpectedBucketOwner: "STRING_VALUE", * RequestPayer: "requester", * }; * const command = new GetBucketAccelerateConfigurationCommand(input); * const response = await client.send(command); * // { // GetBucketAccelerateConfigurationOutput * // Status: "Enabled" || "Suspended", * // RequestCharged: "requester", * // }; * * ``` * * @param GetBucketAccelerateConfigurationCommandInput - {@link GetBucketAccelerateConfigurationCommandInput} * @returns {@link GetBucketAccelerateConfigurationCommandOutput} * @see {@link GetBucketAccelerateConfigurationCommandInput} for command's `input` shape. * @see {@link GetBucketAccelerateConfigurationCommandOutput} for command's `response` shape. * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape. * * @throws {@link S3ServiceException} *

Base exception class for all service exceptions from S3 service.

* * * @public */ export declare class GetBucketAccelerateConfigurationCommand extends GetBucketAccelerateConfigurationCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: GetBucketAccelerateConfigurationRequest; output: GetBucketAccelerateConfigurationOutput; }; sdk: { input: GetBucketAccelerateConfigurationCommandInput; output: GetBucketAccelerateConfigurationCommandOutput; }; }; }