QBusiness / Client / list_indices
list_indices#
- QBusiness.Client.list_indices(**kwargs)#
Lists the Amazon Q indices you have created.
See also: AWS API Documentation
Request Syntax
response = client.list_indices( applicationId='string', maxResults=123, nextToken='string' )
- Parameters:
applicationId (string) –
[REQUIRED]
The identifier of the Amazon Q application connected to the index.
maxResults (integer) – The maximum number of indices to return.
nextToken (string) – If the maxResults response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q indices.
- Return type:
dict
- Returns:
Response Syntax
{ 'indices': [ { 'createdAt': datetime(2015, 1, 1), 'displayName': 'string', 'indexId': 'string', 'status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'UPDATING', 'updatedAt': datetime(2015, 1, 1) }, ], 'nextToken': 'string' }
Response Structure
(dict) –
indices (list) –
An array of information on the items in one or more indexes.
(dict) –
Summary information for your Amazon Q index.
createdAt (datetime) –
The Unix timestamp when the index was created.
displayName (string) –
The name of the index.
indexId (string) –
The identifier for the index.
status (string) –
The current status of the index. When the status is
ACTIVE
, the index is ready.updatedAt (datetime) –
The Unix timestamp when the index was last updated.
nextToken (string) –
If the response is truncated, Amazon Q returns this token that you can use in the subsequent request to retrieve the next set of indexes.
Exceptions
QBusiness.Client.exceptions.ResourceNotFoundException
QBusiness.Client.exceptions.InternalServerException
QBusiness.Client.exceptions.ThrottlingException
QBusiness.Client.exceptions.ValidationException
QBusiness.Client.exceptions.AccessDeniedException