Skip to content

delete_index

Operation

delete_index

delete_index(request: DeleteIndexInput | DeleteIndexInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteIndexInputDict]) -> DeleteIndexOutput

Deletes an Amazon Q Business index.

Parameters:

Name Type Description Default
request DeleteIndexInput | DeleteIndexInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[DeleteIndexInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteIndexOutput

An instance of DeleteIndexOutput.

delete_index async

delete_index(request: DeleteIndexInput | DeleteIndexInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteIndexInputDict]) -> DeleteIndexOutput

Deletes an Amazon Q Business index.

Parameters:

Name Type Description Default
request DeleteIndexInput | DeleteIndexInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[DeleteIndexInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteIndexOutput

An instance of DeleteIndexOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

DeleteIndexInputDict

Bases: TypedDict

Dictionary form of DeleteIndexInput.

Attributes

application_id instance-attribute
application_id: Required[str]

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

index_id instance-attribute
index_id: Required[str]

The identifier of the Amazon Q Business index.

DeleteIndexInput dataclass

Bases: _SerdeShape

Dataclass for DeleteIndexInput structure.

Attributes

application_id class-attribute instance-attribute
application_id: str | 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 = ...

The identifier of the Amazon Q Business index.

Output

DeleteIndexOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteIndexOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.