AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Inheritance Hierarchy

Amazon.Comprehend.IAmazonComprehend

Namespace: Amazon.Comprehend
Assembly: AWSSDK.Comprehend.dll
Version: 3.x.y.z

Syntax

C#
public interface IAmazonComprehend
         IAmazonService, IDisposable

The IAmazonComprehend type exposes the following members

Properties

NameTypeDescription
Public Property Paginators Amazon.Comprehend.Model.IComprehendPaginatorFactory

Paginators for the service

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method BatchDetectDominantLanguage(BatchDetectDominantLanguageRequest)

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.

Public Method BatchDetectDominantLanguageAsync(BatchDetectDominantLanguageRequest, CancellationToken)

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.

Public Method BatchDetectEntities(BatchDetectEntitiesRequest)

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.

Public Method BatchDetectEntitiesAsync(BatchDetectEntitiesRequest, CancellationToken)

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.

Public Method BatchDetectKeyPhrases(BatchDetectKeyPhrasesRequest)

Detects the key noun phrases found in a batch of documents.

Public Method BatchDetectKeyPhrasesAsync(BatchDetectKeyPhrasesRequest, CancellationToken)

Detects the key noun phrases found in a batch of documents.

Public Method BatchDetectSentiment(BatchDetectSentimentRequest)

Inspects a batch of documents and returns an inference of the prevailing sentiment, POSITIVE, NEUTRAL, MIXED, or NEGATIVE, in each one.

Public Method BatchDetectSentimentAsync(BatchDetectSentimentRequest, CancellationToken)

Inspects a batch of documents and returns an inference of the prevailing sentiment, POSITIVE, NEUTRAL, MIXED, or NEGATIVE, in each one.

Public Method BatchDetectSyntax(BatchDetectSyntaxRequest)

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.

Public Method BatchDetectSyntaxAsync(BatchDetectSyntaxRequest, CancellationToken)

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.

Public Method BatchDetectTargetedSentiment(BatchDetectTargetedSentimentRequest)

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 in the Amazon Comprehend Developer Guide.

Public Method BatchDetectTargetedSentimentAsync(BatchDetectTargetedSentimentRequest, CancellationToken)

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 in the Amazon Comprehend Developer Guide.

Public Method ClassifyDocument(ClassifyDocumentRequest)

Creates a classification request to analyze a single document in real-time. ClassifyDocument supports the following model types:

  • Custom classifier - a custom model that you have created and trained. For input, you can provide plain text, a single-page document (PDF, Word, or image), or Amazon Textract API output. For more information, see Custom classification in the Amazon Comprehend Developer Guide.

  • Prompt safety classifier - Amazon Comprehend provides a pre-trained model for classifying input prompts for generative AI applications. For input, you provide English plain text input. For prompt safety classification, the response includes only the Classes field. For more information about prompt safety classifiers, see Prompt safety classification in the Amazon Comprehend Developer Guide.

If the system detects errors while processing a page in the input document, the API response includes an Errors field 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.

Public Method ClassifyDocumentAsync(ClassifyDocumentRequest, CancellationToken)

Creates a classification request to analyze a single document in real-time. ClassifyDocument supports the following model types:

  • Custom classifier - a custom model that you have created and trained. For input, you can provide plain text, a single-page document (PDF, Word, or image), or Amazon Textract API output. For more information, see Custom classification in the Amazon Comprehend Developer Guide.

  • Prompt safety classifier - Amazon Comprehend provides a pre-trained model for classifying input prompts for generative AI applications. For input, you provide English plain text input. For prompt safety classification, the response includes only the Classes field. For more information about prompt safety classifiers, see Prompt safety classification in the Amazon Comprehend Developer Guide.

If the system detects errors while processing a page in the input document, the API response includes an Errors field 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.

Public Method ContainsPiiEntities(ContainsPiiEntitiesRequest)

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.

Public Method ContainsPiiEntitiesAsync(ContainsPiiEntitiesRequest, CancellationToken)

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.

Public Method CreateDataset(CreateDatasetRequest)

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.

Public Method CreateDatasetAsync(CreateDatasetRequest, CancellationToken)

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.

Public Method CreateDocumentClassifier(CreateDocumentClassifierRequest)

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.

Public Method CreateDocumentClassifierAsync(CreateDocumentClassifierRequest, CancellationToken)

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.

Public Method CreateEndpoint(CreateEndpointRequest)

