PutPublicAccessBlock
Note
This operation is not supported by directory buckets.
Creates or modifies the PublicAccessBlock configuration for an
AWS account. For this operation, users must have the
s3:PutAccountPublicAccessBlock permission. For more information, see
Using Amazon S3 block public access.
Related actions include:
Request Syntax
PUT /v20180820/configuration/publicAccessBlock HTTP/1.1
Host: s3-control.amazonaws.com
x-amz-account-id: AccountId
<?xml version="1.0" encoding="UTF-8"?>
<PublicAccessBlockConfiguration xmlns="http://awss3control.amazonaws.com/doc/2018-08-20/">
<BlockPublicAcls>boolean</BlockPublicAcls>
<IgnorePublicAcls>boolean</IgnorePublicAcls>
<BlockPublicPolicy>boolean</BlockPublicPolicy>
<RestrictPublicBuckets>boolean</RestrictPublicBuckets>
</PublicAccessBlockConfiguration>URI Request Parameters
The request uses the following URI parameters.
- x-amz-account-id
-
The account ID for the AWS account whose
PublicAccessBlockconfiguration you want to set.Length Constraints: Maximum length of 64.
Pattern:
^\d{12}$Required: Yes
Request Body
The request accepts the following data in XML format.
- PublicAccessBlockConfiguration
-
Root level tag for the PublicAccessBlockConfiguration parameters.
Required: Yes
- BlockPublicAcls
-
Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to
TRUEcauses the following behavior:-
PutBucketAclandPutObjectAclcalls fail if the specified ACL is public. -
PUT Object calls fail if the request includes a public ACL.
-
PUT Bucket calls fail if the request includes a public ACL.
Enabling this setting doesn't affect existing policies or ACLs.
This property is not supported for Amazon S3 on Outposts.
Type: Boolean
Required: No
-
- BlockPublicPolicy
-
Specifies whether Amazon S3 should block public bucket policies for buckets in this account. Setting this element to
TRUEcauses Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access.Enabling this setting doesn't affect existing bucket policies.
This property is not supported for Amazon S3 on Outposts.
Type: Boolean
Required: No
- IgnorePublicAcls
-
Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to
TRUEcauses Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain.Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.
This property is not supported for Amazon S3 on Outposts.
Type: Boolean
Required: No
- RestrictPublicBuckets
-
Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. Setting this element to
TRUErestricts access to buckets with public policies to only AWS service principals and authorized users within this account.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.
This property is not supported for Amazon S3 on Outposts.
Type: Boolean
Required: No
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
