Module Values.CreateIndexRequestSource

Creates an Amazon Q Business index. To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use. Once the index is active, you can index your documents using the BatchPutDocument API or the CreateDataSource API.

Sourcetype nonrec t = {
  1. applicationId : ApplicationId.t;
    (*

    The identifier of the Amazon Q Business application using the index.

    *)
  2. displayName : IndexName.t;
    (*

    A name for the Amazon Q Business index.

    *)
  3. description : Description.t option;
    (*

    A description for the Amazon Q Business index.

    *)
  4. type_ : IndexType.t option;
    (*

    The index type that's suitable for your needs. For more information on what's included in each type of index, see Amazon Q Business tiers.

    *)
  5. tags : Tags.t option;
    (*

    A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

    *)
  6. capacityConfiguration : IndexCapacityConfiguration.t option;
    (*

    The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.

    *)
  7. clientToken : ClientToken.t option;
    (*

    A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex API with the same client token will create only one index.

    *)
}
Sourceval context_ : string
Sourceval make : ?description:??? -> ?type_:??? -> ?tags:??? -> ?capacityConfiguration:??? -> ?clientToken:??? -> applicationId:ApplicationId.t -> displayName:IndexName.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `String of TagKey.t ]) list ] list | `String of ApplicationId.t | `Structure of (string * [> `Integer of IndexCapacityInteger.t ]) list ]) 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