Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Interface PutBucketPolicyRequest

Hierarchy

Properties

Bucket: undefined | string

The name of the bucket.

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

ChecksumAlgorithm?: string

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 or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 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.

ConfirmRemoveSelfBucketAccess?: boolean

Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.

ContentMD5?: string

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.

ExpectedBucketOwner?: string

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).

Policy: undefined | string

The bucket policy as a JSON document.