get-bucket-request-payment¶
Description¶
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 :
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
get-bucket-request-payment
--bucket <value>
[--expected-bucket-owner <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--bucket (string)
The name of the bucket for which to get the payment request configuration
--expected-bucket-owner (string)
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP
403 (Access Denied)error.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
Examples¶
To retrieve the request payment configuration for a bucket
The following get-bucket-request-payment example retrieves the requester pays configuration for the specified bucket.
aws s3api get-bucket-request-payment \
--bucket my-bucket
Output:
{
"Payer": "BucketOwner"
}