Class: Aws::S3::Types::PutObjectTaggingRequest

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-s3/types.rb

Overview

Note:

When making an API call, you may pass PutObjectTaggingRequest data as a 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",
  request_payer: "requester", # accepts requester
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

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][1

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 using 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 S3 on Outposts][2

in the *Amazon S3 User Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html

Returns:

  • (String)

12506
12507
12508
12509
12510
12511
12512
12513
12514
12515
12516
# File 'lib/aws-sdk-s3/types.rb', line 12506

class PutObjectTaggingRequest < Struct.new(
  :bucket,
  :key,
  :version_id,
  :content_md5,
  :tagging,
  :expected_bucket_owner,
  :request_payer)
  SENSITIVE = []
  include Aws::Structure
end

#content_md5String

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.

Returns:

  • (String)

12506
12507
12508
12509
12510
12511
12512
12513
12514
12515
12516
# File 'lib/aws-sdk-s3/types.rb', line 12506

class PutObjectTaggingRequest < Struct.new(
  :bucket,
  :key,
  :version_id,
  :content_md5,
  :tagging,
  :expected_bucket_owner,
  :request_payer)
  SENSITIVE = []
  include Aws::Structure
end

#expected_bucket_ownerString

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.

Returns:

  • (String)

12506
12507
12508
12509
12510
12511
12512
12513
12514
12515
12516
# File 'lib/aws-sdk-s3/types.rb', line 12506

class PutObjectTaggingRequest < Struct.new(
  :bucket,
  :key,
  :version_id,
  :content_md5,
  :tagging,
  :expected_bucket_owner,
  :request_payer)
  SENSITIVE = []
  include Aws::Structure
end

#keyString

Name of the object key.

Returns:

  • (String)

12506
12507
12508
12509
12510
12511
12512
12513
12514
12515
12516
# File 'lib/aws-sdk-s3/types.rb', line 12506

class PutObjectTaggingRequest < Struct.new(
  :bucket,
  :key,
  :version_id,
  :content_md5,
  :tagging,
  :expected_bucket_owner,
  :request_payer)
  SENSITIVE = []
  include Aws::Structure
end

#request_payerString

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 Requestor Pays Buckets] in the *Amazon S3 User Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

Returns:

  • (String)

12506
12507
12508
12509
12510
12511
12512
12513
12514
12515
12516
# File 'lib/aws-sdk-s3/types.rb', line 12506

class PutObjectTaggingRequest < Struct.new(
  :bucket,
  :key,
  :version_id,
  :content_md5,
  :tagging,
  :expected_bucket_owner,
  :request_payer)
  SENSITIVE = []
  include Aws::Structure
end

#taggingTypes::Tagging

Container for the `TagSet` and `Tag` elements

Returns:


12506
12507
12508
12509
12510
12511
12512
12513
12514
12515
12516
# File 'lib/aws-sdk-s3/types.rb', line 12506

class PutObjectTaggingRequest < Struct.new(
  :bucket,
  :key,
  :version_id,
  :content_md5,
  :tagging,
  :expected_bucket_owner,
  :request_payer)
  SENSITIVE = []
  include Aws::Structure
end

#version_idString

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

Returns:

  • (String)

12506
12507
12508
12509
12510
12511
12512
12513
12514
12515
12516
# File 'lib/aws-sdk-s3/types.rb', line 12506

class PutObjectTaggingRequest < Struct.new(
  :bucket,
  :key,
  :version_id,
  :content_md5,
  :tagging,
  :expected_bucket_owner,
  :request_payer)
  SENSITIVE = []
  include Aws::Structure
end