Class PutBucketRequestPaymentCommand

Example

Use a bare-bones client and the command you need to make an API call.

import { S3Client, PutBucketRequestPaymentCommand } from "ibm-cos-sdk-v2"; // ES Modules import
// const { S3Client, PutBucketRequestPaymentCommand } = require("ibm-cos-sdk-v2"); // CommonJS import
// import type { S3ClientConfig } from "ibm-cos-sdk-v2";
const config = {}; // type is S3ClientConfig
const client = new S3Client(config);
const input = { // PutBucketRequestPaymentRequest
  Bucket: "STRING_VALUE", // required
  ContentMD5: "STRING_VALUE",
  ChecksumAlgorithm: "CRC32" || "CRC32C" || "SHA1" || "SHA256" || "CRC64NVME",
  RequestPaymentConfiguration: { // RequestPaymentConfiguration
    Payer: "Requester" || "BucketOwner", // required
  },
  ExpectedBucketOwner: "STRING_VALUE",
};
const command = new PutBucketRequestPaymentCommand(input);
const response = await client.send(command);
// {};

Copy

Example: Set request payment configuration on a bucket.

// The following example sets request payment configuration on a bucket so that person requesting the download is charged.
const input = {
  Bucket: "examplebucket",
  RequestPaymentConfiguration: {
    Payer: "Requester"
  }
};
const command = new PutBucketRequestPaymentCommand(input);
const response = await client.send(command);
/* response is
{ /* metadata only */ }
*/
Copy