/*
* 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.Threading;
using System.Threading.Tasks;
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 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task BatchDetectDominantLanguageAsync(BatchDetectDominantLanguageRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task BatchDetectEntitiesAsync(BatchDetectEntitiesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task BatchDetectKeyPhrasesAsync(BatchDetectKeyPhrasesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task BatchDetectSentimentAsync(BatchDetectSentimentRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task BatchDetectSyntaxAsync(BatchDetectSyntaxRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task BatchDetectTargetedSentimentAsync(BatchDetectTargetedSentimentRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task ClassifyDocumentAsync(ClassifyDocumentRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task ContainsPiiEntitiesAsync(ContainsPiiEntitiesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task CreateDatasetAsync(CreateDatasetRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task CreateDocumentClassifierAsync(CreateDocumentClassifierRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task CreateEndpointAsync(CreateEndpointRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task CreateEntityRecognizerAsync(CreateEntityRecognizerRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task CreateFlywheelAsync(CreateFlywheelRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task DeleteDocumentClassifierAsync(DeleteDocumentClassifierRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task DeleteEndpointAsync(DeleteEndpointRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task DeleteEntityRecognizerAsync(DeleteEntityRecognizerRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task DeleteFlywheelAsync(DeleteFlywheelRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task DeleteResourcePolicyAsync(DeleteResourcePolicyRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task DescribeDatasetAsync(DescribeDatasetRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task DescribeDocumentClassificationJobAsync(DescribeDocumentClassificationJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeDocumentClassifier
///
/// Gets the properties associated with a document classifier.
///
/// Container for the necessary parameters to execute the DescribeDocumentClassifier service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task DescribeDocumentClassifierAsync(DescribeDocumentClassifierRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task DescribeDominantLanguageDetectionJobAsync(DescribeDominantLanguageDetectionJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task DescribeEndpointAsync(DescribeEndpointRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task DescribeEntitiesDetectionJobAsync(DescribeEntitiesDetectionJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task DescribeEntityRecognizerAsync(DescribeEntityRecognizerRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeEventsDetectionJob
///
/// Gets the status and details of an events detection job.
///
/// Container for the necessary parameters to execute the DescribeEventsDetectionJob service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task DescribeEventsDetectionJobAsync(DescribeEventsDetectionJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task DescribeFlywheelAsync(DescribeFlywheelRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task DescribeFlywheelIterationAsync(DescribeFlywheelIterationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task DescribeKeyPhrasesDetectionJobAsync(DescribeKeyPhrasesDetectionJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task DescribePiiEntitiesDetectionJobAsync(DescribePiiEntitiesDetectionJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task DescribeResourcePolicyAsync(DescribeResourcePolicyRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task DescribeSentimentDetectionJobAsync(DescribeSentimentDetectionJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task DescribeTargetedSentimentDetectionJobAsync(DescribeTargetedSentimentDetectionJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task DescribeTopicsDetectionJobAsync(DescribeTopicsDetectionJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task DetectDominantLanguageAsync(DetectDominantLanguageRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task DetectEntitiesAsync(DetectEntitiesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DetectKeyPhrases
///
/// Detects the key noun phrases found in the text.
///
/// Container for the necessary parameters to execute the DetectKeyPhrases service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task DetectKeyPhrasesAsync(DetectKeyPhrasesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task DetectPiiEntitiesAsync(DetectPiiEntitiesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task DetectSentimentAsync(DetectSentimentRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task DetectSyntaxAsync(DetectSyntaxRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task DetectTargetedSentimentAsync(DetectTargetedSentimentRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task ImportModelAsync(ImportModelRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task ListDatasetsAsync(ListDatasetsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task ListDocumentClassificationJobsAsync(ListDocumentClassificationJobsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task ListDocumentClassifiersAsync(ListDocumentClassifiersRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task ListDocumentClassifierSummariesAsync(ListDocumentClassifierSummariesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task ListDominantLanguageDetectionJobsAsync(ListDominantLanguageDetectionJobsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task ListEndpointsAsync(ListEndpointsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task ListEntitiesDetectionJobsAsync(ListEntitiesDetectionJobsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task ListEntityRecognizersAsync(ListEntityRecognizersRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task ListEntityRecognizerSummariesAsync(ListEntityRecognizerSummariesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task ListEventsDetectionJobsAsync(ListEventsDetectionJobsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task ListFlywheelIterationHistoryAsync(ListFlywheelIterationHistoryRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListFlywheels
///
/// Gets a list of the flywheels that you have created.
///
/// Container for the necessary parameters to execute the ListFlywheels service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task ListFlywheelsAsync(ListFlywheelsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task ListKeyPhrasesDetectionJobsAsync(ListKeyPhrasesDetectionJobsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task ListPiiEntitiesDetectionJobsAsync(ListPiiEntitiesDetectionJobsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task ListSentimentDetectionJobsAsync(ListSentimentDetectionJobsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListTagsForResource
///
/// Lists all tags associated with a given Amazon Comprehend resource.
///
/// Container for the necessary parameters to execute the ListTagsForResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListTagsForResource service method, as returned by 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
Task ListTagsForResourceAsync(ListTagsForResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task ListTargetedSentimentDetectionJobsAsync(ListTargetedSentimentDetectionJobsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task ListTopicsDetectionJobsAsync(ListTopicsDetectionJobsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task PutResourcePolicyAsync(PutResourcePolicyRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task StartDocumentClassificationJobAsync(StartDocumentClassificationJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task StartDominantLanguageDetectionJobAsync(StartDominantLanguageDetectionJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task StartEntitiesDetectionJobAsync(StartEntitiesDetectionJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task StartEventsDetectionJobAsync(StartEventsDetectionJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task StartFlywheelIterationAsync(StartFlywheelIterationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task StartKeyPhrasesDetectionJobAsync(StartKeyPhrasesDetectionJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task StartPiiEntitiesDetectionJobAsync(StartPiiEntitiesDetectionJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task StartSentimentDetectionJobAsync(StartSentimentDetectionJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task StartTargetedSentimentDetectionJobAsync(StartTargetedSentimentDetectionJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task StartTopicsDetectionJobAsync(StartTopicsDetectionJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task StopDominantLanguageDetectionJobAsync(StopDominantLanguageDetectionJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task StopEntitiesDetectionJobAsync(StopEntitiesDetectionJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region StopEventsDetectionJob
///
/// Stops an events detection job in progress.
///
/// Container for the necessary parameters to execute the StopEventsDetectionJob service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task StopEventsDetectionJobAsync(StopEventsDetectionJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task StopKeyPhrasesDetectionJobAsync(StopKeyPhrasesDetectionJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region StopPiiEntitiesDetectionJob
///
/// Stops a PII entities detection job in progress.
///
/// Container for the necessary parameters to execute the StopPiiEntitiesDetectionJob service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task StopPiiEntitiesDetectionJobAsync(StopPiiEntitiesDetectionJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task StopSentimentDetectionJobAsync(StopSentimentDetectionJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task StopTargetedSentimentDetectionJobAsync(StopTargetedSentimentDetectionJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task StopTrainingDocumentClassifierAsync(StopTrainingDocumentClassifierRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task StopTrainingEntityRecognizerAsync(StopTrainingEntityRecognizerRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the TagResource service method, as returned by 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
Task TagResourceAsync(TagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UntagResource
///
/// Removes a specific tag associated with an Amazon Comprehend resource.
///
/// Container for the necessary parameters to execute the UntagResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UntagResource service method, as returned by 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
Task UntagResourceAsync(UntagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task UpdateEndpointAsync(UpdateEndpointRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdateFlywheel
///
/// Update the configuration information for an existing flywheel.
///
/// Container for the necessary parameters to execute the UpdateFlywheel service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task UpdateFlywheelAsync(UpdateFlywheelRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
}
}