kendra / Client / list_thesauri
list_thesauri#
- kendra.Client.list_thesauri(**kwargs)#
Lists the thesauri for an index.
See also: AWS API Documentation
Request Syntax
response = client.list_thesauri( IndexId='string', NextToken='string', MaxResults=123 )
- Parameters:
IndexId (string) –
[REQUIRED]
The identifier of the index with one or more thesauri.
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 thesauri (
ThesaurusSummaryItems
).MaxResults (integer) – The maximum number of thesauri to return.
- Return type:
dict
- Returns:
Response Syntax
{ 'NextToken': 'string', 'ThesaurusSummaryItems': [ { 'Id': 'string', 'Name': 'string', 'Status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'ACTIVE_BUT_UPDATE_FAILED'|'FAILED', 'CreatedAt': datetime(2015, 1, 1), 'UpdatedAt': datetime(2015, 1, 1) }, ] }
Response Structure
(dict) –
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 thesauri.
ThesaurusSummaryItems (list) –
An array of summary information for a thesaurus or multiple thesauri.
(dict) –
An array of summary information for a thesaurus or multiple thesauri.
Id (string) –
The identifier of the thesaurus.
Name (string) –
The name of the thesaurus.
Status (string) –
The status of the thesaurus.
CreatedAt (datetime) –
The Unix timestamp when the thesaurus was created.
UpdatedAt (datetime) –
The Unix timestamp when the thesaurus was last updated.
Exceptions
kendra.Client.exceptions.ValidationException
kendra.Client.exceptions.ResourceNotFoundException
kendra.Client.exceptions.ThrottlingException
kendra.Client.exceptions.AccessDeniedException
kendra.Client.exceptions.InternalServerException