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

Description

Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download. For more information, see Requester Pays Buckets.

The following operations are related to PutBucketRequestPayment:

Synopsis

Creating a Request

data PutBucketRequestPayment Source #

See: newPutBucketRequestPayment smart constructor.

Constructors

PutBucketRequestPayment' 

Fields

  • checksumAlgorithm :: Maybe 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.

  • contentMD5 :: Maybe Text

    The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

    For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

  • 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 bucket name.

  • requestPaymentConfiguration :: RequestPaymentConfiguration

    Container for Payer.

Instances

Instances details
ToHeaders PutBucketRequestPayment Source # 
Instance details

Defined in Amazonka.S3.PutBucketRequestPayment

Methods

toHeaders :: PutBucketRequestPayment -> [Header] #

ToPath PutBucketRequestPayment Source # 
Instance details

Defined in Amazonka.S3.PutBucketRequestPayment

Methods

toPath :: PutBucketRequestPayment -> ByteString #

ToQuery PutBucketRequestPayment Source # 
Instance details

Defined in Amazonka.S3.PutBucketRequestPayment

Methods

toQuery :: PutBucketRequestPayment -> QueryString #

ToElement PutBucketRequestPayment Source # 
Instance details

Defined in Amazonka.S3.PutBucketRequestPayment

Methods

toElement :: PutBucketRequestPayment -> Element #

AWSRequest PutBucketRequestPayment Source # 
Instance details

Defined in Amazonka.S3.PutBucketRequestPayment

Associated Types

type AWSResponse PutBucketRequestPayment #

Methods

request :: (Service -> Service) -> PutBucketRequestPayment -> Request PutBucketRequestPayment #

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

Generic PutBucketRequestPayment Source # 
Instance details

Defined in Amazonka.S3.PutBucketRequestPayment

Associated Types

type Rep PutBucketRequestPayment :: Type -> Type #

Methods

from :: PutBucketRequestPayment -> Rep PutBucketRequestPayment x #

to :: Rep PutBucketRequestPayment x -> PutBucketRequestPayment #

Read PutBucketRequestPayment Source # 
Instance details

Defined in Amazonka.S3.PutBucketRequestPayment

Methods

readsPrec :: Int -> ReadS PutBucketRequestPayment #

readList :: ReadS [PutBucketRequestPayment] #

readPrec :: ReadPrec PutBucketRequestPayment #

readListPrec :: ReadPrec [PutBucketRequestPayment] #

Show PutBucketRequestPayment Source # 
Instance details

Defined in Amazonka.S3.PutBucketRequestPayment

Methods

showsPrec :: Int -> PutBucketRequestPayment -> ShowS #

show :: PutBucketRequestPayment -> String #

showList :: [PutBucketRequestPayment] -> ShowS #

NFData PutBucketRequestPayment Source # 
Instance details

Defined in Amazonka.S3.PutBucketRequestPayment

Methods

rnf :: PutBucketRequestPayment -> () #

Eq PutBucketRequestPayment Source # 
Instance details

Defined in Amazonka.S3.PutBucketRequestPayment

Methods

(==) :: PutBucketRequestPayment -> PutBucketRequestPayment -> Bool #

(/=) :: PutBucketRequestPayment -> PutBucketRequestPayment -> Bool #

Hashable PutBucketRequestPayment Source # 
Instance details

Defined in Amazonka.S3.PutBucketRequestPayment

Methods

hashWithSalt :: Int -> PutBucketRequestPayment -> Int #

hash :: PutBucketRequestPayment -> Int #

type AWSResponse PutBucketRequestPayment Source # 
Instance details

Defined in Amazonka.S3.PutBucketRequestPayment

type AWSResponse PutBucketRequestPayment = PutBucketRequestPaymentResponse
type Rep PutBucketRequestPayment Source # 
Instance details

Defined in Amazonka.S3.PutBucketRequestPayment

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

newPutBucketRequestPayment Source #

