kendra / Client / list_indices
list_indices#
- kendra.Client.list_indices(**kwargs)#
Lists the Amazon Kendra indexes that you created.
See also: AWS API Documentation
Request Syntax
response = client.list_indices( NextToken='string', MaxResults=123 )
- Parameters:
NextToken (string) – If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of indexes.
MaxResults (integer) – The maximum number of indices to return.
- Return type:
dict
- Returns:
Response Syntax
{ 'IndexConfigurationSummaryItems': [ { 'Name': 'string', 'Id': 'string', 'Edition': 'DEVELOPER_EDITION'|'ENTERPRISE_EDITION'|'GEN_AI_ENTERPRISE_EDITION', 'CreatedAt': datetime(2015, 1, 1), 'UpdatedAt': datetime(2015, 1, 1), 'Status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'UPDATING'|'SYSTEM_UPDATING' }, ], 'NextToken': 'string' }
Response Structure
(dict) –
IndexConfigurationSummaryItems (list) –
An array of summary information on the configuration of one or more indexes.
(dict) –
Summary information on the configuration of an index.
Name (string) –
The name of the index.
Id (string) –
A identifier for the index. Use this to identify the index when you are using APIs such as
Query
,DescribeIndex
,UpdateIndex
, andDeleteIndex
.Edition (string) –
Indicates whether the index is a Enterprise Edition index or a Developer Edition index.
CreatedAt (datetime) –
The Unix timestamp when the index was created.
UpdatedAt (datetime) –
The Unix timestamp when the index was last updated.
Status (string) –
The current status of the index. When the status is
ACTIVE
, the index is ready to search.
NextToken (string) –
If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of indexes.
Exceptions
kendra.Client.exceptions.ValidationException
kendra.Client.exceptions.ThrottlingException
kendra.Client.exceptions.AccessDeniedException
kendra.Client.exceptions.InternalServerException