amazonka-s3-2.0: Amazon Simple Storage Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

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

Creating a Request

data GetBucketAccelerateConfiguration Source #

See: newGetBucketAccelerateConfiguration smart constructor.

Constructors

GetBucketAccelerateConfiguration' 

Fields

  • expectedBucketOwner :: Maybe Text

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

  • bucket :: BucketName

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

Instances

Instances details
ToHeaders GetBucketAccelerateConfiguration Source # 
Instance details

Defined in Amazonka.S3.GetBucketAccelerateConfiguration

ToPath GetBucketAccelerateConfiguration Source # 
Instance details

Defined in Amazonka.S3.GetBucketAccelerateConfiguration

ToQuery GetBucketAccelerateConfiguration Source # 
Instance details

Defined in Amazonka.S3.GetBucketAccelerateConfiguration

AWSRequest GetBucketAccelerateConfiguration Source # 
Instance details

Defined in Amazonka.S3.GetBucketAccelerateConfiguration

Generic GetBucketAccelerateConfiguration Source # 
Instance details

Defined in Amazonka.S3.GetBucketAccelerateConfiguration

Associated Types

type Rep GetBucketAccelerateConfiguration :: Type -> Type #

Read GetBucketAccelerateConfiguration Source # 
Instance details

Defined in Amazonka.S3.GetBucketAccelerateConfiguration

Show GetBucketAccelerateConfiguration Source # 
Instance details

Defined in Amazonka.S3.GetBucketAccelerateConfiguration

NFData GetBucketAccelerateConfiguration Source # 
Instance details

Defined in Amazonka.S3.GetBucketAccelerateConfiguration

Eq GetBucketAccelerateConfiguration Source # 
Instance details

Defined in Amazonka.S3.GetBucketAccelerateConfiguration

Hashable GetBucketAccelerateConfiguration Source # 
Instance details

Defined in Amazonka.S3.GetBucketAccelerateConfiguration

type AWSResponse GetBucketAccelerateConfiguration Source # 
Instance details

Defined in Amazonka.S3.GetBucketAccelerateConfiguration

type Rep GetBucketAccelerateConfiguration Source # 
Instance details

Defined in Amazonka.S3.GetBucketAccelerateConfiguration

type Rep GetBucketAccelerateConfiguration = D1 ('MetaData "GetBucketAccelerateConfiguration" "Amazonka.S3.GetBucketAccelerateConfiguration" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "GetBucketAccelerateConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "expectedBucketOwner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BucketName)))

newGetBucketAccelerateConfiguration Source #

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 fails with the HTTP status code 403 Forbidden (access denied).

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 fails with the HTTP status code 403 Forbidden (access denied).

getBucketAccelerateConfiguration_bucket :: Lens' GetBucketAccelerateConfiguration BucketName Source #

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

Destructuring the Response

data GetBucketAccelerateConfigurationResponse Source #

Constructors

GetBucketAccelerateConfigurationResponse' 

Fields

Instances

Instances details
Generic GetBucketAccelerateConfigurationResponse Source # 
Instance details

Defined in Amazonka.S3.GetBucketAccelerateConfiguration

Read GetBucketAccelerateConfigurationResponse Source # 
Instance details

Defined in Amazonka.S3.GetBucketAccelerateConfiguration

Show GetBucketAccelerateConfigurationResponse Source # 
Instance details

Defined in Amazonka.S3.GetBucketAccelerateConfiguration

NFData GetBucketAccelerateConfigurationResponse Source # 
Instance details

Defined in Amazonka.S3.GetBucketAccelerateConfiguration

Eq GetBucketAccelerateConfigurationResponse Source # 
Instance details

Defined in Amazonka.S3.GetBucketAccelerateConfiguration

type Rep GetBucketAccelerateConfigurationResponse Source # 
Instance details

Defined in Amazonka.S3.GetBucketAccelerateConfiguration

type Rep GetBucketAccelerateConfigurationResponse = D1 ('MetaData "GetBucketAccelerateConfigurationResponse" "Amazonka.S3.GetBucketAccelerateConfiguration" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "GetBucketAccelerateConfigurationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BucketAccelerateStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetBucketAccelerateConfigurationResponse Source #

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:

GetBucketAccelerateConfigurationResponse, getBucketAccelerateConfigurationResponse_status - The accelerate configuration of the bucket.

$sel:httpStatus:GetBucketAccelerateConfigurationResponse', getBucketAccelerateConfigurationResponse_httpStatus - The response's http status code.

Response Lenses