/*
* 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 comprehend-2017-11-27.normal.json service model.
*/
using System;
using System.Collections.Generic;
using Amazon.Runtime;
using Amazon.Comprehend.Model;
namespace Amazon.Comprehend
{
///
/// Interface for accessing Comprehend
///
/// Amazon Comprehend is an Amazon Web Services service for gaining insight into the content
/// of documents. Use these actions to determine the topics contained in your documents,
/// the topics they discuss, the predominant sentiment expressed in them, the predominant
/// language used, and more.
///
public partial interface IAmazonComprehend : IAmazonService, IDisposable
{
#if BCL45 || AWS_ASYNC_ENUMERABLES_API
///
/// Paginators for the service
///
IComprehendPaginatorFactory Paginators { get; }
#endif
#region BatchDetectDominantLanguage
///
/// Determines the dominant language of the input text for a batch of documents. For a
/// list of languages that Amazon Comprehend can detect, see Amazon
/// Comprehend Supported Languages.
///
/// Container for the necessary parameters to execute the BatchDetectDominantLanguage service method.
///
/// The response from the BatchDetectDominantLanguage service method, as returned by Comprehend.
///
/// The number of documents in the request exceeds the limit of 25. Try your request again
/// with fewer documents.
///
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The size of the input text exceeds the limit. Use a smaller document.
///
/// REST API Reference for BatchDetectDominantLanguage Operation
BatchDetectDominantLanguageResponse BatchDetectDominantLanguage(BatchDetectDominantLanguageRequest request);
///
/// Initiates the asynchronous execution of the BatchDetectDominantLanguage operation.
///
///
/// Container for the necessary parameters to execute the BatchDetectDominantLanguage operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndBatchDetectDominantLanguage
/// operation.
/// REST API Reference for BatchDetectDominantLanguage Operation
IAsyncResult BeginBatchDetectDominantLanguage(BatchDetectDominantLanguageRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the BatchDetectDominantLanguage operation.
///
///
/// The IAsyncResult returned by the call to BeginBatchDetectDominantLanguage.
///
/// Returns a BatchDetectDominantLanguageResult from Comprehend.
/// REST API Reference for BatchDetectDominantLanguage Operation
BatchDetectDominantLanguageResponse EndBatchDetectDominantLanguage(IAsyncResult asyncResult);
#endregion
#region BatchDetectEntities
///
/// Inspects the text of a batch of documents for named entities and returns information
/// about them. For more information about named entities, see Entities
/// in the Comprehend Developer Guide.
///
/// Container for the necessary parameters to execute the BatchDetectEntities service method.
///
/// The response from the BatchDetectEntities service method, as returned by Comprehend.
///
/// The number of documents in the request exceeds the limit of 25. Try your request again
/// with fewer documents.
///
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The size of the input text exceeds the limit. Use a smaller document.
///
///
/// Amazon Comprehend can't process the language of the input text. For custom entity
/// recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are
/// accepted. For a list of supported languages, Supported
/// languages in the Comprehend Developer Guide.
///
/// REST API Reference for BatchDetectEntities Operation
BatchDetectEntitiesResponse BatchDetectEntities(BatchDetectEntitiesRequest request);
///
/// Initiates the asynchronous execution of the BatchDetectEntities operation.
///
///
/// Container for the necessary parameters to execute the BatchDetectEntities operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndBatchDetectEntities
/// operation.
/// REST API Reference for BatchDetectEntities Operation
IAsyncResult BeginBatchDetectEntities(BatchDetectEntitiesRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the BatchDetectEntities operation.
///
///
/// The IAsyncResult returned by the call to BeginBatchDetectEntities.
///
/// Returns a BatchDetectEntitiesResult from Comprehend.
/// REST API Reference for BatchDetectEntities Operation
BatchDetectEntitiesResponse EndBatchDetectEntities(IAsyncResult asyncResult);
#endregion
#region BatchDetectKeyPhrases
///
/// Detects the key noun phrases found in a batch of documents.
///
/// Container for the necessary parameters to execute the BatchDetectKeyPhrases service method.
///
/// The response from the BatchDetectKeyPhrases service method, as returned by Comprehend.
///
/// The number of documents in the request exceeds the limit of 25. Try your request again
/// with fewer documents.
///
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The size of the input text exceeds the limit. Use a smaller document.
///
///
/// Amazon Comprehend can't process the language of the input text. For custom entity
/// recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are
/// accepted. For a list of supported languages, Supported
/// languages in the Comprehend Developer Guide.
///
/// REST API Reference for BatchDetectKeyPhrases Operation
BatchDetectKeyPhrasesResponse BatchDetectKeyPhrases(BatchDetectKeyPhrasesRequest request);
///
/// Initiates the asynchronous execution of the BatchDetectKeyPhrases operation.
///
///
/// Container for the necessary parameters to execute the BatchDetectKeyPhrases operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndBatchDetectKeyPhrases
/// operation.
/// REST API Reference for BatchDetectKeyPhrases Operation
IAsyncResult BeginBatchDetectKeyPhrases(BatchDetectKeyPhrasesRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the BatchDetectKeyPhrases operation.
///
///
/// The IAsyncResult returned by the call to BeginBatchDetectKeyPhrases.
///
/// Returns a BatchDetectKeyPhrasesResult from Comprehend.
/// REST API Reference for BatchDetectKeyPhrases Operation
BatchDetectKeyPhrasesResponse EndBatchDetectKeyPhrases(IAsyncResult asyncResult);
#endregion
#region BatchDetectSentiment
///
/// Inspects a batch of documents and returns an inference of the prevailing sentiment,
/// POSITIVE
, NEUTRAL
, MIXED
, or NEGATIVE
,
/// in each one.
///
/// Container for the necessary parameters to execute the BatchDetectSentiment service method.
///
/// The response from the BatchDetectSentiment service method, as returned by Comprehend.
///
/// The number of documents in the request exceeds the limit of 25. Try your request again
/// with fewer documents.
///
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The size of the input text exceeds the limit. Use a smaller document.
///
///
/// Amazon Comprehend can't process the language of the input text. For custom entity
/// recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are
/// accepted. For a list of supported languages, Supported
/// languages in the Comprehend Developer Guide.
///
/// REST API Reference for BatchDetectSentiment Operation
BatchDetectSentimentResponse BatchDetectSentiment(BatchDetectSentimentRequest request);
///
/// Initiates the asynchronous execution of the BatchDetectSentiment operation.
///
///
/// Container for the necessary parameters to execute the BatchDetectSentiment operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndBatchDetectSentiment
/// operation.
/// REST API Reference for BatchDetectSentiment Operation
IAsyncResult BeginBatchDetectSentiment(BatchDetectSentimentRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the BatchDetectSentiment operation.
///
///
/// The IAsyncResult returned by the call to BeginBatchDetectSentiment.
///
/// Returns a BatchDetectSentimentResult from Comprehend.
/// REST API Reference for BatchDetectSentiment Operation
BatchDetectSentimentResponse EndBatchDetectSentiment(IAsyncResult asyncResult);
#endregion
#region BatchDetectSyntax
///
/// Inspects the text of a batch of documents for the syntax and part of speech of the
/// words in the document and returns information about them. For more information, see
/// Syntax
/// in the Comprehend Developer Guide.
///
/// Container for the necessary parameters to execute the BatchDetectSyntax service method.
///
/// The response from the BatchDetectSyntax service method, as returned by Comprehend.
///
/// The number of documents in the request exceeds the limit of 25. Try your request again
/// with fewer documents.
///
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The size of the input text exceeds the limit. Use a smaller document.
///
///
/// Amazon Comprehend can't process the language of the input text. For custom entity
/// recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are
/// accepted. For a list of supported languages, Supported
/// languages in the Comprehend Developer Guide.
///
/// REST API Reference for BatchDetectSyntax Operation
BatchDetectSyntaxResponse BatchDetectSyntax(BatchDetectSyntaxRequest request);
///
/// Initiates the asynchronous execution of the BatchDetectSyntax operation.
///
///
/// Container for the necessary parameters to execute the BatchDetectSyntax operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndBatchDetectSyntax
/// operation.
/// REST API Reference for BatchDetectSyntax Operation
IAsyncResult BeginBatchDetectSyntax(BatchDetectSyntaxRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the BatchDetectSyntax operation.
///
///
/// The IAsyncResult returned by the call to BeginBatchDetectSyntax.
///
/// Returns a BatchDetectSyntaxResult from Comprehend.
/// REST API Reference for BatchDetectSyntax Operation
BatchDetectSyntaxResponse EndBatchDetectSyntax(IAsyncResult asyncResult);
#endregion
#region BatchDetectTargetedSentiment
///
/// Inspects a batch of documents and returns a sentiment analysis for each entity identified
/// in the documents.
///
///
///
/// For more information about targeted sentiment, see Targeted
/// sentiment.
///
///
/// Container for the necessary parameters to execute the BatchDetectTargetedSentiment service method.
///
/// The response from the BatchDetectTargetedSentiment service method, as returned by Comprehend.
///
/// The number of documents in the request exceeds the limit of 25. Try your request again
/// with fewer documents.
///
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The size of the input text exceeds the limit. Use a smaller document.
///
///
/// Amazon Comprehend can't process the language of the input text. For custom entity
/// recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are
/// accepted. For a list of supported languages, Supported
/// languages in the Comprehend Developer Guide.
///
/// REST API Reference for BatchDetectTargetedSentiment Operation
BatchDetectTargetedSentimentResponse BatchDetectTargetedSentiment(BatchDetectTargetedSentimentRequest request);
///
/// Initiates the asynchronous execution of the BatchDetectTargetedSentiment operation.
///
///
/// Container for the necessary parameters to execute the BatchDetectTargetedSentiment operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndBatchDetectTargetedSentiment
/// operation.
/// REST API Reference for BatchDetectTargetedSentiment Operation
IAsyncResult BeginBatchDetectTargetedSentiment(BatchDetectTargetedSentimentRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the BatchDetectTargetedSentiment operation.
///
///
/// The IAsyncResult returned by the call to BeginBatchDetectTargetedSentiment.
///
/// Returns a BatchDetectTargetedSentimentResult from Comprehend.
/// REST API Reference for BatchDetectTargetedSentiment Operation
BatchDetectTargetedSentimentResponse EndBatchDetectTargetedSentiment(IAsyncResult asyncResult);
#endregion
#region ClassifyDocument
///
/// Creates a new document classification request to analyze a single document in real-time,
/// using a previously created and trained custom model and an endpoint.
///
///
///
/// You can input plain text or you can upload a single-page input document (text, PDF,
/// Word, or image).
///
///
///
/// If the system detects errors while processing a page in the input document, the API
/// response includes an entry in Errors
that describes the errors.
///
///
///
/// If the system detects a document-level error in your input document, the API returns
/// an InvalidRequestException
error response. For details about this exception,
/// see
/// Errors in semi-structured documents in the Comprehend Developer Guide.
///
///
/// Container for the necessary parameters to execute the ClassifyDocument service method.
///
/// The response from the ClassifyDocument service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The specified resource is not available. Check the resource and try your request again.
///
///
/// The size of the input text exceeds the limit. Use a smaller document.
///
/// REST API Reference for ClassifyDocument Operation
ClassifyDocumentResponse ClassifyDocument(ClassifyDocumentRequest request);
///
/// Initiates the asynchronous execution of the ClassifyDocument operation.
///
///
/// Container for the necessary parameters to execute the ClassifyDocument operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndClassifyDocument
/// operation.
/// REST API Reference for ClassifyDocument Operation
IAsyncResult BeginClassifyDocument(ClassifyDocumentRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ClassifyDocument operation.
///
///
/// The IAsyncResult returned by the call to BeginClassifyDocument.
///
/// Returns a ClassifyDocumentResult from Comprehend.
/// REST API Reference for ClassifyDocument Operation
ClassifyDocumentResponse EndClassifyDocument(IAsyncResult asyncResult);
#endregion
#region ContainsPiiEntities
///
/// Analyzes input text for the presence of personally identifiable information (PII)
/// and returns the labels of identified PII entity types such as name, address, bank
/// account number, or phone number.
///
/// Container for the necessary parameters to execute the ContainsPiiEntities service method.
///
/// The response from the ContainsPiiEntities service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The size of the input text exceeds the limit. Use a smaller document.
///
///
/// Amazon Comprehend can't process the language of the input text. For custom entity
/// recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are
/// accepted. For a list of supported languages, Supported
/// languages in the Comprehend Developer Guide.
///
/// REST API Reference for ContainsPiiEntities Operation
ContainsPiiEntitiesResponse ContainsPiiEntities(ContainsPiiEntitiesRequest request);
///
/// Initiates the asynchronous execution of the ContainsPiiEntities operation.
///
///
/// Container for the necessary parameters to execute the ContainsPiiEntities operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndContainsPiiEntities
/// operation.
/// REST API Reference for ContainsPiiEntities Operation
IAsyncResult BeginContainsPiiEntities(ContainsPiiEntitiesRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ContainsPiiEntities operation.
///
///
/// The IAsyncResult returned by the call to BeginContainsPiiEntities.
///
/// Returns a ContainsPiiEntitiesResult from Comprehend.
/// REST API Reference for ContainsPiiEntities Operation
ContainsPiiEntitiesResponse EndContainsPiiEntities(IAsyncResult asyncResult);
#endregion
#region CreateDataset
///
/// Creates a dataset to upload training or test data for a model associated with a flywheel.
/// For more information about datasets, see
/// Flywheel overview in the Amazon Comprehend Developer Guide.
///
/// Container for the necessary parameters to execute the CreateDataset service method.
///
/// The response from the CreateDataset service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The specified resource name is already in use. Use a different name and try your request
/// again.
///
///
/// The maximum number of resources per account has been exceeded. Review the resources,
/// and then try your request again.
///
///
/// The specified resource ARN was not found. Check the ARN and try your request again.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
///
/// The request contains more tags than can be associated with a resource (50 tags per
/// resource). The maximum number of tags includes both existing tags and those included
/// in your current request.
///
/// REST API Reference for CreateDataset Operation
CreateDatasetResponse CreateDataset(CreateDatasetRequest request);
///
/// Initiates the asynchronous execution of the CreateDataset operation.
///
///
/// Container for the necessary parameters to execute the CreateDataset operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateDataset
/// operation.
/// REST API Reference for CreateDataset Operation
IAsyncResult BeginCreateDataset(CreateDatasetRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the CreateDataset operation.
///
///
/// The IAsyncResult returned by the call to BeginCreateDataset.
///
/// Returns a CreateDatasetResult from Comprehend.
/// REST API Reference for CreateDataset Operation
CreateDatasetResponse EndCreateDataset(IAsyncResult asyncResult);
#endregion
#region CreateDocumentClassifier
///
/// Creates a new document classifier that you can use to categorize documents. To create
/// a classifier, you provide a set of training documents that are labeled with the categories
/// that you want to use. For more information, see Training
/// classifier models in the Comprehend Developer Guide.
///
/// Container for the necessary parameters to execute the CreateDocumentClassifier service method.
///
/// The response from the CreateDocumentClassifier service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The KMS customer managed key (CMK) entered cannot be validated. Verify the key and
/// re-enter it.
///
///
/// The specified resource name is already in use. Use a different name and try your request
/// again.
///
///
/// The maximum number of resources per account has been exceeded. Review the resources,
/// and then try your request again.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
///
/// The request contains more tags than can be associated with a resource (50 tags per
/// resource). The maximum number of tags includes both existing tags and those included
/// in your current request.
///
///
/// Amazon Comprehend can't process the language of the input text. For custom entity
/// recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are
/// accepted. For a list of supported languages, Supported
/// languages in the Comprehend Developer Guide.
///
/// REST API Reference for CreateDocumentClassifier Operation
CreateDocumentClassifierResponse CreateDocumentClassifier(CreateDocumentClassifierRequest request);
///
/// Initiates the asynchronous execution of the CreateDocumentClassifier operation.
///
///
/// Container for the necessary parameters to execute the CreateDocumentClassifier operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateDocumentClassifier
/// operation.
/// REST API Reference for CreateDocumentClassifier Operation
IAsyncResult BeginCreateDocumentClassifier(CreateDocumentClassifierRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the CreateDocumentClassifier operation.
///
///
/// The IAsyncResult returned by the call to BeginCreateDocumentClassifier.
///
/// Returns a CreateDocumentClassifierResult from Comprehend.
/// REST API Reference for CreateDocumentClassifier Operation
CreateDocumentClassifierResponse EndCreateDocumentClassifier(IAsyncResult asyncResult);
#endregion
#region CreateEndpoint
///
/// Creates a model-specific endpoint for synchronous inference for a previously trained
/// custom model For information about endpoints, see Managing
/// endpoints.
///
/// Container for the necessary parameters to execute the CreateEndpoint service method.
///
/// The response from the CreateEndpoint service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The specified resource name is already in use. Use a different name and try your request
/// again.
///
///
/// The maximum number of resources per account has been exceeded. Review the resources,
/// and then try your request again.
///
///
/// The specified resource ARN was not found. Check the ARN and try your request again.
///
///
/// The specified resource is not available. Check the resource and try your request again.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
///
/// The request contains more tags than can be associated with a resource (50 tags per
/// resource). The maximum number of tags includes both existing tags and those included
/// in your current request.
///
/// REST API Reference for CreateEndpoint Operation
CreateEndpointResponse CreateEndpoint(CreateEndpointRequest request);
///
/// Initiates the asynchronous execution of the CreateEndpoint operation.
///
///
/// Container for the necessary parameters to execute the CreateEndpoint operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateEndpoint
/// operation.
/// REST API Reference for CreateEndpoint Operation
IAsyncResult BeginCreateEndpoint(CreateEndpointRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the CreateEndpoint operation.
///
///
/// The IAsyncResult returned by the call to BeginCreateEndpoint.
///
/// Returns a CreateEndpointResult from Comprehend.
/// REST API Reference for CreateEndpoint Operation
CreateEndpointResponse EndCreateEndpoint(IAsyncResult asyncResult);
#endregion
#region CreateEntityRecognizer
///
/// Creates an entity recognizer using submitted files. After your CreateEntityRecognizer
/// request is submitted, you can check job status using the DescribeEntityRecognizer
/// API.
///
/// Container for the necessary parameters to execute the CreateEntityRecognizer service method.
///
/// The response from the CreateEntityRecognizer service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The KMS customer managed key (CMK) entered cannot be validated. Verify the key and
/// re-enter it.
///
///
/// The specified resource name is already in use. Use a different name and try your request
/// again.
///
///
/// The maximum number of resources per account has been exceeded. Review the resources,
/// and then try your request again.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
///
/// The request contains more tags than can be associated with a resource (50 tags per
/// resource). The maximum number of tags includes both existing tags and those included
/// in your current request.
///
///
/// Amazon Comprehend can't process the language of the input text. For custom entity
/// recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are
/// accepted. For a list of supported languages, Supported
/// languages in the Comprehend Developer Guide.
///
/// REST API Reference for CreateEntityRecognizer Operation
CreateEntityRecognizerResponse CreateEntityRecognizer(CreateEntityRecognizerRequest request);
///
/// Initiates the asynchronous execution of the CreateEntityRecognizer operation.
///
///
/// Container for the necessary parameters to execute the CreateEntityRecognizer operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateEntityRecognizer
/// operation.
/// REST API Reference for CreateEntityRecognizer Operation
IAsyncResult BeginCreateEntityRecognizer(CreateEntityRecognizerRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the CreateEntityRecognizer operation.
///
///
/// The IAsyncResult returned by the call to BeginCreateEntityRecognizer.
///
/// Returns a CreateEntityRecognizerResult from Comprehend.
/// REST API Reference for CreateEntityRecognizer Operation
CreateEntityRecognizerResponse EndCreateEntityRecognizer(IAsyncResult asyncResult);
#endregion
#region CreateFlywheel
///
/// A flywheel is an Amazon Web Services resource that orchestrates the ongoing training
/// of a model for custom classification or custom entity recognition. You can create
/// a flywheel to start with an existing trained model, or Comprehend can create and train
/// a new model.
///
///
///
/// When you create the flywheel, Comprehend creates a data lake in your account. The
/// data lake holds the training data and test data for all versions of the model.
///
///
///
/// To use a flywheel with an existing trained model, you specify the active model version.
/// Comprehend copies the model's training data and test data into the flywheel's data
/// lake.
///
///
///
/// To use the flywheel with a new model, you need to provide a dataset for training data
/// (and optional test data) when you create the flywheel.
///
///
///
/// For more information about flywheels, see
/// Flywheel overview in the Amazon Comprehend Developer Guide.
///
///
/// Container for the necessary parameters to execute the CreateFlywheel service method.
///
/// The response from the CreateFlywheel service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The KMS customer managed key (CMK) entered cannot be validated. Verify the key and
/// re-enter it.
///
///
/// The specified resource name is already in use. Use a different name and try your request
/// again.
///
///
/// The maximum number of resources per account has been exceeded. Review the resources,
/// and then try your request again.
///
///
/// The specified resource ARN was not found. Check the ARN and try your request again.
///
///
/// The specified resource is not available. Check the resource and try your request again.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
///
/// The request contains more tags than can be associated with a resource (50 tags per
/// resource). The maximum number of tags includes both existing tags and those included
/// in your current request.
///
///
/// Amazon Comprehend can't process the language of the input text. For custom entity
/// recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are
/// accepted. For a list of supported languages, Supported
/// languages in the Comprehend Developer Guide.
///
/// REST API Reference for CreateFlywheel Operation
CreateFlywheelResponse CreateFlywheel(CreateFlywheelRequest request);
///
/// Initiates the asynchronous execution of the CreateFlywheel operation.
///
///
/// Container for the necessary parameters to execute the CreateFlywheel operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateFlywheel
/// operation.
/// REST API Reference for CreateFlywheel Operation
IAsyncResult BeginCreateFlywheel(CreateFlywheelRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the CreateFlywheel operation.
///
///
/// The IAsyncResult returned by the call to BeginCreateFlywheel.
///
/// Returns a CreateFlywheelResult from Comprehend.
/// REST API Reference for CreateFlywheel Operation
CreateFlywheelResponse EndCreateFlywheel(IAsyncResult asyncResult);
#endregion
#region DeleteDocumentClassifier
///
/// Deletes a previously created document classifier
///
///
///
/// Only those classifiers that are in terminated states (IN_ERROR, TRAINED) will be deleted.
/// If an active inference job is using the model, a ResourceInUseException
/// will be returned.
///
///
///
/// This is an asynchronous action that puts the classifier into a DELETING state, and
/// it is then removed by a background job. Once removed, the classifier disappears from
/// your account and is no longer available for use.
///
///
/// Container for the necessary parameters to execute the DeleteDocumentClassifier service method.
///
/// The response from the DeleteDocumentClassifier service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The specified resource name is already in use. Use a different name and try your request
/// again.
///
///
/// The specified resource ARN was not found. Check the ARN and try your request again.
///
///
/// The specified resource is not available. Check the resource and try your request again.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
/// REST API Reference for DeleteDocumentClassifier Operation
DeleteDocumentClassifierResponse DeleteDocumentClassifier(DeleteDocumentClassifierRequest request);
///
/// Initiates the asynchronous execution of the DeleteDocumentClassifier operation.
///
///
/// Container for the necessary parameters to execute the DeleteDocumentClassifier operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteDocumentClassifier
/// operation.
/// REST API Reference for DeleteDocumentClassifier Operation
IAsyncResult BeginDeleteDocumentClassifier(DeleteDocumentClassifierRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DeleteDocumentClassifier operation.
///
///
/// The IAsyncResult returned by the call to BeginDeleteDocumentClassifier.
///
/// Returns a DeleteDocumentClassifierResult from Comprehend.
/// REST API Reference for DeleteDocumentClassifier Operation
DeleteDocumentClassifierResponse EndDeleteDocumentClassifier(IAsyncResult asyncResult);
#endregion
#region DeleteEndpoint
///
/// Deletes a model-specific endpoint for a previously-trained custom model. All endpoints
/// must be deleted in order for the model to be deleted. For information about endpoints,
/// see Managing
/// endpoints.
///
/// Container for the necessary parameters to execute the DeleteEndpoint service method.
///
/// The response from the DeleteEndpoint service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The specified resource name is already in use. Use a different name and try your request
/// again.
///
///
/// The specified resource ARN was not found. Check the ARN and try your request again.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
/// REST API Reference for DeleteEndpoint Operation
DeleteEndpointResponse DeleteEndpoint(DeleteEndpointRequest request);
///
/// Initiates the asynchronous execution of the DeleteEndpoint operation.
///
///
/// Container for the necessary parameters to execute the DeleteEndpoint operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteEndpoint
/// operation.
/// REST API Reference for DeleteEndpoint Operation
IAsyncResult BeginDeleteEndpoint(DeleteEndpointRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DeleteEndpoint operation.
///
///
/// The IAsyncResult returned by the call to BeginDeleteEndpoint.
///
/// Returns a DeleteEndpointResult from Comprehend.
/// REST API Reference for DeleteEndpoint Operation
DeleteEndpointResponse EndDeleteEndpoint(IAsyncResult asyncResult);
#endregion
#region DeleteEntityRecognizer
///
/// Deletes an entity recognizer.
///
///
///
/// Only those recognizers that are in terminated states (IN_ERROR, TRAINED) will be deleted.
/// If an active inference job is using the model, a ResourceInUseException
/// will be returned.
///
///
///
/// This is an asynchronous action that puts the recognizer into a DELETING state, and
/// it is then removed by a background job. Once removed, the recognizer disappears from
/// your account and is no longer available for use.
///
///
/// Container for the necessary parameters to execute the DeleteEntityRecognizer service method.
///
/// The response from the DeleteEntityRecognizer service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The specified resource name is already in use. Use a different name and try your request
/// again.
///
///
/// The specified resource ARN was not found. Check the ARN and try your request again.
///
///
/// The specified resource is not available. Check the resource and try your request again.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
/// REST API Reference for DeleteEntityRecognizer Operation
DeleteEntityRecognizerResponse DeleteEntityRecognizer(DeleteEntityRecognizerRequest request);
///
/// Initiates the asynchronous execution of the DeleteEntityRecognizer operation.
///
///
/// Container for the necessary parameters to execute the DeleteEntityRecognizer operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteEntityRecognizer
/// operation.
/// REST API Reference for DeleteEntityRecognizer Operation
IAsyncResult BeginDeleteEntityRecognizer(DeleteEntityRecognizerRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DeleteEntityRecognizer operation.
///
///
/// The IAsyncResult returned by the call to BeginDeleteEntityRecognizer.
///
/// Returns a DeleteEntityRecognizerResult from Comprehend.
/// REST API Reference for DeleteEntityRecognizer Operation
DeleteEntityRecognizerResponse EndDeleteEntityRecognizer(IAsyncResult asyncResult);
#endregion
#region DeleteFlywheel
///
/// Deletes a flywheel. When you delete the flywheel, Amazon Comprehend does not delete
/// the data lake or the model associated with the flywheel.
///
///
///
/// For more information about flywheels, see
/// Flywheel overview in the Amazon Comprehend Developer Guide.
///
///
/// Container for the necessary parameters to execute the DeleteFlywheel service method.
///
/// The response from the DeleteFlywheel service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The specified resource name is already in use. Use a different name and try your request
/// again.
///
///
/// The specified resource ARN was not found. Check the ARN and try your request again.
///
///
/// The specified resource is not available. Check the resource and try your request again.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
/// REST API Reference for DeleteFlywheel Operation
DeleteFlywheelResponse DeleteFlywheel(DeleteFlywheelRequest request);
///
/// Initiates the asynchronous execution of the DeleteFlywheel operation.
///
///
/// Container for the necessary parameters to execute the DeleteFlywheel operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteFlywheel
/// operation.
/// REST API Reference for DeleteFlywheel Operation
IAsyncResult BeginDeleteFlywheel(DeleteFlywheelRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DeleteFlywheel operation.
///
///
/// The IAsyncResult returned by the call to BeginDeleteFlywheel.
///
/// Returns a DeleteFlywheelResult from Comprehend.
/// REST API Reference for DeleteFlywheel Operation
DeleteFlywheelResponse EndDeleteFlywheel(IAsyncResult asyncResult);
#endregion
#region DeleteResourcePolicy
///
/// Deletes a resource-based policy that is attached to a custom model.
///
/// Container for the necessary parameters to execute the DeleteResourcePolicy service method.
///
/// The response from the DeleteResourcePolicy service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The specified resource ARN was not found. Check the ARN and try your request again.
///
/// REST API Reference for DeleteResourcePolicy Operation
DeleteResourcePolicyResponse DeleteResourcePolicy(DeleteResourcePolicyRequest request);
///
/// Initiates the asynchronous execution of the DeleteResourcePolicy operation.
///
///
/// Container for the necessary parameters to execute the DeleteResourcePolicy operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteResourcePolicy
/// operation.
/// REST API Reference for DeleteResourcePolicy Operation
IAsyncResult BeginDeleteResourcePolicy(DeleteResourcePolicyRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DeleteResourcePolicy operation.
///
///
/// The IAsyncResult returned by the call to BeginDeleteResourcePolicy.
///
/// Returns a DeleteResourcePolicyResult from Comprehend.
/// REST API Reference for DeleteResourcePolicy Operation
DeleteResourcePolicyResponse EndDeleteResourcePolicy(IAsyncResult asyncResult);
#endregion
#region DescribeDataset
///
/// Returns information about the dataset that you specify. For more information about
/// datasets, see
/// Flywheel overview in the Amazon Comprehend Developer Guide.
///
/// Container for the necessary parameters to execute the DescribeDataset service method.
///
/// The response from the DescribeDataset service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The specified resource ARN was not found. Check the ARN and try your request again.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
/// REST API Reference for DescribeDataset Operation
DescribeDatasetResponse DescribeDataset(DescribeDatasetRequest request);
///
/// Initiates the asynchronous execution of the DescribeDataset operation.
///
///
/// Container for the necessary parameters to execute the DescribeDataset operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeDataset
/// operation.
/// REST API Reference for DescribeDataset Operation
IAsyncResult BeginDescribeDataset(DescribeDatasetRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DescribeDataset operation.
///
///
/// The IAsyncResult returned by the call to BeginDescribeDataset.
///
/// Returns a DescribeDatasetResult from Comprehend.
/// REST API Reference for DescribeDataset Operation
DescribeDatasetResponse EndDescribeDataset(IAsyncResult asyncResult);
#endregion
#region DescribeDocumentClassificationJob
///
/// Gets the properties associated with a document classification job. Use this operation
/// to get the status of a classification job.
///
/// Container for the necessary parameters to execute the DescribeDocumentClassificationJob service method.
///
/// The response from the DescribeDocumentClassificationJob service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The specified job was not found. Check the job ID and try again.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
/// REST API Reference for DescribeDocumentClassificationJob Operation
DescribeDocumentClassificationJobResponse DescribeDocumentClassificationJob(DescribeDocumentClassificationJobRequest request);
///
/// Initiates the asynchronous execution of the DescribeDocumentClassificationJob operation.
///
///
/// Container for the necessary parameters to execute the DescribeDocumentClassificationJob operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeDocumentClassificationJob
/// operation.
/// REST API Reference for DescribeDocumentClassificationJob Operation
IAsyncResult BeginDescribeDocumentClassificationJob(DescribeDocumentClassificationJobRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DescribeDocumentClassificationJob operation.
///
///
/// The IAsyncResult returned by the call to BeginDescribeDocumentClassificationJob.
///
/// Returns a DescribeDocumentClassificationJobResult from Comprehend.
/// REST API Reference for DescribeDocumentClassificationJob Operation
DescribeDocumentClassificationJobResponse EndDescribeDocumentClassificationJob(IAsyncResult asyncResult);
#endregion
#region DescribeDocumentClassifier
///
/// Gets the properties associated with a document classifier.
///
/// Container for the necessary parameters to execute the DescribeDocumentClassifier service method.
///
/// The response from the DescribeDocumentClassifier service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The specified resource ARN was not found. Check the ARN and try your request again.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
/// REST API Reference for DescribeDocumentClassifier Operation
DescribeDocumentClassifierResponse DescribeDocumentClassifier(DescribeDocumentClassifierRequest request);
///
/// Initiates the asynchronous execution of the DescribeDocumentClassifier operation.
///
///
/// Container for the necessary parameters to execute the DescribeDocumentClassifier operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeDocumentClassifier
/// operation.
/// REST API Reference for DescribeDocumentClassifier Operation
IAsyncResult BeginDescribeDocumentClassifier(DescribeDocumentClassifierRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DescribeDocumentClassifier operation.
///
///
/// The IAsyncResult returned by the call to BeginDescribeDocumentClassifier.
///
/// Returns a DescribeDocumentClassifierResult from Comprehend.
/// REST API Reference for DescribeDocumentClassifier Operation
DescribeDocumentClassifierResponse EndDescribeDocumentClassifier(IAsyncResult asyncResult);
#endregion
#region DescribeDominantLanguageDetectionJob
///
/// Gets the properties associated with a dominant language detection job. Use this operation
/// to get the status of a detection job.
///
/// Container for the necessary parameters to execute the DescribeDominantLanguageDetectionJob service method.
///
/// The response from the DescribeDominantLanguageDetectionJob service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The specified job was not found. Check the job ID and try again.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
/// REST API Reference for DescribeDominantLanguageDetectionJob Operation
DescribeDominantLanguageDetectionJobResponse DescribeDominantLanguageDetectionJob(DescribeDominantLanguageDetectionJobRequest request);
///
/// Initiates the asynchronous execution of the DescribeDominantLanguageDetectionJob operation.
///
///
/// Container for the necessary parameters to execute the DescribeDominantLanguageDetectionJob operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeDominantLanguageDetectionJob
/// operation.
/// REST API Reference for DescribeDominantLanguageDetectionJob Operation
IAsyncResult BeginDescribeDominantLanguageDetectionJob(DescribeDominantLanguageDetectionJobRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DescribeDominantLanguageDetectionJob operation.
///
///
/// The IAsyncResult returned by the call to BeginDescribeDominantLanguageDetectionJob.
///
/// Returns a DescribeDominantLanguageDetectionJobResult from Comprehend.
/// REST API Reference for DescribeDominantLanguageDetectionJob Operation
DescribeDominantLanguageDetectionJobResponse EndDescribeDominantLanguageDetectionJob(IAsyncResult asyncResult);
#endregion
#region DescribeEndpoint
///
/// Gets the properties associated with a specific endpoint. Use this operation to get
/// the status of an endpoint. For information about endpoints, see Managing
/// endpoints.
///
/// Container for the necessary parameters to execute the DescribeEndpoint service method.
///
/// The response from the DescribeEndpoint service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The specified resource ARN was not found. Check the ARN and try your request again.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
/// REST API Reference for DescribeEndpoint Operation
DescribeEndpointResponse DescribeEndpoint(DescribeEndpointRequest request);
///
/// Initiates the asynchronous execution of the DescribeEndpoint operation.
///
///
/// Container for the necessary parameters to execute the DescribeEndpoint operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeEndpoint
/// operation.
/// REST API Reference for DescribeEndpoint Operation
IAsyncResult BeginDescribeEndpoint(DescribeEndpointRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DescribeEndpoint operation.
///
///
/// The IAsyncResult returned by the call to BeginDescribeEndpoint.
///
/// Returns a DescribeEndpointResult from Comprehend.
/// REST API Reference for DescribeEndpoint Operation
DescribeEndpointResponse EndDescribeEndpoint(IAsyncResult asyncResult);
#endregion
#region DescribeEntitiesDetectionJob
///
/// Gets the properties associated with an entities detection job. Use this operation
/// to get the status of a detection job.
///
/// Container for the necessary parameters to execute the DescribeEntitiesDetectionJob service method.
///
/// The response from the DescribeEntitiesDetectionJob service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The specified job was not found. Check the job ID and try again.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
/// REST API Reference for DescribeEntitiesDetectionJob Operation
DescribeEntitiesDetectionJobResponse DescribeEntitiesDetectionJob(DescribeEntitiesDetectionJobRequest request);
///
/// Initiates the asynchronous execution of the DescribeEntitiesDetectionJob operation.
///
///
/// Container for the necessary parameters to execute the DescribeEntitiesDetectionJob operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeEntitiesDetectionJob
/// operation.
/// REST API Reference for DescribeEntitiesDetectionJob Operation
IAsyncResult BeginDescribeEntitiesDetectionJob(DescribeEntitiesDetectionJobRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DescribeEntitiesDetectionJob operation.
///
///
/// The IAsyncResult returned by the call to BeginDescribeEntitiesDetectionJob.
///
/// Returns a DescribeEntitiesDetectionJobResult from Comprehend.
/// REST API Reference for DescribeEntitiesDetectionJob Operation
DescribeEntitiesDetectionJobResponse EndDescribeEntitiesDetectionJob(IAsyncResult asyncResult);
#endregion
#region DescribeEntityRecognizer
///
/// Provides details about an entity recognizer including status, S3 buckets containing
/// training data, recognizer metadata, metrics, and so on.
///
/// Container for the necessary parameters to execute the DescribeEntityRecognizer service method.
///
/// The response from the DescribeEntityRecognizer service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The specified resource ARN was not found. Check the ARN and try your request again.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
/// REST API Reference for DescribeEntityRecognizer Operation
DescribeEntityRecognizerResponse DescribeEntityRecognizer(DescribeEntityRecognizerRequest request);
///
/// Initiates the asynchronous execution of the DescribeEntityRecognizer operation.
///
///
/// Container for the necessary parameters to execute the DescribeEntityRecognizer operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeEntityRecognizer
/// operation.
/// REST API Reference for DescribeEntityRecognizer Operation
IAsyncResult BeginDescribeEntityRecognizer(DescribeEntityRecognizerRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DescribeEntityRecognizer operation.
///
///
/// The IAsyncResult returned by the call to BeginDescribeEntityRecognizer.
///
/// Returns a DescribeEntityRecognizerResult from Comprehend.
/// REST API Reference for DescribeEntityRecognizer Operation
DescribeEntityRecognizerResponse EndDescribeEntityRecognizer(IAsyncResult asyncResult);
#endregion
#region DescribeEventsDetectionJob
///
/// Gets the status and details of an events detection job.
///
/// Container for the necessary parameters to execute the DescribeEventsDetectionJob service method.
///
/// The response from the DescribeEventsDetectionJob service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The specified job was not found. Check the job ID and try again.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
/// REST API Reference for DescribeEventsDetectionJob Operation
DescribeEventsDetectionJobResponse DescribeEventsDetectionJob(DescribeEventsDetectionJobRequest request);
///
/// Initiates the asynchronous execution of the DescribeEventsDetectionJob operation.
///
///
/// Container for the necessary parameters to execute the DescribeEventsDetectionJob operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeEventsDetectionJob
/// operation.
/// REST API Reference for DescribeEventsDetectionJob Operation
IAsyncResult BeginDescribeEventsDetectionJob(DescribeEventsDetectionJobRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DescribeEventsDetectionJob operation.
///
///
/// The IAsyncResult returned by the call to BeginDescribeEventsDetectionJob.
///
/// Returns a DescribeEventsDetectionJobResult from Comprehend.
/// REST API Reference for DescribeEventsDetectionJob Operation
DescribeEventsDetectionJobResponse EndDescribeEventsDetectionJob(IAsyncResult asyncResult);
#endregion
#region DescribeFlywheel
///
/// Provides configuration information about the flywheel. For more information about
/// flywheels, see
/// Flywheel overview in the Amazon Comprehend Developer Guide.
///
/// Container for the necessary parameters to execute the DescribeFlywheel service method.
///
/// The response from the DescribeFlywheel service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The specified resource ARN was not found. Check the ARN and try your request again.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
/// REST API Reference for DescribeFlywheel Operation
DescribeFlywheelResponse DescribeFlywheel(DescribeFlywheelRequest request);
///
/// Initiates the asynchronous execution of the DescribeFlywheel operation.
///
///
/// Container for the necessary parameters to execute the DescribeFlywheel operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeFlywheel
/// operation.
/// REST API Reference for DescribeFlywheel Operation
IAsyncResult BeginDescribeFlywheel(DescribeFlywheelRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DescribeFlywheel operation.
///
///
/// The IAsyncResult returned by the call to BeginDescribeFlywheel.
///
/// Returns a DescribeFlywheelResult from Comprehend.
/// REST API Reference for DescribeFlywheel Operation
DescribeFlywheelResponse EndDescribeFlywheel(IAsyncResult asyncResult);
#endregion
#region DescribeFlywheelIteration
///
/// Retrieve the configuration properties of a flywheel iteration. For more information
/// about flywheels, see
/// Flywheel overview in the Amazon Comprehend Developer Guide.
///
/// Container for the necessary parameters to execute the DescribeFlywheelIteration service method.
///
/// The response from the DescribeFlywheelIteration service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The specified resource ARN was not found. Check the ARN and try your request again.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
/// REST API Reference for DescribeFlywheelIteration Operation
DescribeFlywheelIterationResponse DescribeFlywheelIteration(DescribeFlywheelIterationRequest request);
///
/// Initiates the asynchronous execution of the DescribeFlywheelIteration operation.
///
///
/// Container for the necessary parameters to execute the DescribeFlywheelIteration operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeFlywheelIteration
/// operation.
/// REST API Reference for DescribeFlywheelIteration Operation
IAsyncResult BeginDescribeFlywheelIteration(DescribeFlywheelIterationRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DescribeFlywheelIteration operation.
///
///
/// The IAsyncResult returned by the call to BeginDescribeFlywheelIteration.
///
/// Returns a DescribeFlywheelIterationResult from Comprehend.
/// REST API Reference for DescribeFlywheelIteration Operation
DescribeFlywheelIterationResponse EndDescribeFlywheelIteration(IAsyncResult asyncResult);
#endregion
#region DescribeKeyPhrasesDetectionJob
///
/// Gets the properties associated with a key phrases detection job. Use this operation
/// to get the status of a detection job.
///
/// Container for the necessary parameters to execute the DescribeKeyPhrasesDetectionJob service method.
///
/// The response from the DescribeKeyPhrasesDetectionJob service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The specified job was not found. Check the job ID and try again.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
/// REST API Reference for DescribeKeyPhrasesDetectionJob Operation
DescribeKeyPhrasesDetectionJobResponse DescribeKeyPhrasesDetectionJob(DescribeKeyPhrasesDetectionJobRequest request);
///
/// Initiates the asynchronous execution of the DescribeKeyPhrasesDetectionJob operation.
///
///
/// Container for the necessary parameters to execute the DescribeKeyPhrasesDetectionJob operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeKeyPhrasesDetectionJob
/// operation.
/// REST API Reference for DescribeKeyPhrasesDetectionJob Operation
IAsyncResult BeginDescribeKeyPhrasesDetectionJob(DescribeKeyPhrasesDetectionJobRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DescribeKeyPhrasesDetectionJob operation.
///
///
/// The IAsyncResult returned by the call to BeginDescribeKeyPhrasesDetectionJob.
///
/// Returns a DescribeKeyPhrasesDetectionJobResult from Comprehend.
/// REST API Reference for DescribeKeyPhrasesDetectionJob Operation
DescribeKeyPhrasesDetectionJobResponse EndDescribeKeyPhrasesDetectionJob(IAsyncResult asyncResult);
#endregion
#region DescribePiiEntitiesDetectionJob
///
/// Gets the properties associated with a PII entities detection job. For example, you
/// can use this operation to get the job status.
///
/// Container for the necessary parameters to execute the DescribePiiEntitiesDetectionJob service method.
///
/// The response from the DescribePiiEntitiesDetectionJob service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The specified job was not found. Check the job ID and try again.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
/// REST API Reference for DescribePiiEntitiesDetectionJob Operation
DescribePiiEntitiesDetectionJobResponse DescribePiiEntitiesDetectionJob(DescribePiiEntitiesDetectionJobRequest request);
///
/// Initiates the asynchronous execution of the DescribePiiEntitiesDetectionJob operation.
///
///
/// Container for the necessary parameters to execute the DescribePiiEntitiesDetectionJob operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribePiiEntitiesDetectionJob
/// operation.
/// REST API Reference for DescribePiiEntitiesDetectionJob Operation
IAsyncResult BeginDescribePiiEntitiesDetectionJob(DescribePiiEntitiesDetectionJobRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DescribePiiEntitiesDetectionJob operation.
///
///
/// The IAsyncResult returned by the call to BeginDescribePiiEntitiesDetectionJob.
///
/// Returns a DescribePiiEntitiesDetectionJobResult from Comprehend.
/// REST API Reference for DescribePiiEntitiesDetectionJob Operation
DescribePiiEntitiesDetectionJobResponse EndDescribePiiEntitiesDetectionJob(IAsyncResult asyncResult);
#endregion
#region DescribeResourcePolicy
///
/// Gets the details of a resource-based policy that is attached to a custom model, including
/// the JSON body of the policy.
///
/// Container for the necessary parameters to execute the DescribeResourcePolicy service method.
///
/// The response from the DescribeResourcePolicy service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The specified resource ARN was not found. Check the ARN and try your request again.
///
/// REST API Reference for DescribeResourcePolicy Operation
DescribeResourcePolicyResponse DescribeResourcePolicy(DescribeResourcePolicyRequest request);
///
/// Initiates the asynchronous execution of the DescribeResourcePolicy operation.
///
///
/// Container for the necessary parameters to execute the DescribeResourcePolicy operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeResourcePolicy
/// operation.
/// REST API Reference for DescribeResourcePolicy Operation
IAsyncResult BeginDescribeResourcePolicy(DescribeResourcePolicyRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DescribeResourcePolicy operation.
///
///
/// The IAsyncResult returned by the call to BeginDescribeResourcePolicy.
///
/// Returns a DescribeResourcePolicyResult from Comprehend.
/// REST API Reference for DescribeResourcePolicy Operation
DescribeResourcePolicyResponse EndDescribeResourcePolicy(IAsyncResult asyncResult);
#endregion
#region DescribeSentimentDetectionJob
///
/// Gets the properties associated with a sentiment detection job. Use this operation
/// to get the status of a detection job.
///
/// Container for the necessary parameters to execute the DescribeSentimentDetectionJob service method.
///
/// The response from the DescribeSentimentDetectionJob service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The specified job was not found. Check the job ID and try again.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
/// REST API Reference for DescribeSentimentDetectionJob Operation
DescribeSentimentDetectionJobResponse DescribeSentimentDetectionJob(DescribeSentimentDetectionJobRequest request);
///
/// Initiates the asynchronous execution of the DescribeSentimentDetectionJob operation.
///
///
/// Container for the necessary parameters to execute the DescribeSentimentDetectionJob operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeSentimentDetectionJob
/// operation.
/// REST API Reference for DescribeSentimentDetectionJob Operation
IAsyncResult BeginDescribeSentimentDetectionJob(DescribeSentimentDetectionJobRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DescribeSentimentDetectionJob operation.
///
///
/// The IAsyncResult returned by the call to BeginDescribeSentimentDetectionJob.
///
/// Returns a DescribeSentimentDetectionJobResult from Comprehend.
/// REST API Reference for DescribeSentimentDetectionJob Operation
DescribeSentimentDetectionJobResponse EndDescribeSentimentDetectionJob(IAsyncResult asyncResult);
#endregion
#region DescribeTargetedSentimentDetectionJob
///
/// Gets the properties associated with a targeted sentiment detection job. Use this operation
/// to get the status of the job.
///
/// Container for the necessary parameters to execute the DescribeTargetedSentimentDetectionJob service method.
///
/// The response from the DescribeTargetedSentimentDetectionJob service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The specified job was not found. Check the job ID and try again.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
/// REST API Reference for DescribeTargetedSentimentDetectionJob Operation
DescribeTargetedSentimentDetectionJobResponse DescribeTargetedSentimentDetectionJob(DescribeTargetedSentimentDetectionJobRequest request);
///
/// Initiates the asynchronous execution of the DescribeTargetedSentimentDetectionJob operation.
///
///
/// Container for the necessary parameters to execute the DescribeTargetedSentimentDetectionJob operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeTargetedSentimentDetectionJob
/// operation.
/// REST API Reference for DescribeTargetedSentimentDetectionJob Operation
IAsyncResult BeginDescribeTargetedSentimentDetectionJob(DescribeTargetedSentimentDetectionJobRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DescribeTargetedSentimentDetectionJob operation.
///
///
/// The IAsyncResult returned by the call to BeginDescribeTargetedSentimentDetectionJob.
///
/// Returns a DescribeTargetedSentimentDetectionJobResult from Comprehend.
/// REST API Reference for DescribeTargetedSentimentDetectionJob Operation
DescribeTargetedSentimentDetectionJobResponse EndDescribeTargetedSentimentDetectionJob(IAsyncResult asyncResult);
#endregion
#region DescribeTopicsDetectionJob
///
/// Gets the properties associated with a topic detection job. Use this operation to get
/// the status of a detection job.
///
/// Container for the necessary parameters to execute the DescribeTopicsDetectionJob service method.
///
/// The response from the DescribeTopicsDetectionJob service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The specified job was not found. Check the job ID and try again.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
/// REST API Reference for DescribeTopicsDetectionJob Operation
DescribeTopicsDetectionJobResponse DescribeTopicsDetectionJob(DescribeTopicsDetectionJobRequest request);
///
/// Initiates the asynchronous execution of the DescribeTopicsDetectionJob operation.
///
///
/// Container for the necessary parameters to execute the DescribeTopicsDetectionJob operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeTopicsDetectionJob
/// operation.
/// REST API Reference for DescribeTopicsDetectionJob Operation
IAsyncResult BeginDescribeTopicsDetectionJob(DescribeTopicsDetectionJobRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DescribeTopicsDetectionJob operation.
///
///
/// The IAsyncResult returned by the call to BeginDescribeTopicsDetectionJob.
///
/// Returns a DescribeTopicsDetectionJobResult from Comprehend.
/// REST API Reference for DescribeTopicsDetectionJob Operation
DescribeTopicsDetectionJobResponse EndDescribeTopicsDetectionJob(IAsyncResult asyncResult);
#endregion
#region DetectDominantLanguage
///
/// Determines the dominant language of the input text. For a list of languages that Amazon
/// Comprehend can detect, see Amazon
/// Comprehend Supported Languages.
///
/// Container for the necessary parameters to execute the DetectDominantLanguage service method.
///
/// The response from the DetectDominantLanguage service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The size of the input text exceeds the limit. Use a smaller document.
///
/// REST API Reference for DetectDominantLanguage Operation
DetectDominantLanguageResponse DetectDominantLanguage(DetectDominantLanguageRequest request);
///
/// Initiates the asynchronous execution of the DetectDominantLanguage operation.
///
///
/// Container for the necessary parameters to execute the DetectDominantLanguage operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDetectDominantLanguage
/// operation.
/// REST API Reference for DetectDominantLanguage Operation
IAsyncResult BeginDetectDominantLanguage(DetectDominantLanguageRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DetectDominantLanguage operation.
///
///
/// The IAsyncResult returned by the call to BeginDetectDominantLanguage.
///
/// Returns a DetectDominantLanguageResult from Comprehend.
/// REST API Reference for DetectDominantLanguage Operation
DetectDominantLanguageResponse EndDetectDominantLanguage(IAsyncResult asyncResult);
#endregion
#region DetectEntities
///
/// Detects named entities in input text when you use the pre-trained model. Detects custom
/// entities if you have a custom entity recognition model.
///
///
///
/// When detecting named entities using the pre-trained model, use plain text as the
/// input. For more information about named entities, see Entities
/// in the Comprehend Developer Guide.
///
///
///
/// When you use a custom entity recognition model, you can input plain text or you can
/// upload a single-page input document (text, PDF, Word, or image).
///
///
///
/// If the system detects errors while processing a page in the input document, the API
/// response includes an entry in Errors
for each error.
///
///
///
/// If the system detects a document-level error in your input document, the API returns
/// an InvalidRequestException
error response. For details about this exception,
/// see
/// Errors in semi-structured documents in the Comprehend Developer Guide.
///
///
/// Container for the necessary parameters to execute the DetectEntities service method.
///
/// The response from the DetectEntities service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The specified resource is not available. Check the resource and try your request again.
///
///
/// The size of the input text exceeds the limit. Use a smaller document.
///
///
/// Amazon Comprehend can't process the language of the input text. For custom entity
/// recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are
/// accepted. For a list of supported languages, Supported
/// languages in the Comprehend Developer Guide.
///
/// REST API Reference for DetectEntities Operation
DetectEntitiesResponse DetectEntities(DetectEntitiesRequest request);
///
/// Initiates the asynchronous execution of the DetectEntities operation.
///
///
/// Container for the necessary parameters to execute the DetectEntities operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDetectEntities
/// operation.
/// REST API Reference for DetectEntities Operation
IAsyncResult BeginDetectEntities(DetectEntitiesRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DetectEntities operation.
///
///
/// The IAsyncResult returned by the call to BeginDetectEntities.
///
/// Returns a DetectEntitiesResult from Comprehend.
/// REST API Reference for DetectEntities Operation
DetectEntitiesResponse EndDetectEntities(IAsyncResult asyncResult);
#endregion
#region DetectKeyPhrases
///
/// Detects the key noun phrases found in the text.
///
/// Container for the necessary parameters to execute the DetectKeyPhrases service method.
///
/// The response from the DetectKeyPhrases service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The size of the input text exceeds the limit. Use a smaller document.
///
///
/// Amazon Comprehend can't process the language of the input text. For custom entity
/// recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are
/// accepted. For a list of supported languages, Supported
/// languages in the Comprehend Developer Guide.
///
/// REST API Reference for DetectKeyPhrases Operation
DetectKeyPhrasesResponse DetectKeyPhrases(DetectKeyPhrasesRequest request);
///
/// Initiates the asynchronous execution of the DetectKeyPhrases operation.
///
///
/// Container for the necessary parameters to execute the DetectKeyPhrases operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDetectKeyPhrases
/// operation.
/// REST API Reference for DetectKeyPhrases Operation
IAsyncResult BeginDetectKeyPhrases(DetectKeyPhrasesRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DetectKeyPhrases operation.
///
///
/// The IAsyncResult returned by the call to BeginDetectKeyPhrases.
///
/// Returns a DetectKeyPhrasesResult from Comprehend.
/// REST API Reference for DetectKeyPhrases Operation
DetectKeyPhrasesResponse EndDetectKeyPhrases(IAsyncResult asyncResult);
#endregion
#region DetectPiiEntities
///
/// Inspects the input text for entities that contain personally identifiable information
/// (PII) and returns information about them.
///
/// Container for the necessary parameters to execute the DetectPiiEntities service method.
///
/// The response from the DetectPiiEntities service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The size of the input text exceeds the limit. Use a smaller document.
///
///
/// Amazon Comprehend can't process the language of the input text. For custom entity
/// recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are
/// accepted. For a list of supported languages, Supported
/// languages in the Comprehend Developer Guide.
///
/// REST API Reference for DetectPiiEntities Operation
DetectPiiEntitiesResponse DetectPiiEntities(DetectPiiEntitiesRequest request);
///
/// Initiates the asynchronous execution of the DetectPiiEntities operation.
///
///
/// Container for the necessary parameters to execute the DetectPiiEntities operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDetectPiiEntities
/// operation.
/// REST API Reference for DetectPiiEntities Operation
IAsyncResult BeginDetectPiiEntities(DetectPiiEntitiesRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DetectPiiEntities operation.
///
///
/// The IAsyncResult returned by the call to BeginDetectPiiEntities.
///
/// Returns a DetectPiiEntitiesResult from Comprehend.
/// REST API Reference for DetectPiiEntities Operation
DetectPiiEntitiesResponse EndDetectPiiEntities(IAsyncResult asyncResult);
#endregion
#region DetectSentiment
///
/// Inspects text and returns an inference of the prevailing sentiment (POSITIVE
,
/// NEUTRAL
, MIXED
, or NEGATIVE
).
///
/// Container for the necessary parameters to execute the DetectSentiment service method.
///
/// The response from the DetectSentiment service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The size of the input text exceeds the limit. Use a smaller document.
///
///
/// Amazon Comprehend can't process the language of the input text. For custom entity
/// recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are
/// accepted. For a list of supported languages, Supported
/// languages in the Comprehend Developer Guide.
///
/// REST API Reference for DetectSentiment Operation
DetectSentimentResponse DetectSentiment(DetectSentimentRequest request);
///
/// Initiates the asynchronous execution of the DetectSentiment operation.
///
///
/// Container for the necessary parameters to execute the DetectSentiment operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDetectSentiment
/// operation.
/// REST API Reference for DetectSentiment Operation
IAsyncResult BeginDetectSentiment(DetectSentimentRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DetectSentiment operation.
///
///
/// The IAsyncResult returned by the call to BeginDetectSentiment.
///
/// Returns a DetectSentimentResult from Comprehend.
/// REST API Reference for DetectSentiment Operation
DetectSentimentResponse EndDetectSentiment(IAsyncResult asyncResult);
#endregion
#region DetectSyntax
///
/// Inspects text for syntax and the part of speech of words in the document. For more
/// information, see Syntax
/// in the Comprehend Developer Guide.
///
/// Container for the necessary parameters to execute the DetectSyntax service method.
///
/// The response from the DetectSyntax service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The size of the input text exceeds the limit. Use a smaller document.
///
///
/// Amazon Comprehend can't process the language of the input text. For custom entity
/// recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are
/// accepted. For a list of supported languages, Supported
/// languages in the Comprehend Developer Guide.
///
/// REST API Reference for DetectSyntax Operation
DetectSyntaxResponse DetectSyntax(DetectSyntaxRequest request);
///
/// Initiates the asynchronous execution of the DetectSyntax operation.
///
///
/// Container for the necessary parameters to execute the DetectSyntax operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDetectSyntax
/// operation.
/// REST API Reference for DetectSyntax Operation
IAsyncResult BeginDetectSyntax(DetectSyntaxRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DetectSyntax operation.
///
///
/// The IAsyncResult returned by the call to BeginDetectSyntax.
///
/// Returns a DetectSyntaxResult from Comprehend.
/// REST API Reference for DetectSyntax Operation
DetectSyntaxResponse EndDetectSyntax(IAsyncResult asyncResult);
#endregion
#region DetectTargetedSentiment
///
/// Inspects the input text and returns a sentiment analysis for each entity identified
/// in the text.
///
///
///
/// For more information about targeted sentiment, see Targeted
/// sentiment.
///
///
/// Container for the necessary parameters to execute the DetectTargetedSentiment service method.
///
/// The response from the DetectTargetedSentiment service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The size of the input text exceeds the limit. Use a smaller document.
///
///
/// Amazon Comprehend can't process the language of the input text. For custom entity
/// recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are
/// accepted. For a list of supported languages, Supported
/// languages in the Comprehend Developer Guide.
///
/// REST API Reference for DetectTargetedSentiment Operation
DetectTargetedSentimentResponse DetectTargetedSentiment(DetectTargetedSentimentRequest request);
///
/// Initiates the asynchronous execution of the DetectTargetedSentiment operation.
///
///
/// Container for the necessary parameters to execute the DetectTargetedSentiment operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDetectTargetedSentiment
/// operation.
/// REST API Reference for DetectTargetedSentiment Operation
IAsyncResult BeginDetectTargetedSentiment(DetectTargetedSentimentRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DetectTargetedSentiment operation.
///
///
/// The IAsyncResult returned by the call to BeginDetectTargetedSentiment.
///
/// Returns a DetectTargetedSentimentResult from Comprehend.
/// REST API Reference for DetectTargetedSentiment Operation
DetectTargetedSentimentResponse EndDetectTargetedSentiment(IAsyncResult asyncResult);
#endregion
#region ImportModel
///
/// Creates a new custom model that replicates a source custom model that you import.
/// The source model can be in your Amazon Web Services account or another one.
///
///
///
/// If the source model is in another Amazon Web Services account, then it must have a
/// resource-based policy that authorizes you to import it.
///
///
///
/// The source model must be in the same Amazon Web Services Region that you're using
/// when you import. You can't import a model that's in a different Region.
///
///
/// Container for the necessary parameters to execute the ImportModel service method.
///
/// The response from the ImportModel service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The KMS customer managed key (CMK) entered cannot be validated. Verify the key and
/// re-enter it.
///
///
/// The specified resource name is already in use. Use a different name and try your request
/// again.
///
///
/// The maximum number of resources per account has been exceeded. Review the resources,
/// and then try your request again.
///
///
/// The specified resource ARN was not found. Check the ARN and try your request again.
///
///
/// The specified resource is not available. Check the resource and try your request again.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
///
/// The request contains more tags than can be associated with a resource (50 tags per
/// resource). The maximum number of tags includes both existing tags and those included
/// in your current request.
///
/// REST API Reference for ImportModel Operation
ImportModelResponse ImportModel(ImportModelRequest request);
///
/// Initiates the asynchronous execution of the ImportModel operation.
///
///
/// Container for the necessary parameters to execute the ImportModel operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndImportModel
/// operation.
/// REST API Reference for ImportModel Operation
IAsyncResult BeginImportModel(ImportModelRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ImportModel operation.
///
///
/// The IAsyncResult returned by the call to BeginImportModel.
///
/// Returns a ImportModelResult from Comprehend.
/// REST API Reference for ImportModel Operation
ImportModelResponse EndImportModel(IAsyncResult asyncResult);
#endregion
#region ListDatasets
///
/// List the datasets that you have configured in this Region. For more information about
/// datasets, see
/// Flywheel overview in the Amazon Comprehend Developer Guide.
///
/// Container for the necessary parameters to execute the ListDatasets service method.
///
/// The response from the ListDatasets service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The filter specified for the operation is invalid. Specify a different filter.
///
///
/// The request is invalid.
///
///
/// The specified resource ARN was not found. Check the ARN and try your request again.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
/// REST API Reference for ListDatasets Operation
ListDatasetsResponse ListDatasets(ListDatasetsRequest request);
///
/// Initiates the asynchronous execution of the ListDatasets operation.
///
///
/// Container for the necessary parameters to execute the ListDatasets operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListDatasets
/// operation.
/// REST API Reference for ListDatasets Operation
IAsyncResult BeginListDatasets(ListDatasetsRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ListDatasets operation.
///
///
/// The IAsyncResult returned by the call to BeginListDatasets.
///
/// Returns a ListDatasetsResult from Comprehend.
/// REST API Reference for ListDatasets Operation
ListDatasetsResponse EndListDatasets(IAsyncResult asyncResult);
#endregion
#region ListDocumentClassificationJobs
///
/// Gets a list of the documentation classification jobs that you have submitted.
///
/// Container for the necessary parameters to execute the ListDocumentClassificationJobs service method.
///
/// The response from the ListDocumentClassificationJobs service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The filter specified for the operation is invalid. Specify a different filter.
///
///
/// The request is invalid.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
/// REST API Reference for ListDocumentClassificationJobs Operation
ListDocumentClassificationJobsResponse ListDocumentClassificationJobs(ListDocumentClassificationJobsRequest request);
///
/// Initiates the asynchronous execution of the ListDocumentClassificationJobs operation.
///
///
/// Container for the necessary parameters to execute the ListDocumentClassificationJobs operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListDocumentClassificationJobs
/// operation.
/// REST API Reference for ListDocumentClassificationJobs Operation
IAsyncResult BeginListDocumentClassificationJobs(ListDocumentClassificationJobsRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ListDocumentClassificationJobs operation.
///
///
/// The IAsyncResult returned by the call to BeginListDocumentClassificationJobs.
///
/// Returns a ListDocumentClassificationJobsResult from Comprehend.
/// REST API Reference for ListDocumentClassificationJobs Operation
ListDocumentClassificationJobsResponse EndListDocumentClassificationJobs(IAsyncResult asyncResult);
#endregion
#region ListDocumentClassifiers
///
/// Gets a list of the document classifiers that you have created.
///
/// Container for the necessary parameters to execute the ListDocumentClassifiers service method.
///
/// The response from the ListDocumentClassifiers service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The filter specified for the operation is invalid. Specify a different filter.
///
///
/// The request is invalid.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
/// REST API Reference for ListDocumentClassifiers Operation
ListDocumentClassifiersResponse ListDocumentClassifiers(ListDocumentClassifiersRequest request);
///
/// Initiates the asynchronous execution of the ListDocumentClassifiers operation.
///
///
/// Container for the necessary parameters to execute the ListDocumentClassifiers operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListDocumentClassifiers
/// operation.
/// REST API Reference for ListDocumentClassifiers Operation
IAsyncResult BeginListDocumentClassifiers(ListDocumentClassifiersRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ListDocumentClassifiers operation.
///
///
/// The IAsyncResult returned by the call to BeginListDocumentClassifiers.
///
/// Returns a ListDocumentClassifiersResult from Comprehend.
/// REST API Reference for ListDocumentClassifiers Operation
ListDocumentClassifiersResponse EndListDocumentClassifiers(IAsyncResult asyncResult);
#endregion
#region ListDocumentClassifierSummaries
///
/// Gets a list of summaries of the document classifiers that you have created
///
/// Container for the necessary parameters to execute the ListDocumentClassifierSummaries service method.
///
/// The response from the ListDocumentClassifierSummaries service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
/// REST API Reference for ListDocumentClassifierSummaries Operation
ListDocumentClassifierSummariesResponse ListDocumentClassifierSummaries(ListDocumentClassifierSummariesRequest request);
///
/// Initiates the asynchronous execution of the ListDocumentClassifierSummaries operation.
///
///
/// Container for the necessary parameters to execute the ListDocumentClassifierSummaries operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListDocumentClassifierSummaries
/// operation.
/// REST API Reference for ListDocumentClassifierSummaries Operation
IAsyncResult BeginListDocumentClassifierSummaries(ListDocumentClassifierSummariesRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ListDocumentClassifierSummaries operation.
///
///
/// The IAsyncResult returned by the call to BeginListDocumentClassifierSummaries.
///
/// Returns a ListDocumentClassifierSummariesResult from Comprehend.
/// REST API Reference for ListDocumentClassifierSummaries Operation
ListDocumentClassifierSummariesResponse EndListDocumentClassifierSummaries(IAsyncResult asyncResult);
#endregion
#region ListDominantLanguageDetectionJobs
///
/// Gets a list of the dominant language detection jobs that you have submitted.
///
/// Container for the necessary parameters to execute the ListDominantLanguageDetectionJobs service method.
///
/// The response from the ListDominantLanguageDetectionJobs service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The filter specified for the operation is invalid. Specify a different filter.
///
///
/// The request is invalid.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
/// REST API Reference for ListDominantLanguageDetectionJobs Operation
ListDominantLanguageDetectionJobsResponse ListDominantLanguageDetectionJobs(ListDominantLanguageDetectionJobsRequest request);
///
/// Initiates the asynchronous execution of the ListDominantLanguageDetectionJobs operation.
///
///
/// Container for the necessary parameters to execute the ListDominantLanguageDetectionJobs operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListDominantLanguageDetectionJobs
/// operation.
/// REST API Reference for ListDominantLanguageDetectionJobs Operation
IAsyncResult BeginListDominantLanguageDetectionJobs(ListDominantLanguageDetectionJobsRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ListDominantLanguageDetectionJobs operation.
///
///
/// The IAsyncResult returned by the call to BeginListDominantLanguageDetectionJobs.
///
/// Returns a ListDominantLanguageDetectionJobsResult from Comprehend.
/// REST API Reference for ListDominantLanguageDetectionJobs Operation
ListDominantLanguageDetectionJobsResponse EndListDominantLanguageDetectionJobs(IAsyncResult asyncResult);
#endregion
#region ListEndpoints
///
/// Gets a list of all existing endpoints that you've created. For information about endpoints,
/// see Managing
/// endpoints.
///
/// Container for the necessary parameters to execute the ListEndpoints service method.
///
/// The response from the ListEndpoints service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
/// REST API Reference for ListEndpoints Operation
ListEndpointsResponse ListEndpoints(ListEndpointsRequest request);
///
/// Initiates the asynchronous execution of the ListEndpoints operation.
///
///
/// Container for the necessary parameters to execute the ListEndpoints operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListEndpoints
/// operation.
/// REST API Reference for ListEndpoints Operation
IAsyncResult BeginListEndpoints(ListEndpointsRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ListEndpoints operation.
///
///
/// The IAsyncResult returned by the call to BeginListEndpoints.
///
/// Returns a ListEndpointsResult from Comprehend.
/// REST API Reference for ListEndpoints Operation
ListEndpointsResponse EndListEndpoints(IAsyncResult asyncResult);
#endregion
#region ListEntitiesDetectionJobs
///
/// Gets a list of the entity detection jobs that you have submitted.
///
/// Container for the necessary parameters to execute the ListEntitiesDetectionJobs service method.
///
/// The response from the ListEntitiesDetectionJobs service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The filter specified for the operation is invalid. Specify a different filter.
///
///
/// The request is invalid.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
/// REST API Reference for ListEntitiesDetectionJobs Operation
ListEntitiesDetectionJobsResponse ListEntitiesDetectionJobs(ListEntitiesDetectionJobsRequest request);
///
/// Initiates the asynchronous execution of the ListEntitiesDetectionJobs operation.
///
///
/// Container for the necessary parameters to execute the ListEntitiesDetectionJobs operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListEntitiesDetectionJobs
/// operation.
/// REST API Reference for ListEntitiesDetectionJobs Operation
IAsyncResult BeginListEntitiesDetectionJobs(ListEntitiesDetectionJobsRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ListEntitiesDetectionJobs operation.
///
///
/// The IAsyncResult returned by the call to BeginListEntitiesDetectionJobs.
///
/// Returns a ListEntitiesDetectionJobsResult from Comprehend.
/// REST API Reference for ListEntitiesDetectionJobs Operation
ListEntitiesDetectionJobsResponse EndListEntitiesDetectionJobs(IAsyncResult asyncResult);
#endregion
#region ListEntityRecognizers
///
/// Gets a list of the properties of all entity recognizers that you created, including
/// recognizers currently in training. Allows you to filter the list of recognizers based
/// on criteria such as status and submission time. This call returns up to 500 entity
/// recognizers in the list, with a default number of 100 recognizers in the list.
///
///
///
/// The results of this list are not in any particular order. Please get the list and
/// sort locally if needed.
///
///
/// Container for the necessary parameters to execute the ListEntityRecognizers service method.
///
/// The response from the ListEntityRecognizers service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The filter specified for the operation is invalid. Specify a different filter.
///
///
/// The request is invalid.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
/// REST API Reference for ListEntityRecognizers Operation
ListEntityRecognizersResponse ListEntityRecognizers(ListEntityRecognizersRequest request);
///
/// Initiates the asynchronous execution of the ListEntityRecognizers operation.
///
///
/// Container for the necessary parameters to execute the ListEntityRecognizers operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListEntityRecognizers
/// operation.
/// REST API Reference for ListEntityRecognizers Operation
IAsyncResult BeginListEntityRecognizers(ListEntityRecognizersRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ListEntityRecognizers operation.
///
///
/// The IAsyncResult returned by the call to BeginListEntityRecognizers.
///
/// Returns a ListEntityRecognizersResult from Comprehend.
/// REST API Reference for ListEntityRecognizers Operation
ListEntityRecognizersResponse EndListEntityRecognizers(IAsyncResult asyncResult);
#endregion
#region ListEntityRecognizerSummaries
///
/// Gets a list of summaries for the entity recognizers that you have created.
///
/// Container for the necessary parameters to execute the ListEntityRecognizerSummaries service method.
///
/// The response from the ListEntityRecognizerSummaries service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
/// REST API Reference for ListEntityRecognizerSummaries Operation
ListEntityRecognizerSummariesResponse ListEntityRecognizerSummaries(ListEntityRecognizerSummariesRequest request);
///
/// Initiates the asynchronous execution of the ListEntityRecognizerSummaries operation.
///
///
/// Container for the necessary parameters to execute the ListEntityRecognizerSummaries operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListEntityRecognizerSummaries
/// operation.
/// REST API Reference for ListEntityRecognizerSummaries Operation
IAsyncResult BeginListEntityRecognizerSummaries(ListEntityRecognizerSummariesRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ListEntityRecognizerSummaries operation.
///
///
/// The IAsyncResult returned by the call to BeginListEntityRecognizerSummaries.
///
/// Returns a ListEntityRecognizerSummariesResult from Comprehend.
/// REST API Reference for ListEntityRecognizerSummaries Operation
ListEntityRecognizerSummariesResponse EndListEntityRecognizerSummaries(IAsyncResult asyncResult);
#endregion
#region ListEventsDetectionJobs
///
/// Gets a list of the events detection jobs that you have submitted.
///
/// Container for the necessary parameters to execute the ListEventsDetectionJobs service method.
///
/// The response from the ListEventsDetectionJobs service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The filter specified for the operation is invalid. Specify a different filter.
///
///
/// The request is invalid.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
/// REST API Reference for ListEventsDetectionJobs Operation
ListEventsDetectionJobsResponse ListEventsDetectionJobs(ListEventsDetectionJobsRequest request);
///
/// Initiates the asynchronous execution of the ListEventsDetectionJobs operation.
///
///
/// Container for the necessary parameters to execute the ListEventsDetectionJobs operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListEventsDetectionJobs
/// operation.
/// REST API Reference for ListEventsDetectionJobs Operation
IAsyncResult BeginListEventsDetectionJobs(ListEventsDetectionJobsRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ListEventsDetectionJobs operation.
///
///
/// The IAsyncResult returned by the call to BeginListEventsDetectionJobs.
///
/// Returns a ListEventsDetectionJobsResult from Comprehend.
/// REST API Reference for ListEventsDetectionJobs Operation
ListEventsDetectionJobsResponse EndListEventsDetectionJobs(IAsyncResult asyncResult);
#endregion
#region ListFlywheelIterationHistory
///
/// Information about the history of a flywheel iteration. For more information about
/// flywheels, see
/// Flywheel overview in the Amazon Comprehend Developer Guide.
///
/// Container for the necessary parameters to execute the ListFlywheelIterationHistory service method.
///
/// The response from the ListFlywheelIterationHistory service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The filter specified for the operation is invalid. Specify a different filter.
///
///
/// The request is invalid.
///
///
/// The specified resource ARN was not found. Check the ARN and try your request again.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
/// REST API Reference for ListFlywheelIterationHistory Operation
ListFlywheelIterationHistoryResponse ListFlywheelIterationHistory(ListFlywheelIterationHistoryRequest request);
///
/// Initiates the asynchronous execution of the ListFlywheelIterationHistory operation.
///
///
/// Container for the necessary parameters to execute the ListFlywheelIterationHistory operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListFlywheelIterationHistory
/// operation.
/// REST API Reference for ListFlywheelIterationHistory Operation
IAsyncResult BeginListFlywheelIterationHistory(ListFlywheelIterationHistoryRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ListFlywheelIterationHistory operation.
///
///
/// The IAsyncResult returned by the call to BeginListFlywheelIterationHistory.
///
/// Returns a ListFlywheelIterationHistoryResult from Comprehend.
/// REST API Reference for ListFlywheelIterationHistory Operation
ListFlywheelIterationHistoryResponse EndListFlywheelIterationHistory(IAsyncResult asyncResult);
#endregion
#region ListFlywheels
///
/// Gets a list of the flywheels that you have created.
///
/// Container for the necessary parameters to execute the ListFlywheels service method.
///
/// The response from the ListFlywheels service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The filter specified for the operation is invalid. Specify a different filter.
///
///
/// The request is invalid.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
/// REST API Reference for ListFlywheels Operation
ListFlywheelsResponse ListFlywheels(ListFlywheelsRequest request);
///
/// Initiates the asynchronous execution of the ListFlywheels operation.
///
///
/// Container for the necessary parameters to execute the ListFlywheels operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListFlywheels
/// operation.
/// REST API Reference for ListFlywheels Operation
IAsyncResult BeginListFlywheels(ListFlywheelsRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ListFlywheels operation.
///
///
/// The IAsyncResult returned by the call to BeginListFlywheels.
///
/// Returns a ListFlywheelsResult from Comprehend.
/// REST API Reference for ListFlywheels Operation
ListFlywheelsResponse EndListFlywheels(IAsyncResult asyncResult);
#endregion
#region ListKeyPhrasesDetectionJobs
///
/// Get a list of key phrase detection jobs that you have submitted.
///
/// Container for the necessary parameters to execute the ListKeyPhrasesDetectionJobs service method.
///
/// The response from the ListKeyPhrasesDetectionJobs service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The filter specified for the operation is invalid. Specify a different filter.
///
///
/// The request is invalid.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
/// REST API Reference for ListKeyPhrasesDetectionJobs Operation
ListKeyPhrasesDetectionJobsResponse ListKeyPhrasesDetectionJobs(ListKeyPhrasesDetectionJobsRequest request);
///
/// Initiates the asynchronous execution of the ListKeyPhrasesDetectionJobs operation.
///
///
/// Container for the necessary parameters to execute the ListKeyPhrasesDetectionJobs operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListKeyPhrasesDetectionJobs
/// operation.
/// REST API Reference for ListKeyPhrasesDetectionJobs Operation
IAsyncResult BeginListKeyPhrasesDetectionJobs(ListKeyPhrasesDetectionJobsRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ListKeyPhrasesDetectionJobs operation.
///
///
/// The IAsyncResult returned by the call to BeginListKeyPhrasesDetectionJobs.
///
/// Returns a ListKeyPhrasesDetectionJobsResult from Comprehend.
/// REST API Reference for ListKeyPhrasesDetectionJobs Operation
ListKeyPhrasesDetectionJobsResponse EndListKeyPhrasesDetectionJobs(IAsyncResult asyncResult);
#endregion
#region ListPiiEntitiesDetectionJobs
///
/// Gets a list of the PII entity detection jobs that you have submitted.
///
/// Container for the necessary parameters to execute the ListPiiEntitiesDetectionJobs service method.
///
/// The response from the ListPiiEntitiesDetectionJobs service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The filter specified for the operation is invalid. Specify a different filter.
///
///
/// The request is invalid.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
/// REST API Reference for ListPiiEntitiesDetectionJobs Operation
ListPiiEntitiesDetectionJobsResponse ListPiiEntitiesDetectionJobs(ListPiiEntitiesDetectionJobsRequest request);
///
/// Initiates the asynchronous execution of the ListPiiEntitiesDetectionJobs operation.
///
///
/// Container for the necessary parameters to execute the ListPiiEntitiesDetectionJobs operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListPiiEntitiesDetectionJobs
/// operation.
/// REST API Reference for ListPiiEntitiesDetectionJobs Operation
IAsyncResult BeginListPiiEntitiesDetectionJobs(ListPiiEntitiesDetectionJobsRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ListPiiEntitiesDetectionJobs operation.
///
///
/// The IAsyncResult returned by the call to BeginListPiiEntitiesDetectionJobs.
///
/// Returns a ListPiiEntitiesDetectionJobsResult from Comprehend.
/// REST API Reference for ListPiiEntitiesDetectionJobs Operation
ListPiiEntitiesDetectionJobsResponse EndListPiiEntitiesDetectionJobs(IAsyncResult asyncResult);
#endregion
#region ListSentimentDetectionJobs
///
/// Gets a list of sentiment detection jobs that you have submitted.
///
/// Container for the necessary parameters to execute the ListSentimentDetectionJobs service method.
///
/// The response from the ListSentimentDetectionJobs service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The filter specified for the operation is invalid. Specify a different filter.
///
///
/// The request is invalid.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
/// REST API Reference for ListSentimentDetectionJobs Operation
ListSentimentDetectionJobsResponse ListSentimentDetectionJobs(ListSentimentDetectionJobsRequest request);
///
/// Initiates the asynchronous execution of the ListSentimentDetectionJobs operation.
///
///
/// Container for the necessary parameters to execute the ListSentimentDetectionJobs operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListSentimentDetectionJobs
/// operation.
/// REST API Reference for ListSentimentDetectionJobs Operation
IAsyncResult BeginListSentimentDetectionJobs(ListSentimentDetectionJobsRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ListSentimentDetectionJobs operation.
///
///
/// The IAsyncResult returned by the call to BeginListSentimentDetectionJobs.
///
/// Returns a ListSentimentDetectionJobsResult from Comprehend.
/// REST API Reference for ListSentimentDetectionJobs Operation
ListSentimentDetectionJobsResponse EndListSentimentDetectionJobs(IAsyncResult asyncResult);
#endregion
#region ListTagsForResource
///
/// Lists all tags associated with a given Amazon Comprehend resource.
///
/// Container for the necessary parameters to execute the ListTagsForResource service method.
///
/// The response from the ListTagsForResource service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The specified resource ARN was not found. Check the ARN and try your request again.
///
/// REST API Reference for ListTagsForResource Operation
ListTagsForResourceResponse ListTagsForResource(ListTagsForResourceRequest request);
///
/// Initiates the asynchronous execution of the ListTagsForResource operation.
///
///
/// Container for the necessary parameters to execute the ListTagsForResource operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListTagsForResource
/// operation.
/// REST API Reference for ListTagsForResource Operation
IAsyncResult BeginListTagsForResource(ListTagsForResourceRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ListTagsForResource operation.
///
///
/// The IAsyncResult returned by the call to BeginListTagsForResource.
///
/// Returns a ListTagsForResourceResult from Comprehend.
/// REST API Reference for ListTagsForResource Operation
ListTagsForResourceResponse EndListTagsForResource(IAsyncResult asyncResult);
#endregion
#region ListTargetedSentimentDetectionJobs
///
/// Gets a list of targeted sentiment detection jobs that you have submitted.
///
/// Container for the necessary parameters to execute the ListTargetedSentimentDetectionJobs service method.
///
/// The response from the ListTargetedSentimentDetectionJobs service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The filter specified for the operation is invalid. Specify a different filter.
///
///
/// The request is invalid.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
/// REST API Reference for ListTargetedSentimentDetectionJobs Operation
ListTargetedSentimentDetectionJobsResponse ListTargetedSentimentDetectionJobs(ListTargetedSentimentDetectionJobsRequest request);
///
/// Initiates the asynchronous execution of the ListTargetedSentimentDetectionJobs operation.
///
///
/// Container for the necessary parameters to execute the ListTargetedSentimentDetectionJobs operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListTargetedSentimentDetectionJobs
/// operation.
/// REST API Reference for ListTargetedSentimentDetectionJobs Operation
IAsyncResult BeginListTargetedSentimentDetectionJobs(ListTargetedSentimentDetectionJobsRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ListTargetedSentimentDetectionJobs operation.
///
///
/// The IAsyncResult returned by the call to BeginListTargetedSentimentDetectionJobs.
///
/// Returns a ListTargetedSentimentDetectionJobsResult from Comprehend.
/// REST API Reference for ListTargetedSentimentDetectionJobs Operation
ListTargetedSentimentDetectionJobsResponse EndListTargetedSentimentDetectionJobs(IAsyncResult asyncResult);
#endregion
#region ListTopicsDetectionJobs
///
/// Gets a list of the topic detection jobs that you have submitted.
///
/// Container for the necessary parameters to execute the ListTopicsDetectionJobs service method.
///
/// The response from the ListTopicsDetectionJobs service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The filter specified for the operation is invalid. Specify a different filter.
///
///
/// The request is invalid.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
/// REST API Reference for ListTopicsDetectionJobs Operation
ListTopicsDetectionJobsResponse ListTopicsDetectionJobs(ListTopicsDetectionJobsRequest request);
///
/// Initiates the asynchronous execution of the ListTopicsDetectionJobs operation.
///
///
/// Container for the necessary parameters to execute the ListTopicsDetectionJobs operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListTopicsDetectionJobs
/// operation.
/// REST API Reference for ListTopicsDetectionJobs Operation
IAsyncResult BeginListTopicsDetectionJobs(ListTopicsDetectionJobsRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ListTopicsDetectionJobs operation.
///
///
/// The IAsyncResult returned by the call to BeginListTopicsDetectionJobs.
///
/// Returns a ListTopicsDetectionJobsResult from Comprehend.
/// REST API Reference for ListTopicsDetectionJobs Operation
ListTopicsDetectionJobsResponse EndListTopicsDetectionJobs(IAsyncResult asyncResult);
#endregion
#region PutResourcePolicy
///
/// Attaches a resource-based policy to a custom model. You can use this policy to authorize
/// an entity in another Amazon Web Services account to import the custom model, which
/// replicates it in Amazon Comprehend in their account.
///
/// Container for the necessary parameters to execute the PutResourcePolicy service method.
///
/// The response from the PutResourcePolicy service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The specified resource ARN was not found. Check the ARN and try your request again.
///
/// REST API Reference for PutResourcePolicy Operation
PutResourcePolicyResponse PutResourcePolicy(PutResourcePolicyRequest request);
///
/// Initiates the asynchronous execution of the PutResourcePolicy operation.
///
///
/// Container for the necessary parameters to execute the PutResourcePolicy operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutResourcePolicy
/// operation.
/// REST API Reference for PutResourcePolicy Operation
IAsyncResult BeginPutResourcePolicy(PutResourcePolicyRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the PutResourcePolicy operation.
///
///
/// The IAsyncResult returned by the call to BeginPutResourcePolicy.
///
/// Returns a PutResourcePolicyResult from Comprehend.
/// REST API Reference for PutResourcePolicy Operation
PutResourcePolicyResponse EndPutResourcePolicy(IAsyncResult asyncResult);
#endregion
#region StartDocumentClassificationJob
///
/// Starts an asynchronous document classification job. Use the DescribeDocumentClassificationJob
/// operation to track the progress of the job.
///
/// Container for the necessary parameters to execute the StartDocumentClassificationJob service method.
///
/// The response from the StartDocumentClassificationJob service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The KMS customer managed key (CMK) entered cannot be validated. Verify the key and
/// re-enter it.
///
///
/// The specified resource name is already in use. Use a different name and try your request
/// again.
///
///
/// The specified resource ARN was not found. Check the ARN and try your request again.
///
///
/// The specified resource is not available. Check the resource and try your request again.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
///
/// The request contains more tags than can be associated with a resource (50 tags per
/// resource). The maximum number of tags includes both existing tags and those included
/// in your current request.
///
/// REST API Reference for StartDocumentClassificationJob Operation
StartDocumentClassificationJobResponse StartDocumentClassificationJob(StartDocumentClassificationJobRequest request);
///
/// Initiates the asynchronous execution of the StartDocumentClassificationJob operation.
///
///
/// Container for the necessary parameters to execute the StartDocumentClassificationJob operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStartDocumentClassificationJob
/// operation.
/// REST API Reference for StartDocumentClassificationJob Operation
IAsyncResult BeginStartDocumentClassificationJob(StartDocumentClassificationJobRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the StartDocumentClassificationJob operation.
///
///
/// The IAsyncResult returned by the call to BeginStartDocumentClassificationJob.
///
/// Returns a StartDocumentClassificationJobResult from Comprehend.
/// REST API Reference for StartDocumentClassificationJob Operation
StartDocumentClassificationJobResponse EndStartDocumentClassificationJob(IAsyncResult asyncResult);
#endregion
#region StartDominantLanguageDetectionJob
///
/// Starts an asynchronous dominant language detection job for a collection of documents.
/// Use the operation to track the status of a job.
///
/// Container for the necessary parameters to execute the StartDominantLanguageDetectionJob service method.
///
/// The response from the StartDominantLanguageDetectionJob service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The KMS customer managed key (CMK) entered cannot be validated. Verify the key and
/// re-enter it.
///
///
/// The specified resource name is already in use. Use a different name and try your request
/// again.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
///
/// The request contains more tags than can be associated with a resource (50 tags per
/// resource). The maximum number of tags includes both existing tags and those included
/// in your current request.
///
/// REST API Reference for StartDominantLanguageDetectionJob Operation
StartDominantLanguageDetectionJobResponse StartDominantLanguageDetectionJob(StartDominantLanguageDetectionJobRequest request);
///
/// Initiates the asynchronous execution of the StartDominantLanguageDetectionJob operation.
///
///
/// Container for the necessary parameters to execute the StartDominantLanguageDetectionJob operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStartDominantLanguageDetectionJob
/// operation.
/// REST API Reference for StartDominantLanguageDetectionJob Operation
IAsyncResult BeginStartDominantLanguageDetectionJob(StartDominantLanguageDetectionJobRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the StartDominantLanguageDetectionJob operation.
///
///
/// The IAsyncResult returned by the call to BeginStartDominantLanguageDetectionJob.
///
/// Returns a StartDominantLanguageDetectionJobResult from Comprehend.
/// REST API Reference for StartDominantLanguageDetectionJob Operation
StartDominantLanguageDetectionJobResponse EndStartDominantLanguageDetectionJob(IAsyncResult asyncResult);
#endregion
#region StartEntitiesDetectionJob
///
/// Starts an asynchronous entity detection job for a collection of documents. Use the
/// operation to track the status of a job.
///
///
///
/// This API can be used for either standard entity detection or custom entity recognition.
/// In order to be used for custom entity recognition, the optional EntityRecognizerArn
/// must be used in order to provide access to the recognizer being used to detect the
/// custom entity.
///
///
/// Container for the necessary parameters to execute the StartEntitiesDetectionJob service method.
///
/// The response from the StartEntitiesDetectionJob service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The KMS customer managed key (CMK) entered cannot be validated. Verify the key and
/// re-enter it.
///
///
/// The specified resource name is already in use. Use a different name and try your request
/// again.
///
///
/// The specified resource ARN was not found. Check the ARN and try your request again.
///
///
/// The specified resource is not available. Check the resource and try your request again.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
///
/// The request contains more tags than can be associated with a resource (50 tags per
/// resource). The maximum number of tags includes both existing tags and those included
/// in your current request.
///
/// REST API Reference for StartEntitiesDetectionJob Operation
StartEntitiesDetectionJobResponse StartEntitiesDetectionJob(StartEntitiesDetectionJobRequest request);
///
/// Initiates the asynchronous execution of the StartEntitiesDetectionJob operation.
///
///
/// Container for the necessary parameters to execute the StartEntitiesDetectionJob operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStartEntitiesDetectionJob
/// operation.
/// REST API Reference for StartEntitiesDetectionJob Operation
IAsyncResult BeginStartEntitiesDetectionJob(StartEntitiesDetectionJobRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the StartEntitiesDetectionJob operation.
///
///
/// The IAsyncResult returned by the call to BeginStartEntitiesDetectionJob.
///
/// Returns a StartEntitiesDetectionJobResult from Comprehend.
/// REST API Reference for StartEntitiesDetectionJob Operation
StartEntitiesDetectionJobResponse EndStartEntitiesDetectionJob(IAsyncResult asyncResult);
#endregion
#region StartEventsDetectionJob
///
/// Starts an asynchronous event detection job for a collection of documents.
///
/// Container for the necessary parameters to execute the StartEventsDetectionJob service method.
///
/// The response from the StartEventsDetectionJob service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The KMS customer managed key (CMK) entered cannot be validated. Verify the key and
/// re-enter it.
///
///
/// The specified resource name is already in use. Use a different name and try your request
/// again.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
///
/// The request contains more tags than can be associated with a resource (50 tags per
/// resource). The maximum number of tags includes both existing tags and those included
/// in your current request.
///
/// REST API Reference for StartEventsDetectionJob Operation
StartEventsDetectionJobResponse StartEventsDetectionJob(StartEventsDetectionJobRequest request);
///
/// Initiates the asynchronous execution of the StartEventsDetectionJob operation.
///
///
/// Container for the necessary parameters to execute the StartEventsDetectionJob operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStartEventsDetectionJob
/// operation.
/// REST API Reference for StartEventsDetectionJob Operation
IAsyncResult BeginStartEventsDetectionJob(StartEventsDetectionJobRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the StartEventsDetectionJob operation.
///
///
/// The IAsyncResult returned by the call to BeginStartEventsDetectionJob.
///
/// Returns a StartEventsDetectionJobResult from Comprehend.
/// REST API Reference for StartEventsDetectionJob Operation
StartEventsDetectionJobResponse EndStartEventsDetectionJob(IAsyncResult asyncResult);
#endregion
#region StartFlywheelIteration
///
/// Start the flywheel iteration.This operation uses any new datasets to train a new model
/// version. For more information about flywheels, see
/// Flywheel overview in the Amazon Comprehend Developer Guide.
///
/// Container for the necessary parameters to execute the StartFlywheelIteration service method.
///
/// The response from the StartFlywheelIteration service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The specified resource name is already in use. Use a different name and try your request
/// again.
///
///
/// The specified resource ARN was not found. Check the ARN and try your request again.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
/// REST API Reference for StartFlywheelIteration Operation
StartFlywheelIterationResponse StartFlywheelIteration(StartFlywheelIterationRequest request);
///
/// Initiates the asynchronous execution of the StartFlywheelIteration operation.
///
///
/// Container for the necessary parameters to execute the StartFlywheelIteration operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStartFlywheelIteration
/// operation.
/// REST API Reference for StartFlywheelIteration Operation
IAsyncResult BeginStartFlywheelIteration(StartFlywheelIterationRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the StartFlywheelIteration operation.
///
///
/// The IAsyncResult returned by the call to BeginStartFlywheelIteration.
///
/// Returns a StartFlywheelIterationResult from Comprehend.
/// REST API Reference for StartFlywheelIteration Operation
StartFlywheelIterationResponse EndStartFlywheelIteration(IAsyncResult asyncResult);
#endregion
#region StartKeyPhrasesDetectionJob
///
/// Starts an asynchronous key phrase detection job for a collection of documents. Use
/// the operation to track the status of a job.
///
/// Container for the necessary parameters to execute the StartKeyPhrasesDetectionJob service method.
///
/// The response from the StartKeyPhrasesDetectionJob service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The KMS customer managed key (CMK) entered cannot be validated. Verify the key and
/// re-enter it.
///
///
/// The specified resource name is already in use. Use a different name and try your request
/// again.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
///
/// The request contains more tags than can be associated with a resource (50 tags per
/// resource). The maximum number of tags includes both existing tags and those included
/// in your current request.
///
/// REST API Reference for StartKeyPhrasesDetectionJob Operation
StartKeyPhrasesDetectionJobResponse StartKeyPhrasesDetectionJob(StartKeyPhrasesDetectionJobRequest request);
///
/// Initiates the asynchronous execution of the StartKeyPhrasesDetectionJob operation.
///
///
/// Container for the necessary parameters to execute the StartKeyPhrasesDetectionJob operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStartKeyPhrasesDetectionJob
/// operation.
/// REST API Reference for StartKeyPhrasesDetectionJob Operation
IAsyncResult BeginStartKeyPhrasesDetectionJob(StartKeyPhrasesDetectionJobRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the StartKeyPhrasesDetectionJob operation.
///
///
/// The IAsyncResult returned by the call to BeginStartKeyPhrasesDetectionJob.
///
/// Returns a StartKeyPhrasesDetectionJobResult from Comprehend.
/// REST API Reference for StartKeyPhrasesDetectionJob Operation
StartKeyPhrasesDetectionJobResponse EndStartKeyPhrasesDetectionJob(IAsyncResult asyncResult);
#endregion
#region StartPiiEntitiesDetectionJob
///
/// Starts an asynchronous PII entity detection job for a collection of documents.
///
/// Container for the necessary parameters to execute the StartPiiEntitiesDetectionJob service method.
///
/// The response from the StartPiiEntitiesDetectionJob service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The KMS customer managed key (CMK) entered cannot be validated. Verify the key and
/// re-enter it.
///
///
/// The specified resource name is already in use. Use a different name and try your request
/// again.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
///
/// The request contains more tags than can be associated with a resource (50 tags per
/// resource). The maximum number of tags includes both existing tags and those included
/// in your current request.
///
/// REST API Reference for StartPiiEntitiesDetectionJob Operation
StartPiiEntitiesDetectionJobResponse StartPiiEntitiesDetectionJob(StartPiiEntitiesDetectionJobRequest request);
///
/// Initiates the asynchronous execution of the StartPiiEntitiesDetectionJob operation.
///
///
/// Container for the necessary parameters to execute the StartPiiEntitiesDetectionJob operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStartPiiEntitiesDetectionJob
/// operation.
/// REST API Reference for StartPiiEntitiesDetectionJob Operation
IAsyncResult BeginStartPiiEntitiesDetectionJob(StartPiiEntitiesDetectionJobRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the StartPiiEntitiesDetectionJob operation.
///
///
/// The IAsyncResult returned by the call to BeginStartPiiEntitiesDetectionJob.
///
/// Returns a StartPiiEntitiesDetectionJobResult from Comprehend.
/// REST API Reference for StartPiiEntitiesDetectionJob Operation
StartPiiEntitiesDetectionJobResponse EndStartPiiEntitiesDetectionJob(IAsyncResult asyncResult);
#endregion
#region StartSentimentDetectionJob
///
/// Starts an asynchronous sentiment detection job for a collection of documents. Use
/// the operation to track the status of a job.
///
/// Container for the necessary parameters to execute the StartSentimentDetectionJob service method.
///
/// The response from the StartSentimentDetectionJob service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The KMS customer managed key (CMK) entered cannot be validated. Verify the key and
/// re-enter it.
///
///
/// The specified resource name is already in use. Use a different name and try your request
/// again.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
///
/// The request contains more tags than can be associated with a resource (50 tags per
/// resource). The maximum number of tags includes both existing tags and those included
/// in your current request.
///
/// REST API Reference for StartSentimentDetectionJob Operation
StartSentimentDetectionJobResponse StartSentimentDetectionJob(StartSentimentDetectionJobRequest request);
///
/// Initiates the asynchronous execution of the StartSentimentDetectionJob operation.
///
///
/// Container for the necessary parameters to execute the StartSentimentDetectionJob operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStartSentimentDetectionJob
/// operation.
/// REST API Reference for StartSentimentDetectionJob Operation
IAsyncResult BeginStartSentimentDetectionJob(StartSentimentDetectionJobRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the StartSentimentDetectionJob operation.
///
///
/// The IAsyncResult returned by the call to BeginStartSentimentDetectionJob.
///
/// Returns a StartSentimentDetectionJobResult from Comprehend.
/// REST API Reference for StartSentimentDetectionJob Operation
StartSentimentDetectionJobResponse EndStartSentimentDetectionJob(IAsyncResult asyncResult);
#endregion
#region StartTargetedSentimentDetectionJob
///
/// Starts an asynchronous targeted sentiment detection job for a collection of documents.
/// Use the DescribeTargetedSentimentDetectionJob
operation to track the
/// status of a job.
///
/// Container for the necessary parameters to execute the StartTargetedSentimentDetectionJob service method.
///
/// The response from the StartTargetedSentimentDetectionJob service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The KMS customer managed key (CMK) entered cannot be validated. Verify the key and
/// re-enter it.
///
///
/// The specified resource name is already in use. Use a different name and try your request
/// again.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
///
/// The request contains more tags than can be associated with a resource (50 tags per
/// resource). The maximum number of tags includes both existing tags and those included
/// in your current request.
///
/// REST API Reference for StartTargetedSentimentDetectionJob Operation
StartTargetedSentimentDetectionJobResponse StartTargetedSentimentDetectionJob(StartTargetedSentimentDetectionJobRequest request);
///
/// Initiates the asynchronous execution of the StartTargetedSentimentDetectionJob operation.
///
///
/// Container for the necessary parameters to execute the StartTargetedSentimentDetectionJob operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStartTargetedSentimentDetectionJob
/// operation.
/// REST API Reference for StartTargetedSentimentDetectionJob Operation
IAsyncResult BeginStartTargetedSentimentDetectionJob(StartTargetedSentimentDetectionJobRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the StartTargetedSentimentDetectionJob operation.
///
///
/// The IAsyncResult returned by the call to BeginStartTargetedSentimentDetectionJob.
///
/// Returns a StartTargetedSentimentDetectionJobResult from Comprehend.
/// REST API Reference for StartTargetedSentimentDetectionJob Operation
StartTargetedSentimentDetectionJobResponse EndStartTargetedSentimentDetectionJob(IAsyncResult asyncResult);
#endregion
#region StartTopicsDetectionJob
///
/// Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob
/// operation to track the status of a job.
///
/// Container for the necessary parameters to execute the StartTopicsDetectionJob service method.
///
/// The response from the StartTopicsDetectionJob service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The KMS customer managed key (CMK) entered cannot be validated. Verify the key and
/// re-enter it.
///
///
/// The specified resource name is already in use. Use a different name and try your request
/// again.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
///
/// The request contains more tags than can be associated with a resource (50 tags per
/// resource). The maximum number of tags includes both existing tags and those included
/// in your current request.
///
/// REST API Reference for StartTopicsDetectionJob Operation
StartTopicsDetectionJobResponse StartTopicsDetectionJob(StartTopicsDetectionJobRequest request);
///
/// Initiates the asynchronous execution of the StartTopicsDetectionJob operation.
///
///
/// Container for the necessary parameters to execute the StartTopicsDetectionJob operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStartTopicsDetectionJob
/// operation.
/// REST API Reference for StartTopicsDetectionJob Operation
IAsyncResult BeginStartTopicsDetectionJob(StartTopicsDetectionJobRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the StartTopicsDetectionJob operation.
///
///
/// The IAsyncResult returned by the call to BeginStartTopicsDetectionJob.
///
/// Returns a StartTopicsDetectionJobResult from Comprehend.
/// REST API Reference for StartTopicsDetectionJob Operation
StartTopicsDetectionJobResponse EndStartTopicsDetectionJob(IAsyncResult asyncResult);
#endregion
#region StopDominantLanguageDetectionJob
///
/// Stops a dominant language detection job in progress.
///
///
///
/// If the job state is IN_PROGRESS
the job is marked for termination and
/// put into the STOP_REQUESTED
state. If the job completes before it can
/// be stopped, it is put into the COMPLETED
state; otherwise the job is
/// stopped and put into the STOPPED
state.
///
///
///
/// If the job is in the COMPLETED
or FAILED
state when you
/// call the StopDominantLanguageDetectionJob
operation, the operation returns
/// a 400 Internal Request Exception.
///
///
///
/// When a job is stopped, any documents already processed are written to the output location.
///
///
/// Container for the necessary parameters to execute the StopDominantLanguageDetectionJob service method.
///
/// The response from the StopDominantLanguageDetectionJob service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The specified job was not found. Check the job ID and try again.
///
/// REST API Reference for StopDominantLanguageDetectionJob Operation
StopDominantLanguageDetectionJobResponse StopDominantLanguageDetectionJob(StopDominantLanguageDetectionJobRequest request);
///
/// Initiates the asynchronous execution of the StopDominantLanguageDetectionJob operation.
///
///
/// Container for the necessary parameters to execute the StopDominantLanguageDetectionJob operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStopDominantLanguageDetectionJob
/// operation.
/// REST API Reference for StopDominantLanguageDetectionJob Operation
IAsyncResult BeginStopDominantLanguageDetectionJob(StopDominantLanguageDetectionJobRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the StopDominantLanguageDetectionJob operation.
///
///
/// The IAsyncResult returned by the call to BeginStopDominantLanguageDetectionJob.
///
/// Returns a StopDominantLanguageDetectionJobResult from Comprehend.
/// REST API Reference for StopDominantLanguageDetectionJob Operation
StopDominantLanguageDetectionJobResponse EndStopDominantLanguageDetectionJob(IAsyncResult asyncResult);
#endregion
#region StopEntitiesDetectionJob
///
/// Stops an entities detection job in progress.
///
///
///
/// If the job state is IN_PROGRESS
the job is marked for termination and
/// put into the STOP_REQUESTED
state. If the job completes before it can
/// be stopped, it is put into the COMPLETED
state; otherwise the job is
/// stopped and put into the STOPPED
state.
///
///
///
/// If the job is in the COMPLETED
or FAILED
state when you
/// call the StopDominantLanguageDetectionJob
operation, the operation returns
/// a 400 Internal Request Exception.
///
///
///
/// When a job is stopped, any documents already processed are written to the output location.
///
///
/// Container for the necessary parameters to execute the StopEntitiesDetectionJob service method.
///
/// The response from the StopEntitiesDetectionJob service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The specified job was not found. Check the job ID and try again.
///
/// REST API Reference for StopEntitiesDetectionJob Operation
StopEntitiesDetectionJobResponse StopEntitiesDetectionJob(StopEntitiesDetectionJobRequest request);
///
/// Initiates the asynchronous execution of the StopEntitiesDetectionJob operation.
///
///
/// Container for the necessary parameters to execute the StopEntitiesDetectionJob operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStopEntitiesDetectionJob
/// operation.
/// REST API Reference for StopEntitiesDetectionJob Operation
IAsyncResult BeginStopEntitiesDetectionJob(StopEntitiesDetectionJobRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the StopEntitiesDetectionJob operation.
///
///
/// The IAsyncResult returned by the call to BeginStopEntitiesDetectionJob.
///
/// Returns a StopEntitiesDetectionJobResult from Comprehend.
/// REST API Reference for StopEntitiesDetectionJob Operation
StopEntitiesDetectionJobResponse EndStopEntitiesDetectionJob(IAsyncResult asyncResult);
#endregion
#region StopEventsDetectionJob
///
/// Stops an events detection job in progress.
///
/// Container for the necessary parameters to execute the StopEventsDetectionJob service method.
///
/// The response from the StopEventsDetectionJob service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The specified job was not found. Check the job ID and try again.
///
/// REST API Reference for StopEventsDetectionJob Operation
StopEventsDetectionJobResponse StopEventsDetectionJob(StopEventsDetectionJobRequest request);
///
/// Initiates the asynchronous execution of the StopEventsDetectionJob operation.
///
///
/// Container for the necessary parameters to execute the StopEventsDetectionJob operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStopEventsDetectionJob
/// operation.
/// REST API Reference for StopEventsDetectionJob Operation
IAsyncResult BeginStopEventsDetectionJob(StopEventsDetectionJobRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the StopEventsDetectionJob operation.
///
///
/// The IAsyncResult returned by the call to BeginStopEventsDetectionJob.
///
/// Returns a StopEventsDetectionJobResult from Comprehend.
/// REST API Reference for StopEventsDetectionJob Operation
StopEventsDetectionJobResponse EndStopEventsDetectionJob(IAsyncResult asyncResult);
#endregion
#region StopKeyPhrasesDetectionJob
///
/// Stops a key phrases detection job in progress.
///
///
///
/// If the job state is IN_PROGRESS
the job is marked for termination and
/// put into the STOP_REQUESTED
state. If the job completes before it can
/// be stopped, it is put into the COMPLETED
state; otherwise the job is
/// stopped and put into the STOPPED
state.
///
///
///
/// If the job is in the COMPLETED
or FAILED
state when you
/// call the StopDominantLanguageDetectionJob
operation, the operation returns
/// a 400 Internal Request Exception.
///
///
///
/// When a job is stopped, any documents already processed are written to the output location.
///
///
/// Container for the necessary parameters to execute the StopKeyPhrasesDetectionJob service method.
///
/// The response from the StopKeyPhrasesDetectionJob service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The specified job was not found. Check the job ID and try again.
///
/// REST API Reference for StopKeyPhrasesDetectionJob Operation
StopKeyPhrasesDetectionJobResponse StopKeyPhrasesDetectionJob(StopKeyPhrasesDetectionJobRequest request);
///
/// Initiates the asynchronous execution of the StopKeyPhrasesDetectionJob operation.
///
///
/// Container for the necessary parameters to execute the StopKeyPhrasesDetectionJob operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStopKeyPhrasesDetectionJob
/// operation.
/// REST API Reference for StopKeyPhrasesDetectionJob Operation
IAsyncResult BeginStopKeyPhrasesDetectionJob(StopKeyPhrasesDetectionJobRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the StopKeyPhrasesDetectionJob operation.
///
///
/// The IAsyncResult returned by the call to BeginStopKeyPhrasesDetectionJob.
///
/// Returns a StopKeyPhrasesDetectionJobResult from Comprehend.
/// REST API Reference for StopKeyPhrasesDetectionJob Operation
StopKeyPhrasesDetectionJobResponse EndStopKeyPhrasesDetectionJob(IAsyncResult asyncResult);
#endregion
#region StopPiiEntitiesDetectionJob
///
/// Stops a PII entities detection job in progress.
///
/// Container for the necessary parameters to execute the StopPiiEntitiesDetectionJob service method.
///
/// The response from the StopPiiEntitiesDetectionJob service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The specified job was not found. Check the job ID and try again.
///
/// REST API Reference for StopPiiEntitiesDetectionJob Operation
StopPiiEntitiesDetectionJobResponse StopPiiEntitiesDetectionJob(StopPiiEntitiesDetectionJobRequest request);
///
/// Initiates the asynchronous execution of the StopPiiEntitiesDetectionJob operation.
///
///
/// Container for the necessary parameters to execute the StopPiiEntitiesDetectionJob operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStopPiiEntitiesDetectionJob
/// operation.
/// REST API Reference for StopPiiEntitiesDetectionJob Operation
IAsyncResult BeginStopPiiEntitiesDetectionJob(StopPiiEntitiesDetectionJobRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the StopPiiEntitiesDetectionJob operation.
///
///
/// The IAsyncResult returned by the call to BeginStopPiiEntitiesDetectionJob.
///
/// Returns a StopPiiEntitiesDetectionJobResult from Comprehend.
/// REST API Reference for StopPiiEntitiesDetectionJob Operation
StopPiiEntitiesDetectionJobResponse EndStopPiiEntitiesDetectionJob(IAsyncResult asyncResult);
#endregion
#region StopSentimentDetectionJob
///
/// Stops a sentiment detection job in progress.
///
///
///
/// If the job state is IN_PROGRESS
, the job is marked for termination and
/// put into the STOP_REQUESTED
state. If the job completes before it can
/// be stopped, it is put into the COMPLETED
state; otherwise the job is
/// be stopped and put into the STOPPED
state.
///
///
///
/// If the job is in the COMPLETED
or FAILED
state when you
/// call the StopDominantLanguageDetectionJob
operation, the operation returns
/// a 400 Internal Request Exception.
///
///
///
/// When a job is stopped, any documents already processed are written to the output location.
///
///
/// Container for the necessary parameters to execute the StopSentimentDetectionJob service method.
///
/// The response from the StopSentimentDetectionJob service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The specified job was not found. Check the job ID and try again.
///
/// REST API Reference for StopSentimentDetectionJob Operation
StopSentimentDetectionJobResponse StopSentimentDetectionJob(StopSentimentDetectionJobRequest request);
///
/// Initiates the asynchronous execution of the StopSentimentDetectionJob operation.
///
///
/// Container for the necessary parameters to execute the StopSentimentDetectionJob operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStopSentimentDetectionJob
/// operation.
/// REST API Reference for StopSentimentDetectionJob Operation
IAsyncResult BeginStopSentimentDetectionJob(StopSentimentDetectionJobRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the StopSentimentDetectionJob operation.
///
///
/// The IAsyncResult returned by the call to BeginStopSentimentDetectionJob.
///
/// Returns a StopSentimentDetectionJobResult from Comprehend.
/// REST API Reference for StopSentimentDetectionJob Operation
StopSentimentDetectionJobResponse EndStopSentimentDetectionJob(IAsyncResult asyncResult);
#endregion
#region StopTargetedSentimentDetectionJob
///
/// Stops a targeted sentiment detection job in progress.
///
///
///
/// If the job state is IN_PROGRESS
, the job is marked for termination and
/// put into the STOP_REQUESTED
state. If the job completes before it can
/// be stopped, it is put into the COMPLETED
state; otherwise the job is
/// be stopped and put into the STOPPED
state.
///
///
///
/// If the job is in the COMPLETED
or FAILED
state when you
/// call the StopDominantLanguageDetectionJob
operation, the operation returns
/// a 400 Internal Request Exception.
///
///
///
/// When a job is stopped, any documents already processed are written to the output location.
///
///
/// Container for the necessary parameters to execute the StopTargetedSentimentDetectionJob service method.
///
/// The response from the StopTargetedSentimentDetectionJob service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The specified job was not found. Check the job ID and try again.
///
/// REST API Reference for StopTargetedSentimentDetectionJob Operation
StopTargetedSentimentDetectionJobResponse StopTargetedSentimentDetectionJob(StopTargetedSentimentDetectionJobRequest request);
///
/// Initiates the asynchronous execution of the StopTargetedSentimentDetectionJob operation.
///
///
/// Container for the necessary parameters to execute the StopTargetedSentimentDetectionJob operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStopTargetedSentimentDetectionJob
/// operation.
/// REST API Reference for StopTargetedSentimentDetectionJob Operation
IAsyncResult BeginStopTargetedSentimentDetectionJob(StopTargetedSentimentDetectionJobRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the StopTargetedSentimentDetectionJob operation.
///
///
/// The IAsyncResult returned by the call to BeginStopTargetedSentimentDetectionJob.
///
/// Returns a StopTargetedSentimentDetectionJobResult from Comprehend.
/// REST API Reference for StopTargetedSentimentDetectionJob Operation
StopTargetedSentimentDetectionJobResponse EndStopTargetedSentimentDetectionJob(IAsyncResult asyncResult);
#endregion
#region StopTrainingDocumentClassifier
///
/// Stops a document classifier training job while in progress.
///
///
///
/// If the training job state is TRAINING
, the job is marked for termination
/// and put into the STOP_REQUESTED
state. If the training job completes
/// before it can be stopped, it is put into the TRAINED
; otherwise the training
/// job is stopped and put into the STOPPED
state and the service sends back
/// an HTTP 200 response with an empty HTTP body.
///
///
/// Container for the necessary parameters to execute the StopTrainingDocumentClassifier service method.
///
/// The response from the StopTrainingDocumentClassifier service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The specified resource ARN was not found. Check the ARN and try your request again.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
/// REST API Reference for StopTrainingDocumentClassifier Operation
StopTrainingDocumentClassifierResponse StopTrainingDocumentClassifier(StopTrainingDocumentClassifierRequest request);
///
/// Initiates the asynchronous execution of the StopTrainingDocumentClassifier operation.
///
///
/// Container for the necessary parameters to execute the StopTrainingDocumentClassifier operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStopTrainingDocumentClassifier
/// operation.
/// REST API Reference for StopTrainingDocumentClassifier Operation
IAsyncResult BeginStopTrainingDocumentClassifier(StopTrainingDocumentClassifierRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the StopTrainingDocumentClassifier operation.
///
///
/// The IAsyncResult returned by the call to BeginStopTrainingDocumentClassifier.
///
/// Returns a StopTrainingDocumentClassifierResult from Comprehend.
/// REST API Reference for StopTrainingDocumentClassifier Operation
StopTrainingDocumentClassifierResponse EndStopTrainingDocumentClassifier(IAsyncResult asyncResult);
#endregion
#region StopTrainingEntityRecognizer
///
/// Stops an entity recognizer training job while in progress.
///
///
///
/// If the training job state is TRAINING
, the job is marked for termination
/// and put into the STOP_REQUESTED
state. If the training job completes
/// before it can be stopped, it is put into the TRAINED
; otherwise the training
/// job is stopped and putted into the STOPPED
state and the service sends
/// back an HTTP 200 response with an empty HTTP body.
///
///
/// Container for the necessary parameters to execute the StopTrainingEntityRecognizer service method.
///
/// The response from the StopTrainingEntityRecognizer service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The specified resource ARN was not found. Check the ARN and try your request again.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
/// REST API Reference for StopTrainingEntityRecognizer Operation
StopTrainingEntityRecognizerResponse StopTrainingEntityRecognizer(StopTrainingEntityRecognizerRequest request);
///
/// Initiates the asynchronous execution of the StopTrainingEntityRecognizer operation.
///
///
/// Container for the necessary parameters to execute the StopTrainingEntityRecognizer operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStopTrainingEntityRecognizer
/// operation.
/// REST API Reference for StopTrainingEntityRecognizer Operation
IAsyncResult BeginStopTrainingEntityRecognizer(StopTrainingEntityRecognizerRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the StopTrainingEntityRecognizer operation.
///
///
/// The IAsyncResult returned by the call to BeginStopTrainingEntityRecognizer.
///
/// Returns a StopTrainingEntityRecognizerResult from Comprehend.
/// REST API Reference for StopTrainingEntityRecognizer Operation
StopTrainingEntityRecognizerResponse EndStopTrainingEntityRecognizer(IAsyncResult asyncResult);
#endregion
#region TagResource
///
/// Associates a specific tag with an Amazon Comprehend resource. A tag is a key-value
/// pair that adds as a metadata to a resource used by Amazon Comprehend. For example,
/// a tag with "Sales" as the key might be added to a resource to indicate its use by
/// the sales department.
///
/// Container for the necessary parameters to execute the TagResource service method.
///
/// The response from the TagResource service method, as returned by Comprehend.
///
/// Concurrent modification of the tags associated with an Amazon Comprehend resource
/// is not supported.
///
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The specified resource ARN was not found. Check the ARN and try your request again.
///
///
/// The request contains more tags than can be associated with a resource (50 tags per
/// resource). The maximum number of tags includes both existing tags and those included
/// in your current request.
///
/// REST API Reference for TagResource Operation
TagResourceResponse TagResource(TagResourceRequest request);
///
/// Initiates the asynchronous execution of the TagResource operation.
///
///
/// Container for the necessary parameters to execute the TagResource operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndTagResource
/// operation.
/// REST API Reference for TagResource Operation
IAsyncResult BeginTagResource(TagResourceRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the TagResource operation.
///
///
/// The IAsyncResult returned by the call to BeginTagResource.
///
/// Returns a TagResourceResult from Comprehend.
/// REST API Reference for TagResource Operation
TagResourceResponse EndTagResource(IAsyncResult asyncResult);
#endregion
#region UntagResource
///
/// Removes a specific tag associated with an Amazon Comprehend resource.
///
/// Container for the necessary parameters to execute the UntagResource service method.
///
/// The response from the UntagResource service method, as returned by Comprehend.
///
/// Concurrent modification of the tags associated with an Amazon Comprehend resource
/// is not supported.
///
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The specified resource ARN was not found. Check the ARN and try your request again.
///
///
/// The request contains more tag keys than can be associated with a resource (50 tag
/// keys per resource).
///
/// REST API Reference for UntagResource Operation
UntagResourceResponse UntagResource(UntagResourceRequest request);
///
/// Initiates the asynchronous execution of the UntagResource operation.
///
///
/// Container for the necessary parameters to execute the UntagResource operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUntagResource
/// operation.
/// REST API Reference for UntagResource Operation
IAsyncResult BeginUntagResource(UntagResourceRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the UntagResource operation.
///
///
/// The IAsyncResult returned by the call to BeginUntagResource.
///
/// Returns a UntagResourceResult from Comprehend.
/// REST API Reference for UntagResource Operation
UntagResourceResponse EndUntagResource(IAsyncResult asyncResult);
#endregion
#region UpdateEndpoint
///
/// Updates information about the specified endpoint. For information about endpoints,
/// see Managing
/// endpoints.
///
/// Container for the necessary parameters to execute the UpdateEndpoint service method.
///
/// The response from the UpdateEndpoint service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The specified resource name is already in use. Use a different name and try your request
/// again.
///
///
/// The maximum number of resources per account has been exceeded. Review the resources,
/// and then try your request again.
///
///
/// The specified resource ARN was not found. Check the ARN and try your request again.
///
///
/// The specified resource is not available. Check the resource and try your request again.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
/// REST API Reference for UpdateEndpoint Operation
UpdateEndpointResponse UpdateEndpoint(UpdateEndpointRequest request);
///
/// Initiates the asynchronous execution of the UpdateEndpoint operation.
///
///
/// Container for the necessary parameters to execute the UpdateEndpoint operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateEndpoint
/// operation.
/// REST API Reference for UpdateEndpoint Operation
IAsyncResult BeginUpdateEndpoint(UpdateEndpointRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the UpdateEndpoint operation.
///
///
/// The IAsyncResult returned by the call to BeginUpdateEndpoint.
///
/// Returns a UpdateEndpointResult from Comprehend.
/// REST API Reference for UpdateEndpoint Operation
UpdateEndpointResponse EndUpdateEndpoint(IAsyncResult asyncResult);
#endregion
#region UpdateFlywheel
///
/// Update the configuration information for an existing flywheel.
///
/// Container for the necessary parameters to execute the UpdateFlywheel service method.
///
/// The response from the UpdateFlywheel service method, as returned by Comprehend.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request is invalid.
///
///
/// The KMS customer managed key (CMK) entered cannot be validated. Verify the key and
/// re-enter it.
///
///
/// The specified resource ARN was not found. Check the ARN and try your request again.
///
///
/// The number of requests exceeds the limit. Resubmit your request later.
///
/// REST API Reference for UpdateFlywheel Operation
UpdateFlywheelResponse UpdateFlywheel(UpdateFlywheelRequest request);
///
/// Initiates the asynchronous execution of the UpdateFlywheel operation.
///
///
/// Container for the necessary parameters to execute the UpdateFlywheel operation on AmazonComprehendClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateFlywheel
/// operation.
/// REST API Reference for UpdateFlywheel Operation
IAsyncResult BeginUpdateFlywheel(UpdateFlywheelRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the UpdateFlywheel operation.
///
///
/// The IAsyncResult returned by the call to BeginUpdateFlywheel.
///
/// Returns a UpdateFlywheelResult from Comprehend.
/// REST API Reference for UpdateFlywheel Operation
UpdateFlywheelResponse EndUpdateFlywheel(IAsyncResult asyncResult);
#endregion
}
}