DescribeFaqResponse (p.awso.0.9.0.doc.awso.kendra.Awso

Sourcetype nonrec t = {

id : FaqId.t option;
(*
The identifier of the FAQ.
*)
indexId : IndexId.t option;
(*
The identifier of the index for the FAQ.
*)
name : FaqName.t option;
(*
The name that you gave the FAQ when it was created.
*)
description : Description.t option;
(*
The description of the FAQ that you provided when it was created.
*)
createdAt : Timestamp.t option;
(*
The Unix timestamp when the FAQ was created.
*)
updatedAt : Timestamp.t option;
(*
The Unix timestamp when the FAQ was last updated.
*)
s3Path : S3Path.t option;
status : FaqStatus.t option;
(*
The status of the FAQ. It is ready to use when the status is ACTIVE.
*)
roleArn : RoleArn.t option;
(*
The Amazon Resource Name (ARN) of the IAM role that provides access to the S3 bucket containing the FAQ file.
*)
errorMessage : ErrorMessage.t option;
(*
If the Status field is FAILED, the ErrorMessage field contains the reason why the FAQ failed.
*)
fileFormat : FaqFileFormat.t option;
(*
The file format used for the FAQ file.
*)
languageCode : LanguageCode.t option;
(*
The code for a language. This shows a supported language for the FAQ document. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.
*)

}

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 : 
  ?id:??? ->
  ?indexId:??? ->
  ?name:??? ->
  ?description:??? ->
  ?createdAt:??? ->
  ?updatedAt:??? ->
  ?s3Path:??? ->
  ?status:??? ->
  ?roleArn:??? ->
  ?errorMessage:??? ->
  ?fileFormat:??? ->
  ?languageCode:??? ->
  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
          | `String of FaqId.t
          | `Structure of (string * [> `String of S3BucketName.t ]) 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