Skip to content

S3  >  Operations  >  put_bucket_accelerate_configuration

put_bucket_accelerate_configuration

Operation

put_bucket_accelerate_configuration async

put_bucket_accelerate_configuration(request: PutBucketAccelerateConfigurationInput | PutBucketAccelerateConfigurationInputDict, /, *, plugins: list[Plugin] | None = None) -> PutBucketAccelerateConfigurationOutput
put_bucket_accelerate_configuration(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[PutBucketAccelerateConfigurationInputDict]) -> PutBucketAccelerateConfigurationOutput
Note

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:

Warning

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.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
PutBucketAccelerateConfigurationOutput

An instance of PutBucketAccelerateConfigurationOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

PutBucketAccelerateConfigurationInput dataclass

Bases: _SerdeShape

Dataclass for PutBucketAccelerateConfigurationInput structure.

Attributes
accelerate_configuration class-attribute instance-attribute
accelerate_configuration: AccelerateConfiguration | None = ...

Container for setting the transfer acceleration state.

bucket class-attribute instance-attribute
bucket: str | None = ...

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

checksum_algorithm class-attribute instance-attribute
checksum_algorithm: str | None = ...

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.

expected_bucket_owner class-attribute instance-attribute
expected_bucket_owner: str | None = ...

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).

Dictionaries

PutBucketAccelerateConfigurationInputDict

Bases: TypedDict

Dictionary form of PutBucketAccelerateConfigurationInput.

Attributes
accelerate_configuration instance-attribute

Container for setting the transfer acceleration state.

bucket instance-attribute
bucket: Required[str]

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

checksum_algorithm instance-attribute
checksum_algorithm: str | None

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.

expected_bucket_owner instance-attribute
expected_bucket_owner: str | None

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).

Output

PutBucketAccelerateConfigurationOutput dataclass

Bases: _SerdeShape

Dataclass for PutBucketAccelerateConfigurationOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.