PutBucketPolicyCommand

Use a bare-bones client and the command you need to make an API call.

PutBucketPolicyCommandInput

[PutBucketPolicyCommandInput](@aws-sdk/client-s3!PutBucketPolicyCommandInput:Interface)

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 <code>https://s3express-control.region-code.amazonaws.com/bucket-name </code>. Virtual-hosted-style requests aren't supported. For more information about endpoints in Availability Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the Amazon S3 User Guide. For more information about endpoints in Local Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html">Concepts for directory buckets in Local Zones</a> in the Amazon S3 User Guide. </note> <dl> <dt>Permissions</dt> <dd> 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 <code>PutBucketPolicy</code> permissions on the specified bucket and belong to the bucket owner's account in order to use this operation. If you don't have <code>PutBucketPolicy</code> permissions, Amazon S3 returns a <code>403 Access Denied</code> 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 <code>405 Method Not Allowed</code> 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 <code>GetBucketPolicy</code>, <code>PutBucketPolicy</code>, and <code>DeleteBucketPolicy</code> 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 Web Services Organizations policies. </important> <ul> <li> General purpose bucket permissions - The <code>s3:PutBucketPolicy</code> permission is required in a policy. For more information about general purpose buckets bucket policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using Bucket Policies and User Policies</a> in the Amazon S3 User Guide. </li> <li> Directory bucket permissions - To grant access to this API operation, you must have the <code>s3express:PutBucketPolicy</code> 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 Web Services account that owns the resource. For more information about directory bucket policies and permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html">Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone</a> in the Amazon S3 User Guide. </li> </ul> </dd> <dt>Example bucket policies</dt> <dd> General purpose buckets example bucket policies - See <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html">Bucket policy examples</a> in the Amazon S3 User Guide. Directory bucket example bucket policies - See <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html">Example bucket policies for S3 Express One Zone</a> in the Amazon S3 User Guide. </dd> <dt>HTTP Host header syntax</dt> <dd> Directory buckets - The HTTP Host header syntax is <code>s3express-control.region-code.amazonaws.com</code>. </dd> </dl> The following operations are related to <code>PutBucketPolicy</code>: <ul> <li> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a> </li> <li> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html">DeleteBucket</a> </li> </ul>

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 <code>https://s3express-control.region-code.amazonaws.com/bucket-name </code>. 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 format <code> bucket-base-name--zone-id--x-s3</code> (for example, <code> DOC-EXAMPLE-BUCKET--usw2-az1--x-s3</code>). For information about bucket naming restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory bucket naming rules</a> in the Amazon S3 User Guide 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

Policy

The bucket policy as a JSON document. For directory buckets, the only IAM action supported in the bucket policy is <code>s3express:CreateSession</code>.

ChecksumAlgorithm

Indicates the algorithm used to create the checksum for the request 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 <code>x-amz-checksum-algorithm </code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For the <code>x-amz-checksum-algorithm </code> header, replace <code> algorithm </code> with the supported algorithm from the following list: <ul> <li> <code>CRC32</code> </li> <li> <code>CRC32C</code> </li> <li> <code>CRC64NVME</code> </li> <li> <code>SHA1</code> </li> <li> <code>SHA256</code> </li> </ul> For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the Amazon S3 User Guide. If the individual checksum value you provide through <code>x-amz-checksum-algorithm </code> doesn't match the checksum algorithm you set through <code>x-amz-sdk-checksum-algorithm</code>, Amazon S3 fails the request with a <code>BadDigest</code> error. <note> For directory buckets, when you use Amazon Web Services SDKs, <code>CRC32</code> is the default checksum algorithm that's used for performance. </note>

ConfirmRemoveSelfBucketAccess

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. </note>

ContentMD5

The MD5 hash of the request body. For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically. <note> This functionality is not supported for directory buckets. </note>

ExpectedBucketOwner

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 <code>403 Forbidden</code> (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 <code>501 Not Implemented</code>. </note>

The input for [PutBucketPolicyCommand](@aws-sdk/client-s3!PutBucketPolicyCommand:Class).

$metadata

PutBucketPolicyCommandOutput

The output of [PutBucketPolicyCommand](@aws-sdk/client-s3!PutBucketPolicyCommand:Class).

$fault

$response

$retryable

(constructor)

options

Constructs a new instance of the <code>ServiceException</code> class

[Symbol.hasInstance]

instance

Custom instanceof check to support the operator for ServiceException base class

isInstance

value

Checks if a value is an instance of ServiceException (duck typed)

S3ServiceException

Base exception class for all service exceptions from S3 service.