Put Bucket Request Payment

s3_put_bucket_request_payment

R Documentation

This operation is not supported for directory buckets¶

Description¶

This operation is not supported for 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 put_bucket_request_payment:

create_bucket
get_bucket_request_payment

Usage¶

s3_put_bucket_request_payment(Bucket, ContentMD5, ChecksumAlgorithm,
  RequestPaymentConfiguration, ExpectedBucketOwner)

Arguments¶

Bucket

[required] The bucket name.

ContentMD5

The Base64 encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

ChecksumAlgorithm

Indicates the algorithm used to create the checksum for the request 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

[required] Container for Payer.

ExpectedBucketOwner

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).

Value¶

An empty list.

Request syntax¶

svc$put_bucket_request_payment(
  Bucket = "string",
  ContentMD5 = "string",
  ChecksumAlgorithm = "CRC32"|"CRC32C"|"SHA1"|"SHA256"|"CRC64NVME",
  RequestPaymentConfiguration = list(
    Payer = "Requester"|"BucketOwner"
  ),
  ExpectedBucketOwner = "string"
)

Examples¶

## Not run: 
# The following example sets request payment configuration on a bucket so
# that person requesting the download is charged.
svc$put_bucket_request_payment(
  Bucket = "examplebucket",
  RequestPaymentConfiguration = list(
    Payer = "Requester"
  )
)

## End(Not run)