UpdateRescoreExecutionPlan
Updates a rescore execution plan. A rescore execution plan
is an Amazon Kendra Intelligent Ranking resource used for
provisioning the Rescore API. You can update the
number of capacity units you require for Amazon Kendra
Intelligent Ranking to rescore or re-rank a search service's
results.
Request Syntax
{
"CapacityUnits": {
"RescoreCapacityUnits": number
},
"Description": "string",
"Id": "string",
"Name": "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.
- CapacityUnits
-
You can set additional capacity units to meet the needs of your rescore execution plan. You are given a single capacity unit by default. If you want to use the default capacity, you don't set additional capacity units. For more information on the default capacity and additional capacity units, see Adjusting capacity.
Type: CapacityUnitsConfiguration object
Required: No
- Description
-
A new description for the rescore execution plan.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Pattern:
^\P{C}*$Required: No
- Id
-
The identifier of the rescore execution plan that you want to update.
Type: String
Length Constraints: Fixed length of 36.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9-]*Required: Yes
- Name
-
A new name for the rescore execution plan.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9_-]*Required: No
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
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
- ConflictException
-
A conflict occurred with the request. Please fix any inconsistencies with your resources 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
- ResourceNotFoundException
-
The resource you want to use doesn't exist. Please check you have provided the correct resource and try again.
HTTP Status Code: 400
- ServiceQuotaExceededException
-
You have exceeded the set limits for your Amazon Kendra Intelligent Ranking service. Please see Quotas for more information, or contact Support
to inquire about an increase of limits. HTTP Status Code: 400
- 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
