GetPublicAccessBlockCommand

Suggest an Edit

This operation is not supported for directory buckets.

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:

Example Syntax

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,
//   },
// };

GetPublicAccessBlockCommand Input

See GetPublicAccessBlockCommandInput for more details

Parameter
Type
Description
Bucket
Required
string | undefined

The name of the Amazon S3 bucket whose PublicAccessBlock configuration you want to retrieve.

Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "aws-sdk/signature-v4-crt" package to your project dependencies. For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues

ExpectedBucketOwner
string | undefined

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

GetPublicAccessBlockCommand Output

See GetPublicAccessBlockCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
PublicAccessBlockConfiguration
PublicAccessBlockConfiguration | undefined

The PublicAccessBlock configuration currently in effect for this Amazon S3 bucket.

Throws

Name
Fault
Details
S3ServiceException
Base exception class for all service exceptions from S3 service.