ElastiCache / Client / describe_user_groups

describe_user_groups

ElastiCache.Client.describe_user_groups(**kwargs)

Returns a list of user groups.

See also: AWS API Documentation

Request Syntax

response = client.describe_user_groups(
    UserGroupId='string',
    MaxRecords=123,
    Marker='string'
)

Parameters:

• UserGroupId (string) – The ID of the user group.

• 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

{
    'UserGroups': [
        {
            'UserGroupId': 'string',
            'Status': 'string',
            'Engine': 'string',
            'UserIds': [
                'string',
            ],
            'MinimumEngineVersion': 'string',
            'PendingChanges': {
                'UserIdsToRemove': [
                    'string',
                ],
                'UserIdsToAdd': [
                    'string',
                ]
            },
            'ReplicationGroups': [
                'string',
            ],
            'ServerlessCaches': [
                'string',
            ],
            'ARN': 'string'
        },
    ],
    'Marker': 'string'
}

Response Structure

• (dict) –

  • UserGroups (list) –

    Returns a list of user groups.

    • (dict) –

      • UserGroupId (string) –

        The ID of the user group.

      • Status (string) –

        Indicates user group status. Can be “creating”, “active”, “modifying”, “deleting”.

      • Engine (string) –

        The current supported value is Redis.

      • UserIds (list) –

        The list of user IDs that belong to the user group.

        • (string) –

      • MinimumEngineVersion (string) –

        The minimum engine version required, which is Redis 6.0

      • PendingChanges (dict) –

        A list of updates being applied to the user group.

        • UserIdsToRemove (list) –

          The list of user IDs to remove.

          • (string) –

        • UserIdsToAdd (list) –

          The list of user IDs to add.

          • (string) –

      • ReplicationGroups (list) –

        A list of replication groups that the user group can access.

        • (string) –

      • ServerlessCaches (list) –

        Indicates which serverless caches the specified user group is associated with. Available for Redis only.

        • (string) –

      • ARN (string) –

        The Amazon Resource Name (ARN) of the user group.

  • 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

• ElastiCache.Client.exceptions.UserGroupNotFoundFault

• ElastiCache.Client.exceptions.ServiceLinkedRoleNotFoundFault

• ElastiCache.Client.exceptions.InvalidParameterCombinationException