@aws-sdk/client-s3
Version:
AWS SDK for JavaScript S3 Client for Node.js, Browser and React Native
65 lines (64 loc) • 3.92 kB
TypeScript
import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
import { PutBucketAccelerateConfigurationRequest } from "../models/models_0";
import { Command as $Command } from "@aws-sdk/smithy-client";
import { Handler, MiddlewareStack, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer } from "@aws-sdk/types";
export declare type PutBucketAccelerateConfigurationCommandInput = PutBucketAccelerateConfigurationRequest;
export declare type PutBucketAccelerateConfigurationCommandOutput = __MetadataBearer;
/**
* <p>Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration is a
* bucket-level feature that enables you to perform faster data transfers to Amazon S3.</p>
*
* <p> To use this operation, you must have permission to perform the
* s3:PutAccelerateConfiguration action. The bucket owner has this permission by default. The
* bucket owner can grant this permission to others. For more information about permissions,
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html">Managing Access Permissions to Your Amazon S3
* Resources</a>.</p>
*
* <p> The Transfer Acceleration state of a bucket can be set to one of the following two
* values:</p>
* <ul>
* <li>
* <p> Enabled – Enables accelerated data transfers to the bucket.</p>
* </li>
* <li>
* <p> Suspended – Disables accelerated data transfers to the bucket.</p>
* </li>
* </ul>
*
*
* <p>The <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAccelerateConfiguration.html">GetBucketAccelerateConfiguration</a> operation returns the transfer acceleration
* state of a bucket.</p>
*
* <p>After setting the Transfer Acceleration state of a bucket to Enabled, it might take up
* to thirty minutes before the data transfer rates to the bucket increase.</p>
*
* <p> The name of the bucket used for Transfer Acceleration must be DNS-compliant and must
* not contain periods (".").</p>
*
* <p> For more information about transfer acceleration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html">Transfer Acceleration</a>.</p>
*
* <p>The following operations are related to
* <code>PutBucketAccelerateConfiguration</code>:</p>
* <ul>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAccelerateConfiguration.html">GetBucketAccelerateConfiguration</a>
* </p>
* </li>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a>
* </p>
* </li>
* </ul>
*/
export declare class PutBucketAccelerateConfigurationCommand extends $Command<PutBucketAccelerateConfigurationCommandInput, PutBucketAccelerateConfigurationCommandOutput, S3ClientResolvedConfig> {
readonly input: PutBucketAccelerateConfigurationCommandInput;
constructor(input: PutBucketAccelerateConfigurationCommandInput);
/**
* @internal
*/
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutBucketAccelerateConfigurationCommandInput, PutBucketAccelerateConfigurationCommandOutput>;
private serialize;
private deserialize;
}