Class PutBucketAccelerateConfigurationCommandProtected

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.

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 Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

The Transfer Acceleration state of a bucket can be set to one of the following two values:

• Enabled – Enables accelerated data transfers to the bucket.

• Suspended – Disables accelerated data transfers to the bucket.

The GetBucketAccelerateConfiguration action returns the transfer acceleration state of a bucket.

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.

The name of the bucket used for Transfer Acceleration must be DNS-compliant and must not contain periods (".").

For more information about transfer acceleration, see Transfer Acceleration.

The following operations are related to PutBucketAccelerateConfiguration:

• GetBucketAccelerateConfiguration

• CreateBucket

Example

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

import { S3Client, PutBucketAccelerateConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import
// const { S3Client, PutBucketAccelerateConfigurationCommand } = require("@aws-sdk/client-s3"); // CommonJS import
const client = new S3Client(config);
const input = { // PutBucketAccelerateConfigurationRequest
  Bucket: "STRING_VALUE", // required
  AccelerateConfiguration: { // AccelerateConfiguration
    Status: "Enabled" || "Suspended",
  },
  ExpectedBucketOwner: "STRING_VALUE",
  ChecksumAlgorithm: "CRC32" || "CRC32C" || "SHA1" || "SHA256",
};
const command = new PutBucketAccelerateConfigurationCommand(input);
const response = await client.send(command);
// {};

Param

PutBucketAccelerateConfigurationCommandInput

Returns

PutBucketAccelerateConfigurationCommandOutput

See

• PutBucketAccelerateConfigurationCommandInput for command's input shape.
• PutBucketAccelerateConfigurationCommandOutput for command's response shape.
• config for S3Client's config shape.

Throws

S3ServiceException

Base exception class for all service exceptions from S3 service.