Package-level declarations

Types

Link copied to clipboard

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

Link copied to clipboard

Sets additional capacity units configured for your rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API. You can add and remove capacity units to fit your usage requirements.

Link copied to clipboard

A conflict occurred with the request. Please fix any inconsistencies with your resources and try again.

Link copied to clipboard
class Document

Information about a document from a search service such as OpenSearch (self managed). Amazon Kendra Intelligent Ranking uses this information to rank and score on.

Link copied to clipboard

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.

Link copied to clipboard

Base class for all service related exceptions thrown by the KendraRanking client

Link copied to clipboard

The request information for listing tags associated with a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

Summary information for a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

A result item for a document with a new relevancy score.

Link copied to clipboard

The resource you want to use doesn't exist. Please check you have provided the correct resource and try again.

Link copied to clipboard

The resource you want to use is unavailable. Please check you have provided the correct resource information and try again.

Link copied to clipboard

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.

Link copied to clipboard
class Tag

A key-value pair that identifies or categorizes a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API. You can also use a tag to help control access to a rescore execution plan. A tag key and value can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

Link copied to clipboard

The request information for tagging a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The request information to remove a tag from a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.

Link copied to clipboard

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

Link copied to clipboard

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