MemoryDB / Client / update_user

update_user

MemoryDB.Client.update_user(**kwargs)

Changes user password(s) and/or access string.

See also: AWS API Documentation

Request Syntax

response = client.update_user(
    UserName='string',
    AuthenticationMode={
        'Type': 'password',
        'Passwords': [
            'string',
        ]
    },
    AccessString='string'
)

Parameters:

• UserName (string) –

  [REQUIRED]

  The name of the user

• AuthenticationMode (dict) –

  Denotes the user’s authentication properties, such as whether it requires a password to authenticate.

  • Type (string) –

    Indicates whether the user requires a password to authenticate. All newly-created users require a password.

  • Passwords (list) –

    The password(s) used for authentication

    • (string) –

• AccessString (string) – Access permissions string used for this user.

Return type:

dict

Returns:

Response Syntax

{
    'User': {
        'Name': 'string',
        'Status': 'string',
        'AccessString': 'string',
        'ACLNames': [
            'string',
        ],
        'MinimumEngineVersion': 'string',
        'Authentication': {
            'Type': 'password'|'no-password',
            'PasswordCount': 123
        },
        'ARN': 'string'
    }
}

Response Structure

• (dict) –

  • User (dict) –

    The updated user

    • Name (string) –

      The name of the user

    • Status (string) –

      Indicates the user status. Can be “active”, “modifying” or “deleting”.

    • AccessString (string) –

      Access permissions string used for this user.

    • ACLNames (list) –

      The names of the Access Control Lists to which the user belongs

      • (string) –

    • MinimumEngineVersion (string) –

      The minimum engine version supported for the user

    • Authentication (dict) –

      Denotes whether the user requires a password to authenticate.

      • Type (string) –

        Indicates whether the user requires a password to authenticate.

      • PasswordCount (integer) –

        The number of passwords belonging to the user. The maximum is two.

    • ARN (string) –

      The Amazon Resource Name (ARN) of the user.

Exceptions

• MemoryDB.Client.exceptions.UserNotFoundFault

• MemoryDB.Client.exceptions.InvalidUserStateFault

• MemoryDB.Client.exceptions.InvalidParameterValueException

• MemoryDB.Client.exceptions.InvalidParameterCombinationException