s3_put_object_tagging: Sets the supplied tag-set to an object that already exists in...

View source: R/s3_operations.R

s3_put_object_taggingR Documentation

Sets the supplied tag-set to an object that already exists in a bucket

Description

Sets the supplied tag-set to an object that already exists in a bucket.

See https://www.paws-r-sdk.com/docs/s3_put_object_tagging/ for full documentation.

Usage

s3_put_object_tagging(
  Bucket,
  Key,
  VersionId = NULL,
  ContentMD5 = NULL,
  ChecksumAlgorithm = NULL,
  Tagging,
  ExpectedBucketOwner = NULL,
  RequestPayer = NULL
)

Arguments

Bucket

[required] The bucket name containing the object.

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 you use 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

Key

[required] Name of the object key.

VersionId

The versionId of the object that the tag-set will be added to.

ContentMD5

The MD5 hash for 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.

ChecksumAlgorithm

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.

Tagging

[required] Container for the TagSet and Tag elements

ExpectedBucketOwner

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

RequestPayer

paws.storage documentation built on Sept. 12, 2023, 1:23 a.m.