get_bucket_request_payment¶
Operation¶
get_bucket_request_payment
¶
get_bucket_request_payment(request: GetBucketRequestPaymentInput | GetBucketRequestPaymentInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetBucketRequestPaymentInputDict]) -> GetBucketRequestPaymentOutput
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:
Warning
You must URL encode any signed header values that contain spaces. For
example, if your header value is my file.txt, containing two spaces
after my, you must URL encode this value to my%20%20file.txt.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetBucketRequestPaymentInput | GetBucketRequestPaymentInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[GetBucketRequestPaymentInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetBucketRequestPaymentOutput
|
An instance of |
get_bucket_request_payment
async
¶
get_bucket_request_payment(request: GetBucketRequestPaymentInput | GetBucketRequestPaymentInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetBucketRequestPaymentInputDict]) -> GetBucketRequestPaymentOutput
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:
Warning
You must URL encode any signed header values that contain spaces. For
example, if your header value is my file.txt, containing two spaces
after my, you must URL encode this value to my%20%20file.txt.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetBucketRequestPaymentInput | GetBucketRequestPaymentInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[GetBucketRequestPaymentInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetBucketRequestPaymentOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
GetBucketRequestPaymentInput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetBucketRequestPaymentInput structure.
Attributes¶
bucket
class-attribute
instance-attribute
¶
bucket: str | None = ...
The name of the bucket for which to get the payment request configuration
expected_bucket_owner
class-attribute
instance-attribute
¶
expected_bucket_owner: str | None = ...
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).
Output¶
GetBucketRequestPaymentOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetBucketRequestPaymentOutput structure.
Attributes¶
payer
class-attribute
instance-attribute
¶
payer: str | None = ...
Specifies who pays for the download and request fees.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.