Creates a model-specific endpoint for synchronous inference for a previously trained custom model For information about endpoints, see Managing endpoints.

Public Method CreateEndpointAsync(CreateEndpointRequest, CancellationToken)

Creates a model-specific endpoint for synchronous inference for a previously trained custom model For information about endpoints, see Managing endpoints.

Public Method CreateEntityRecognizer(CreateEntityRecognizerRequest)

Creates an entity recognizer using submitted files. After your CreateEntityRecognizer request is submitted, you can check job status using the DescribeEntityRecognizer API.

Public Method CreateEntityRecognizerAsync(CreateEntityRecognizerRequest, CancellationToken)

Creates an entity recognizer using submitted files. After your CreateEntityRecognizer request is submitted, you can check job status using the DescribeEntityRecognizer API.

Public Method CreateFlywheel(CreateFlywheelRequest)

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.

Public Method CreateFlywheelAsync(CreateFlywheelRequest, CancellationToken)

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.

Public Method DeleteDocumentClassifier(DeleteDocumentClassifierRequest)

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.

Public Method DeleteDocumentClassifierAsync(DeleteDocumentClassifierRequest, CancellationToken)

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.

Public Method DeleteEndpoint(DeleteEndpointRequest)

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.

Public Method DeleteEndpointAsync(DeleteEndpointRequest, CancellationToken)

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.

Public Method DeleteEntityRecognizer(DeleteEntityRecognizerRequest)

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.

Public Method DeleteEntityRecognizerAsync(DeleteEntityRecognizerRequest, CancellationToken)

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.

Public Method DeleteFlywheel(DeleteFlywheelRequest)

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.

Public Method DeleteFlywheelAsync(DeleteFlywheelRequest, CancellationToken)

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.

Public Method DeleteResourcePolicy(DeleteResourcePolicyRequest)

Deletes a resource-based policy that is attached to a custom model.

Public Method DeleteResourcePolicyAsync(DeleteResourcePolicyRequest, CancellationToken)

Deletes a resource-based policy that is attached to a custom model.

Public Method DescribeDataset(DescribeDatasetRequest)

Returns information about the dataset that you specify. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.

Public Method DescribeDatasetAsync(DescribeDatasetRequest, CancellationToken)

Returns information about the dataset that you specify. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.

Public Method DescribeDocumentClassificationJob(DescribeDocumentClassificationJobRequest)

Gets the properties associated with a document classification job. Use this operation to get the status of a classification job.

Public Method DescribeDocumentClassificationJobAsync(DescribeDocumentClassificationJobRequest, CancellationToken)

Gets the properties associated with a document classification job. Use this operation to get the status of a classification job.

Public Method DescribeDocumentClassifier(DescribeDocumentClassifierRequest)

Gets the properties associated with a document classifier.

Public Method DescribeDocumentClassifierAsync(DescribeDocumentClassifierRequest, CancellationToken)

Gets the properties associated with a document classifier.

Public Method DescribeDominantLanguageDetectionJob(DescribeDominantLanguageDetectionJobRequest)

Gets the properties associated with a dominant language detection job. Use this operation to get the status of a detection job.

Public Method DescribeDominantLanguageDetectionJobAsync(DescribeDominantLanguageDetectionJobRequest, CancellationToken)

Gets the properties associated with a dominant language detection job. Use this operation to get the status of a detection job.

Public Method DescribeEndpoint(DescribeEndpointRequest)

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.

Public Method DescribeEndpointAsync(DescribeEndpointRequest, CancellationToken)

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.

Public Method DescribeEntitiesDetectionJob(DescribeEntitiesDetectionJobRequest)

Gets the properties associated with an entities detection job. Use this operation to get the status of a detection job.

Public Method DescribeEntitiesDetectionJobAsync(DescribeEntitiesDetectionJobRequest, CancellationToken)

Gets the properties associated with an entities detection job. Use this operation to get the status of a detection job.

Public Method DescribeEntityRecognizer(DescribeEntityRecognizerRequest)

Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on.

Public Method DescribeEntityRecognizerAsync(DescribeEntityRecognizerRequest, CancellationToken)

Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on.

Public Method DescribeEventsDetectionJob(DescribeEventsDetectionJobRequest)

Gets the status and details of an events detection job.

Public Method DescribeEventsDetectionJobAsync(DescribeEventsDetectionJobRequest, CancellationToken)

Gets the status and details of an events detection job.

Public Method DescribeFlywheel(DescribeFlywheelRequest)

