delete_ai_guardrail ¶

delete_ai_guardrail(
    assistant_id: UuidOrArn,
    ai_guardrail_id: UuidOrArnOrEitherWithQualifier,
    *,
    config_overrides: Optional[QConnectClientConfig] = None,
) -> DeleteAIGuardrailResponse

Deletes an Amazon Q in Connect AI Guardrail.

Parameters:

assistant_id (UuidOrArn) –

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
ai_guardrail_id (UuidOrArnOrEitherWithQualifier) –

The identifier of the Amazon Q in Connect AI Guardrail. Can be either the ID or the ARN. URLs cannot contain the ARN.

Raises:

AccessDeniedException –

You do not have sufficient access to perform this action.
ConflictException –

The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
ResourceNotFoundException –

The specified resource does not exist.
ThrottlingException –

The throttling limit has been exceeded.
UnauthorizedException –

You do not have permission to perform this action.
ValidationException –

The input fails to satisfy the constraints specified by a service.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_qconnect/_services/q_connect.py

def delete_ai_guardrail(
    self,
    assistant_id: "capo_qconnect.types.uuid_or_arn.UuidOrArn",
    ai_guardrail_id: "capo_qconnect.types.uuid_or_arn_or_either_with_qualifier.UuidOrArnOrEitherWithQualifier",
    *,
    config_overrides: Optional[QConnectClientConfig] = None,
) -> "capo_qconnect.types.delete_ai_guardrail_response.DeleteAIGuardrailResponse":
    """<p>Deletes an Amazon Q in Connect AI Guardrail.</p>

    Args:
        assistant_id: <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
        ai_guardrail_id: <p>The identifier of the Amazon Q in Connect AI Guardrail. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>

    Raises:
        capo_qconnect.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_qconnect.errors.conflict_exception.ConflictException: <p>The request could not be processed because of conflict in the current state of the resource. For example, if you're using a <code>Create</code> API (such as <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.</p>
        capo_qconnect.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource does not exist.</p>
        capo_qconnect.errors.throttling_exception.ThrottlingException: <p>The throttling limit has been exceeded.</p>
        capo_qconnect.errors.unauthorized_exception.UnauthorizedException: <p>You do not have permission to perform this action.</p>
        capo_qconnect.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by a service.</p>
        capo_qconnect.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_qconnect.types.delete_ai_guardrail_request.DeleteAIGuardrailRequest]",
    ) -> OperationResponse[
        "capo_qconnect.types.delete_ai_guardrail_response.DeleteAIGuardrailResponse"
    ]:
        import capo_qconnect._operations.wisdom_service.delete_ai_guardrail

        output, http_response = (
            capo_qconnect._operations.wisdom_service.delete_ai_guardrail.delete_ai_guardrail(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteAIGuardrail")
    )
    input_: capo_qconnect.types.delete_ai_guardrail_request.DeleteAIGuardrailRequest = {
        "assistant_id": assistant_id,
        "ai_guardrail_id": ai_guardrail_id,
    }

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