Class: Aws::S3::Types::PutBucketTaggingRequest

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 PutBucketTaggingRequest data as a hash:

{
  bucket: "BucketName", # required
  content_md5: "ContentMD5",
  checksum_algorithm: "CRC32", # accepts CRC32, CRC32C, SHA1, SHA256
  tagging: { # required
    tag_set: [ # required
      {
        key: "ObjectKey", # required
        value: "Value", # required
      },
    ],
  },
  expected_bucket_owner: "AccountId",
}

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bucket ⇒ String

The bucket name.

Returns:

  • (String) 


12685
12686
12687
12688
12689
12690
12691
12692
12693
 
# File 'lib/aws-sdk-s3/types.rb', line 12685

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

#checksum_algorithm ⇒ String

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.

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

Returns:

  • (String) 


12685
12686
12687
12688
12689
12690
12691
12692
12693
 
# File 'lib/aws-sdk-s3/types.rb', line 12685

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

#content_md5 ⇒ String

The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see [RFC 1864].

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

[1]: www.ietf.org/rfc/rfc1864.txt

Returns:

  • (String) 


12685
12686
12687
12688
12689
12690
12691
12692
12693
 
# File 'lib/aws-sdk-s3/types.rb', line 12685

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

#expected_bucket_owner ⇒ String

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

Returns:

  • (String) 


12685
12686
12687
12688
12689
12690
12691
12692
12693
 
# File 'lib/aws-sdk-s3/types.rb', line 12685

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

#tagging ⇒ Types::Tagging

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

Returns:



12685
12686
12687
12688
12689
12690
12691
12692
12693
 
# File 'lib/aws-sdk-s3/types.rb', line 12685

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