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

    Class GetBucketOwnershipControlsCommand

    This operation is not supported for directory buckets.

    Retrieves OwnershipControls for an Amazon S3 bucket. To use this operation, you must have the s3:GetBucketOwnershipControls permission. For more information about Amazon S3 permissions, see Specifying permissions in a policy.

    A bucket doesn't have OwnershipControls settings in the following cases:

    • The bucket was created before the BucketOwnerEnforced ownership setting was introduced and you've never explicitly applied this value

    • You've manually deleted the bucket ownership control value using the DeleteBucketOwnershipControls API operation.

    By default, Amazon S3 sets OwnershipControls for all newly created buckets.

    For information about Amazon S3 Object Ownership, see Using Object Ownership.

    The following operations are related to GetBucketOwnershipControls:

    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, GetBucketOwnershipControlsCommand } from "ibm-cos-sdk-v2"; // ES Modules import
    // const { S3Client, GetBucketOwnershipControlsCommand } = 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 = { // GetBucketOwnershipControlsRequest
    Bucket: "STRING_VALUE", // required
    ExpectedBucketOwner: "STRING_VALUE",
    };
    const command = new GetBucketOwnershipControlsCommand(input);
    const response = await client.send(command);
    // { // GetBucketOwnershipControlsOutput
    // OwnershipControls: { // OwnershipControls
    // Rules: [ // OwnershipControlsRules // required
    // { // OwnershipControlsRule
    // ObjectOwnership: "BucketOwnerPreferred" || "ObjectWriter" || "BucketOwnerEnforced", // required
    // },
    // ],
    // },
    // };

    GetBucketOwnershipControlsCommandInput

    S3ServiceException

    Base exception class for all service exceptions from S3 service.

    Hierarchy

    Index

    Constructors

    Constructors

    • Returns GetBucketOwnershipControlsCommand

    • Parameters

      Returns GetBucketOwnershipControlsCommand