IBM COS SDK for JavaScript V2 - v1.0.0
    Preparing search index...

    Class GetBucketRequestPaymentCommand

    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:

    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.

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

    import { S3Client, GetBucketRequestPaymentCommand } from "ibm-cos-sdk-v2"; // ES Modules import
    // const { S3Client, GetBucketRequestPaymentCommand } = 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 = { // GetBucketRequestPaymentRequest
    Bucket: "STRING_VALUE", // required
    ExpectedBucketOwner: "STRING_VALUE",
    };
    const command = new GetBucketRequestPaymentCommand(input);
    const response = await client.send(command);
    // { // GetBucketRequestPaymentOutput
    // Payer: "Requester" || "BucketOwner",
    // };

    GetBucketRequestPaymentCommandInput

    S3ServiceException

    Base exception class for all service exceptions from S3 service.

    // The following example retrieves bucket versioning configuration.
    const input = {
    Bucket: "examplebucket"
    };
    const command = new GetBucketRequestPaymentCommand(input);
    const response = await client.send(command);
    /* response is
    {
    Payer: "BucketOwner"
    }
    */

    Hierarchy

    Index

    Constructors

    Constructors

    • Returns GetBucketRequestPaymentCommand

    • Parameters

      Returns GetBucketRequestPaymentCommand