| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.S3.PutBucketAccelerateConfiguration
Description
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:
Synopsis
- data PutBucketAccelerateConfiguration = PutBucketAccelerateConfiguration' {}
- newPutBucketAccelerateConfiguration :: BucketName -> AccelerateConfiguration -> PutBucketAccelerateConfiguration
- putBucketAccelerateConfiguration_checksumAlgorithm :: Lens' PutBucketAccelerateConfiguration (Maybe ChecksumAlgorithm)
- putBucketAccelerateConfiguration_expectedBucketOwner :: Lens' PutBucketAccelerateConfiguration (Maybe Text)
- putBucketAccelerateConfiguration_bucket :: Lens' PutBucketAccelerateConfiguration BucketName
- putBucketAccelerateConfiguration_accelerateConfiguration :: Lens' PutBucketAccelerateConfiguration AccelerateConfiguration
- data PutBucketAccelerateConfigurationResponse = PutBucketAccelerateConfigurationResponse' {
- newPutBucketAccelerateConfigurationResponse :: PutBucketAccelerateConfigurationResponse
Creating a Request
data PutBucketAccelerateConfiguration Source #
See: newPutBucketAccelerateConfiguration smart constructor.
Constructors
| PutBucketAccelerateConfiguration' | |
Fields
| |
Instances
newPutBucketAccelerateConfiguration Source #
Arguments
| :: BucketName | |
| -> AccelerateConfiguration |
|
| -> PutBucketAccelerateConfiguration |
Create a value of PutBucketAccelerateConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutBucketAccelerateConfiguration, putBucketAccelerateConfiguration_checksumAlgorithm - Indicates the algorithm used to create the checksum for the object when
using the SDK. This header will not provide any additional functionality
if not using the SDK. When sending 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.
$sel:expectedBucketOwner:PutBucketAccelerateConfiguration', putBucketAccelerateConfiguration_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
PutBucketAccelerateConfiguration, putBucketAccelerateConfiguration_bucket - The name of the bucket for which the accelerate configuration is set.
$sel:accelerateConfiguration:PutBucketAccelerateConfiguration', putBucketAccelerateConfiguration_accelerateConfiguration - Container for setting the transfer acceleration state.
Request Lenses
putBucketAccelerateConfiguration_checksumAlgorithm :: Lens' PutBucketAccelerateConfiguration (Maybe ChecksumAlgorithm) Source #
Indicates the algorithm used to create the checksum for the object when
using the SDK. This header will not provide any additional functionality
if not using the SDK. When sending 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.
putBucketAccelerateConfiguration_expectedBucketOwner :: Lens' PutBucketAccelerateConfiguration (Maybe Text) Source #
The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
putBucketAccelerateConfiguration_bucket :: Lens' PutBucketAccelerateConfiguration BucketName Source #
The name of the bucket for which the accelerate configuration is set.
putBucketAccelerateConfiguration_accelerateConfiguration :: Lens' PutBucketAccelerateConfiguration AccelerateConfiguration Source #
Container for setting the transfer acceleration state.
Destructuring the Response
data PutBucketAccelerateConfigurationResponse Source #
See: newPutBucketAccelerateConfigurationResponse smart constructor.
Constructors
| PutBucketAccelerateConfigurationResponse' | |
Instances
newPutBucketAccelerateConfigurationResponse :: PutBucketAccelerateConfigurationResponse Source #
Create a value of PutBucketAccelerateConfigurationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.