list_indices¶
Operation¶
async
¶
list_indices(input: ListIndicesInput, plugins: list[Plugin] | None = None) -> ListIndicesOutput
Lists the Amazon Q Business indices you have created.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ListIndicesInput
|
An instance of |
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 |
|---|---|
ListIndicesOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for ListIndicesInput structure.
Attributes¶
class-attribute
instance-attribute
¶
application_id: str | None = None
The identifier of the Amazon Q Business application connected to the index.
class-attribute
instance-attribute
¶
max_results: int | None = None
The maximum number of indices to return.
class-attribute
instance-attribute
¶
next_token: str | None = None
If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business indices.
Output¶
dataclass
¶
Dataclass for ListIndicesOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
indices: list[Index] | None = None
An array of information on the items in one or more indexes.
class-attribute
instance-attribute
¶
next_token: str | None = None
If the response is truncated, Amazon Q Business returns this token that you can use in the subsequent request to retrieve the next set of indexes.