Provides configuration information about the flywheel. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.

Public Method DescribeFlywheelAsync(DescribeFlywheelRequest, CancellationToken)

Provides configuration information about the flywheel. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.

Public Method DescribeFlywheelIteration(DescribeFlywheelIterationRequest)

Retrieve the configuration properties of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.

Public Method DescribeFlywheelIterationAsync(DescribeFlywheelIterationRequest, CancellationToken)

Retrieve the configuration properties of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.

Public Method DescribeKeyPhrasesDetectionJob(DescribeKeyPhrasesDetectionJobRequest)

Gets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job.

Public Method DescribeKeyPhrasesDetectionJobAsync(DescribeKeyPhrasesDetectionJobRequest, CancellationToken)

Gets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job.

Public Method DescribePiiEntitiesDetectionJob(DescribePiiEntitiesDetectionJobRequest)

Gets the properties associated with a PII entities detection job. For example, you can use this operation to get the job status.

Public Method DescribePiiEntitiesDetectionJobAsync(DescribePiiEntitiesDetectionJobRequest, CancellationToken)

Gets the properties associated with a PII entities detection job. For example, you can use this operation to get the job status.

Public Method DescribeResourcePolicy(DescribeResourcePolicyRequest)

Gets the details of a resource-based policy that is attached to a custom model, including the JSON body of the policy.

Public Method DescribeResourcePolicyAsync(DescribeResourcePolicyRequest, CancellationToken)

Gets the details of a resource-based policy that is attached to a custom model, including the JSON body of the policy.

Public Method DescribeSentimentDetectionJob(DescribeSentimentDetectionJobRequest)

Gets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job.

Public Method DescribeSentimentDetectionJobAsync(DescribeSentimentDetectionJobRequest, CancellationToken)

Gets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job.

Public Method DescribeTargetedSentimentDetectionJob(DescribeTargetedSentimentDetectionJobRequest)

Gets the properties associated with a targeted sentiment detection job. Use this operation to get the status of the job.

Public Method DescribeTargetedSentimentDetectionJobAsync(DescribeTargetedSentimentDetectionJobRequest, CancellationToken)

Gets the properties associated with a targeted sentiment detection job. Use this operation to get the status of the job.

Public Method DescribeTopicsDetectionJob(DescribeTopicsDetectionJobRequest)

Gets the properties associated with a topic detection job. Use this operation to get the status of a detection job.

Public Method DescribeTopicsDetectionJobAsync(DescribeTopicsDetectionJobRequest, CancellationToken)

Gets the properties associated with a topic detection job. Use this operation to get the status of a detection job.

Public Method DetectDominantLanguage(DetectDominantLanguageRequest)

Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.

Public Method DetectDominantLanguageAsync(DetectDominantLanguageRequest, CancellationToken)

Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.

Public Method DetectEntities(DetectEntitiesRequest)

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.

Public Method DetectEntitiesAsync(DetectEntitiesRequest, CancellationToken)

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.

Public Method DetectKeyPhrases(DetectKeyPhrasesRequest)

Detects the key noun phrases found in the text.

Public Method DetectKeyPhrasesAsync(DetectKeyPhrasesRequest, CancellationToken)

Detects the key noun phrases found in the text.

Public Method DetectPiiEntities(DetectPiiEntitiesRequest)

Inspects the input text for entities that contain personally identifiable information (PII) and returns information about them.

Public Method DetectPiiEntitiesAsync(DetectPiiEntitiesRequest, CancellationToken)

Inspects the input text for entities that contain personally identifiable information (PII) and returns information about them.

Public Method DetectSentiment(DetectSentimentRequest)

Inspects text and returns an inference of the prevailing sentiment (POSITIVE, NEUTRAL, MIXED, or NEGATIVE).

Public Method DetectSentimentAsync(DetectSentimentRequest, CancellationToken)

Inspects text and returns an inference of the prevailing sentiment (POSITIVE, NEUTRAL, MIXED, or NEGATIVE).

Public Method DetectSyntax(DetectSyntaxRequest)

Inspects text for syntax and the part of speech of words in the document. For more information, see Syntax in the Comprehend Developer Guide.

Public Method DetectSyntaxAsync(DetectSyntaxRequest, CancellationToken)

Inspects text for syntax and the part of speech of words in the document. For more information, see Syntax in the Comprehend Developer Guide.

Public Method DetectTargetedSentiment(DetectTargetedSentimentRequest)

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 in the Amazon Comprehend Developer Guide.

