Class: Aws::IAM::User

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

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions collapse

Associations 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 '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:



667
668
669
670
671
672
673
 
# File 'lib/aws-sdk-iam/user.rb', line 667

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:



680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
 
# File 'lib/aws-sdk-iam/user.rb', line 680

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.access_key_metadata.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 (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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

Returns:

  • (EmptyStructure) 


314
315
316
317
318
 
# File 'lib/aws-sdk-iam/user.rb', line 314

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

#arn ⇒ String

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.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html

Returns:

  • (String) 


65
66
67
 
# File '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) 


336
337
338
339
340
 
# File 'lib/aws-sdk-iam/user.rb', line 336

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 parameter allows (through 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. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

    [1]: wikipedia.org/wiki/regex

Returns:



722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
 
# File 'lib/aws-sdk-iam/user.rb', line 722

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

#client ⇒ Client

Returns:



136
137
138
 
# File 'lib/aws-sdk-iam/user.rb', line 136

def client
  @client
end

#create(options = {}) ⇒ User

Examples:

Request syntax with placeholder values


user = user.create({
  path: "pathType",
  permissions_boundary: "arnType",
  tags: [
    {
      key: "tagKeyType", # required
      value: "tagValueType", # required
    },
  ],
})

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 parameter allows (through 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. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

    [1]: docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html [2]: wikipedia.org/wiki/regex

  • :permissions_boundary (String) —

    The ARN of the policy that is used to set the permissions boundary for the user.

  • :tags (Array<Types::Tag>) —

    A list of tags that you want to attach to the newly created user. Each tag consists of a key name and an associated value. For more information about tagging, see [Tagging IAM Identities] in the *IAM User Guide*.

    <note markdown=“1”> If any one of the tags is invalid or if you exceed the allowed number of tags per user, then the entire request fails and the user is not created.

    </note>

    [1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html

Returns:



392
393
394
395
396
397
398
399
400
 
# File 'lib/aws-sdk-iam/user.rb', line 392

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:



407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/aws-sdk-iam/user.rb', line 407

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_date ⇒ Time

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

[1]: www.iso.org/iso/iso8601

Returns:

  • (Time) 


76
77
78
 
# File '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] that is used to validate this parameter is a string of characters. That string can include 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. Any of these characters are valid in a password. However, many tools, such as the AWS Management Console, might restrict the ability to type certain characters because they have special meaning within that tool.

    [1]: wikipedia.org/wiki/regex

  • :password_reset_required (Boolean) —

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

Returns:



445
446
447
448
449
450
451
452
453
 
# File 'lib/aws-sdk-iam/user.rb', line 445

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 (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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :policy_document (required, String) —

    The policy document.

    The [regex pattern] used to validate this parameter is a string of characters consisting of the following:

    • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range

    • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

    • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)

    [1]: wikipedia.org/wiki/regex

Returns:



492
493
494
495
496
497
498
499
500
 
# File 'lib/aws-sdk-iam/user.rb', line 492

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

#data ⇒ Types::User

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

Returns:



156
157
158
159
 
# File 'lib/aws-sdk-iam/user.rb', line 156

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.



164
165
166
 
# File 'lib/aws-sdk-iam/user.rb', line 164

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


user.delete()

Parameters:

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

    ({})

Returns:

  • (EmptyStructure) 


507
508
509
510
511
 
# File 'lib/aws-sdk-iam/user.rb', line 507

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) 


529
530
531
532
533
 
# File 'lib/aws-sdk-iam/user.rb', line 529

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 (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:

    ,.@:/-

    [1]: wikipedia.org/wiki/regex

  • :authentication_code_1 (required, String) —

    An authentication code emitted by the device.

    The format for this parameter is a string of six 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].

    [1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa_sync.html

  • :authentication_code_2 (required, String) —

    A subsequent authentication code emitted by the device.

    The format for this parameter is a string of six 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].

    [1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa_sync.html

Returns:



586
587
588
589
590
591
592
593
594
 
# File 'lib/aws-sdk-iam/user.rb', line 586

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.



171
172
173
174
175
176
177
178
179
180
 
# File 'lib/aws-sdk-iam/user.rb', line 171

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:



745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
 
# File 'lib/aws-sdk-iam/user.rb', line 745

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

#identifiers ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


878
879
880
 
# File 'lib/aws-sdk-iam/user.rb', line 878

def identifiers
  { name: @name }
end

#load ⇒ self 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) 


146
147
148
149
150
 
# File 'lib/aws-sdk-iam/user.rb', line 146

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

#login_profile ⇒ LoginProfile

Returns:



765
766
767
768
769
770
 
# File 'lib/aws-sdk-iam/user.rb', line 765

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

#mfa_device(serial_number) ⇒ MfaDevice

Parameters:

  • serial_number (String)

Returns:



774
775
776
777
778
779
780
 
# File 'lib/aws-sdk-iam/user.rb', line 774

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:



787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
 
# File 'lib/aws-sdk-iam/user.rb', line 787

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

#name ⇒ String Also known as: user_name

Returns:

  • (String) 


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

def name
  @name
end

#password_last_used ⇒ Time

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 20, 2014.

A null valuedoes 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 operations.

[1]: www.iso.org/iso/iso8601 [2]: docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html

Returns:

  • (Time) 


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

def password_last_used
  data[:password_last_used]
end

#path ⇒ String

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

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html

Returns:

  • (String) 


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

def path
  data[:path]
end

#permissions_boundary ⇒ Types::AttachedPermissionsBoundary

The ARN of the policy used to set the permissions boundary for the user.

For more information about permissions boundaries, see [Permissions Boundaries for IAM Identities ](IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*.

Returns:



117
118
119
 
# File 'lib/aws-sdk-iam/user.rb', line 117

def permissions_boundary
  data[:permissions_boundary]
end

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

Examples:

Request syntax with placeholder values


user.policies()

Parameters:

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

    ({})

Returns:



812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
 
# File 'lib/aws-sdk-iam/user.rb', line 812

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:



833
834
835
836
837
838
839
 
# File 'lib/aws-sdk-iam/user.rb', line 833

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 (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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

Returns:

  • (EmptyStructure) 


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

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:



843
844
845
846
847
848
849
 
# File 'lib/aws-sdk-iam/user.rb', line 843

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:



856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
 
# File 'lib/aws-sdk-iam/user.rb', line 856

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

#tags ⇒ Array<Types::Tag>

A list of tags that are associated with the specified user. For more information about tagging, see [Tagging IAM Identities] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html

Returns:



129
130
131
 
# File 'lib/aws-sdk-iam/user.rb', line 129

def tags
  data[:tags]
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 parameter allows (through 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. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

    [1]: wikipedia.org/wiki/regex

  • :new_user_name (String) —

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

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

Returns:



654
655
656
657
658
659
660
661
 
# File 'lib/aws-sdk-iam/user.rb', line 654

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_id ⇒ String

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

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html

Returns:

  • (String) 


53
54
55
 
# File '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



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/aws-sdk-iam/user.rb', line 277

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:



188
189
190
191
192
193
194
195
196
197
 
# File 'lib/aws-sdk-iam/user.rb', line 188

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