delete_user ¶

def delete_user(
    self,
    *,
    config_overrides: Optional[ElastiCacheClientConfig] = None,
    user_id: Optional["capo_elasticache.types.user_id.UserId"] = None,
) -> "capo_elasticache.types.user.User":
    """<p>For Valkey engine version 7.2 onwards and Redis OSS 6.0 onwards: Deletes a user. The user will be removed from all user groups and in turn removed from all replication groups. 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_id: <p>The ID of the user.</p>

    Raises:
        capo_elasticache.errors.default_user_associated_to_user_group_fault.DefaultUserAssociatedToUserGroupFault: <p>The default user assigned to the user group.</p>
        capo_elasticache.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>The value for a parameter is invalid.</p>
        capo_elasticache.errors.invalid_user_state_fault.InvalidUserStateFault: <p>The user is not in 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_not_found_fault.UserNotFoundFault: <p>The user does not exist or could not be found.</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_message.DeleteUserMessage]",
    ) -> OperationResponse["capo_elasticache.types.user.User"]:
        import capo_elasticache._operations.amazon_elasti_cache_v9.delete_user

        output, http_response = (
            capo_elasticache._operations.amazon_elasti_cache_v9.delete_user.delete_user(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteUser")
    )
    input_: capo_elasticache.types.delete_user_message.DeleteUserMessage = {}
    if user_id is not None:
        input_["user_id"] = user_id

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output