DescribeFeaturedResultsSetResponse (p.awso.0.9.1.doc.awso.kendra.Awso_kendra.Values.DescribeFeaturedResultsSetResponse)

Sourcetype nonrec t = {

featuredResultsSetId : FeaturedResultsSetId.t option;
(*
The identifier of the set of featured results.
*)
featuredResultsSetName : FeaturedResultsSetName.t option;
(*
The name for the set of featured results.
*)
description : FeaturedResultsSetDescription.t option;
(*
The description for the set of featured results.
*)
status : FeaturedResultsSetStatus.t option;
(*
The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use. You can still configure your settings before setting the status to ACTIVE. You can set the status to ACTIVE or INACTIVE using the UpdateFeaturedResultsSet API. The queries you specify for featured results must be unique per featured results set for each index, whether the status is ACTIVE or INACTIVE.
*)
queryTexts : QueryTextList.t option;
(*
The list of queries for featuring results. For more information on the list of queries, see FeaturedResultsSet.
*)
featuredDocumentsWithMetadata : FeaturedDocumentWithMetadataList.t option;
(*
The list of document IDs for the documents you want to feature with their metadata information. For more information on the list of featured documents, see FeaturedResultsSet.
*)
featuredDocumentsMissing : FeaturedDocumentMissingList.t option;
(*
The list of document IDs that don't exist but you have specified as featured documents. Amazon Kendra cannot feature these documents if they don't exist in the index. You can check the status of a document and its ID or check for documents with status errors using the BatchGetDocumentStatus API.
*)
lastUpdatedTimestamp : Long.t option;
(*
The timestamp when the set of featured results was last updated.
*)
creationTimestamp : Long.t option;
(*
The Unix timestamp when the set of the featured results was created.
*)

}

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 : 
  ?featuredResultsSetId:??? ->
  ?featuredResultsSetName:??? ->
  ?description:??? ->
  ?status:??? ->
  ?queryTexts:??? ->
  ?featuredDocumentsWithMetadata:??? ->
  ?featuredDocumentsMissing:??? ->
  ?lastUpdatedTimestamp:??? ->
  ?creationTimestamp:??? ->
  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 QueryText.t
            | `Structure of (string * [> `String of DocumentId.t ]) list ]
              list
          | `Long of Long.t
          | `String of FeaturedResultsSetId.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