Qbusiness  >  Operations  >  delete_index

delete_index

Operation

delete_index async

delete_index(input: DeleteIndexInput, plugins: list[Plugin] | None = None) -> DeleteIndexOutput

Deletes an Amazon Q Business index.

Parameters:

Name	Type	Description	Default
input	DeleteIndexInput	An instance of DeleteIndexInput.	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
DeleteIndexOutput	An instance of DeleteIndexOutput.

Input

DeleteIndexInput dataclass

Dataclass for DeleteIndexInput structure.

Attributes

application_id class-attribute instance-attribute

application_id: str | None = None

The identifier of the Amazon Q Business application the Amazon Q Business index is linked to.

index_id class-attribute instance-attribute

index_id: str | None = None

The identifier of the Amazon Q Business index.

Output

DeleteIndexOutput dataclass

Dataclass for DeleteIndexOutput structure.