/* * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ /* * Do not modify this file. This file is generated from the kendra-ranking-2022-10-19.normal.json service model. */ using System; using System.Collections.Generic; using Amazon.Runtime; using Amazon.KendraRanking.Model; namespace Amazon.KendraRanking { /// /// Interface for accessing KendraRanking /// /// Amazon Kendra Intelligent Ranking uses Amazon Kendra semantic search capabilities /// to intelligently re-rank a search service's results. /// public partial interface IAmazonKendraRanking : IAmazonService, IDisposable { #if BCL45 || AWS_ASYNC_ENUMERABLES_API /// /// Paginators for the service /// IKendraRankingPaginatorFactory Paginators { get; } #endif #region CreateRescoreExecutionPlan /// /// Creates a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent /// Ranking resource used for provisioning the Rescore API. You set the number /// of capacity units that you require for Amazon Kendra Intelligent Ranking to rescore /// or re-rank a search service's results. /// /// /// /// For an example of using the CreateRescoreExecutionPlan API, including /// using the Python and Java SDKs, see Semantically /// ranking a search service's results. /// /// /// Container for the necessary parameters to execute the CreateRescoreExecutionPlan service method. /// /// The response from the CreateRescoreExecutionPlan service method, as returned by KendraRanking. /// /// You don’t have sufficient access to perform this action. Please ensure you have the /// required permission policies and user accounts and try again. /// /// /// A conflict occurred with the request. Please fix any inconsistencies with your resources /// and try again. /// /// /// 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. /// /// /// 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. /// /// /// The request was denied due to request throttling. Please reduce the number of requests /// and try again. /// /// /// The input fails to satisfy the constraints set by the Amazon Kendra Intelligent Ranking /// service. Please provide the correct input and try again. /// /// REST API Reference for CreateRescoreExecutionPlan Operation CreateRescoreExecutionPlanResponse CreateRescoreExecutionPlan(CreateRescoreExecutionPlanRequest request); /// /// Initiates the asynchronous execution of the CreateRescoreExecutionPlan operation. /// /// /// Container for the necessary parameters to execute the CreateRescoreExecutionPlan operation on AmazonKendraRankingClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateRescoreExecutionPlan /// operation. /// REST API Reference for CreateRescoreExecutionPlan Operation IAsyncResult BeginCreateRescoreExecutionPlan(CreateRescoreExecutionPlanRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the CreateRescoreExecutionPlan operation. /// /// /// The IAsyncResult returned by the call to BeginCreateRescoreExecutionPlan. /// /// Returns a CreateRescoreExecutionPlanResult from KendraRanking. /// REST API Reference for CreateRescoreExecutionPlan Operation CreateRescoreExecutionPlanResponse EndCreateRescoreExecutionPlan(IAsyncResult asyncResult); #endregion #region DeleteRescoreExecutionPlan /// /// Deletes a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent /// Ranking resource used for provisioning the Rescore API. /// /// Container for the necessary parameters to execute the DeleteRescoreExecutionPlan service method. /// /// The response from the DeleteRescoreExecutionPlan service method, as returned by KendraRanking. /// /// You don’t have sufficient access to perform this action. Please ensure you have the /// required permission policies and user accounts and try again. /// /// /// A conflict occurred with the request. Please fix any inconsistencies with your resources /// and try again. /// /// /// 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. /// /// /// The resource you want to use doesn't exist. Please check you have provided the correct /// resource and try again. /// /// /// The request was denied due to request throttling. Please reduce the number of requests /// and try again. /// /// /// The input fails to satisfy the constraints set by the Amazon Kendra Intelligent Ranking /// service. Please provide the correct input and try again. /// /// REST API Reference for DeleteRescoreExecutionPlan Operation DeleteRescoreExecutionPlanResponse DeleteRescoreExecutionPlan(DeleteRescoreExecutionPlanRequest request); /// /// Initiates the asynchronous execution of the DeleteRescoreExecutionPlan operation. /// /// /// Container for the necessary parameters to execute the DeleteRescoreExecutionPlan operation on AmazonKendraRankingClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteRescoreExecutionPlan /// operation. /// REST API Reference for DeleteRescoreExecutionPlan Operation IAsyncResult BeginDeleteRescoreExecutionPlan(DeleteRescoreExecutionPlanRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DeleteRescoreExecutionPlan operation. /// /// /// The IAsyncResult returned by the call to BeginDeleteRescoreExecutionPlan. /// /// Returns a DeleteRescoreExecutionPlanResult from KendraRanking. /// REST API Reference for DeleteRescoreExecutionPlan Operation DeleteRescoreExecutionPlanResponse EndDeleteRescoreExecutionPlan(IAsyncResult asyncResult); #endregion #region DescribeRescoreExecutionPlan /// /// Gets information about a rescore execution plan. A rescore execution plan is an Amazon /// Kendra Intelligent Ranking resource used for provisioning the Rescore /// API. /// /// Container for the necessary parameters to execute the DescribeRescoreExecutionPlan service method. /// /// The response from the DescribeRescoreExecutionPlan service method, as returned by KendraRanking. /// /// You don’t have sufficient access to perform this action. Please ensure you have the /// required permission policies and user accounts and try again. /// /// /// 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. /// /// /// The resource you want to use doesn't exist. Please check you have provided the correct /// resource and try again. /// /// /// The request was denied due to request throttling. Please reduce the number of requests /// and try again. /// /// /// The input fails to satisfy the constraints set by the Amazon Kendra Intelligent Ranking /// service. Please provide the correct input and try again. /// /// REST API Reference for DescribeRescoreExecutionPlan Operation DescribeRescoreExecutionPlanResponse DescribeRescoreExecutionPlan(DescribeRescoreExecutionPlanRequest request); /// /// Initiates the asynchronous execution of the DescribeRescoreExecutionPlan operation. /// /// /// Container for the necessary parameters to execute the DescribeRescoreExecutionPlan operation on AmazonKendraRankingClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeRescoreExecutionPlan /// operation. /// REST API Reference for DescribeRescoreExecutionPlan Operation IAsyncResult BeginDescribeRescoreExecutionPlan(DescribeRescoreExecutionPlanRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DescribeRescoreExecutionPlan operation. /// /// /// The IAsyncResult returned by the call to BeginDescribeRescoreExecutionPlan. /// /// Returns a DescribeRescoreExecutionPlanResult from KendraRanking. /// REST API Reference for DescribeRescoreExecutionPlan Operation DescribeRescoreExecutionPlanResponse EndDescribeRescoreExecutionPlan(IAsyncResult asyncResult); #endregion #region ListRescoreExecutionPlans /// /// Lists your rescore execution plans. A rescore execution plan is an Amazon Kendra Intelligent /// Ranking resource used for provisioning the Rescore API. /// /// Container for the necessary parameters to execute the ListRescoreExecutionPlans service method. /// /// The response from the ListRescoreExecutionPlans service method, as returned by KendraRanking. /// /// You don’t have sufficient access to perform this action. Please ensure you have the /// required permission policies and user accounts and try again. /// /// /// 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. /// /// /// The request was denied due to request throttling. Please reduce the number of requests /// and try again. /// /// /// The input fails to satisfy the constraints set by the Amazon Kendra Intelligent Ranking /// service. Please provide the correct input and try again. /// /// REST API Reference for ListRescoreExecutionPlans Operation ListRescoreExecutionPlansResponse ListRescoreExecutionPlans(ListRescoreExecutionPlansRequest request); /// /// Initiates the asynchronous execution of the ListRescoreExecutionPlans operation. /// /// /// Container for the necessary parameters to execute the ListRescoreExecutionPlans operation on AmazonKendraRankingClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListRescoreExecutionPlans /// operation. /// REST API Reference for ListRescoreExecutionPlans Operation IAsyncResult BeginListRescoreExecutionPlans(ListRescoreExecutionPlansRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListRescoreExecutionPlans operation. /// /// /// The IAsyncResult returned by the call to BeginListRescoreExecutionPlans. /// /// Returns a ListRescoreExecutionPlansResult from KendraRanking. /// REST API Reference for ListRescoreExecutionPlans Operation ListRescoreExecutionPlansResponse EndListRescoreExecutionPlans(IAsyncResult asyncResult); #endregion #region ListTagsForResource /// /// Gets a list of tags associated with a specified resource. A rescore execution plan /// is an example of a resource that can have tags associated with it. /// /// Container for the necessary parameters to execute the ListTagsForResource service method. /// /// The response from the ListTagsForResource service method, as returned by KendraRanking. /// /// You don’t have sufficient access to perform this action. Please ensure you have the /// required permission policies and user accounts and try again. /// /// /// 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. /// /// /// The resource you want to use is unavailable. Please check you have provided the correct /// resource information and try again. /// /// /// The request was denied due to request throttling. Please reduce the number of requests /// and try again. /// /// /// The input fails to satisfy the constraints set by the Amazon Kendra Intelligent Ranking /// service. Please provide the correct input and try again. /// /// REST API Reference for ListTagsForResource Operation ListTagsForResourceResponse ListTagsForResource(ListTagsForResourceRequest request); /// /// Initiates the asynchronous execution of the ListTagsForResource operation. /// /// /// Container for the necessary parameters to execute the ListTagsForResource operation on AmazonKendraRankingClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListTagsForResource /// operation. /// REST API Reference for ListTagsForResource Operation IAsyncResult BeginListTagsForResource(ListTagsForResourceRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListTagsForResource operation. /// /// /// The IAsyncResult returned by the call to BeginListTagsForResource. /// /// Returns a ListTagsForResourceResult from KendraRanking. /// REST API Reference for ListTagsForResource Operation ListTagsForResourceResponse EndListTagsForResource(IAsyncResult asyncResult); #endregion #region Rescore /// /// Rescores or re-ranks search results from a search service such as OpenSearch (self /// managed). You use the semantic search capabilities of Amazon Kendra Intelligent Ranking /// to improve the search service's results. /// /// Container for the necessary parameters to execute the Rescore service method. /// /// The response from the Rescore service method, as returned by KendraRanking. /// /// You don’t have sufficient access to perform this action. Please ensure you have the /// required permission policies and user accounts and try again. /// /// /// A conflict occurred with the request. Please fix any inconsistencies with your resources /// and try again. /// /// /// 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. /// /// /// The resource you want to use doesn't exist. Please check you have provided the correct /// resource and try again. /// /// /// The request was denied due to request throttling. Please reduce the number of requests /// and try again. /// /// /// The input fails to satisfy the constraints set by the Amazon Kendra Intelligent Ranking /// service. Please provide the correct input and try again. /// /// REST API Reference for Rescore Operation RescoreResponse Rescore(RescoreRequest request); /// /// Initiates the asynchronous execution of the Rescore operation. /// /// /// Container for the necessary parameters to execute the Rescore operation on AmazonKendraRankingClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRescore /// operation. /// REST API Reference for Rescore Operation IAsyncResult BeginRescore(RescoreRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the Rescore operation. /// /// /// The IAsyncResult returned by the call to BeginRescore. /// /// Returns a RescoreResult from KendraRanking. /// REST API Reference for Rescore Operation RescoreResponse EndRescore(IAsyncResult asyncResult); #endregion #region TagResource /// /// Adds a specified tag to a specified rescore execution plan. A rescore execution plan /// is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore /// API. If the tag already exists, the existing value is replaced with the new value. /// /// Container for the necessary parameters to execute the TagResource service method. /// /// The response from the TagResource service method, as returned by KendraRanking. /// /// You don’t have sufficient access to perform this action. Please ensure you have the /// required permission policies and user accounts and try again. /// /// /// 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. /// /// /// The resource you want to use is unavailable. Please check you have provided the correct /// resource information and try again. /// /// /// The request was denied due to request throttling. Please reduce the number of requests /// and try again. /// /// /// The input fails to satisfy the constraints set by the Amazon Kendra Intelligent Ranking /// service. Please provide the correct input and try again. /// /// REST API Reference for TagResource Operation TagResourceResponse TagResource(TagResourceRequest request); /// /// Initiates the asynchronous execution of the TagResource operation. /// /// /// Container for the necessary parameters to execute the TagResource operation on AmazonKendraRankingClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndTagResource /// operation. /// REST API Reference for TagResource Operation IAsyncResult BeginTagResource(TagResourceRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the TagResource operation. /// /// /// The IAsyncResult returned by the call to BeginTagResource. /// /// Returns a TagResourceResult from KendraRanking. /// REST API Reference for TagResource Operation TagResourceResponse EndTagResource(IAsyncResult asyncResult); #endregion #region UntagResource /// /// Removes a tag from a rescore execution plan. A rescore execution plan is an Amazon /// Kendra Intelligent Ranking resource used for provisioning the Rescore /// operation. /// /// Container for the necessary parameters to execute the UntagResource service method. /// /// The response from the UntagResource service method, as returned by KendraRanking. /// /// You don’t have sufficient access to perform this action. Please ensure you have the /// required permission policies and user accounts and try again. /// /// /// 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. /// /// /// The resource you want to use is unavailable. Please check you have provided the correct /// resource information and try again. /// /// /// The request was denied due to request throttling. Please reduce the number of requests /// and try again. /// /// /// The input fails to satisfy the constraints set by the Amazon Kendra Intelligent Ranking /// service. Please provide the correct input and try again. /// /// REST API Reference for UntagResource Operation UntagResourceResponse UntagResource(UntagResourceRequest request); /// /// Initiates the asynchronous execution of the UntagResource operation. /// /// /// Container for the necessary parameters to execute the UntagResource operation on AmazonKendraRankingClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUntagResource /// operation. /// REST API Reference for UntagResource Operation IAsyncResult BeginUntagResource(UntagResourceRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the UntagResource operation. /// /// /// The IAsyncResult returned by the call to BeginUntagResource. /// /// Returns a UntagResourceResult from KendraRanking. /// REST API Reference for UntagResource Operation UntagResourceResponse EndUntagResource(IAsyncResult asyncResult); #endregion #region 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. /// /// Container for the necessary parameters to execute the UpdateRescoreExecutionPlan service method. /// /// The response from the UpdateRescoreExecutionPlan service method, as returned by KendraRanking. /// /// You don’t have sufficient access to perform this action. Please ensure you have the /// required permission policies and user accounts and try again. /// /// /// A conflict occurred with the request. Please fix any inconsistencies with your resources /// and try again. /// /// /// 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. /// /// /// The resource you want to use doesn't exist. Please check you have provided the correct /// resource and try again. /// /// /// 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. /// /// /// The request was denied due to request throttling. Please reduce the number of requests /// and try again. /// /// /// The input fails to satisfy the constraints set by the Amazon Kendra Intelligent Ranking /// service. Please provide the correct input and try again. /// /// REST API Reference for UpdateRescoreExecutionPlan Operation UpdateRescoreExecutionPlanResponse UpdateRescoreExecutionPlan(UpdateRescoreExecutionPlanRequest request); /// /// Initiates the asynchronous execution of the UpdateRescoreExecutionPlan operation. /// /// /// Container for the necessary parameters to execute the UpdateRescoreExecutionPlan operation on AmazonKendraRankingClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateRescoreExecutionPlan /// operation. /// REST API Reference for UpdateRescoreExecutionPlan Operation IAsyncResult BeginUpdateRescoreExecutionPlan(UpdateRescoreExecutionPlanRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the UpdateRescoreExecutionPlan operation. /// /// /// The IAsyncResult returned by the call to BeginUpdateRescoreExecutionPlan. /// /// Returns a UpdateRescoreExecutionPlanResult from KendraRanking. /// REST API Reference for UpdateRescoreExecutionPlan Operation UpdateRescoreExecutionPlanResponse EndUpdateRescoreExecutionPlan(IAsyncResult asyncResult); #endregion } }