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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-s3/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",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

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.

Returns:

  • (String)


11805
11806
11807
11808
11809
11810
11811
11812
11813
11814
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 11805

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

#content_md5String

The MD5 hash for the request body.

Returns:

  • (String)


11805
11806
11807
11808
11809
11810
11811
11812
11813
11814
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 11805

class PutObjectTaggingRequest < Struct.new(
  :bucket,
  :key,
  :version_id,
  :content_md5,
  :tagging,
  :expected_bucket_owner)
  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)


11805
11806
11807
11808
11809
11810
11811
11812
11813
11814
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 11805

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

#keyString

Name of the object key.

Returns:

  • (String)


11805
11806
11807
11808
11809
11810
11811
11812
11813
11814
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 11805

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

#taggingTypes::Tagging

Container for the TagSet and Tag elements

Returns:



11805
11806
11807
11808
11809
11810
11811
11812
11813
11814
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 11805

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

#version_idString

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

Returns:

  • (String)


11805
11806
11807
11808
11809
11810
11811
11812
11813
11814
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 11805

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