Public Method DetectTargetedSentimentAsync(DetectTargetedSentimentRequest, CancellationToken)

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 in the Amazon Comprehend Developer Guide.

Public Method DetectToxicContent(DetectToxicContentRequest)

Performs toxicity analysis on the list of text strings that you provide as input. The API response contains a results list that matches the size of the input list. For more information about toxicity detection, see Toxicity detection in the Amazon Comprehend Developer Guide.

Public Method DetectToxicContentAsync(DetectToxicContentRequest, CancellationToken)

Performs toxicity analysis on the list of text strings that you provide as input. The API response contains a results list that matches the size of the input list. For more information about toxicity detection, see Toxicity detection in the Amazon Comprehend Developer Guide.

Public Method DetermineServiceOperationEndpoint(AmazonWebServiceRequest)

Returns the endpoint that will be used for a particular request.

Public Method ImportModel(ImportModelRequest)

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.

Public Method ImportModelAsync(ImportModelRequest, CancellationToken)

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.

Public Method ListDatasets(ListDatasetsRequest)

List the datasets that you have configured in this Region. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.

Public Method ListDatasetsAsync(ListDatasetsRequest, CancellationToken)

List the datasets that you have configured in this Region. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.

Public Method ListDocumentClassificationJobs(ListDocumentClassificationJobsRequest)

Gets a list of the documentation classification jobs that you have submitted.

Public Method ListDocumentClassificationJobsAsync(ListDocumentClassificationJobsRequest, CancellationToken)

Gets a list of the documentation classification jobs that you have submitted.

Public Method ListDocumentClassifiers(ListDocumentClassifiersRequest)

Gets a list of the document classifiers that you have created.

Public Method ListDocumentClassifiersAsync(ListDocumentClassifiersRequest, CancellationToken)

Gets a list of the document classifiers that you have created.

Public Method ListDocumentClassifierSummaries(ListDocumentClassifierSummariesRequest)

Gets a list of summaries of the document classifiers that you have created

Public Method ListDocumentClassifierSummariesAsync(ListDocumentClassifierSummariesRequest, CancellationToken)

Gets a list of summaries of the document classifiers that you have created

Public Method ListDominantLanguageDetectionJobs(ListDominantLanguageDetectionJobsRequest)

Gets a list of the dominant language detection jobs that you have submitted.

Public Method ListDominantLanguageDetectionJobsAsync(ListDominantLanguageDetectionJobsRequest, CancellationToken)

Gets a list of the dominant language detection jobs that you have submitted.

Public Method ListEndpoints(ListEndpointsRequest)

Gets a list of all existing endpoints that you've created. For information about endpoints, see Managing endpoints.

Public Method ListEndpointsAsync(ListEndpointsRequest, CancellationToken)

Gets a list of all existing endpoints that you've created. For information about endpoints, see Managing endpoints.

Public Method ListEntitiesDetectionJobs(ListEntitiesDetectionJobsRequest)

Gets a list of the entity detection jobs that you have submitted.

Public Method ListEntitiesDetectionJobsAsync(ListEntitiesDetectionJobsRequest, CancellationToken)

Gets a list of the entity detection jobs that you have submitted.

Public Method ListEntityRecognizers(ListEntityRecognizersRequest)

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.

Public Method ListEntityRecognizersAsync(ListEntityRecognizersRequest, CancellationToken)

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.

Public Method ListEntityRecognizerSummaries(ListEntityRecognizerSummariesRequest)

Gets a list of summaries for the entity recognizers that you have created.

Public Method ListEntityRecognizerSummariesAsync(ListEntityRecognizerSummariesRequest, CancellationToken)

Gets a list of summaries for the entity recognizers that you have created.

Public Method ListEventsDetectionJobs(ListEventsDetectionJobsRequest)

Gets a list of the events detection jobs that you have submitted.

Public Method ListEventsDetectionJobsAsync(ListEventsDetectionJobsRequest, CancellationToken)

Gets a list of the events detection jobs that you have submitted.

Public Method ListFlywheelIterationHistory(ListFlywheelIterationHistoryRequest)

Information about the history of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.

Public Method ListFlywheelIterationHistoryAsync(ListFlywheelIterationHistoryRequest, CancellationToken)

Information about the history of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.

Public Method ListFlywheels(ListFlywheelsRequest)

Gets a list of the flywheels that you have created.

