For Valkey engine version 7.2 onwards and Redis OSS 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).
Parameters:
-
user_group_id
(Optional[String], default:
None
)
–
The ID of the user group.
Raises:
Source code in docs_src/capo_elasticache/_services/elasti_cache.py
| def delete_user_group(
self,
*,
config_overrides: Optional[ElastiCacheClientConfig] = None,
user_group_id: Optional["capo_elasticache.types.string.String"] = None,
) -> "capo_elasticache.types.user_group.UserGroup":
"""<p>For Valkey engine version 7.2 onwards and Redis OSS 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 <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/dg/Clusters.RBAC.html">Using Role Based Access Control (RBAC)</a>. </p>
Args:
user_group_id: <p>The ID of the user group.</p>
Raises:
capo_elasticache.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>The value for a parameter is invalid.</p>
capo_elasticache.errors.invalid_user_group_state_fault.InvalidUserGroupStateFault: <p>The user group is not in an active state.</p>
capo_elasticache.errors.service_linked_role_not_found_fault.ServiceLinkedRoleNotFoundFault: <p>The specified service linked role (SLR) was not found.</p>
capo_elasticache.errors.user_group_not_found_fault.UserGroupNotFoundFault: <p>The user group was not found or does not exist</p>
capo_elasticache.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_elasticache.types.delete_user_group_message.DeleteUserGroupMessage]",
) -> OperationResponse["capo_elasticache.types.user_group.UserGroup"]:
import capo_elasticache._operations.amazon_elasti_cache_v9.delete_user_group
output, http_response = (
capo_elasticache._operations.amazon_elasti_cache_v9.delete_user_group.delete_user_group(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DeleteUserGroup")
)
input_: capo_elasticache.types.delete_user_group_message.DeleteUserGroupMessage = {}
if user_group_id is not None:
input_["user_group_id"] = user_group_id
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|