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

    Class PutPublicAccessBlockCommand

    This operation is not supported for directory buckets.

    Creates or modifies the PublicAccessBlock configuration for an Amazon S3 bucket. To use this operation, you must have the s3:PutBucketPublicAccessBlock permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.

    When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or an object, it checks the PublicAccessBlock configuration for both the bucket (or the bucket that contains the object) and the bucket owner's account. Account-level settings automatically inherit from organization-level policies when present. If the PublicAccessBlock configurations are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings.

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

    The following operations are related to PutPublicAccessBlock:

    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, PutPublicAccessBlockCommand } from "ibm-cos-sdk-v2"; // ES Modules import
    // const { S3Client, PutPublicAccessBlockCommand } = 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 = { // PutPublicAccessBlockRequest
    Bucket: "STRING_VALUE", // required
    ContentMD5: "STRING_VALUE",
    ChecksumAlgorithm: "CRC32" || "CRC32C" || "SHA1" || "SHA256" || "CRC64NVME",
    PublicAccessBlockConfiguration: { // PublicAccessBlockConfiguration
    BlockPublicAcls: true || false,
    IgnorePublicAcls: true || false,
    BlockPublicPolicy: true || false,
    RestrictPublicBuckets: true || false,
    },
    ExpectedBucketOwner: "STRING_VALUE",
    };
    const command = new PutPublicAccessBlockCommand(input);
    const response = await client.send(command);
    // {};

    PutPublicAccessBlockCommandInput

    S3ServiceException

    Base exception class for all service exceptions from S3 service.

    Hierarchy

    Index

    Constructors

    Constructors

    • Returns PutPublicAccessBlockCommand

    • Parameters

      Returns PutPublicAccessBlockCommand