Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace PutObjectAclRequest

Hierarchy

Index

Properties

Optional ACL

ACL: ObjectCannedACL | string

The canned ACL to apply to the object. For more information, see Canned ACL.

Optional AccessControlPolicy

AccessControlPolicy: AccessControlPolicy

Contains the elements that set the ACL permissions for an object per grantee.

Bucket

Bucket: string | undefined

The bucket name that contains the object to which you want to attach the ACL.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points 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

Optional ChecksumAlgorithm

ChecksumAlgorithm: 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.

Optional ContentMD5

ContentMD5: undefined | string

The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to RFC 1864.>

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

Optional ExpectedBucketOwner

ExpectedBucketOwner: undefined | 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).

Optional GrantFullControl

GrantFullControl: undefined | string

Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

This action is not supported by Amazon S3 on Outposts.

Optional GrantRead

GrantRead: undefined | string

Allows grantee to list the objects in the bucket.

This action is not supported by Amazon S3 on Outposts.

Optional GrantReadACP

GrantReadACP: undefined | string

Allows grantee to read the bucket ACL.

This action is not supported by Amazon S3 on Outposts.

Optional GrantWrite

GrantWrite: undefined | string

Allows grantee to create new objects in the bucket.

For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.

Optional GrantWriteACP

GrantWriteACP: undefined | string

Allows grantee to write the ACL for the applicable bucket.

This action is not supported by Amazon S3 on Outposts.

Key

Key: string | undefined

Key for which the PUT action was initiated.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

Optional RequestPayer

RequestPayer: RequestPayer | string

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

Optional VersionId

VersionId: undefined | string

VersionId used to reference a specific version of the object.