Arguments

:: BucketName

PutBucketRequestPayment

-> RequestPaymentConfiguration

$sel:requestPaymentConfiguration:PutBucketRequestPayment'

-> PutBucketRequestPayment 

Create a value of PutBucketRequestPayment 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:

PutBucketRequestPayment, putBucketRequestPayment_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:contentMD5:PutBucketRequestPayment', putBucketRequestPayment_contentMD5 - The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

$sel:expectedBucketOwner:PutBucketRequestPayment', putBucketRequestPayment_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).

PutBucketRequestPayment, putBucketRequestPayment_bucket - The bucket name.

$sel:requestPaymentConfiguration:PutBucketRequestPayment', putBucketRequestPayment_requestPaymentConfiguration - Container for Payer.

Request Lenses

putBucketRequestPayment_checksumAlgorithm :: Lens' PutBucketRequestPayment (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.

putBucketRequestPayment_contentMD5 :: Lens' PutBucketRequestPayment (Maybe Text) Source #

The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

putBucketRequestPayment_expectedBucketOwner :: Lens' PutBucketRequestPayment (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).

putBucketRequestPayment_bucket :: Lens' PutBucketRequestPayment BucketName Source #

The bucket name.

putBucketRequestPayment_requestPaymentConfiguration :: Lens' PutBucketRequestPayment RequestPaymentConfiguration Source #

Container for Payer.

Destructuring the Response

data PutBucketRequestPaymentResponse Source #

See: newPutBucketRequestPaymentResponse smart constructor.

Constructors

PutBucketRequestPaymentResponse' 

Instances

Instances details
Generic PutBucketRequestPaymentResponse Source # 
Instance details

Defined in Amazonka.S3.PutBucketRequestPayment

Associated Types

type Rep PutBucketRequestPaymentResponse :: Type -> Type #

Methods

from :: PutBucketRequestPaymentResponse -> Rep PutBucketRequestPaymentResponse x #

to :: Rep PutBucketRequestPaymentResponse x -> PutBucketRequestPaymentResponse #

Read PutBucketRequestPaymentResponse Source # 
Instance details

Defined in Amazonka.S3.PutBucketRequestPayment

Methods

readsPrec :: Int -> ReadS PutBucketRequestPaymentResponse #

readList :: ReadS [PutBucketRequestPaymentResponse] #

readPrec :: ReadPrec PutBucketRequestPaymentResponse #

readListPrec :: ReadPrec [PutBucketRequestPaymentResponse] #

Show PutBucketRequestPaymentResponse Source # 
Instance details

Defined in Amazonka.S3.PutBucketRequestPayment

Methods

showsPrec :: Int -> PutBucketRequestPaymentResponse -> ShowS #

show :: PutBucketRequestPaymentResponse -> String #

showList :: [PutBucketRequestPaymentResponse] -> ShowS #

NFData PutBucketRequestPaymentResponse Source # 
Instance details

Defined in Amazonka.S3.PutBucketRequestPayment

Methods

rnf :: PutBucketRequestPaymentResponse -> () #

Eq PutBucketRequestPaymentResponse Source # 
Instance details

Defined in Amazonka.S3.PutBucketRequestPayment

Methods

(==) :: PutBucketRequestPaymentResponse -> PutBucketRequestPaymentResponse -> Bool #

(/=) :: PutBucketRequestPaymentResponse -> PutBucketRequestPaymentResponse -> Bool #

type Rep PutBucketRequestPaymentResponse Source # 
Instance details

Defined in Amazonka.S3.PutBucketRequestPayment

type Rep PutBucketRequestPaymentResponse = D1 ('MetaData "PutBucketRequestPaymentResponse" "Amazonka.S3.PutBucketRequestPayment" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "PutBucketRequestPaymentResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newPutBucketRequestPaymentResponse :: PutBucketRequestPaymentResponse Source #

Create a value of PutBucketRequestPaymentResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.