PutBucketAccelerateConfigurationCommand

Suggest an Edit

This operation is not supported for directory buckets.

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:

Example Syntax

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" || "CRC64NVME",
};
const command = new PutBucketAccelerateConfigurationCommand(input);
const response = await client.send(command);
// {};

PutBucketAccelerateConfigurationCommand Input

See PutBucketAccelerateConfigurationCommandInput for more details

Parameter
Type
Description
AccelerateConfiguration
Required
AccelerateConfiguration | undefined

Container for setting the transfer acceleration state.

Bucket
Required
string | undefined

The name of the bucket for which the accelerate configuration is set.

Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "aws-sdk/signature-v4-crt" package to your project dependencies. For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues

ChecksumAlgorithm
ChecksumAlgorithm | undefined

Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity  in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

ExpectedBucketOwner
string | undefined

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

PutBucketAccelerateConfigurationCommand Output

See PutBucketAccelerateConfigurationCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
S3ServiceException
Base exception class for all service exceptions from S3 service.