Class: Aws::S3::BucketTagging

Inherits:

Resources::Resource

• Object
• Resources::Resource
• Aws::S3::BucketTagging

Defined in:

(unknown)

Instance Attribute Summary

• #bucket_name ⇒ String readonly
• #tag_set ⇒ Array<Types::Tag> readonly

  Contains the tag set.

Attributes inherited from Resources::Resource

#client, #identifiers

Instance Method Summary

• #bucket ⇒ Bucket
• #delete(options = {}) ⇒ Struct

  Deletes the tags from the bucket.

  To use this operation, you must have permission to perform the s3:PutBucketTagging action.

• #initialize ⇒ Object constructor
• #put(options = {}) ⇒ Struct

  Sets the tags for a bucket.

  Use tags to organize your AWS bill to reflect your own cost structure.

Methods inherited from Resources::Resource

add_data_attribute, add_identifier, #data, data_attributes, #data_loaded?, identifiers, #load, #wait_until

Methods included from Resources::OperationMethods

#add_batch_operation, #add_operation, #batch_operation, #batch_operation_names, #batch_operations, #operation, #operation_names, #operations

Constructor Details

#initialize(bucket_name, options = {}) ⇒ Object #initialize(options = {}) ⇒ Object

Overloads:

• #initialize(bucket_name, options = {}) ⇒ Object

  Parameters:

  • bucket_name (String)

  Options Hash (options):

  • :client (Client) —

    When `:client is not given, the options hash is used to construct a new Client object.

• #initialize(options = {}) ⇒ Object

  Options Hash (options):

  • :bucket_name (required, String)
  • :client (Client) —

    When `:client is not given, the options hash is used to construct a new Client object.

Instance Attribute Details

#bucket_name ⇒ String (readonly)

Returns:

• (String)

#tag_set ⇒ Array<Types::Tag> (readonly)

Contains the tag set.

Returns:

• (Array<Types::Tag>) —

  Contains the tag set.

Instance Method Details

#bucket ⇒ Bucket

Returns:

• (Bucket)

#delete(options = {}) ⇒ Struct

Deletes the tags from the bucket.

To use this operation, you must have permission to perform the s3:PutBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others.

The following operations are related to DeleteBucketTagging:

• GetBucketTagging

• PutBucketTagging

Examples:

Request syntax example with placeholder values

buckettagging.delete({
  expected_bucket_owner: "AccountId",
  use_accelerate_endpoint: false,
})

Options Hash (options):

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

• :use_accelerate_endpoint (Boolean) —

  When true, the "https://BUCKETNAME.s3-accelerate.amazonaws.com" endpoint will be used.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• Client#delete_bucket_tagging

#put(options = {}) ⇒ Struct

Sets the tags for a bucket.

Use tags to organize your AWS bill to reflect your own cost structure. To do this, sign up to get your AWS account bill with tag key values included. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values. For example, you can tag several resources with a specific application name, and then organize your billing information to see the total cost of that application across several services. For more information, see Cost Allocation and Tagging.

Within a bucket, if you add a tag that has the same key as an existing tag, the new value overwrites the old value. For more information, see Using Cost Allocation in Amazon S3 Bucket Tags.

To use this operation, you must have permissions to perform the s3:PutBucketTagging action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

PutBucketTagging has the following special errors:

• Error code: InvalidTagError

  • Description: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For information about tag restrictions, see User-Defined Tag Restrictions and AWS-Generated Cost Allocation Tag Restrictions.

• Error code: MalformedXMLError

  • Description: The XML provided does not match the schema.

• Error code: OperationAbortedError

  • Description: A conflicting conditional operation is currently in progress against this resource. Please try again.

• Error code: InternalError

  • Description: The service was unable to apply the provided tag to the bucket.

The following operations are related to PutBucketTagging:

• GetBucketTagging

• DeleteBucketTagging

Examples:

Request syntax example with placeholder values

buckettagging.put({
  content_md5: "ContentMD5",
  tagging: { # required
    tag_set: [ # required
      {
        key: "ObjectKey", # required
        value: "Value", # required
      },
    ],
  },
  expected_bucket_owner: "AccountId",
  use_accelerate_endpoint: false,
})

Options Hash (options):

• :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 AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

• :tagging (required, Types::Tagging) —

  Container for the TagSet and Tag elements.

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

• :use_accelerate_endpoint (Boolean) —

  When true, the "https://BUCKETNAME.s3-accelerate.amazonaws.com" endpoint will be used.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• Client#put_bucket_tagging