Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListRescoreExecutionPlans

Lists your rescore execution plans. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.

Request Syntax


{
   "MaxResults": number,
   "NextToken": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

MaxResults

The maximum number of rescore execution plans to return.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: No

NextToken

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 800.

Pattern: ^\P{C}*$

Required: No

Response Syntax


{
   "NextToken": "string",
   "SummaryItems": [ 
      { 
         "CreatedAt": number,
         "Id": "string",
         "Name": "string",
         "Status": "string",
         "UpdatedAt": number
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

If the response is truncated, Amazon Kendra Intelligent Ranking returns a pagination token in the response.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 800.

Pattern: ^\P{C}*$

SummaryItems

An array of summary information for one or more rescore execution plans.

Type: Array of RescoreExecutionPlanSummary objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don’t have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

HTTP Status Code: 400

InternalServerException

An issue occurred with the internal server used for your Amazon Kendra Intelligent Ranking service. Please wait a few minutes and try again, or contact Support for help.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling. Please reduce the number of requests and try again.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints set by the Amazon Kendra Intelligent Ranking service. Please provide the correct input and try again.

HTTP Status Code: 400