Class: Aws::IAM::AccountSummary

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

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ AccountSummary

Returns a new instance of AccountSummary.

Options Hash (options):



18
19
20
21
22
23
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/account_summary.rb', line 18

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

Instance Method Details

#client ⇒ Client

Returns:



37
38
39
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/account_summary.rb', line 37

def client
  @client
end

#data ⇒ Types::GetAccountSummaryResponse

Returns the data for this Aws::IAM::AccountSummary. Calls Client#get_account_summary if #data_loaded? is false.

Returns:



59
60
61
62
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/account_summary.rb', line 59

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.



67
68
69
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/account_summary.rb', line 67

def data_loaded?
  !!@data
end

#load ⇒ self Also known as: reload

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

.reload.data

Returns:

  • (self) 


47
48
49
50
51
52
53
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/account_summary.rb', line 47

def load
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.
  end
  @data = resp.data
  self
end

#summary_map ⇒ Hash<String,Integer>

A set of key–value pairs containing information about IAM entity usage and IAM quotas.

Returns:

  • (Hash<String,Integer>) 


30
31
32
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/account_summary.rb', line 30

def summary_map
  data[:summary_map]
end

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

Deprecated.

Use [Aws::IAM::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



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/account_summary.rb', line 151

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::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    Aws::Waiters::Waiter.new(options).wait({})
  end
end