list_indices¶
Operation¶
list_indices
¶
list_indices(request: ListIndicesInput | ListIndicesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListIndicesInputDict]) -> ListIndicesOutput
Lists the Amazon Q Business indices you have created.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListIndicesInput | ListIndicesInputDict | 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[ListIndicesInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListIndicesOutput
|
An instance of |
list_indices
async
¶
list_indices(request: ListIndicesInput | ListIndicesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListIndicesInputDict]) -> ListIndicesOutput
Lists the Amazon Q Business indices you have created.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListIndicesInput | ListIndicesInputDict | 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[ListIndicesInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListIndicesOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
ListIndicesInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListIndicesInput structure.
Attributes¶
application_id
class-attribute
instance-attribute
¶
application_id: str | None = ...
The identifier of the Amazon Q Business application connected to the index.
max_results
class-attribute
instance-attribute
¶
max_results: int | None = ...
The maximum number of indices to return.
next_token
class-attribute
instance-attribute
¶
next_token: str | 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¶
ListIndicesOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListIndicesOutput structure.
Attributes¶
indices
class-attribute
instance-attribute
¶
An array of information on the items in one or more indexes.
next_token
class-attribute
instance-attribute
¶
next_token: str | 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.
response_metadata
class-attribute
instance-attribute
¶
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.