ElastiCache / Client / describe_users

describe_users#

ElastiCache.Client.describe_users(**kwargs)#

Returns a list of users.

See also: AWS API Documentation

Request Syntax

response = client.describe_users(
    Engine='string',
    UserId='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string'
)
Parameters:

  • Engine (string) – The Redis engine.

  • UserId (string) – The ID of the user.

  • Filters (list) –

    Filter to determine the list of User IDs 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, UserId.

      • Values (list) – [REQUIRED]

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

        • (string) –

  • MaxRecords (integer) – The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

  • Marker (string) – An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >

Return type:

dict

Returns:

Response Syntax

{
    'Users': [
        {
            'UserId': 'string',
            'UserName': 'string',
            'Status': 'string',
            'Engine': 'string',
            'MinimumEngineVersion': 'string',
            'AccessString': 'string',
            'UserGroupIds': [
                'string',
            ],
            'Authentication': {
                'Type': 'password'|'no-password'|'iam',
                'PasswordCount': 123
            },
            'ARN': 'string'
        },
    ],
    'Marker': 'string'
}

Response Structure

  • (dict) –

    • Users (list) –

      A list of users.

      • (dict) –

        • UserId (string) –

          The ID of the user.

        • UserName (string) –

          The username of the user.

        • Status (string) –

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

        • Engine (string) –

          The current supported value is Redis.

        • MinimumEngineVersion (string) –

          The minimum engine version required, which is Redis 6.0

        • AccessString (string) –

          Access permissions string used for this user.

        • UserGroupIds (list) –

          Returns a list of the user group IDs the user belongs to.

          • (string) –

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

    • Marker (string) –

      An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >

Exceptions