PutBucketPolicy
Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than
the root user of the AWS account that owns the bucket, the calling identity must 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 a 403
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 a 405 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 AWS account can perform the
GetBucketPolicy
, PutBucketPolicy
, and
DeleteBucketPolicy
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 AWS Organizations
policies.
For more information, see Bucket policy examples.
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.
Required: Yes
- Content-MD5
-
The MD5 hash of the request body.
For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.
- 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.
- x-amz-expected-bucket-owner
-
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code
403 Forbidden
(access denied). - x-amz-sdk-checksum-algorithm
-
Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding
x-amz-checksum
orx-amz-trailer
header sent. Otherwise, Amazon S3 fails the request with the HTTP status code400 Bad Request
. For more information, see Checking object integrity in the Amazon S3 User Guide.If you provide an individual checksum, Amazon S3 ignores any provided
ChecksumAlgorithm
parameter.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
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
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 AWS SDKs, see the following: