Amazonka.S3.GetBucketAccelerateConfiguration

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

• PutBucketAccelerateConfiguration

Creating a Request

data GetBucketAccelerateConfiguration

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

ToHeaders GetBucketAccelerateConfiguration

Defined in Amazonka.S3.GetBucketAccelerateConfiguration

Methods

toHeaders :: GetBucketAccelerateConfiguration -> [Header]

ToPath GetBucketAccelerateConfiguration

Defined in Amazonka.S3.GetBucketAccelerateConfiguration

Methods

toPath :: GetBucketAccelerateConfiguration -> ByteString

ToQuery GetBucketAccelerateConfiguration

Defined in Amazonka.S3.GetBucketAccelerateConfiguration

Methods

toQuery :: GetBucketAccelerateConfiguration -> QueryString

AWSRequest GetBucketAccelerateConfiguration

Defined in Amazonka.S3.GetBucketAccelerateConfiguration

Associated Types

type AWSResponse GetBucketAccelerateConfiguration

Methods

request :: (Service -> Service) -> GetBucketAccelerateConfiguration -> Request GetBucketAccelerateConfiguration

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetBucketAccelerateConfiguration -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetBucketAccelerateConfiguration)))

Generic GetBucketAccelerateConfiguration

Defined in Amazonka.S3.GetBucketAccelerateConfiguration

Associated Types

type Rep GetBucketAccelerateConfiguration :: Type -> Type

Methods

from :: GetBucketAccelerateConfiguration -> Rep GetBucketAccelerateConfiguration x

to :: Rep GetBucketAccelerateConfiguration x -> GetBucketAccelerateConfiguration

Read GetBucketAccelerateConfiguration

Defined in Amazonka.S3.GetBucketAccelerateConfiguration

Methods

readsPrec :: Int -> ReadS GetBucketAccelerateConfiguration

readList :: ReadS [GetBucketAccelerateConfiguration]

readPrec :: ReadPrec GetBucketAccelerateConfiguration

readListPrec :: ReadPrec [GetBucketAccelerateConfiguration]

Show GetBucketAccelerateConfiguration

Defined in Amazonka.S3.GetBucketAccelerateConfiguration

Methods

showsPrec :: Int -> GetBucketAccelerateConfiguration -> ShowS

show :: GetBucketAccelerateConfiguration -> String

showList :: [GetBucketAccelerateConfiguration] -> ShowS

NFData GetBucketAccelerateConfiguration

Defined in Amazonka.S3.GetBucketAccelerateConfiguration

Methods

rnf :: GetBucketAccelerateConfiguration -> ()

Eq GetBucketAccelerateConfiguration

Defined in Amazonka.S3.GetBucketAccelerateConfiguration

Methods

(==) :: GetBucketAccelerateConfiguration -> GetBucketAccelerateConfiguration -> Bool

(/=) :: GetBucketAccelerateConfiguration -> GetBucketAccelerateConfiguration -> Bool

Hashable GetBucketAccelerateConfiguration

Defined in Amazonka.S3.GetBucketAccelerateConfiguration

Methods

hashWithSalt :: Int -> GetBucketAccelerateConfiguration -> Int

hash :: GetBucketAccelerateConfiguration -> Int

type AWSResponse GetBucketAccelerateConfiguration

Defined in Amazonka.S3.GetBucketAccelerateConfiguration

type AWSResponse GetBucketAccelerateConfiguration = GetBucketAccelerateConfigurationResponse

type Rep GetBucketAccelerateConfiguration

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

Arguments

:: BucketName

GetBucketAccelerateConfiguration

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

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

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

Destructuring the Response

data GetBucketAccelerateConfigurationResponse

See: newGetBucketAccelerateConfigurationResponse smart constructor.

Constructors

GetBucketAccelerateConfigurationResponse'

Fields

• status :: Maybe BucketAccelerateStatus

  The accelerate configuration of the bucket.

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetBucketAccelerateConfigurationResponse

Defined in Amazonka.S3.GetBucketAccelerateConfiguration

Associated Types

type Rep GetBucketAccelerateConfigurationResponse :: Type -> Type

Methods

from :: GetBucketAccelerateConfigurationResponse -> Rep GetBucketAccelerateConfigurationResponse x

to :: Rep GetBucketAccelerateConfigurationResponse x -> GetBucketAccelerateConfigurationResponse

Read GetBucketAccelerateConfigurationResponse

Defined in Amazonka.S3.GetBucketAccelerateConfiguration

Methods

readsPrec :: Int -> ReadS GetBucketAccelerateConfigurationResponse

readList :: ReadS [GetBucketAccelerateConfigurationResponse]

readPrec :: ReadPrec GetBucketAccelerateConfigurationResponse

readListPrec :: ReadPrec [GetBucketAccelerateConfigurationResponse]

Show GetBucketAccelerateConfigurationResponse

Defined in Amazonka.S3.GetBucketAccelerateConfiguration

Methods

showsPrec :: Int -> GetBucketAccelerateConfigurationResponse -> ShowS

show :: GetBucketAccelerateConfigurationResponse -> String

showList :: [GetBucketAccelerateConfigurationResponse] -> ShowS

NFData GetBucketAccelerateConfigurationResponse

Defined in Amazonka.S3.GetBucketAccelerateConfiguration

Methods

rnf :: GetBucketAccelerateConfigurationResponse -> ()

Eq GetBucketAccelerateConfigurationResponse

Defined in Amazonka.S3.GetBucketAccelerateConfiguration

Methods

(==) :: GetBucketAccelerateConfigurationResponse -> GetBucketAccelerateConfigurationResponse -> Bool

(/=) :: GetBucketAccelerateConfigurationResponse -> GetBucketAccelerateConfigurationResponse -> Bool

type Rep GetBucketAccelerateConfigurationResponse

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

Arguments

:: Int

$sel:httpStatus:GetBucketAccelerateConfigurationResponse'

-> 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:

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)

The accelerate configuration of the bucket.

getBucketAccelerateConfigurationResponse_httpStatus :: Lens' GetBucketAccelerateConfigurationResponse Int

The response's http status code.