Public Method ListFlywheelsAsync(ListFlywheelsRequest, CancellationToken)

Gets a list of the flywheels that you have created.

Public Method ListKeyPhrasesDetectionJobs(ListKeyPhrasesDetectionJobsRequest)

Get a list of key phrase detection jobs that you have submitted.

Public Method ListKeyPhrasesDetectionJobsAsync(ListKeyPhrasesDetectionJobsRequest, CancellationToken)

Get a list of key phrase detection jobs that you have submitted.

Public Method ListPiiEntitiesDetectionJobs(ListPiiEntitiesDetectionJobsRequest)

Gets a list of the PII entity detection jobs that you have submitted.

Public Method ListPiiEntitiesDetectionJobsAsync(ListPiiEntitiesDetectionJobsRequest, CancellationToken)

Gets a list of the PII entity detection jobs that you have submitted.

Public Method ListSentimentDetectionJobs(ListSentimentDetectionJobsRequest)

Gets a list of sentiment detection jobs that you have submitted.

Public Method ListSentimentDetectionJobsAsync(ListSentimentDetectionJobsRequest, CancellationToken)

Gets a list of sentiment detection jobs that you have submitted.

Public Method ListTagsForResource(ListTagsForResourceRequest)

Lists all tags associated with a given Amazon Comprehend resource.

Public Method ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken)

Lists all tags associated with a given Amazon Comprehend resource.

Public Method ListTargetedSentimentDetectionJobs(ListTargetedSentimentDetectionJobsRequest)

Gets a list of targeted sentiment detection jobs that you have submitted.

Public Method ListTargetedSentimentDetectionJobsAsync(ListTargetedSentimentDetectionJobsRequest, CancellationToken)

Gets a list of targeted sentiment detection jobs that you have submitted.

Public Method ListTopicsDetectionJobs(ListTopicsDetectionJobsRequest)

Gets a list of the topic detection jobs that you have submitted.

Public Method ListTopicsDetectionJobsAsync(ListTopicsDetectionJobsRequest, CancellationToken)

Gets a list of the topic detection jobs that you have submitted.

Public Method PutResourcePolicy(PutResourcePolicyRequest)

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.

Public Method PutResourcePolicyAsync(PutResourcePolicyRequest, CancellationToken)

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.

Public Method StartDocumentClassificationJob(StartDocumentClassificationJobRequest)

Starts an asynchronous document classification job using a custom classification model. Use the DescribeDocumentClassificationJob operation to track the progress of the job.

Public Method StartDocumentClassificationJobAsync(StartDocumentClassificationJobRequest, CancellationToken)

Starts an asynchronous document classification job using a custom classification model. Use the DescribeDocumentClassificationJob operation to track the progress of the job.

Public Method StartDominantLanguageDetectionJob(StartDominantLanguageDetectionJobRequest)

Starts an asynchronous dominant language detection job for a collection of documents. Use the operation to track the status of a job.

Public Method StartDominantLanguageDetectionJobAsync(StartDominantLanguageDetectionJobRequest, CancellationToken)

Starts an asynchronous dominant language detection job for a collection of documents. Use the operation to track the status of a job.

Public Method StartEntitiesDetectionJob(StartEntitiesDetectionJobRequest)

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.

Public Method StartEntitiesDetectionJobAsync(StartEntitiesDetectionJobRequest, CancellationToken)

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.

Public Method StartEventsDetectionJob(StartEventsDetectionJobRequest)

Starts an asynchronous event detection job for a collection of documents.

Public Method StartEventsDetectionJobAsync(StartEventsDetectionJobRequest, CancellationToken)

Starts an asynchronous event detection job for a collection of documents.

Public Method StartFlywheelIteration(StartFlywheelIterationRequest)

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.

Public Method StartFlywheelIterationAsync(StartFlywheelIterationRequest, CancellationToken)

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.

Public Method StartKeyPhrasesDetectionJob(StartKeyPhrasesDetectionJobRequest)

Starts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the status of a job.

Public Method StartKeyPhrasesDetectionJobAsync(StartKeyPhrasesDetectionJobRequest, CancellationToken)

Starts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the status of a job.

Public Method StartPiiEntitiesDetectionJob(StartPiiEntitiesDetectionJobRequest)

Starts an asynchronous PII entity detection job for a collection of documents.

Public Method StartPiiEntitiesDetectionJobAsync(StartPiiEntitiesDetectionJobRequest, CancellationToken)

