GetBucketRequestPayment
Note
This operation is not supported for directory buckets.
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:
Request Syntax
GET /?requestPayment HTTP/1.1
Host: Bucket.s3.amazonaws.com
x-amz-expected-bucket-owner: ExpectedBucketOwner
URI Request Parameters
The request uses the following URI parameters.
- Bucket
-
The name of the bucket for which to get the payment request configuration
Required: Yes
- x-amz-expected-bucket-owner
-
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).
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
<?xml version="1.0" encoding="UTF-8"?>
<RequestPaymentConfiguration>
<Payer>string</Payer>
</RequestPaymentConfiguration>Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in XML format by the service.
- RequestPaymentConfiguration
-
Root level tag for the RequestPaymentConfiguration parameters.
Required: Yes
- Payer
-
Specifies who pays for the download and request fees.
Type: String
Valid Values:
Requester | BucketOwner
Examples
Sample Request
The following request returns the payer for the bucket, amzn-s3-demo-bucket.
GET ?requestPayment HTTP/1.1 Host: amzn-s3-demo-bucket.s3.<Region>.amazonaws.com Date: Wed, 01 Mar 2009 12:00:00 GMT Authorization: authorization string
Sample Response
This response shows that the bucket is a Requester Pays bucket, meaning the person requesting a download from this bucket pays the transfer fees.
HTTP/1.1 200 OK
x-amz-id-2: YgIPIfBiKa2bj0KMg95r/0zo3emzU4dzsD4rcKCHQUAdQkf3ShJTOOpXUueF6QKo
x-amz-request-id: 236A8905248E5A01
Date: Wed, 01 Mar 2009 12:00:00 GMT
Content-Type: [type]
Content-Length: 0
Connection: close
Server: AmazonS3
<?xml version="1.0" encoding="UTF-8"?>
<RequestPaymentConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
<Payer>Requester</Payer>
</RequestPaymentConfiguration>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
