delete_guardrail ¶

delete_guardrail(
    guardrail_identifier: GuardrailIdentifier,
    *,
    config_overrides: Optional[BedrockClientConfig] = None,
    guardrail_version: Optional[GuardrailNumericalVersion] = None,
) -> DeleteGuardrailResponse

Deletes a guardrail.

To delete a guardrail, only specify the ARN of the guardrail in the guardrailIdentifier field. If you delete a guardrail, all of its versions will be deleted.
To delete a version of a guardrail, specify the ARN of the guardrail in the guardrailIdentifier field and the version in the guardrailVersion field.

Parameters:

guardrail_identifier (GuardrailIdentifier) –

The unique identifier of the guardrail. This can be an ID or the ARN.
guardrail_version (Optional[GuardrailNumericalVersion], default: None ) –

The version of the guardrail.

Raises:

AccessDeniedException –

The request is denied because of missing access permissions.
ConflictException –

Error occurred because of a conflict while performing an operation.
InternalServerException –

An internal server error occurred. Retry your request.
ResourceInUseException –

Thrown when attempting to delete or modify a resource that is currently being used by other resources or operations. For example, trying to delete an Automated Reasoning policy that is referenced by an active guardrail.
ResourceNotFoundException –

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
ThrottlingException –

The number of requests exceeds the limit. Resubmit your request later.
ValidationException –

Input validation failed. Check your request parameters and retry the request.
UnknownServiceError –

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

Source code in docs_src/capo_bedrock/_services/bedrock.py

def delete_guardrail(
    self,
    guardrail_identifier: "capo_bedrock.types.guardrail_identifier.GuardrailIdentifier",
    *,
    config_overrides: Optional[BedrockClientConfig] = None,
    guardrail_version: Optional[
        "capo_bedrock.types.guardrail_numerical_version.GuardrailNumericalVersion"
    ] = None,
) -> "capo_bedrock.types.delete_guardrail_response.DeleteGuardrailResponse":
    """<p>Deletes a guardrail.</p> <ul> <li> <p>To delete a guardrail, only specify the ARN of the guardrail in the <code>guardrailIdentifier</code> field. If you delete a guardrail, all of its versions will be deleted.</p> </li> <li> <p>To delete a version of a guardrail, specify the ARN of the guardrail in the <code>guardrailIdentifier</code> field and the version in the <code>guardrailVersion</code> field.</p> </li> </ul>

    Args:
        guardrail_identifier: <p>The unique identifier of the guardrail. This can be an ID or the ARN.</p>
        guardrail_version: <p>The version of the guardrail.</p>

    Raises:
        capo_bedrock.errors.access_denied_exception.AccessDeniedException: <p>The request is denied because of missing access permissions.</p>
        capo_bedrock.errors.conflict_exception.ConflictException: <p>Error occurred because of a conflict while performing an operation.</p>
        capo_bedrock.errors.internal_server_exception.InternalServerException: <p>An internal server error occurred. Retry your request.</p>
        capo_bedrock.errors.resource_in_use_exception.ResourceInUseException: <p>Thrown when attempting to delete or modify a resource that is currently being used by other resources or operations. For example, trying to delete an Automated Reasoning policy that is referenced by an active guardrail.</p>
        capo_bedrock.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
        capo_bedrock.errors.throttling_exception.ThrottlingException: <p>The number of requests exceeds the limit. Resubmit your request later.</p>
        capo_bedrock.errors.validation_exception.ValidationException: <p>Input validation failed. Check your request parameters and retry the request.</p>
        capo_bedrock.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_bedrock.types.delete_guardrail_request.DeleteGuardrailRequest]",
    ) -> OperationResponse[
        "capo_bedrock.types.delete_guardrail_response.DeleteGuardrailResponse"
    ]:
        import capo_bedrock._operations.amazon_bedrock_control_plane_service.delete_guardrail

        output, http_response = (
            capo_bedrock._operations.amazon_bedrock_control_plane_service.delete_guardrail.delete_guardrail(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteGuardrail")
    )
    input_: capo_bedrock.types.delete_guardrail_request.DeleteGuardrailRequest = {
        "guardrail_identifier": guardrail_identifier
    }
    if guardrail_version is not None:
        input_["guardrail_version"] = guardrail_version

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