You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::IAM::Waiters::UserExists

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

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ UserExists

Returns a new instance of UserExists

Parameters:

  • options (Hash)

Options Hash (options):

  • :client (required, Client)
  • :max_attempts (Integer) — default: 20
  • :delay (Integer) — default: 1
  • :before_attempt (Proc)
  • :before_wait (Proc)


147
148
149
150
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/waiters.rb', line 147

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 20,
    delay: 1,
    poller: Aws::Waiters::Poller.new(
      operation_name: :get_user,
      acceptors: [
        {
          "state" => "success",
          "matcher" => "status",
          "expected" => 200
        },
        {
          "state" => "retry",
          "matcher" => "error",
          "expected" => "NoSuchEntity"
        }
      ]
    )
  }.merge(options))
end

Instance Method Details

#wait(params = {}) ⇒ Types::GetUserResponse

Returns a response object which responds to the following methods:

Parameters:

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

    a customizable set of options

Options Hash (params):

  • :user_name (String)

    The name of the user to get information about.

    This parameter is optional. If it is not included, it defaults to the user making the request. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

Returns:



172
173
174
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/waiters.rb', line 172

def wait(params = {})
  @waiter.wait(client: @client, params: params)
end