Starts an asynchronous PII entity detection job for a collection of documents.

Public Method StartSentimentDetectionJob(StartSentimentDetectionJobRequest)

Starts an asynchronous sentiment detection job for a collection of documents. Use the operation to track the status of a job.

Public Method StartSentimentDetectionJobAsync(StartSentimentDetectionJobRequest, CancellationToken)

Starts an asynchronous sentiment detection job for a collection of documents. Use the operation to track the status of a job.

Public Method StartTargetedSentimentDetectionJob(StartTargetedSentimentDetectionJobRequest)

Starts an asynchronous targeted sentiment detection job for a collection of documents. Use the DescribeTargetedSentimentDetectionJob operation to track the status of a job.

Public Method StartTargetedSentimentDetectionJobAsync(StartTargetedSentimentDetectionJobRequest, CancellationToken)

Starts an asynchronous targeted sentiment detection job for a collection of documents. Use the DescribeTargetedSentimentDetectionJob operation to track the status of a job.

Public Method StartTopicsDetectionJob(StartTopicsDetectionJobRequest)

Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob operation to track the status of a job.

Public Method StartTopicsDetectionJobAsync(StartTopicsDetectionJobRequest, CancellationToken)

Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob operation to track the status of a job.

Public Method StopDominantLanguageDetectionJob(StopDominantLanguageDetectionJobRequest)

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.

Public Method StopDominantLanguageDetectionJobAsync(StopDominantLanguageDetectionJobRequest, CancellationToken)

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.

Public Method StopEntitiesDetectionJob(StopEntitiesDetectionJobRequest)

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.

Public Method StopEntitiesDetectionJobAsync(StopEntitiesDetectionJobRequest, CancellationToken)

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.

Public Method StopEventsDetectionJob(StopEventsDetectionJobRequest)

Stops an events detection job in progress.

Public Method StopEventsDetectionJobAsync(StopEventsDetectionJobRequest, CancellationToken)

Stops an events detection job in progress.

Public Method StopKeyPhrasesDetectionJob(StopKeyPhrasesDetectionJobRequest)

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.

Public Method StopKeyPhrasesDetectionJobAsync(StopKeyPhrasesDetectionJobRequest, CancellationToken)

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.

Public Method StopPiiEntitiesDetectionJob(StopPiiEntitiesDetectionJobRequest)

Stops a PII entities detection job in progress.

Public Method StopPiiEntitiesDetectionJobAsync(StopPiiEntitiesDetectionJobRequest, CancellationToken)

Stops a PII entities detection job in progress.

Public Method StopSentimentDetectionJob(StopSentimentDetectionJobRequest)

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.

Public Method StopSentimentDetectionJobAsync(StopSentimentDetectionJobRequest, CancellationToken)

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.

Public Method StopTargetedSentimentDetectionJob(StopTargetedSentimentDetectionJobRequest)

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.

Public Method StopTargetedSentimentDetectionJobAsync(StopTargetedSentimentDetectionJobRequest, CancellationToken)

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.

Public Method StopTrainingDocumentClassifier(StopTrainingDocumentClassifierRequest)

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.

Public Method StopTrainingDocumentClassifierAsync(StopTrainingDocumentClassifierRequest, CancellationToken)

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.

Public Method StopTrainingEntityRecognizer(StopTrainingEntityRecognizerRequest)

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.

Public Method StopTrainingEntityRecognizerAsync(StopTrainingEntityRecognizerRequest, CancellationToken)

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.

Public Method TagResource(TagResourceRequest)

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.

Public Method TagResourceAsync(TagResourceRequest, CancellationToken)

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.

Public Method UntagResource(UntagResourceRequest)

Removes a specific tag associated with an Amazon Comprehend resource.

Public Method UntagResourceAsync(UntagResourceRequest, CancellationToken)

Removes a specific tag associated with an Amazon Comprehend resource.

Public Method UpdateEndpoint(UpdateEndpointRequest)

Updates information about the specified endpoint. For information about endpoints, see Managing endpoints.

Public Method UpdateEndpointAsync(UpdateEndpointRequest, CancellationToken)

Updates information about the specified endpoint. For information about endpoints, see Managing endpoints.

Public Method UpdateFlywheel(UpdateFlywheelRequest)

Update the configuration information for an existing flywheel.

Public Method UpdateFlywheelAsync(UpdateFlywheelRequest, CancellationToken)

Update the configuration information for an existing flywheel.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5