S3 / Client / get_bucket_request_payment

get_bucket_request_payment#

S3.Client.get_bucket_request_payment(**kwargs)#

Returns the request payment configuration of a bucket. To use this version of the operation, you must be the bucket owner. For more information, see Requester Pays Buckets.

The following operations are related to GetBucketRequestPayment :

ListObjects

See also: AWS API Documentation

Request Syntax

response = client.get_bucket_request_payment(
    Bucket='string',
    ExpectedBucketOwner='string'
)

Parameters:

Bucket (string) –
[REQUIRED]

The name of the bucket for which to get the payment request configuration
ExpectedBucketOwner (string) – 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).

Return type:

dict

Returns:

Response Syntax

{
    'Payer': 'Requester'|'BucketOwner'
}

Response Structure

(dict) –
- Payer (string) –
  
  Specifies who pays for the download and request fees.

Examples

The following example retrieves bucket versioning configuration.

response = client.get_bucket_request_payment(
    Bucket='examplebucket',
)

print(response)

Expected Output:

{
    'Payer': 'BucketOwner',
    'ResponseMetadata': {
        '...': '...',
    },
}