S3 / Client / put_bucket_request_payment

put_bucket_request_payment#

S3.Client.put_bucket_request_payment(**kwargs)#

Note

This operation is not supported by directory buckets.

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:

See also: AWS API Documentation

Request Syntax

response = client.put_bucket_request_payment(
    Bucket='string',
    ChecksumAlgorithm='CRC32'|'CRC32C'|'SHA1'|'SHA256',
    RequestPaymentConfiguration={
        'Payer': 'Requester'|'BucketOwner'
    },
    ExpectedBucketOwner='string'
)
Parameters:

  • Bucket (string) –

    [REQUIRED]

    The bucket name.

  • ChecksumAlgorithm (string) –

    Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don’t use the SDK. When you send 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.

  • RequestPaymentConfiguration (dict) –

    [REQUIRED]

    Container for Payer.

    • Payer (string) – [REQUIRED]

      Specifies who pays for the download and request fees.

  • ExpectedBucketOwner (string) – The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

Returns:

None

Examples

The following example sets request payment configuration on a bucket so that person requesting the download is charged.

response = client.put_bucket_request_payment(
    Bucket='examplebucket',
    RequestPaymentConfiguration={
        'Payer': 'Requester',
    },
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}