describe_users

describe_users(**kwargs)

Returns a list of users.

See also: AWS API Documentation

Request Syntax

response = client.describe_users(
    UserName='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string'
)
Parameters
  • UserName (string) -- The name of the user
  • Filters (list) --

    Filter to determine the list of users to return.

    • (dict) --

      Used to streamline results of a search based on the property being filtered.

      • Name (string) -- [REQUIRED]

        The property being filtered. For example, UserName.

      • Values (list) -- [REQUIRED]

        The property values to filter on. For example, "user-123".

        • (string) --
  • MaxResults (integer) -- The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
  • NextToken (string) -- An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    • Users (list) --

      A list of users.

      • (dict) --

        You create users and assign them specific permissions by using an access string. You assign the users to Access Control Lists aligned with a specific role (administrators, human resources) that are then deployed to one or more MemoryDB clusters.

        • 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.

    • NextToken (string) --

      An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

Exceptions

  • MemoryDB.Client.exceptions.UserNotFoundFault
  • MemoryDB.Client.exceptions.InvalidParameterCombinationException