Amazon Simple Storage Service
API Reference (API Version 2006-03-01)

PUT PublicAccessBlock

Description

This operation creates or modifies the PublicAccessBlock configuration for an Amazon Web Services account. In order to use this operation, you must have the s3:PutAccountPublicAccessBlock permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy in the Amazon Simple Storage Service Developer Guide.

Important

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 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 object public, see The Meaning of "Public" in the Amazon Simple Storage Service Developer Guide.

Requests

Syntax

PUT /v20180820/configuration/publicAccessBlock HTTP/1.1 Host: <account-id>.s3-control.amazonaws.com x-amz-date: <Thu, 15 Nov 2016 00:17:21 GMT> Authorization: <authorization string> (see Authenticating Requests (AWS Signature Version 4))

Note

For information about locating your AWS account ID, see Finding your AWS Account ID in the Amazon Web Services General Reference.

Request Parameters

This operation does not use request parameters.

Request Headers

This implementation of the operation uses only request headers that are common to all operations. For more information, see Common Request Headers.

Request Elements

This operation uses the following request elements. You can enable BlockPublicAcls, IgnorePublicAcls, BlockPublicPolicy, and RestrictPublicBuckets in any combination.

Name Description Required
PublicAccessBlockConfiguration

A PublicAccessBlock configuration. You can enable the configuration elements in any combination.

Type: Container

Children: BlockPublicAcls, IgnorePublicAcls, BlockPublicPolicy, RestrictPublicBuckets

Yes
BlockPublicAcls

Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets and objects in this account. Setting this element to TRUE causes the following behavior:

Important

Enabling this setting doesn't affect existing policies or ACLs.

Type: Boolean

Ancestor: PublicAccessBlockConfiguration

Valid values: TRUE | FALSE

No
IgnorePublicAcls

Specifies whether Amazon S3 should ignore public ACLs for buckets and objects in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and objects in those buckets.

Important

Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.

Type: Boolean

Ancestor: PublicAccessBlockConfiguration

Valid values: TRUE | FALSE

No
BlockPublicPolicy

Specifies whether Amazon S3 should block public bucket policies for buckets in this account. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access.

Important

Enabling this setting doesn't affect existing bucket policies.

Type: Boolean

Ancestor: PublicAccessBlockConfiguration

Valid values: TRUE | FALSE

No
RestrictPublicBuckets

Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. If this element is set to TRUE, then only AWS services and authorized users within this account can access buckets with public policies.

Important

Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.

Type: Boolean

Ancestor: PublicAccessBlockConfiguration

Valid values: TRUE | FALSE

No

Responses

Response Headers

The operation returns response headers that are common to most responses. For more information, see Common Response Headers.

Response Elements

This operation does not return response elements.

Special Errors

This implementation of the operation does not return special errors. For general information about Amazon S3 errors and a list of error codes, see Error Responses.

Examples

First Sample Request

The following request puts an account PublicAccessBlock configuration that blocks public ACLs for buckets in the specified account.

PUT /v20180820/configuration/publicAccessBlock HTTP/1.1 Host: <account-id>.s3-control.amazonaws.com x-amz-date: <Thu, 15 Nov 2016 00:17:21 GMT> Authorization: <signatureValue> <?xml version="1.0" encoding="UTF-8"?> <PublicAccessBlockConfiguration> <BlockPublicAcls>TRUE</BlockPublicAcls> <IgnorePublicAcls>FALSE</IgnorePublicAcls> <BlockPublicPolicy>FALSE</BlockPublicPolicy> <RestrictPublicBuckets>FALSE</RestrictPublicBuckets> </PublicAccessBlockConfiguration>

First Sample Response

HTTP/1.1 200 OK x-amz-id-2: ITnGT1y4REXAMPLEPi4hklTXouTf0hccUjo0iCPEXAMPLEutBj3M7fPGlWO2SEWp x-amz-request-id: 51991EXAMPLE5321 Date: Thu, 15 Nov 2016 00:17:22 GMT Server: AmazonS3 Content-Length: 0

Second Sample Request

The following request puts an account PublicAccessBlock configuration that ignores public ACLs and restricts public bucket policies for buckets in the specified account.

PUT /v20180820/configuration/publicAccessBlock HTTP/1.1 Host: <account-id>.s3-control.amazonaws.com x-amz-date: <Thu, 15 Nov 2016 00:17:21 GMT> Authorization: <signatureValue> <?xml version="1.0" encoding="UTF-8"?> <PublicAccessBlockConfiguration> <BlockPublicAcls>FALSE</BlockPublicAcls> <IgnorePublicAcls>TRUE</IgnorePublicAcls> <BlockPublicPolicy>FALSE</BlockPublicPolicy> <RestrictPublicBuckets>TRUE</RestrictPublicBuckets> </PublicAccessBlockConfiguration>

Second Sample Response

HTTP/1.1 200 OK x-amz-id-2: ITnGT1y4REXAMPLEPi4hklTXouTf0hccUjo0iCPEXAMPLEutBj3M7fPGlWO2SEWp x-amz-request-id: 51991EXAMPLE5321 Date: Thu, 15 Nov 2016 00:17:22 GMT Server: AmazonS3 Content-Length: 0