GetGuardrailResponse (u.bd1fbe2ccff02fd1cddfdcb5f1e38e71.awso.0.9.1.doc.awso.bedrock.Awso

Sourcetype nonrec t = {

name : GuardrailName.t option;
(*
The name of the guardrail.
*)
description : GuardrailDescription.t option;
(*
The description of the guardrail.
*)
guardrailId : GuardrailId.t option;
(*
The unique identifier of the guardrail.
*)
guardrailArn : GuardrailArn.t option;
(*
The ARN of the guardrail.
*)
version : GuardrailVersion.t option;
(*
The version of the guardrail.
*)
status : GuardrailStatus.t option;
(*
The status of the guardrail.
*)
topicPolicy : GuardrailTopicPolicy.t option;
(*
The topic policy that was configured for the guardrail.
*)
contentPolicy : GuardrailContentPolicy.t option;
(*
The content policy that was configured for the guardrail.
*)
wordPolicy : GuardrailWordPolicy.t option;
(*
The word policy that was configured for the guardrail.
*)
sensitiveInformationPolicy : GuardrailSensitiveInformationPolicy.t option;
(*
The sensitive information policy that was configured for the guardrail.
*)
contextualGroundingPolicy : GuardrailContextualGroundingPolicy.t option;
(*
The contextual grounding policy used in the guardrail.
*)
automatedReasoningPolicy : GuardrailAutomatedReasoningPolicy.t option;
(*
The current Automated Reasoning policy configuration for the guardrail, if any is configured.
*)
crossRegionDetails : GuardrailCrossRegionDetails.t option;
(*
Details about the system-defined guardrail profile that you're using with your guardrail, including the guardrail profile ID and Amazon Resource Name (ARN).
*)
createdAt : Timestamp.t option;
(*
The date and time at which the guardrail was created.
*)
updatedAt : Timestamp.t option;
(*
The date and time at which the guardrail was updated.
*)
statusReasons : GuardrailStatusReasons.t option;
(*
Appears if the status is FAILED. A list of reasons for why the guardrail failed to be created, updated, versioned, or deleted.
*)
failureRecommendations : GuardrailFailureRecommendations.t option;
(*
Appears if the status of the guardrail is FAILED. A list of recommendations to carry out before retrying the request.
*)
blockedInputMessaging : GuardrailBlockedMessaging.t option;
(*
The message that the guardrail returns when it blocks a prompt.
*)
blockedOutputsMessaging : GuardrailBlockedMessaging.t option;
(*
The message that the guardrail returns when it blocks a model response.
*)
kmsKeyArn : KmsKeyArn.t option;
(*
The ARN of the KMS key that encrypts the guardrail.
*)

}

Sourcetype nonrec error = [

| `AccessDeniedException of AccessDeniedException.t
| `InternalServerException of InternalServerException.t
| `ResourceNotFoundException of ResourceNotFoundException.t
| `ThrottlingException of ThrottlingException.t
| `ValidationException of ValidationException.t
| `Unknown_operation_error of string * string option

]

val make : 
  ?name:??? ->
  ?description:??? ->
  ?guardrailId:??? ->
  ?guardrailArn:??? ->
  ?version:??? ->
  ?status:??? ->
  ?topicPolicy:??? ->
  ?contentPolicy:??? ->
  ?wordPolicy:??? ->
  ?sensitiveInformationPolicy:??? ->
  ?contextualGroundingPolicy:??? ->
  ?automatedReasoningPolicy:??? ->
  ?crossRegionDetails:??? ->
  ?createdAt:??? ->
  ?updatedAt:??? ->
  ?statusReasons:??? ->
  ?failureRecommendations:??? ->
  ?blockedInputMessaging:??? ->
  ?blockedOutputsMessaging:??? ->
  ?kmsKeyArn:??? ->
  unit ->
  t

Source

val error_of_json : 
  string ->
  Yojson.Safe.t ->
  [> `AccessDeniedException of AccessDeniedException.t
  | `InternalServerException of InternalServerException.t
  | `ResourceNotFoundException of ResourceNotFoundException.t
  | `ThrottlingException of ThrottlingException.t
  | `Unknown_operation_error of string * string option
  | `ValidationException of ValidationException.t ]

Source

val error_of_xml : 
  string ->
  Awso.Xml.t ->
  [> `AccessDeniedException of AccessDeniedException.t
  | `InternalServerException of InternalServerException.t
  | `ResourceNotFoundException of ResourceNotFoundException.t
  | `ThrottlingException of ThrottlingException.t
  | `Unknown_operation_error of string * string option
  | `ValidationException of ValidationException.t ]

Sourceval error_to_json : error -> Yojson.Safe.t

Source

val to_value : 
  t ->
  [> `Structure of
       (string
        * [> `Enum of string
          | `List of [> `String of GuardrailStatusReason.t ] list
          | `String of GuardrailName.t
          | `Structure of
            (string
             * [> `Double of AutomatedReasoningConfidenceFilterThreshold.t
               | `List of
                 [> `String of AutomatedReasoningPolicyArn.t
                 | `Structure of
                   (string
                    * [> `Boolean of Boolean.t
                      | `Double of
                        GuardrailContextualGroundingFilterThresholdDouble.t
                      | `Enum of string
                      | `List of
                        [> `Enum of string
                        | `String of GuardrailTopicExample.t ]
                          list
                      | `String of GuardrailTopicName.t ])
                     list ]
                   list
               | `String of GuardrailCrossRegionGuardrailProfileId.t
               | `Structure of (string * [> `Enum of string ]) list ])
              list
          | `Timestamp of Timestamp.t ])
         list ]

Sourceval to_query : t -> Awso.Client.Query.t

Sourceval of_xml : Awso.Xml.t -> t

Sourceval of_string : string -> t

Sourceval of_json : Yojson.Safe.t -> t

Sourceval to_json : t -> Yojson.Safe.t