delete_user_group¶

delete_user_group(**kwargs)¶

For Redis engine version 6.0 onwards: Deletes a user group. The user group must first be disassociated from the replication group before it can be deleted. For more information, see Using Role Based Access Control (RBAC).

See also: AWS API Documentation

Request Syntax

response = client.delete_user_group(
    UserGroupId='string'
)

Parameters

UserGroupId (string) --

[REQUIRED]

The ID of the user group.

Return type

dict

Returns

Response Syntax

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

Response Structure

(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) --
- ARN (string) --
  The Amazon Resource Name (ARN) of the user group.

Exceptions

ElastiCache.Client.exceptions.UserGroupNotFoundFault
ElastiCache.Client.exceptions.InvalidUserGroupStateFault
ElastiCache.Client.exceptions.ServiceLinkedRoleNotFoundFault
ElastiCache.Client.exceptions.InvalidParameterValueException

Table Of Contents

delete_user_group¶