/*
* 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-2019-02-03.normal.json service model.
*/
using System;
using System.Threading;
using System.Threading.Tasks;
using System.Collections.Generic;
using Amazon.Runtime;
using Amazon.Kendra.Model;
namespace Amazon.Kendra
{
///
/// Interface for accessing Kendra
///
/// Amazon Kendra is a service for indexing large document sets.
///
public partial interface IAmazonKendra : IAmazonService, IDisposable
{
#if AWS_ASYNC_ENUMERABLES_API
///
/// Paginators for the service
///
IKendraPaginatorFactory Paginators { get; }
#endif
#region AssociateEntitiesToExperience
///
/// Grants users or groups in your IAM Identity Center identity source access to your
/// Amazon Kendra experience. You can create an Amazon Kendra experience such as a search
/// application. For more information on creating a search application experience, see
/// Building
/// a search experience with no code.
///
/// Container for the necessary parameters to execute the AssociateEntitiesToExperience service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the AssociateEntitiesToExperience service method, as returned by Kendra.
///
/// 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 service. Please
/// wait a few minutes and try again, or contact Support
/// for help.
///
///
/// The resource you want to use already exists. Please check you have provided the correct
/// resource and try again.
///
///
/// 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for AssociateEntitiesToExperience Operation
Task AssociateEntitiesToExperienceAsync(AssociateEntitiesToExperienceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region AssociatePersonasToEntities
///
/// Defines the specific permissions of users or groups in your IAM Identity Center identity
/// source with access to your Amazon Kendra experience. You can create an Amazon Kendra
/// experience such as a search application. For more information on creating a search
/// application experience, see Building
/// a search experience with no code.
///
/// Container for the necessary parameters to execute the AssociatePersonasToEntities service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the AssociatePersonasToEntities service method, as returned by Kendra.
///
/// 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 service. Please
/// wait a few minutes and try again, or contact Support
/// for help.
///
///
/// The resource you want to use already exists. Please check you have provided the correct
/// resource and try again.
///
///
/// 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for AssociatePersonasToEntities Operation
Task AssociatePersonasToEntitiesAsync(AssociatePersonasToEntitiesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region BatchDeleteDocument
///
/// Removes one or more documents from an index. The documents must have been added with
/// the BatchPutDocument
API.
///
///
///
/// The documents are deleted asynchronously. You can see the progress of the deletion
/// by using Amazon Web Services CloudWatch. Any error messages related to the processing
/// of the batch are sent to you CloudWatch log.
///
///
/// Container for the necessary parameters to execute the BatchDeleteDocument service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the BatchDeleteDocument service method, as returned by Kendra.
///
/// 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 inconsistences with your resources
/// and try again.
///
///
/// An issue occurred with the internal server used for your Amazon Kendra 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for BatchDeleteDocument Operation
Task BatchDeleteDocumentAsync(BatchDeleteDocumentRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region BatchDeleteFeaturedResultsSet
///
/// Removes one or more sets of featured results. Features results are placed above all
/// other results for certain queries. If there's an exact match of a query, then one
/// or more specific documents are featured in the search results.
///
/// Container for the necessary parameters to execute the BatchDeleteFeaturedResultsSet service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the BatchDeleteFeaturedResultsSet service method, as returned by Kendra.
///
/// 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 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for BatchDeleteFeaturedResultsSet Operation
Task BatchDeleteFeaturedResultsSetAsync(BatchDeleteFeaturedResultsSetRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region BatchGetDocumentStatus
///
/// Returns the indexing status for one or more documents submitted with the
/// BatchPutDocument API.
///
///
///
/// When you use the BatchPutDocument
API, documents are indexed asynchronously.
/// You can use the BatchGetDocumentStatus
API to get the current status
/// of a list of documents so that you can determine if they have been successfully indexed.
///
///
///
/// You can also use the BatchGetDocumentStatus
API to check the status of
/// the
/// BatchDeleteDocument API. When a document is deleted from the index, Amazon Kendra
/// returns NOT_FOUND
as the status.
///
///
/// Container for the necessary parameters to execute the BatchGetDocumentStatus service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the BatchGetDocumentStatus service method, as returned by Kendra.
///
/// 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 inconsistences with your resources
/// and try again.
///
///
/// An issue occurred with the internal server used for your Amazon Kendra 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for BatchGetDocumentStatus Operation
Task BatchGetDocumentStatusAsync(BatchGetDocumentStatusRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region BatchPutDocument
///
/// Adds one or more documents to an index.
///
///
///
/// The BatchPutDocument
API enables you to ingest inline documents or a
/// set of documents stored in an Amazon S3 bucket. Use this API to ingest your text and
/// unstructured text into an index, add custom attributes to the documents, and to attach
/// an access control list to the documents added to the index.
///
///
///
/// The documents are indexed asynchronously. You can see the progress of the batch using
/// Amazon Web Services CloudWatch. Any error messages related to processing the batch
/// are sent to your Amazon Web Services CloudWatch log.
///
///
///
/// For an example of ingesting inline documents using Python and Java SDKs, see Adding
/// files directly to an index.
///
///
/// Container for the necessary parameters to execute the BatchPutDocument service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the BatchPutDocument service method, as returned by Kendra.
///
/// 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 inconsistences with your resources
/// and try again.
///
///
/// An issue occurred with the internal server used for your Amazon Kendra 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 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for BatchPutDocument Operation
Task BatchPutDocumentAsync(BatchPutDocumentRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ClearQuerySuggestions
///
/// Clears existing query suggestions from an index.
///
///
///
/// This deletes existing suggestions only, not the queries in the query log. After you
/// clear suggestions, Amazon Kendra learns new suggestions based on new queries added
/// to the query log from the time you cleared suggestions. If you do not see any new
/// suggestions, then please allow Amazon Kendra to collect enough queries to learn new
/// suggestions.
///
///
///
/// ClearQuerySuggestions
is currently not supported in the Amazon Web Services
/// GovCloud (US-West) region.
///
///
/// Container for the necessary parameters to execute the ClearQuerySuggestions service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ClearQuerySuggestions service method, as returned by Kendra.
///
/// 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 inconsistences with your resources
/// and try again.
///
///
/// An issue occurred with the internal server used for your Amazon Kendra 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for ClearQuerySuggestions Operation
Task ClearQuerySuggestionsAsync(ClearQuerySuggestionsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateAccessControlConfiguration
///
/// Creates an access configuration for your documents. This includes user and group access
/// information for your documents. This is useful for user context filtering, where search
/// results are filtered based on the user or their group access to documents.
///
///
///
/// You can use this to re-configure your existing document level access control without
/// indexing all of your documents again. For example, your index contains top-secret
/// company documents that only certain employees or users should access. One of these
/// users leaves the company or switches to a team that should be blocked from accessing
/// top-secret documents. The user still has access to top-secret documents because the
/// user had access when your documents were previously indexed. You can create a specific
/// access control configuration for the user with deny access. You can later update the
/// access control configuration to allow access if the user returns to the company and
/// re-joins the 'top-secret' team. You can re-configure access control for your documents
/// as circumstances change.
///
///
///
/// To apply your access control configuration to certain documents, you call the BatchPutDocument
/// API with the AccessControlConfigurationId
included in the Document
/// object. If you use an S3 bucket as a data source, you update the .metadata.json
/// with the AccessControlConfigurationId
and synchronize your data source.
/// Amazon Kendra currently only supports access control configuration for S3 data sources
/// and documents indexed using the BatchPutDocument
API.
///
///
/// Container for the necessary parameters to execute the CreateAccessControlConfiguration service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateAccessControlConfiguration service method, as returned by Kendra.
///
/// 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 inconsistences with your resources
/// and try again.
///
///
/// An issue occurred with the internal server used for your Amazon Kendra 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 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for CreateAccessControlConfiguration Operation
Task CreateAccessControlConfigurationAsync(CreateAccessControlConfigurationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateDataSource
///
/// Creates a data source connector that you want to use with an Amazon Kendra index.
///
///
///
/// You specify a name, data source connector type and description for your data source.
/// You also specify configuration information for the data source connector.
///
///
///
/// CreateDataSource
is a synchronous operation. The operation returns 200
/// if the data source was successfully created. Otherwise, an exception is raised.
///
///
///
/// For an example of creating an index and data source using the Python SDK, see Getting
/// started with Python SDK. For an example of creating an index and data source using
/// the Java SDK, see Getting
/// started with Java SDK.
///
///
/// Container for the necessary parameters to execute the CreateDataSource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateDataSource service method, as returned by Kendra.
///
/// 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 inconsistences with your resources
/// and try again.
///
///
/// An issue occurred with the internal server used for your Amazon Kendra service. Please
/// wait a few minutes and try again, or contact Support
/// for help.
///
///
/// The resource you want to use already exists. Please check you have provided the correct
/// resource and try again.
///
///
/// 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 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for CreateDataSource Operation
Task CreateDataSourceAsync(CreateDataSourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateExperience
///
/// Creates an Amazon Kendra experience such as a search application. For more information
/// on creating a search application experience, including using the Python and Java SDKs,
/// see Building
/// a search experience with no code.
///
/// Container for the necessary parameters to execute the CreateExperience service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateExperience service method, as returned by Kendra.
///
/// 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 inconsistences with your resources
/// and try again.
///
///
/// An issue occurred with the internal server used for your Amazon Kendra 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 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for CreateExperience Operation
Task CreateExperienceAsync(CreateExperienceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateFaq
///
/// Creates a set of frequently ask questions (FAQs) using a specified FAQ file stored
/// in an Amazon S3 bucket.
///
///
///
/// Adding FAQs to an index is an asynchronous operation.
///
///
///
/// For an example of adding an FAQ to an index using Python and Java SDKs, see Using
/// your FAQ file.
///
///
/// Container for the necessary parameters to execute the CreateFaq service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateFaq service method, as returned by Kendra.
///
/// 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 inconsistences with your resources
/// and try again.
///
///
/// An issue occurred with the internal server used for your Amazon Kendra 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 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for CreateFaq Operation
Task CreateFaqAsync(CreateFaqRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateFeaturedResultsSet
///
/// Creates a set of featured results to display at the top of the search results page.
/// Featured results are placed above all other results for certain queries. You map specific
/// queries to specific documents for featuring in the results. If a query contains an
/// exact match, then one or more specific documents are featured in the search results.
///
///
///
/// You can create up to 50 sets of featured results per index. You can request to increase
/// this limit by contacting Support.
///
///
/// Container for the necessary parameters to execute the CreateFeaturedResultsSet service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateFeaturedResultsSet service method, as returned by Kendra.
///
/// 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 inconsistences with your resources
/// and try again.
///
///
/// An error message with a list of conflicting queries used across different sets of
/// featured results. This occurred with the request for a new featured results set. Check
/// that the queries you specified for featured results are unique per featured results
/// set for each index.
///
///
/// An issue occurred with the internal server used for your Amazon Kendra 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for CreateFeaturedResultsSet Operation
Task CreateFeaturedResultsSetAsync(CreateFeaturedResultsSetRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateIndex
///
/// Creates an Amazon Kendra index. Index creation is an asynchronous API. To determine
/// if index creation has completed, check the Status
field returned from
/// a call to DescribeIndex
. The Status
field is set to ACTIVE
/// when the index is ready to use.
///
///
///
/// Once the index is active you can index your documents using the BatchPutDocument
/// API or using one of the supported data sources.
///
///
///
/// For an example of creating an index and data source using the Python SDK, see Getting
/// started with Python SDK. For an example of creating an index and data source using
/// the Java SDK, see Getting
/// started with Java SDK.
///
///
/// Container for the necessary parameters to execute the CreateIndex service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateIndex service method, as returned by Kendra.
///
/// 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 inconsistences with your resources
/// and try again.
///
///
/// An issue occurred with the internal server used for your Amazon Kendra service. Please
/// wait a few minutes and try again, or contact Support
/// for help.
///
///
/// The resource you want to use already exists. Please check you have provided the correct
/// resource and try again.
///
///
/// You have exceeded the set limits for your Amazon Kendra 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for CreateIndex Operation
Task CreateIndexAsync(CreateIndexRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateQuerySuggestionsBlockList
///
/// Creates a block list to exlcude certain queries from suggestions.
///
///
///
/// Any query that contains words or phrases specified in the block list is blocked or
/// filtered out from being shown as a suggestion.
///
///
///
/// You need to provide the file location of your block list text file in your S3 bucket.
/// In your text file, enter each block word or phrase on a separate line.
///
///
///
/// For information on the current quota limits for block lists, see Quotas
/// for Amazon Kendra.
///
///
///
/// CreateQuerySuggestionsBlockList
is currently not supported in the Amazon
/// Web Services GovCloud (US-West) region.
///
///
///
/// For an example of creating a block list for query suggestions using the Python SDK,
/// see Query
/// suggestions block list.
///
///
/// Container for the necessary parameters to execute the CreateQuerySuggestionsBlockList service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateQuerySuggestionsBlockList service method, as returned by Kendra.
///
/// 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 inconsistences with your resources
/// and try again.
///
///
/// An issue occurred with the internal server used for your Amazon Kendra 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 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for CreateQuerySuggestionsBlockList Operation
Task CreateQuerySuggestionsBlockListAsync(CreateQuerySuggestionsBlockListRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateThesaurus
///
/// Creates a thesaurus for an index. The thesaurus contains a list of synonyms in Solr
/// format.
///
///
///
/// For an example of adding a thesaurus file to an index, see Adding
/// custom synonyms to an index.
///
///
/// Container for the necessary parameters to execute the CreateThesaurus service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateThesaurus service method, as returned by Kendra.
///
/// 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 inconsistences with your resources
/// and try again.
///
///
/// An issue occurred with the internal server used for your Amazon Kendra 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 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for CreateThesaurus Operation
Task CreateThesaurusAsync(CreateThesaurusRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteAccessControlConfiguration
///
/// Deletes an access control configuration that you created for your documents in an
/// index. This includes user and group access information for your documents. This is
/// useful for user context filtering, where search results are filtered based on the
/// user or their group access to documents.
///
/// Container for the necessary parameters to execute the DeleteAccessControlConfiguration service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteAccessControlConfiguration service method, as returned by Kendra.
///
/// 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 inconsistences with your resources
/// and try again.
///
///
/// An issue occurred with the internal server used for your Amazon Kendra 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for DeleteAccessControlConfiguration Operation
Task DeleteAccessControlConfigurationAsync(DeleteAccessControlConfigurationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteDataSource
///
/// Deletes an Amazon Kendra data source connector. An exception is not thrown if the
/// data source is already being deleted. While the data source is being deleted, the
/// Status
field returned by a call to the DescribeDataSource
/// API is set to DELETING
. For more information, see Deleting
/// Data Sources.
///
/// Container for the necessary parameters to execute the DeleteDataSource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteDataSource service method, as returned by Kendra.
///
/// 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 inconsistences with your resources
/// and try again.
///
///
/// An issue occurred with the internal server used for your Amazon Kendra 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for DeleteDataSource Operation
Task DeleteDataSourceAsync(DeleteDataSourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteExperience
///
/// Deletes your Amazon Kendra experience such as a search application. For more information
/// on creating a search application experience, see Building
/// a search experience with no code.
///
/// Container for the necessary parameters to execute the DeleteExperience service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteExperience service method, as returned by Kendra.
///
/// 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 inconsistences with your resources
/// and try again.
///
///
/// An issue occurred with the internal server used for your Amazon Kendra 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for DeleteExperience Operation
Task DeleteExperienceAsync(DeleteExperienceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteFaq
///
/// Removes an FAQ from an index.
///
/// Container for the necessary parameters to execute the DeleteFaq service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteFaq service method, as returned by Kendra.
///
/// 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 inconsistences with your resources
/// and try again.
///
///
/// An issue occurred with the internal server used for your Amazon Kendra 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for DeleteFaq Operation
Task DeleteFaqAsync(DeleteFaqRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteIndex
///
/// Deletes an existing Amazon Kendra index. An exception is not thrown if the index is
/// already being deleted. While the index is being deleted, the Status
field
/// returned by a call to the DescribeIndex
API is set to DELETING
.
///
/// Container for the necessary parameters to execute the DeleteIndex service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteIndex service method, as returned by Kendra.
///
/// 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 inconsistences with your resources
/// and try again.
///
///
/// An issue occurred with the internal server used for your Amazon Kendra 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for DeleteIndex Operation
Task DeleteIndexAsync(DeleteIndexRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeletePrincipalMapping
///
/// Deletes a group so that all users and sub groups that belong to the group can no longer
/// access documents only available to that group.
///
///
///
/// For example, after deleting the group "Summer Interns", all interns who belonged to
/// that group no longer see intern-only documents in their search results.
///
///
///
/// If you want to delete or replace users or sub groups of a group, you need to use the
/// PutPrincipalMapping
operation. For example, if a user in the group "Engineering"
/// leaves the engineering team and another user takes their place, you provide an updated
/// list of users or sub groups that belong to the "Engineering" group when calling PutPrincipalMapping
.
/// You can update your internal list of users or sub groups and input this list when
/// calling PutPrincipalMapping
.
///
///
///
/// DeletePrincipalMapping
is currently not supported in the Amazon Web
/// Services GovCloud (US-West) region.
///
///
/// Container for the necessary parameters to execute the DeletePrincipalMapping service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeletePrincipalMapping service method, as returned by Kendra.
///
/// 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 inconsistences with your resources
/// and try again.
///
///
/// An issue occurred with the internal server used for your Amazon Kendra 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for DeletePrincipalMapping Operation
Task DeletePrincipalMappingAsync(DeletePrincipalMappingRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteQuerySuggestionsBlockList
///
/// Deletes a block list used for query suggestions for an index.
///
///
///
/// A deleted block list might not take effect right away. Amazon Kendra needs to refresh
/// the entire suggestions list to add back the queries that were previously blocked.
///
///
///
/// DeleteQuerySuggestionsBlockList
is currently not supported in the Amazon
/// Web Services GovCloud (US-West) region.
///
///
/// Container for the necessary parameters to execute the DeleteQuerySuggestionsBlockList service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteQuerySuggestionsBlockList service method, as returned by Kendra.
///
/// 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 inconsistences with your resources
/// and try again.
///
///
/// An issue occurred with the internal server used for your Amazon Kendra 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for DeleteQuerySuggestionsBlockList Operation
Task DeleteQuerySuggestionsBlockListAsync(DeleteQuerySuggestionsBlockListRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteThesaurus
///
/// Deletes an existing Amazon Kendra thesaurus.
///
/// Container for the necessary parameters to execute the DeleteThesaurus service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteThesaurus service method, as returned by Kendra.
///
/// 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 inconsistences with your resources
/// and try again.
///
///
/// An issue occurred with the internal server used for your Amazon Kendra 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for DeleteThesaurus Operation
Task DeleteThesaurusAsync(DeleteThesaurusRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeAccessControlConfiguration
///
/// Gets information about an access control configuration that you created for your documents
/// in an index. This includes user and group access information for your documents. This
/// is useful for user context filtering, where search results are filtered based on the
/// user or their group access to documents.
///
/// Container for the necessary parameters to execute the DescribeAccessControlConfiguration service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeAccessControlConfiguration service method, as returned by Kendra.
///
/// 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 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for DescribeAccessControlConfiguration Operation
Task DescribeAccessControlConfigurationAsync(DescribeAccessControlConfigurationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeDataSource
///
/// Gets information about an Amazon Kendra data source connector.
///
/// Container for the necessary parameters to execute the DescribeDataSource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeDataSource service method, as returned by Kendra.
///
/// 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 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for DescribeDataSource Operation
Task DescribeDataSourceAsync(DescribeDataSourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeExperience
///
/// Gets information about your Amazon Kendra experience such as a search application.
/// For more information on creating a search application experience, see Building
/// a search experience with no code.
///
/// Container for the necessary parameters to execute the DescribeExperience service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeExperience service method, as returned by Kendra.
///
/// 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 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for DescribeExperience Operation
Task DescribeExperienceAsync(DescribeExperienceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeFaq
///
/// Gets information about an FAQ list.
///
/// Container for the necessary parameters to execute the DescribeFaq service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeFaq service method, as returned by Kendra.
///
/// 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 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for DescribeFaq Operation
Task DescribeFaqAsync(DescribeFaqRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeFeaturedResultsSet
///
/// Gets information about a set of featured results. Features results are placed above
/// all other results for certain queries. If there's an exact match of a query, then
/// one or more specific documents are featured in the search results.
///
/// Container for the necessary parameters to execute the DescribeFeaturedResultsSet service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeFeaturedResultsSet service method, as returned by Kendra.
///
/// 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 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for DescribeFeaturedResultsSet Operation
Task DescribeFeaturedResultsSetAsync(DescribeFeaturedResultsSetRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeIndex
///
/// Gets information about an existing Amazon Kendra index.
///
/// Container for the necessary parameters to execute the DescribeIndex service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeIndex service method, as returned by Kendra.
///
/// 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 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for DescribeIndex Operation
Task DescribeIndexAsync(DescribeIndexRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribePrincipalMapping
///
/// Describes the processing of PUT
and DELETE
actions for mapping
/// users to their groups. This includes information on the status of actions currently
/// processing or yet to be processed, when actions were last updated, when actions were
/// received by Amazon Kendra, the latest action that should process and apply after other
/// actions, and useful error messages if an action could not be processed.
///
///
///
/// DescribePrincipalMapping
is currently not supported in the Amazon Web
/// Services GovCloud (US-West) region.
///
///
/// Container for the necessary parameters to execute the DescribePrincipalMapping service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribePrincipalMapping service method, as returned by Kendra.
///
/// 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 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for DescribePrincipalMapping Operation
Task DescribePrincipalMappingAsync(DescribePrincipalMappingRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeQuerySuggestionsBlockList
///
/// Gets information about a block list used for query suggestions for an index.
///
///
///
/// This is used to check the current settings that are applied to a block list.
///
///
///
/// DescribeQuerySuggestionsBlockList
is currently not supported in the
/// Amazon Web Services GovCloud (US-West) region.
///
///
/// Container for the necessary parameters to execute the DescribeQuerySuggestionsBlockList service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeQuerySuggestionsBlockList service method, as returned by Kendra.
///
/// 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 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for DescribeQuerySuggestionsBlockList Operation
Task DescribeQuerySuggestionsBlockListAsync(DescribeQuerySuggestionsBlockListRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeQuerySuggestionsConfig
///
/// Gets information on the settings of query suggestions for an index.
///
///
///
/// This is used to check the current settings applied to query suggestions.
///
///
///
/// DescribeQuerySuggestionsConfig
is currently not supported in the Amazon
/// Web Services GovCloud (US-West) region.
///
///
/// Container for the necessary parameters to execute the DescribeQuerySuggestionsConfig service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeQuerySuggestionsConfig service method, as returned by Kendra.
///
/// 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 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for DescribeQuerySuggestionsConfig Operation
Task DescribeQuerySuggestionsConfigAsync(DescribeQuerySuggestionsConfigRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeThesaurus
///
/// Gets information about an existing Amazon Kendra thesaurus.
///
/// Container for the necessary parameters to execute the DescribeThesaurus service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeThesaurus service method, as returned by Kendra.
///
/// 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 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for DescribeThesaurus Operation
Task DescribeThesaurusAsync(DescribeThesaurusRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DisassociateEntitiesFromExperience
///
/// Prevents users or groups in your IAM Identity Center identity source from accessing
/// your Amazon Kendra experience. You can create an Amazon Kendra experience such as
/// a search application. For more information on creating a search application experience,
/// see Building
/// a search experience with no code.
///
/// Container for the necessary parameters to execute the DisassociateEntitiesFromExperience service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DisassociateEntitiesFromExperience service method, as returned by Kendra.
///
/// 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 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for DisassociateEntitiesFromExperience Operation
Task DisassociateEntitiesFromExperienceAsync(DisassociateEntitiesFromExperienceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DisassociatePersonasFromEntities
///
/// Removes the specific permissions of users or groups in your IAM Identity Center identity
/// source with access to your Amazon Kendra experience. You can create an Amazon Kendra
/// experience such as a search application. For more information on creating a search
/// application experience, see Building
/// a search experience with no code.
///
/// Container for the necessary parameters to execute the DisassociatePersonasFromEntities service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DisassociatePersonasFromEntities service method, as returned by Kendra.
///
/// 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 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for DisassociatePersonasFromEntities Operation
Task DisassociatePersonasFromEntitiesAsync(DisassociatePersonasFromEntitiesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetQuerySuggestions
///
/// Fetches the queries that are suggested to your users.
///
///
///
/// GetQuerySuggestions
is currently not supported in the Amazon Web Services
/// GovCloud (US-West) region.
///
///
/// Container for the necessary parameters to execute the GetQuerySuggestions service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetQuerySuggestions service method, as returned by Kendra.
///
/// 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 inconsistences with your resources
/// and try again.
///
///
/// An issue occurred with the internal server used for your Amazon Kendra 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 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for GetQuerySuggestions Operation
Task GetQuerySuggestionsAsync(GetQuerySuggestionsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetSnapshots
///
/// Retrieves search metrics data. The data provides a snapshot of how your users interact
/// with your search application and how effective the application is.
///
/// Container for the necessary parameters to execute the GetSnapshots service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetSnapshots service method, as returned by Kendra.
///
/// 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 service. Please
/// wait a few minutes and try again, or contact Support
/// for help.
///
///
/// The input to the request is not valid. Please provide the correct input and try again.
///
///
/// The resource you want to use doesn’t exist. Please check you have provided the correct
/// resource and try again.
///
/// REST API Reference for GetSnapshots Operation
Task GetSnapshotsAsync(GetSnapshotsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListAccessControlConfigurations
///
/// Lists one or more access control configurations for an index. This includes user and
/// group access information for your documents. This is useful for user context filtering,
/// where search results are filtered based on the user or their group access to documents.
///
/// Container for the necessary parameters to execute the ListAccessControlConfigurations service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListAccessControlConfigurations service method, as returned by Kendra.
///
/// 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 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for ListAccessControlConfigurations Operation
Task ListAccessControlConfigurationsAsync(ListAccessControlConfigurationsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListDataSources
///
/// Lists the data source connectors that you have created.
///
/// Container for the necessary parameters to execute the ListDataSources service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListDataSources service method, as returned by Kendra.
///
/// 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 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for ListDataSources Operation
Task ListDataSourcesAsync(ListDataSourcesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListDataSourceSyncJobs
///
/// Gets statistics about synchronizing a data source connector.
///
/// Container for the necessary parameters to execute the ListDataSourceSyncJobs service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListDataSourceSyncJobs service method, as returned by Kendra.
///
/// 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 inconsistences with your resources
/// and try again.
///
///
/// An issue occurred with the internal server used for your Amazon Kendra 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for ListDataSourceSyncJobs Operation
Task ListDataSourceSyncJobsAsync(ListDataSourceSyncJobsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListEntityPersonas
///
/// Lists specific permissions of users and groups with access to your Amazon Kendra experience.
///
/// Container for the necessary parameters to execute the ListEntityPersonas service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListEntityPersonas service method, as returned by Kendra.
///
/// 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 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for ListEntityPersonas Operation
Task ListEntityPersonasAsync(ListEntityPersonasRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListExperienceEntities
///
/// Lists users or groups in your IAM Identity Center identity source that are granted
/// access to your Amazon Kendra experience. You can create an Amazon Kendra experience
/// such as a search application. For more information on creating a search application
/// experience, see Building
/// a search experience with no code.
///
/// Container for the necessary parameters to execute the ListExperienceEntities service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListExperienceEntities service method, as returned by Kendra.
///
/// 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 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for ListExperienceEntities Operation
Task ListExperienceEntitiesAsync(ListExperienceEntitiesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListExperiences
///
/// Lists one or more Amazon Kendra experiences. You can create an Amazon Kendra experience
/// such as a search application. For more information on creating a search application
/// experience, see Building
/// a search experience with no code.
///
/// Container for the necessary parameters to execute the ListExperiences service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListExperiences service method, as returned by Kendra.
///
/// 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 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for ListExperiences Operation
Task ListExperiencesAsync(ListExperiencesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListFaqs
///
/// Gets a list of FAQ lists associated with an index.
///
/// Container for the necessary parameters to execute the ListFaqs service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListFaqs service method, as returned by Kendra.
///
/// 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 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for ListFaqs Operation
Task ListFaqsAsync(ListFaqsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListFeaturedResultsSets
///
/// Lists all your sets of featured results for a given index. Features results are placed
/// above all other results for certain queries. If there's an exact match of a query,
/// then one or more specific documents are featured in the search results.
///
/// Container for the necessary parameters to execute the ListFeaturedResultsSets service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListFeaturedResultsSets service method, as returned by Kendra.
///
/// 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 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for ListFeaturedResultsSets Operation
Task ListFeaturedResultsSetsAsync(ListFeaturedResultsSetsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListGroupsOlderThanOrderingId
///
/// Provides a list of groups that are mapped to users before a given ordering or timestamp
/// identifier.
///
///
///
/// ListGroupsOlderThanOrderingId
is currently not supported in the Amazon
/// Web Services GovCloud (US-West) region.
///
///
/// Container for the necessary parameters to execute the ListGroupsOlderThanOrderingId service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListGroupsOlderThanOrderingId service method, as returned by Kendra.
///
/// 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 inconsistences with your resources
/// and try again.
///
///
/// An issue occurred with the internal server used for your Amazon Kendra 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for ListGroupsOlderThanOrderingId Operation
Task ListGroupsOlderThanOrderingIdAsync(ListGroupsOlderThanOrderingIdRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListIndices
///
/// Lists the Amazon Kendra indexes that you created.
///
/// Container for the necessary parameters to execute the ListIndices service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListIndices service method, as returned by Kendra.
///
/// 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 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for ListIndices Operation
Task ListIndicesAsync(ListIndicesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListQuerySuggestionsBlockLists
///
/// Lists the block lists used for query suggestions for an index.
///
///
///
/// For information on the current quota limits for block lists, see Quotas
/// for Amazon Kendra.
///
///
///
/// ListQuerySuggestionsBlockLists
is currently not supported in the Amazon
/// Web Services GovCloud (US-West) region.
///
///
/// Container for the necessary parameters to execute the ListQuerySuggestionsBlockLists service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListQuerySuggestionsBlockLists service method, as returned by Kendra.
///
/// 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 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for ListQuerySuggestionsBlockLists Operation
Task ListQuerySuggestionsBlockListsAsync(ListQuerySuggestionsBlockListsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListTagsForResource
///
/// Gets a list of tags associated with a specified resource. Indexes, FAQs, and data
/// sources can have tags associated with them.
///
/// Container for the necessary parameters to execute the ListTagsForResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListTagsForResource service method, as returned by Kendra.
///
/// 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 service. Please
/// wait a few minutes and try again, or contact Support
/// for help.
///
///
/// The resource you want to use isn't available. 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for ListTagsForResource Operation
Task ListTagsForResourceAsync(ListTagsForResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListThesauri
///
/// Lists the thesauri for an index.
///
/// Container for the necessary parameters to execute the ListThesauri service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListThesauri service method, as returned by Kendra.
///
/// 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 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for ListThesauri Operation
Task ListThesauriAsync(ListThesauriRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region PutPrincipalMapping
///
/// Maps users to their groups so that you only need to provide the user ID when you issue
/// the query.
///
///
///
/// You can also map sub groups to groups. For example, the group "Company Intellectual
/// Property Teams" includes sub groups "Research" and "Engineering". These sub groups
/// include their own list of users or people who work in these teams. Only users who
/// work in research and engineering, and therefore belong in the intellectual property
/// group, can see top-secret company documents in their search results.
///
///
///
/// This is useful for user context filtering, where search results are filtered based
/// on the user or their group access to documents. For more information, see Filtering
/// on user context.
///
///
///
/// If more than five PUT
actions for a group are currently processing, a
/// validation exception is thrown.
///
///
/// Container for the necessary parameters to execute the PutPrincipalMapping service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the PutPrincipalMapping service method, as returned by Kendra.
///
/// 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 inconsistences with your resources
/// and try again.
///
///
/// An issue occurred with the internal server used for your Amazon Kendra 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 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for PutPrincipalMapping Operation
Task PutPrincipalMappingAsync(PutPrincipalMappingRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region Query
///
/// Searches an index given an input query.
///
///
///
/// You can configure boosting or relevance tuning at the query level to override boosting
/// at the index level, filter based on document fields/attributes and faceted search,
/// and filter based on the user or their group access to documents. You can also include
/// certain fields in the response that might provide useful additional information.
///
///
///
/// A query response contains three types of results.
///
/// -
///
/// Relevant suggested answers. The answers can be either a text excerpt or table excerpt.
/// The answer can be highlighted in the excerpt.
///
///
-
///
/// Matching FAQs or questions-answer from your FAQ file.
///
///
-
///
/// Relevant documents. This result type includes an excerpt of the document with the
/// document title. The searched terms can be highlighted in the excerpt.
///
///
///
/// You can specify that the query return only one type of result using the QueryResultTypeFilter
/// parameter. Each query returns the 100 most relevant results. If you filter result
/// type to only question-answers, a maximum of four results are returned. If you filter
/// result type to only answers, a maximum of three results are returned.
///
///
/// Container for the necessary parameters to execute the Query service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the Query service method, as returned by Kendra.
///
/// 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 inconsistences with your resources
/// and try again.
///
///
/// An issue occurred with the internal server used for your Amazon Kendra 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 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for Query Operation
Task QueryAsync(QueryRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region Retrieve
///
/// Retrieves relevant passages or text excerpts given an input query.
///
///
///
/// This API is similar to the Query
/// API. However, by default, the Query
API only returns excerpt passages
/// of up to 100 token words. With the Retrieve
API, you can retrieve longer
/// passages of up to 200 token words and up to 100 semantically relevant passages. This
/// doesn't include question-answer or FAQ type responses from your index. The passages
/// are text excerpts that can be semantically extracted from multiple documents and multiple
/// parts of the same document. If in extreme cases your documents produce no relevant
/// passages using the Retrieve
API, you can alternatively use the Query
/// API.
///
///
///
/// You can also do the following:
///
/// -
///
/// Override boosting at the index level
///
///
-
///
/// Filter based on document fields or attributes
///
///
-
///
/// Filter based on the user or their group access to documents
///
///
///
/// You can also include certain fields in the response that might provide useful additional
/// information.
///
///
/// Container for the necessary parameters to execute the Retrieve service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the Retrieve service method, as returned by Kendra.
///
/// 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 inconsistences with your resources
/// and try again.
///
///
/// An issue occurred with the internal server used for your Amazon Kendra 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 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for Retrieve Operation
Task RetrieveAsync(RetrieveRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region StartDataSourceSyncJob
///
/// Starts a synchronization job for a data source connector. If a synchronization job
/// is already in progress, Amazon Kendra returns a ResourceInUseException
/// exception.
///
/// Container for the necessary parameters to execute the StartDataSourceSyncJob service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the StartDataSourceSyncJob service method, as returned by Kendra.
///
/// 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 inconsistences with your resources
/// and try again.
///
///
/// An issue occurred with the internal server used for your Amazon Kendra service. Please
/// wait a few minutes and try again, or contact Support
/// for help.
///
///
/// The resource you want to use is currently in use. Please check you have provided the
/// correct resource and try again.
///
///
/// 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for StartDataSourceSyncJob Operation
Task StartDataSourceSyncJobAsync(StartDataSourceSyncJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region StopDataSourceSyncJob
///
/// Stops a synchronization job that is currently running. You can't stop a scheduled
/// synchronization job.
///
/// Container for the necessary parameters to execute the StopDataSourceSyncJob service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the StopDataSourceSyncJob service method, as returned by Kendra.
///
/// 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 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for StopDataSourceSyncJob Operation
Task StopDataSourceSyncJobAsync(StopDataSourceSyncJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region SubmitFeedback
///
/// Enables you to provide feedback to Amazon Kendra to improve the performance of your
/// index.
///
///
///
/// SubmitFeedback
is currently not supported in the Amazon Web Services
/// GovCloud (US-West) region.
///
///
/// Container for the necessary parameters to execute the SubmitFeedback service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the SubmitFeedback service method, as returned by Kendra.
///
/// 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 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 resource you want to use isn't available. 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for SubmitFeedback Operation
Task SubmitFeedbackAsync(SubmitFeedbackRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region TagResource
///
/// Adds the specified tag to the specified index, FAQ, or data source resource. 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the TagResource service method, as returned by Kendra.
///
/// 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 service. Please
/// wait a few minutes and try again, or contact Support
/// for help.
///
///
/// The resource you want to use isn't available. 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for TagResource Operation
Task TagResourceAsync(TagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UntagResource
///
/// Removes a tag from an index, FAQ, or a data source.
///
/// Container for the necessary parameters to execute the UntagResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UntagResource service method, as returned by Kendra.
///
/// 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 service. Please
/// wait a few minutes and try again, or contact Support
/// for help.
///
///
/// The resource you want to use isn't available. 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for UntagResource Operation
Task UntagResourceAsync(UntagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdateAccessControlConfiguration
///
/// Updates an access control configuration for your documents in an index. This includes
/// user and group access information for your documents. This is useful for user context
/// filtering, where search results are filtered based on the user or their group access
/// to documents.
///
///
///
/// You can update an access control configuration you created without indexing all of
/// your documents again. For example, your index contains top-secret company documents
/// that only certain employees or users should access. You created an 'allow' access
/// control configuration for one user who recently joined the 'top-secret' team, switching
/// from a team with 'deny' access to top-secret documents. However, the user suddenly
/// returns to their previous team and should no longer have access to top secret documents.
/// You can update the access control configuration to re-configure access control for
/// your documents as circumstances change.
///
///
///
/// You call the BatchPutDocument
/// API to apply the updated access control configuration, with the AccessControlConfigurationId
/// included in the Document
/// object. If you use an S3 bucket as a data source, you synchronize your data source
/// to apply the AccessControlConfigurationId
in the .metadata.json
/// file. Amazon Kendra currently only supports access control configuration for S3 data
/// sources and documents indexed using the BatchPutDocument
API.
///
///
/// Container for the necessary parameters to execute the UpdateAccessControlConfiguration service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdateAccessControlConfiguration service method, as returned by Kendra.
///
/// 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 inconsistences with your resources
/// and try again.
///
///
/// An issue occurred with the internal server used for your Amazon Kendra 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 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for UpdateAccessControlConfiguration Operation
Task UpdateAccessControlConfigurationAsync(UpdateAccessControlConfigurationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdateDataSource
///
/// Updates an existing Amazon Kendra data source connector.
///
/// Container for the necessary parameters to execute the UpdateDataSource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdateDataSource service method, as returned by Kendra.
///
/// 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 inconsistences with your resources
/// and try again.
///
///
/// An issue occurred with the internal server used for your Amazon Kendra 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for UpdateDataSource Operation
Task UpdateDataSourceAsync(UpdateDataSourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdateExperience
///
/// Updates your Amazon Kendra experience such as a search application. For more information
/// on creating a search application experience, see Building
/// a search experience with no code.
///
/// Container for the necessary parameters to execute the UpdateExperience service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdateExperience service method, as returned by Kendra.
///
/// 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 inconsistences with your resources
/// and try again.
///
///
/// An issue occurred with the internal server used for your Amazon Kendra 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for UpdateExperience Operation
Task UpdateExperienceAsync(UpdateExperienceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdateFeaturedResultsSet
///
/// Updates a set of featured results. Features results are placed above all other results
/// for certain queries. You map specific queries to specific documents for featuring
/// in the results. If a query contains an exact match of a query, then one or more specific
/// documents are featured in the search results.
///
/// Container for the necessary parameters to execute the UpdateFeaturedResultsSet service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdateFeaturedResultsSet service method, as returned by Kendra.
///
/// 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 error message with a list of conflicting queries used across different sets of
/// featured results. This occurred with the request for a new featured results set. Check
/// that the queries you specified for featured results are unique per featured results
/// set for each index.
///
///
/// An issue occurred with the internal server used for your Amazon Kendra 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for UpdateFeaturedResultsSet Operation
Task UpdateFeaturedResultsSetAsync(UpdateFeaturedResultsSetRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdateIndex
///
/// Updates an existing Amazon Kendra index.
///
/// Container for the necessary parameters to execute the UpdateIndex service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdateIndex service method, as returned by Kendra.
///
/// 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 inconsistences with your resources
/// and try again.
///
///
/// An issue occurred with the internal server used for your Amazon Kendra 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 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for UpdateIndex Operation
Task UpdateIndexAsync(UpdateIndexRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdateQuerySuggestionsBlockList
///
/// Updates a block list used for query suggestions for an index.
///
///
///
/// Updates to a block list might not take effect right away. Amazon Kendra needs to refresh
/// the entire suggestions list to apply any updates to the block list. Other changes
/// not related to the block list apply immediately.
///
///
///
/// If a block list is updating, then you need to wait for the first update to finish
/// before submitting another update.
///
///
///
/// Amazon Kendra supports partial updates, so you only need to provide the fields you
/// want to update.
///
///
///
/// UpdateQuerySuggestionsBlockList
is currently not supported in the Amazon
/// Web Services GovCloud (US-West) region.
///
///
/// Container for the necessary parameters to execute the UpdateQuerySuggestionsBlockList service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdateQuerySuggestionsBlockList service method, as returned by Kendra.
///
/// 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 inconsistences with your resources
/// and try again.
///
///
/// An issue occurred with the internal server used for your Amazon Kendra 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for UpdateQuerySuggestionsBlockList Operation
Task UpdateQuerySuggestionsBlockListAsync(UpdateQuerySuggestionsBlockListRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdateQuerySuggestionsConfig
///
/// Updates the settings of query suggestions for an index.
///
///
///
/// Amazon Kendra supports partial updates, so you only need to provide the fields you
/// want to update.
///
///
///
/// If an update is currently processing, you need to wait for the update to finish before
/// making another update.
///
///
///
/// Updates to query suggestions settings might not take effect right away. The time for
/// your updated settings to take effect depends on the updates made and the number of
/// search queries in your index.
///
///
///
/// You can still enable/disable query suggestions at any time.
///
///
///
/// UpdateQuerySuggestionsConfig
is currently not supported in the Amazon
/// Web Services GovCloud (US-West) region.
///
///
/// Container for the necessary parameters to execute the UpdateQuerySuggestionsConfig service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdateQuerySuggestionsConfig service method, as returned by Kendra.
///
/// 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 inconsistences with your resources
/// and try again.
///
///
/// An issue occurred with the internal server used for your Amazon Kendra 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for UpdateQuerySuggestionsConfig Operation
Task UpdateQuerySuggestionsConfigAsync(UpdateQuerySuggestionsConfigRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdateThesaurus
///
/// Updates a thesaurus for an index.
///
/// Container for the necessary parameters to execute the UpdateThesaurus service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdateThesaurus service method, as returned by Kendra.
///
/// 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 inconsistences with your resources
/// and try again.
///
///
/// An issue occurred with the internal server used for your Amazon Kendra 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 service. Please
/// provide the correct input and try again.
///
/// REST API Reference for UpdateThesaurus Operation
Task UpdateThesaurusAsync(UpdateThesaurusRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
}
}