IAM / Waiter / UserExists

UserExists#

class IAM.Waiter.UserExists#
waiter = client.get_waiter('user_exists')
wait(**kwargs)#

Polls IAM.Client.get_user() every 1 seconds until a successful state is reached. An error is returned after 20 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    UserName='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)
Parameters:
  • UserName (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: _+=,.@-

  • WaiterConfig (dict) –

    A dictionary that provides parameters to control waiting behavior.

    • Delay (integer) –

      The amount of time in seconds to wait between attempts. Default: 1

    • MaxAttempts (integer) –

      The maximum number of attempts to be made. Default: 20

Returns:

None