You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::S3::Types::PutObjectTaggingRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::S3::Types::PutObjectTaggingRequest
- Defined in:
- (unknown)
Overview
When passing PutObjectTaggingRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
bucket: "BucketName", # required
key: "ObjectKey", # required
version_id: "ObjectVersionId",
content_md5: "ContentMD5",
tagging: { # required
tag_set: [ # required
{
key: "ObjectKey", # required
value: "Value", # required
},
],
},
expected_bucket_owner: "AccountId",
use_accelerate_endpoint: false,
}
Instance Attribute Summary collapse
-
#bucket ⇒ String
The bucket name containing the object.
-
#content_md5 ⇒ String
The MD5 hash for the request body.
-
#expected_bucket_owner ⇒ String
The account id of the expected bucket owner.
-
#key ⇒ String
Name of the object key.
-
#tagging ⇒ Types::Tagging
Container for the
TagSet
andTag
elements. -
#use_accelerate_endpoint ⇒ Boolean
When true, the "https://BUCKETNAME.s3-accelerate.amazonaws.com" endpoint will be used.
-
#version_id ⇒ String
The versionId of the object that the tag-set will be added to.
Instance Attribute Details
#bucket ⇒ String
The bucket name containing the object.
When using this API 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 operation with an access point through the AWS 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 Simple Storage Service Developer Guide.
When using this API 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 operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
#content_md5 ⇒ String
The MD5 hash for the request body.
For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.
#expected_bucket_owner ⇒ String
The account id of the expected bucket owner. If the bucket is owned by a
different account, the request will fail with an HTTP 403 (Access
Denied)
error.
#key ⇒ String
Name of the object key.
#tagging ⇒ Types::Tagging
Container for the TagSet
and Tag
elements
#use_accelerate_endpoint ⇒ Boolean
When true, the "https://BUCKETNAME.s3-accelerate.amazonaws.com" endpoint will be used.
#version_id ⇒ String
The versionId of the object that the tag-set will be added to.