KendraRanking / Client / list_rescore_execution_plans
list_rescore_execution_plans#
- KendraRanking.Client.list_rescore_execution_plans(**kwargs)#
Lists your rescore execution plans. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the
Rescore
API.See also: AWS API Documentation
Request Syntax
response = client.list_rescore_execution_plans( NextToken='string', MaxResults=123 )
- Parameters:
NextToken (string) – If the response is truncated, Amazon Kendra Intelligent Ranking returns a pagination token in the response. You can use this pagination token to retrieve the next set of rescore execution plans.
MaxResults (integer) – The maximum number of rescore execution plans to return.
- Return type:
dict
- Returns:
Response Syntax
{ 'SummaryItems': [ { 'Name': 'string', 'Id': 'string', 'CreatedAt': datetime(2015, 1, 1), 'UpdatedAt': datetime(2015, 1, 1), 'Status': 'CREATING'|'UPDATING'|'ACTIVE'|'DELETING'|'FAILED' }, ], 'NextToken': 'string' }
Response Structure
(dict) –
SummaryItems (list) –
An array of summary information for one or more rescore execution plans.
(dict) –
Summary information for a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the
Rescore
API.Name (string) –
The name of the rescore execution plan.
Id (string) –
The identifier of the rescore execution plan.
CreatedAt (datetime) –
The Unix timestamp when the rescore execution plan was created.
UpdatedAt (datetime) –
The Unix timestamp when the rescore execution plan was last updated.
Status (string) –
The current status of the rescore execution plan. When the value is
ACTIVE
, the rescore execution plan is ready for use.
NextToken (string) –
If the response is truncated, Amazon Kendra Intelligent Ranking returns a pagination token in the response.
Exceptions
KendraRanking.Client.exceptions.ValidationException
KendraRanking.Client.exceptions.AccessDeniedException
KendraRanking.Client.exceptions.ThrottlingException
KendraRanking.Client.exceptions.InternalServerException