PutBucketPolicy
Applies an Amazon S3 bucket policy to an Amazon S3 bucket.
Note
Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name
. Virtual-hosted-style requests aren't supported.
For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the
Amazon S3 User Guide. For more information about endpoints in Local Zones, see Available Local Zone for directory buckets in the
Amazon S3 User Guide.
- Permissions
-
If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must both have the
PutBucketPolicy
permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.If you don't have
PutBucketPolicy
permissions, Amazon S3 returns a403 Access Denied
error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a405 Method Not Allowed
error.Important
To ensure that bucket owners don't inadvertently lock themselves out of their own buckets, the root principal in a bucket owner's Amazon Web Services account can perform the
GetBucketPolicy
,PutBucketPolicy
, andDeleteBucketPolicy
API actions, even if their bucket policy explicitly denies the root principal's access. Bucket owner root principals can only be blocked from performing these API actions by VPC endpoint policies and Amazon Organizations policies.-
General purpose bucket permissions - The
s3:PutBucketPolicy
permission is required in a policy. For more information about general purpose buckets bucket policies, see Using Bucket Policies and User Policies in the Amazon S3 User Guide. -
Directory bucket permissions - To grant access to this API operation, you must have the
s3express:PutBucketPolicy
permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.
-
- Example bucket policies
-
General purpose buckets example bucket policies - See Bucket policy examples in the Amazon S3 User Guide.
Directory bucket example bucket policies - See Example bucket policies for S3 Express One Zone in the Amazon S3 User Guide.
- HTTP Host header syntax
-
Directory buckets - The HTTP Host header syntax is
s3express-control.region-code.amazonaws.com
.
The following operations are related to PutBucketPolicy
:
Request Syntax
PUT /?policy HTTP/1.1
Host: Bucket
.s3.amazonaws.com
Content-MD5: ContentMD5
x-amz-sdk-checksum-algorithm: ChecksumAlgorithm
x-amz-confirm-remove-self-bucket-access: ConfirmRemoveSelfBucketAccess
x-amz-expected-bucket-owner: ExpectedBucketOwner
{ Policy
in JSON format }
URI Request Parameters
The request uses the following URI parameters.
- Bucket
-
The name of the bucket.
Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format
https://s3express-control.region-code.amazonaws.com/bucket-name
. Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the formatbucket-base-name--zone-id--x-s3
(for example,DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User GuideRequired: Yes
- Content-MD5
-
The MD5 hash of the request body.
For requests made using the Amazon Command Line Interface (CLI) or Amazon SDKs, this field is calculated automatically.
Note
This functionality is not supported for directory buckets.
- x-amz-confirm-remove-self-bucket-access
-
Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.
Note
This functionality is not supported for directory buckets.
- x-amz-expected-bucket-owner
-
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).Note
For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code
501 Not Implemented
. - x-amz-sdk-checksum-algorithm
-
Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding
x-amz-checksum-algorithm
orx-amz-trailer
header sent. Otherwise, Amazon S3 fails the request with the HTTP status code400 Bad Request
.For the
x-amz-checksum-algorithm
header, replacealgorithm
with the supported algorithm from the following list:-
CRC32
-
CRC32C
-
SHA1
-
SHA256
For more information, see Checking object integrity in the Amazon S3 User Guide.
If the individual checksum value you provide through
x-amz-checksum-algorithm
doesn't match the checksum algorithm you set throughx-amz-sdk-checksum-algorithm
, Amazon S3 ignores any providedChecksumAlgorithm
parameter and uses the checksum algorithm that matches the provided value inx-amz-checksum-algorithm
.Note
For directory buckets, when you use Amazon SDKs,
CRC32
is the default checksum algorithm that's used for performance.Valid Values:
CRC32 | CRC32C | SHA1 | SHA256
-
Request Body
The request accepts the following data in JSON format.
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.
Examples
Sample Request for general purpose buckets
The following request shows the PUT individual policy request for the bucket.
PUT /?policy HTTP/1.1 Host: bucket.s3.<Region>.amazonaws.com Date: Tue, 04 Apr 2010 20:34:56 GMT Authorization: authorization string { "Version":"2008-10-17", "Id":"aaaa-bbbb-cccc-dddd", "Statement" : [ { "Effect":"Allow", "Sid":"1", "Principal" : { "AWS":["111122223333","444455556666"] }, "Action":["s3:*"], "Resource":"arn:aws:s3:::bucket/*" } ] }
Sample Response for general purpose buckets
This example illustrates one usage of PutBucketPolicy.
HTTP/1.1 204 No Content x-amz-id-2: Uuag1LuByR5Onimru9SAMPLEAtRPfTaOFg== x-amz-request-id: 656c76696e6727732SAMPLE7374 Date: Tue, 04 Apr 2010 20:34:56 GMT Connection: keep-alive Server: AmazonS3
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: