Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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
- data PutBucketRequestPayment = PutBucketRequestPayment' {}
- newPutBucketRequestPayment :: BucketName -> RequestPaymentConfiguration -> PutBucketRequestPayment
- putBucketRequestPayment_checksumAlgorithm :: Lens' PutBucketRequestPayment (Maybe ChecksumAlgorithm)
- putBucketRequestPayment_contentMD5 :: Lens' PutBucketRequestPayment (Maybe Text)
- putBucketRequestPayment_expectedBucketOwner :: Lens' PutBucketRequestPayment (Maybe Text)
- putBucketRequestPayment_bucket :: Lens' PutBucketRequestPayment BucketName
- putBucketRequestPayment_requestPaymentConfiguration :: Lens' PutBucketRequestPayment RequestPaymentConfiguration
- data PutBucketRequestPaymentResponse = PutBucketRequestPaymentResponse' {
- newPutBucketRequestPaymentResponse :: PutBucketRequestPaymentResponse
Creating a Request
data PutBucketRequestPayment Source #
See: newPutBucketRequestPayment
smart constructor.
PutBucketRequestPayment' | |
|
Instances
newPutBucketRequestPayment Source #
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.
Instances
newPutBucketRequestPaymentResponse :: PutBucketRequestPaymentResponse Source #
Create a value of PutBucketRequestPaymentResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.