DeleteUserGroup - Amazon ElastiCache
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


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

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.


The ID of the user group.

Type: String

Required: Yes

Response Elements

The following elements are returned by the service.


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

Type: String


The current supported value is Redis.

Type: String

Pattern: [a-zA-Z]*


The minimum engine version required, which is Redis 6.0

Type: String


A list of updates being applied to the user group.

Type: UserGroupPendingChanges object


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

Type: Array of strings


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

Type: Array of strings


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

Type: String


The ID of the user group.

Type: String


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

Type: Array of strings

Length Constraints: Minimum length of 1.

Pattern: [a-zA-Z][a-zA-Z0-9\-]*


For information about the errors that are common to all actions, see Common Errors.


The value for a parameter is invalid.

HTTP Status Code: 400


The user group is not in an active state.

HTTP Status Code: 400


The specified service linked role (SLR) was not found.

HTTP Status Code: 400


The user group was not found or does not exist

HTTP Status Code: 404

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: