ElastiCache / Client / modify_user_group
modify_user_group#
- ElastiCache.Client.modify_user_group(**kwargs)#
Changes the list of users that belong to the user group.
See also: AWS API Documentation
Request Syntax
response = client.modify_user_group( UserGroupId='string', UserIdsToAdd=[ 'string', ], UserIdsToRemove=[ 'string', ] )
- Parameters:
UserGroupId (string) –
[REQUIRED]
The ID of the user group.
UserIdsToAdd (list) –
The list of user IDs to add to the user group.
(string) –
UserIdsToRemove (list) –
The list of user IDs to remove from the user group.
(string) –
- Return type:
dict
- Returns:
Response Syntax
{ 'UserGroupId': 'string', 'Status': 'string', 'Engine': 'string', 'UserIds': [ 'string', ], 'MinimumEngineVersion': 'string', 'PendingChanges': { 'UserIdsToRemove': [ 'string', ], 'UserIdsToAdd': [ 'string', ] }, 'ReplicationGroups': [ 'string', ], 'ServerlessCaches': [ '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) –
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.
Exceptions
ElastiCache.Client.exceptions.UserGroupNotFoundFault
ElastiCache.Client.exceptions.UserNotFoundFault
ElastiCache.Client.exceptions.DuplicateUserNameFault
ElastiCache.Client.exceptions.ServiceLinkedRoleNotFoundFault
ElastiCache.Client.exceptions.DefaultUserRequired
ElastiCache.Client.exceptions.InvalidUserGroupStateFault
ElastiCache.Client.exceptions.InvalidParameterValueException
ElastiCache.Client.exceptions.InvalidParameterCombinationException