Class GetPublicAccessBlockCommandProtected

Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. To use this operation, you must have the s3:GetBucketPublicAccessBlock 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. If the PublicAccessBlock settings 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 GetPublicAccessBlock:

• Using Amazon S3 Block Public Access

• PutPublicAccessBlock

• GetPublicAccessBlock

• DeletePublicAccessBlock

Example

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

import { S3Client, GetPublicAccessBlockCommand } from "@aws-sdk/client-s3"; // ES Modules import
// const { S3Client, GetPublicAccessBlockCommand } = require("@aws-sdk/client-s3"); // CommonJS import
const client = new S3Client(config);
const input = { // GetPublicAccessBlockRequest
  Bucket: "STRING_VALUE", // required
  ExpectedBucketOwner: "STRING_VALUE",
};
const command = new GetPublicAccessBlockCommand(input);
const response = await client.send(command);
// { // GetPublicAccessBlockOutput
//   PublicAccessBlockConfiguration: { // PublicAccessBlockConfiguration
//     BlockPublicAcls: true || false,
//     IgnorePublicAcls: true || false,
//     BlockPublicPolicy: true || false,
//     RestrictPublicBuckets: true || false,
//   },
// };

Param

GetPublicAccessBlockCommandInput

Returns

GetPublicAccessBlockCommandOutput

See

• GetPublicAccessBlockCommandInput for command's input shape.
• GetPublicAccessBlockCommandOutput for command's response shape.
• config for S3Client's config shape.

Throws

S3ServiceException

Base exception class for all service exceptions from S3 service.