| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.S3.GetBucketAccelerateConfiguration
Description
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.
Related Resources
Synopsis
- data GetBucketAccelerateConfiguration = GetBucketAccelerateConfiguration' {}
- newGetBucketAccelerateConfiguration :: BucketName -> GetBucketAccelerateConfiguration
- getBucketAccelerateConfiguration_expectedBucketOwner :: Lens' GetBucketAccelerateConfiguration (Maybe Text)
- getBucketAccelerateConfiguration_bucket :: Lens' GetBucketAccelerateConfiguration BucketName
- data GetBucketAccelerateConfigurationResponse = GetBucketAccelerateConfigurationResponse' {}
- newGetBucketAccelerateConfigurationResponse :: Int -> GetBucketAccelerateConfigurationResponse
- getBucketAccelerateConfigurationResponse_status :: Lens' GetBucketAccelerateConfigurationResponse (Maybe BucketAccelerateStatus)
- getBucketAccelerateConfigurationResponse_httpStatus :: Lens' GetBucketAccelerateConfigurationResponse Int
Creating a Request
data GetBucketAccelerateConfiguration Source #
See: newGetBucketAccelerateConfiguration smart constructor.
Constructors
| GetBucketAccelerateConfiguration' | |
Fields
| |
Instances
newGetBucketAccelerateConfiguration Source #
Arguments
| :: BucketName | |
| -> GetBucketAccelerateConfiguration |
Create a value of GetBucketAccelerateConfiguration 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:
$sel:expectedBucketOwner:GetBucketAccelerateConfiguration', getBucketAccelerateConfiguration_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request will fail with an HTTP
403 (Access Denied) error.
$sel:bucket:GetBucketAccelerateConfiguration', getBucketAccelerateConfiguration_bucket - The name of the bucket for which the accelerate configuration is
retrieved.
Request Lenses
getBucketAccelerateConfiguration_expectedBucketOwner :: Lens' GetBucketAccelerateConfiguration (Maybe Text) Source #
The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request will fail with an HTTP
403 (Access Denied) error.
getBucketAccelerateConfiguration_bucket :: Lens' GetBucketAccelerateConfiguration BucketName Source #
The name of the bucket for which the accelerate configuration is retrieved.
Destructuring the Response
data GetBucketAccelerateConfigurationResponse Source #
See: newGetBucketAccelerateConfigurationResponse smart constructor.
Constructors
| GetBucketAccelerateConfigurationResponse' | |
Fields
| |
Instances
newGetBucketAccelerateConfigurationResponse Source #
Arguments
| :: Int | |
| -> GetBucketAccelerateConfigurationResponse |
Create a value of GetBucketAccelerateConfigurationResponse 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:
$sel:status:GetBucketAccelerateConfigurationResponse', getBucketAccelerateConfigurationResponse_status - The accelerate configuration of the bucket.
$sel:httpStatus:GetBucketAccelerateConfigurationResponse', getBucketAccelerateConfigurationResponse_httpStatus - The response's http status code.
Response Lenses
getBucketAccelerateConfigurationResponse_status :: Lens' GetBucketAccelerateConfigurationResponse (Maybe BucketAccelerateStatus) Source #
The accelerate configuration of the bucket.
getBucketAccelerateConfigurationResponse_httpStatus :: Lens' GetBucketAccelerateConfigurationResponse Int Source #
The response's http status code.