libZSservicesZSamazonka-s3ZSamazonka-s3
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

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

  • 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 will fail with an HTTP 403 (Access Denied) error.

  • bucket :: BucketName

    The bucket name.

  • requestPaymentConfiguration :: RequestPaymentConfiguration

    Container for Payer.

Instances

Instances details
Eq PutBucketRequestPayment Source # 
Instance details

Defined in Amazonka.S3.PutBucketRequestPayment

Methods

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

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

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 #

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 #

NFData PutBucketRequestPayment Source # 
Instance details

Defined in Amazonka.S3.PutBucketRequestPayment

Methods

rnf :: PutBucketRequestPayment -> () #

Hashable PutBucketRequestPayment Source # 
Instance details

Defined in Amazonka.S3.PutBucketRequestPayment

Methods

hashWithSalt :: Int -> PutBucketRequestPayment -> Int #

hash :: PutBucketRequestPayment -> Int #

AWSRequest PutBucketRequestPayment Source # 
Instance details

Defined in Amazonka.S3.PutBucketRequestPayment

Associated Types

type AWSResponse PutBucketRequestPayment #

Methods

request :: PutBucketRequestPayment -> Request PutBucketRequestPayment #

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

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 #

type Rep PutBucketRequestPayment Source # 
Instance details

Defined in Amazonka.S3.PutBucketRequestPayment

type Rep PutBucketRequestPayment = D1 ('MetaData "PutBucketRequestPayment" "Amazonka.S3.PutBucketRequestPayment" "libZSservicesZSamazonka-s3ZSamazonka-s3" 'False) (C1 ('MetaCons "PutBucketRequestPayment'" 'PrefixI 'True) ((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))))
type AWSResponse PutBucketRequestPayment Source # 
Instance details

Defined in Amazonka.S3.PutBucketRequestPayment

type AWSResponse PutBucketRequestPayment = PutBucketRequestPaymentResponse

newPutBucketRequestPayment Source #

Arguments

:: BucketName

$sel:bucket: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:

$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 will fail with an HTTP 403 (Access Denied) error.

$sel:bucket:PutBucketRequestPayment', putBucketRequestPayment_bucket - The bucket name.

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

Request Lenses

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 will fail with an HTTP 403 (Access Denied) error.

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
Eq PutBucketRequestPaymentResponse Source # 
Instance details

Defined in Amazonka.S3.PutBucketRequestPayment

Methods

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

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

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 #

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 #

NFData PutBucketRequestPaymentResponse Source # 
Instance details

Defined in Amazonka.S3.PutBucketRequestPayment

Methods

rnf :: PutBucketRequestPaymentResponse -> () #

type Rep PutBucketRequestPaymentResponse Source # 
Instance details

Defined in Amazonka.S3.PutBucketRequestPayment

type Rep PutBucketRequestPaymentResponse = D1 ('MetaData "PutBucketRequestPaymentResponse" "Amazonka.S3.PutBucketRequestPayment" "libZSservicesZSamazonka-s3ZSamazonka-s3" '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.