Qbusiness  >  Operations  >  create_index

create_index

Operation

create_index async

create_index(input: CreateIndexInput, plugins: list[Plugin] | None = None) -> CreateIndexOutput

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.

Parameters:

Name	Type	Description	Default
input	CreateIndexInput	An instance of CreateIndexInput.	required
plugins	list[Plugin] | None	A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.	None

Returns:

Type	Description
CreateIndexOutput	An instance of CreateIndexOutput.

Input

CreateIndexInput dataclass

Dataclass for CreateIndexInput structure.

Attributes

application_id class-attribute instance-attribute

application_id: str | None = None

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

capacity_configuration class-attribute instance-attribute

capacity_configuration: IndexCapacityConfiguration | None = None

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

client_token class-attribute instance-attribute

client_token: str | None = None

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.

description class-attribute instance-attribute

description: str | None = None

A description for the Amazon Q Business index.

display_name class-attribute instance-attribute

display_name: str | None = None

A name for the Amazon Q Business index.

tags class-attribute instance-attribute

tags: list[Tag] | None = None

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: _ . : / = + - @.

type class-attribute instance-attribute

type: IndexType | None = None

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.

Output

CreateIndexOutput dataclass

Dataclass for CreateIndexOutput structure.

Attributes

index_arn class-attribute instance-attribute

index_arn: str | None = None

The Amazon Resource Name (ARN) of an Amazon Q Business index.

index_id class-attribute instance-attribute

index_id: str | None = None

The identifier for the Amazon Q Business index.