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

Class: Aws::IAM::User

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

Defined Under Namespace

Classes: Collection

Actions collapse

Associations collapse

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, options = {}) ⇒ User #initialize(options = {}) ⇒ User

Returns a new instance of User

Overloads:

  • #initialize(name, options = {}) ⇒ User

    Parameters:

    • name (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ User

    Options Hash (options):

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


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

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

Instance Method Details

#access_key(id) ⇒ AccessKey

Parameters:

  • id (String)

Returns:



614
615
616
617
618
619
620
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 614

def access_key(id)
  AccessKey.new(
    user_name: @name,
    id: id,
    client: @client
  )
end

#access_keys(options = {}) ⇒ AccessKey::Collection

Examples:

Request syntax with placeholder values


user.access_keys()

Parameters:

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

    ({})

Returns:



627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 627

def access_keys(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(user_name: @name)
    resp = @client.list_access_keys(options)
    resp.each_page do |page|
      batch = []
      page.data..each do |a|
        batch << AccessKey.new(
          user_name: @name,
          id: a.access_key_id,
          data: a,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  AccessKey::Collection.new(batches)
end

#add_group(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


user.add_group({
  group_name: "groupNameType", # required
})

Parameters:

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

    ({})

Options Hash (options):

  • :group_name (required, String)

    The name of the group to update.

    This parameter allows (per 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:

  • (EmptyStructure)


290
291
292
293
294
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 290

def add_group(options = {})
  options = options.merge(user_name: @name)
  resp = @client.add_user_to_group(options)
  resp.data
end

#arnString

The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the Using IAM guide.

Returns:

  • (String)


65
66
67
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 65

def arn
  data[:arn]
end

#attach_policy(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


user.attach_policy({
  policy_arn: "arnType", # required
})

Parameters:

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

    ({})

Options Hash (options):

Returns:

  • (EmptyStructure)


312
313
314
315
316
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 312

def attach_policy(options = {})
  options = options.merge(user_name: @name)
  resp = @client.attach_user_policy(options)
  resp.data
end

#attached_policies(options = {}) ⇒ Policy::Collection

Examples:

Request syntax with placeholder values


attached_policies = user.attached_policies({
  path_prefix: "policyPathType",
})

Parameters:

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

    ({})

Options Hash (options):

  • :path_prefix (String)

    The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.

    This paramater allows (per its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\u0021) thru the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

Returns:



669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 669

def attached_policies(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(user_name: @name)
    resp = @client.list_attached_user_policies(options)
    resp.each_page do |page|
      batch = []
      page.data.attached_policies.each do |a|
        batch << Policy.new(
          arn: a.policy_arn,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  Policy::Collection.new(batches)
end

#clientClient

Returns:



112
113
114
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 112

def client
  @client
end

#create(options = {}) ⇒ User

Examples:

Request syntax with placeholder values


user = user.create({
  path: "pathType",
})

Parameters:

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

    ({})

Options Hash (options):

  • :path (String)

    The path for the user name. For more information about paths, see IAM Identifiers in the IAM User Guide.

    This parameter is optional. If it is not included, it defaults to a slash (/).

    This paramater allows (per its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\u0021) thru the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

Returns:



343
344
345
346
347
348
349
350
351
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 343

def create(options = {})
  options = options.merge(user_name: @name)
  resp = @client.create_user(options)
  User.new(
    name: options[:user_name],
    data: resp.data.user,
    client: @client
  )
end

#create_access_key_pair(options = {}) ⇒ AccessKeyPair

Examples:

Request syntax with placeholder values


user.create_access_key_pair()

Parameters:

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

    ({})

Returns:



358
359
360
361
362
363
364
365
366
367
368
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 358

def create_access_key_pair(options = {})
  options = options.merge(user_name: @name)
  resp = @client.create_access_key(options)
  AccessKeyPair.new(
    user_name: @name,
    id: resp.data.access_key.access_key_id,
    secret: resp.data.access_key.secret_access_key,
    data: resp.data.access_key,
    client: @client
  )
end

#create_dateTime

The date and time, in ISO 8601 date-time format, when the user was created.

Returns:

  • (Time)


76
77
78
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 76

def create_date
  data[:create_date]
end

#create_login_profile(options = {}) ⇒ LoginProfile

Examples:

Request syntax with placeholder values


loginprofile = user.({
  password: "passwordType", # required
  password_reset_required: false,
})

Parameters:

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

    ({})

Options Hash (options):

  • :password (required, String)

    The new password for the user.

    The regex pattern used to validate this parameter is a string of characters consisting of almost any printable ASCII character from the space (\u0020) through the end of the ASCII character range (\u00FF). You can also include the tab (\u0009), line feed (\u000A), and carriage return (\u000D) characters. Although any of these characters are valid in a password, note that many tools, such as the AWS Management Console, might restrict the ability to enter certain characters because they have special meaning within that tool.

  • :password_reset_required (Boolean)

    Specifies whether the user is required to set a new password on next sign-in.

Returns:



396
397
398
399
400
401
402
403
404
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 396

def (options = {})
  options = options.merge(user_name: @name)
  resp = @client.(options)
  LoginProfile.new(
    user_name: resp.data..user_name,
    data: resp.data.,
    client: @client
  )
end

#create_policy(options = {}) ⇒ UserPolicy

Examples:

Request syntax with placeholder values


userpolicy = user.create_policy({
  policy_name: "policyNameType", # required
  policy_document: "policyDocumentType", # required
})

Parameters:

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

    ({})

Options Hash (options):

  • :policy_name (required, String)

    The name of the policy document.

    This parameter allows (per 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: =,.@-+

  • :policy_document (required, String)

    The policy document.

    The regex pattern used to validate this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (\u0020) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF). It also includes the special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D).

Returns:



439
440
441
442
443
444
445
446
447
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 439

def create_policy(options = {})
  options = options.merge(user_name: @name)
  resp = @client.put_user_policy(options)
  UserPolicy.new(
    user_name: @name,
    name: options[:policy_name],
    client: @client
  )
end

#dataTypes::User

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

Returns:



132
133
134
135
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 132

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.



140
141
142
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 140

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


user.delete()

Parameters:

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

    ({})

Returns:

  • (EmptyStructure)


454
455
456
457
458
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 454

def delete(options = {})
  options = options.merge(user_name: @name)
  resp = @client.delete_user(options)
  resp.data
end

#detach_policy(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


user.detach_policy({
  policy_arn: "arnType", # required
})

Parameters:

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

    ({})

Options Hash (options):

Returns:

  • (EmptyStructure)


476
477
478
479
480
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 476

def detach_policy(options = {})
  options = options.merge(user_name: @name)
  resp = @client.detach_user_policy(options)
  resp.data
end

#enable_mfa(options = {}) ⇒ MfaDevice

Examples:

Request syntax with placeholder values


mfadevice = user.enable_mfa({
  serial_number: "serialNumberType", # required
  authentication_code_1: "authenticationCodeType", # required
  authentication_code_2: "authenticationCodeType", # required
})

Parameters:

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

    ({})

Options Hash (options):

  • :serial_number (required, String)

    The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.

    This parameter allows (per 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: =,.@:/-

  • :authentication_code_1 (required, String)

    An authentication code emitted by the device.

    The format for this parameter is a string of 6 digits.

    Submit your request immediately after generating the authentication codes. If you generate the codes and then wait too long to submit the request, the MFA device successfully associates with the user but the MFA device becomes out of sync. This happens because time-based one-time passwords (TOTP) expire after a short period of time. If this happens, you can resync the device.

  • :authentication_code_2 (required, String)

    A subsequent authentication code emitted by the device.

    The format for this parameter is a string of 6 digits.

    Submit your request immediately after generating the authentication codes. If you generate the codes and then wait too long to submit the request, the MFA device successfully associates with the user but the MFA device becomes out of sync. This happens because time-based one-time passwords (TOTP) expire after a short period of time. If this happens, you can resync the device.

Returns:



533
534
535
536
537
538
539
540
541
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 533

def enable_mfa(options = {})
  options = options.merge(user_name: @name)
  resp = @client.enable_mfa_device(options)
  MfaDevice.new(
    user_name: @name,
    serial_number: options[:serial_number],
    client: @client
  )
end

#exists?(options = {}) ⇒ Boolean

Returns true if the User exists.

Parameters:

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

    ({})

Returns:

  • (Boolean)

    Returns true if the User exists.



147
148
149
150
151
152
153
154
155
156
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 147

def exists?(options = {})
  begin
    wait_until_exists(options.merge(max_attempts: 1))
    true
  rescue Aws::Waiters::Errors::UnexpectedError => e
    raise e.error
  rescue Aws::Waiters::Errors::WaiterFailed
    false
  end
end

#groups(options = {}) ⇒ Group::Collection

Examples:

Request syntax with placeholder values


user.groups()

Parameters:

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

    ({})

Returns:



692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 692

def groups(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(user_name: @name)
    resp = @client.list_groups_for_user(options)
    resp.each_page do |page|
      batch = []
      page.data.groups.each do |g|
        batch << Group.new(
          name: g.group_name,
          data: g,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  Group::Collection.new(batches)
end

#loadself Also known as: reload

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

user.reload.data

Returns:

  • (self)


122
123
124
125
126
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 122

def load
  resp = @client.get_user(user_name: @name)
  @data = resp.user
  self
end

#login_profileLoginProfile

Returns:



712
713
714
715
716
717
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 712

def 
  LoginProfile.new(
    user_name: @name,
    client: @client
  )
end

#mfa_device(serial_number) ⇒ MfaDevice

Parameters:

  • serial_number (String)

Returns:



721
722
723
724
725
726
727
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 721

def mfa_device(serial_number)
  MfaDevice.new(
    user_name: @name,
    serial_number: serial_number,
    client: @client
  )
end

#mfa_devices(options = {}) ⇒ MfaDevice::Collection

Examples:

Request syntax with placeholder values


user.mfa_devices()

Parameters:

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

    ({})

Returns:



734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 734

def mfa_devices(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(user_name: @name)
    resp = @client.list_mfa_devices(options)
    resp.each_page do |page|
      batch = []
      page.data.mfa_devices.each do |m|
        batch << MfaDevice.new(
          user_name: @name,
          serial_number: m.serial_number,
          data: m,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  MfaDevice::Collection.new(batches)
end

#nameString Also known as: user_name

Returns:

  • (String)


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

def name
  @name
end

#password_last_usedTime

The date and time, in ISO 8601 date-time format, when the user's password was last used to sign in to an AWS website. For a list of AWS websites that capture a user's last sign-in time, see the Credential Reports topic in the Using IAM guide. If a password is used more than once in a five-minute span, only the first use is returned in this field. If the field is null (no value) then it indicates that they never signed in with a password. This can be because:

  • The user never had a password.

  • A password exists but has not been used since IAM started tracking this information on October 20th, 2014.

A null does not mean that the user never had a password. Also, if the user does not currently have a password, but had one in the past, then this field contains the date and time the most recent password was used.

This value is returned only in the GetUser and ListUsers actions.

Returns:

  • (Time)


105
106
107
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 105

def password_last_used
  data[:password_last_used]
end

#pathString

The path to the user. For more information about paths, see IAM Identifiers in the Using IAM guide.

Returns:

  • (String)


41
42
43
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 41

def path
  data[:path]
end

#policies(options = {}) ⇒ UserPolicy::Collection

Examples:

Request syntax with placeholder values


user.policies()

Parameters:

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

    ({})

Returns:



759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 759

def policies(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(user_name: @name)
    resp = @client.list_user_policies(options)
    resp.each_page do |page|
      batch = []
      page.data.policy_names.each do |p|
        batch << UserPolicy.new(
          user_name: @name,
          name: p,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  UserPolicy::Collection.new(batches)
end

#policy(name) ⇒ UserPolicy

Parameters:

  • name (String)

Returns:



780
781
782
783
784
785
786
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 780

def policy(name)
  UserPolicy.new(
    user_name: @name,
    name: name,
    client: @client
  )
end

#remove_group(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


user.remove_group({
  group_name: "groupNameType", # required
})

Parameters:

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

    ({})

Options Hash (options):

  • :group_name (required, String)

    The name of the group to update.

    This parameter allows (per 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:

  • (EmptyStructure)


561
562
563
564
565
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 561

def remove_group(options = {})
  options = options.merge(user_name: @name)
  resp = @client.remove_user_from_group(options)
  resp.data
end

#signing_certificate(id) ⇒ SigningCertificate

Parameters:

  • id (String)

Returns:



790
791
792
793
794
795
796
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 790

def signing_certificate(id)
  SigningCertificate.new(
    user_name: @name,
    id: id,
    client: @client
  )
end

#signing_certificates(options = {}) ⇒ SigningCertificate::Collection

Examples:

Request syntax with placeholder values


user.signing_certificates()

Parameters:

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

    ({})

Returns:



803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 803

def signing_certificates(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(user_name: @name)
    resp = @client.list_signing_certificates(options)
    resp.each_page do |page|
      batch = []
      page.data.certificates.each do |c|
        batch << SigningCertificate.new(
          user_name: @name,
          id: c.certificate_id,
          data: c,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  SigningCertificate::Collection.new(batches)
end

#update(options = {}) ⇒ User

Examples:

Request syntax with placeholder values


user = user.update({
  new_path: "pathType",
  new_user_name: "userNameType",
})

Parameters:

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

    ({})

Options Hash (options):

  • :new_path (String)

    New path for the IAM user. Include this parameter only if you're changing the user's path.

    This paramater allows (per its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\u0021) thru the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

  • :new_user_name (String)

    New name for the user. Include this parameter only if you're changing the user's name.

    This parameter allows (per 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:



601
602
603
604
605
606
607
608
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 601

def update(options = {})
  options = options.merge(user_name: @name)
  resp = @client.update_user(options)
  User.new(
    name: options[:new_user_name],
    client: @client
  )
end

#user_idString

The stable and unique string identifying the user. For more information about IDs, see IAM Identifiers in the Using IAM guide.

Returns:

  • (String)


53
54
55
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 53

def user_id
  data[:user_id]
end

#wait_until(options = {}, &block) ⇒ 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) {|instance| instance.state.name == 'running' }

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

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



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 253

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

#wait_until_exists(options = {}) ⇒ User

Parameters:

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

    ({})

Options Hash (options):

  • :max_attempts (Integer) — default: 20
  • :delay (Float) — default: 1
  • :before_attempt (Proc)
  • :before_wait (Proc)

Returns:



164
165
166
167
168
169
170
171
172
173
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 164

def wait_until_exists(options = {})
  options, params = separate_params_and_options(options)
  waiter = Waiters::UserExists.new(options)
  yield_waiter_and_warn(waiter, &Proc.new) if block_given?
  waiter.wait(params.merge(user_name: @name))
  User.new({
    name: @name,
    client: @client
  })
end