GetIndexResponse (p.awso.0.9.1.doc.awso.qbusiness.Awso

Sourcetype nonrec t = {

applicationId : ApplicationId.t option;
(*
The identifier of the Amazon Q Business application associated with the index.
*)
indexId : IndexId.t option;
(*
The identifier of the Amazon Q Business index.
*)
displayName : IndexName.t option;
(*
The name of the Amazon Q Business index.
*)
indexArn : IndexArn.t option;
(*
The Amazon Resource Name (ARN) of the Amazon Q Business index.
*)
status : IndexStatus.t option;
(*
The current status of the index. When the value is ACTIVE, the index is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why.
*)
type_ : IndexType.t option;
(*
The type of index attached to your Amazon Q Business application.
*)
description : Description.t option;
(*
The description for the Amazon Q Business index.
*)
createdAt : Timestamp.t option;
(*
The Unix timestamp when the Amazon Q Business index was created.
*)
updatedAt : Timestamp.t option;
(*
The Unix timestamp when the Amazon Q Business index was last updated.
*)
capacityConfiguration : IndexCapacityConfiguration.t option;
(*
The storage capacity units chosen for your Amazon Q Business index.
*)
documentAttributeConfigurations : DocumentAttributeConfigurations.t option;
(*
Configuration information for document attributes or metadata. Document metadata are fields associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.
*)
error : ErrorDetail.t option;
(*
When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.
*)
indexStatistics : IndexStatistics.t option;
(*
Provides information about the number of documents indexed.
*)

}

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 : 
  ?applicationId:??? ->
  ?indexId:??? ->
  ?displayName:??? ->
  ?indexArn:??? ->
  ?status:??? ->
  ?type_:??? ->
  ?description:??? ->
  ?createdAt:??? ->
  ?updatedAt:??? ->
  ?capacityConfiguration:??? ->
  ?documentAttributeConfigurations:??? ->
  ?error:??? ->
  ?indexStatistics:??? ->
  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
            [> `Structure of
                 (string
                  * [> `Enum of string
                    | `String of DocumentMetadataConfigurationName.t ])
                   list ]
              list
          | `String of ApplicationId.t
          | `Structure of
            (string
             * [> `Enum of string
               | `Integer of IndexCapacityInteger.t
               | `String of ErrorMessage.t
               | `Structure of
                 (string
                  * [> `Integer of IndexedTextDocument.t
                    | `Long of IndexedTextBytes.t ])
                   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