Skip to content

get_guardrail

get_guardrail(
    guardrail_identifier: GuardrailIdentifier,
    *,
    config_overrides: Optional[BedrockClientConfig] = None,
    guardrail_version: Optional[GuardrailVersion] = None,
) -> GetGuardrailResponse

Gets details about a guardrail. If you don't specify a version, the response returns details for the DRAFT version.

Parameters:

  • guardrail_identifier (GuardrailIdentifier) –

    The unique identifier of the guardrail for which to get details. This can be an ID or the ARN.

  • guardrail_version (Optional[GuardrailVersion], default: None ) –

    The version of the guardrail for which to get details. If you don't specify a version, the response returns details for the DRAFT version.

Raises:

Source code in docs_src/capo_bedrock/_services/bedrock.py
def get_guardrail(
    self,
    guardrail_identifier: "capo_bedrock.types.guardrail_identifier.GuardrailIdentifier",
    *,
    config_overrides: Optional[BedrockClientConfig] = None,
    guardrail_version: Optional[
        "capo_bedrock.types.guardrail_version.GuardrailVersion"
    ] = None,
) -> "capo_bedrock.types.get_guardrail_response.GetGuardrailResponse":
    """<p>Gets details about a guardrail. If you don't specify a version, the response returns details for the <code>DRAFT</code> version.</p>

    Args:
        guardrail_identifier: <p>The unique identifier of the guardrail for which to get details. This can be an ID or the ARN.</p>
        guardrail_version: <p>The version of the guardrail for which to get details. If you don't specify a version, the response returns details for the <code>DRAFT</code> version.</p>

    Raises:
        capo_bedrock.errors.access_denied_exception.AccessDeniedException: <p>The request is denied because of missing access permissions.</p>
        capo_bedrock.errors.internal_server_exception.InternalServerException: <p>An internal server error occurred. Retry your request.</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.get_guardrail_request.GetGuardrailRequest]",
    ) -> OperationResponse[
        "capo_bedrock.types.get_guardrail_response.GetGuardrailResponse"
    ]:
        import capo_bedrock._operations.amazon_bedrock_control_plane_service.get_guardrail

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

    def _redact_output(
        output: "capo_bedrock.types.get_guardrail_response.GetGuardrailResponse",
    ) -> dict[str, Any]:
        import capo_bedrock.types.get_guardrail_response

        return capo_bedrock.types.get_guardrail_response.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("GetGuardrail", redact_output=_redact_output),
    )
    input_: capo_bedrock.types.get_guardrail_request.GetGuardrailRequest = {
        "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