Skip to content

S3  >  Operations  >  get_bucket_accelerate_configuration

get_bucket_accelerate_configuration

Operation

get_bucket_accelerate_configuration async

get_bucket_accelerate_configuration(request: GetBucketAccelerateConfigurationInput | GetBucketAccelerateConfigurationInputDict, /, *, plugins: list[Plugin] | None = None) -> GetBucketAccelerateConfigurationOutput
get_bucket_accelerate_configuration(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetBucketAccelerateConfigurationInputDict]) -> GetBucketAccelerateConfigurationOutput
Note

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:

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
GetBucketAccelerateConfigurationOutput

An instance of GetBucketAccelerateConfigurationOutput.

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

GetBucketAccelerateConfigurationInput dataclass

Bases: _SerdeShape

Dataclass for GetBucketAccelerateConfigurationInput structure.

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

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

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

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

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for the corresponding charges. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

Note

This functionality is not supported for directory buckets.

Dictionaries

GetBucketAccelerateConfigurationInputDict

Bases: TypedDict

Dictionary form of GetBucketAccelerateConfigurationInput.

Attributes
bucket instance-attribute
bucket: Required[str]

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

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

request_payer instance-attribute
request_payer: str | None

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for the corresponding charges. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

Note

This functionality is not supported for directory buckets.

Output

GetBucketAccelerateConfigurationOutput dataclass

Bases: _SerdeShape

Dataclass for GetBucketAccelerateConfigurationOutput structure.

Attributes

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

If present, indicates that the requester was successfully charged for the request. For more information, see Using Requester Pays buckets for storage transfers and usage in the Amazon Simple Storage Service user guide.

Note

This functionality is not supported for directory buckets.

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.

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

The accelerate configuration of the bucket.