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

    Class GetBucketPolicyStatusCommand

    This operation is not supported for directory buckets.

    Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.

    For more information about when Amazon S3 considers a bucket public, see The Meaning of "Public".

    The following operations are related to GetBucketPolicyStatus:

    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, GetBucketPolicyStatusCommand } from "ibm-cos-sdk-v2"; // ES Modules import
    // const { S3Client, GetBucketPolicyStatusCommand } = 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 = { // GetBucketPolicyStatusRequest
    Bucket: "STRING_VALUE", // required
    ExpectedBucketOwner: "STRING_VALUE",
    };
    const command = new GetBucketPolicyStatusCommand(input);
    const response = await client.send(command);
    // { // GetBucketPolicyStatusOutput
    // PolicyStatus: { // PolicyStatus
    // IsPublic: true || false,
    // },
    // };

    GetBucketPolicyStatusCommandInput

    S3ServiceException

    Base exception class for all service exceptions from S3 service.

    Hierarchy

    Index

    Constructors

    Constructors

    • Returns GetBucketPolicyStatusCommand

    • Parameters

      Returns GetBucketPolicyStatusCommand