Class: Aws::S3::BucketTagging

Inherits:
Object
  • Object
show all
Defined in:
gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_tagging.rb

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions collapse

Associations collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of BucketTagging.

Overloads:

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

    Parameters:

    • bucket_name (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ BucketTagging

    Options Hash (options):

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


22
23
24
25
26
27
28
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_tagging.rb', line 22

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @bucket_name = extract_bucket_name(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
  @waiter_block_warned = false
end

Instance Method Details

#bucketBucket

Returns:



237
238
239
240
241
242
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_tagging.rb', line 237

def bucket
  Bucket.new(
    name: @bucket_name,
    client: @client
  )
end

#bucket_nameString

Returns:

  • (String)


33
34
35
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_tagging.rb', line 33

def bucket_name
  @bucket_name
end

#clientClient

Returns:



46
47
48
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_tagging.rb', line 46

def client
  @client
end

#dataTypes::GetBucketTaggingOutput

Returns the data for this Aws::S3::BucketTagging. Calls Client#get_bucket_tagging if #data_loaded? is false.

Returns:



66
67
68
69
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_tagging.rb', line 66

def data
  load unless @data
  @data
end

#data_loaded?Boolean

Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

Returns:

  • (Boolean)

    Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.



74
75
76
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_tagging.rb', line 74

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


bucket_tagging.delete({
  expected_bucket_owner: "AccountId",
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

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.

Returns:

  • (EmptyStructure)


188
189
190
191
192
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_tagging.rb', line 188

def delete(options = {})
  options = options.merge(bucket: @bucket_name)
  resp = @client.delete_bucket_tagging(options)
  resp.data
end

#loadself Also known as: reload

Loads, or reloads #data for the current Aws::S3::BucketTagging. Returns self making it possible to chain methods.

bucket_tagging.reload.data

Returns:

  • (self)


56
57
58
59
60
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_tagging.rb', line 56

def load
  resp = @client.get_bucket_tagging(bucket: @bucket_name)
  @data = resp.data
  self
end

#put(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


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

Parameters:

  • options (Hash) (defaults to: {})

    ({})

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 Amazon Web Services Command Line Interface (CLI) or Amazon Web Services 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.

Returns:

  • (EmptyStructure)


228
229
230
231
232
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_tagging.rb', line 228

def put(options = {})
  options = options.merge(bucket: @bucket_name)
  resp = @client.put_bucket_tagging(options)
  resp.data
end

#tag_setArray<Types::Tag>

Contains the tag set.

Returns:



39
40
41
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_tagging.rb', line 39

def tag_set
  data[:tag_set]
end

#wait_until(options = {}) {|resource| ... } ⇒ Resource

Deprecated.

Use [Aws::S3::Client] #wait_until instead

Note:

The waiting operation is performed on a copy. The original resource remains unchanged.

Waiter polls an API operation until a resource enters a desired state.

Basic Usage

Waiter will polls until it is successful, it fails by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop until condition is true
resource.wait_until(options) {|resource| condition}

Example

instance.wait_until(max_attempts:10, delay:5) do |instance|
  instance.state.name == 'running'
end

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. The waiting condition is set by passing a block to #wait_until:

# poll for ~25 seconds
resource.wait_until(max_attempts:5,delay:5) {|resource|...}

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
# poll for 1 hour, instead of a number of attempts
proc = Proc.new do |attempts, response|
  throw :failure if Time.now - started_at > 3600
end

  # disable max attempts
instance.wait_until(before_wait:proc, max_attempts:nil) {...}

Handling Errors

When a waiter is successful, it returns the Resource. When a waiter fails, it raises an error.

begin
  resource.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

attempts attempt in seconds invoked before each attempt invoked before each wait

Parameters:

  • options (Hash) (defaults to: {})

    a customizable set of options

Options Hash (options):

  • :max_attempts (Integer) — default: 10

    Maximum number of

  • :delay (Integer) — default: 10

    Delay between each

  • :before_attempt (Proc) — default: nil

    Callback

  • :before_wait (Proc) — default: nil

    Callback

Yield Parameters:

  • resource (Resource)

    to be used in the waiting condition.

Returns:

  • (Resource)

    if the waiter was successful

Raises:

  • (Aws::Waiters::Errors::FailureStateError)

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

    yet successful.

  • (Aws::Waiters::Errors::UnexpectedError)

    Raised when an error is encountered while polling for a resource that is not expected.

  • (NotImplementedError)

    Raised when the resource does not



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_tagging.rb', line 158

def wait_until(options = {}, &block)
  self_copy = self.dup
  attempts = 0
  options[:max_attempts] = 10 unless options.key?(:max_attempts)
  options[:delay] ||= 10
  options[:poller] = Proc.new do
    attempts += 1
    if block.call(self_copy)
      [:success, self_copy]
    else
      self_copy.reload unless attempts == options[:max_attempts]
      :retry
    end
  end
  Aws::Waiters::Waiter.new(options).wait({})
end