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

Inherits:

Struct

• Object
• Struct
• Aws::S3::Types::PutObjectTaggingRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-s3/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #bucket ⇒ String

  The bucket name containing the object.

• #checksum_algorithm ⇒ String

  Indicates the algorithm used to create the checksum for the object when you use the SDK.

• #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.

• #request_payer ⇒ String

  Confirms that the requester knows that they will be charged for the request.

• #tagging ⇒ Types::Tagging

  Container for the ‘TagSet` and `Tag` elements.

• #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.

**Access points** - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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*.

**S3 on Outposts** - When you use this action with 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, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see [What is S3 on Outposts?] 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)

# File 'lib/aws-sdk-s3/types.rb', line 15974

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

#checksum_algorithm ⇒ String

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don’t use the SDK. When you send 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.

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 15974

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

#content_md5 ⇒ String

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)

# File 'lib/aws-sdk-s3/types.rb', line 15974

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

#expected_bucket_owner ⇒ String

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 15974

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

#key ⇒ String

Name of the object key.

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 15974

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

#request_payer ⇒ String

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets] in the *Amazon S3 User Guide*.

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

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

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 15974

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

#tagging ⇒ Types::Tagging

Container for the ‘TagSet` and `Tag` elements

Returns:

• (Types::Tagging)

# File 'lib/aws-sdk-s3/types.rb', line 15974

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

#version_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 15974

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