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.

Classes

NameDescription
Class BatchDetectDominantLanguageItemResult

The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.

Class BatchDetectDominantLanguageRequest

Container for the parameters to the BatchDetectDominantLanguage operation. 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.

Class BatchDetectDominantLanguageResponse

This is the response object from the BatchDetectDominantLanguage operation.

Class BatchDetectEntitiesItemResult

The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.

Class BatchDetectEntitiesRequest

Container for the parameters to the BatchDetectEntities operation. Inspects the text of a batch of documents for named entities and returns information about them. For more information about named entities, see how-entities

Class BatchDetectEntitiesResponse

This is the response object from the BatchDetectEntities operation.

Class BatchDetectKeyPhrasesItemResult

The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.

Class BatchDetectKeyPhrasesRequest

Container for the parameters to the BatchDetectKeyPhrases operation. Detects the key noun phrases found in a batch of documents.

Class BatchDetectKeyPhrasesResponse

This is the response object from the BatchDetectKeyPhrases operation.

Class BatchDetectSentimentItemResult

The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.

Class BatchDetectSentimentRequest

Container for the parameters to the BatchDetectSentiment operation. Inspects a batch of documents and returns an inference of the prevailing sentiment, POSITIVE, NEUTRAL, MIXED, or NEGATIVE, in each one.

Class BatchDetectSentimentResponse

This is the response object from the BatchDetectSentiment operation.

Class BatchDetectSyntaxItemResult

The result of calling the operation. The operation returns one object that is successfully processed by the operation.

Class BatchDetectSyntaxRequest

Container for the parameters to the BatchDetectSyntax operation. 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 how-syntax.

Class BatchDetectSyntaxResponse

This is the response object from the BatchDetectSyntax operation.

Class BatchItemError

Describes an error that occurred while processing a document in a batch. The operation returns on BatchItemError object for each document that contained an error.

Class BatchSizeLimitExceededException

Comprehend exception

Class DescribeDominantLanguageDetectionJobRequest

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

Class DescribeDominantLanguageDetectionJobResponse

This is the response object from the DescribeDominantLanguageDetectionJob operation.

Class DescribeEntitiesDetectionJobRequest

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

Class DescribeEntitiesDetectionJobResponse

This is the response object from the DescribeEntitiesDetectionJob operation.

Class DescribeKeyPhrasesDetectionJobRequest

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

Class DescribeKeyPhrasesDetectionJobResponse

This is the response object from the DescribeKeyPhrasesDetectionJob operation.

Class DescribeSentimentDetectionJobRequest

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

Class DescribeSentimentDetectionJobResponse

This is the response object from the DescribeSentimentDetectionJob operation.

Class DescribeTopicsDetectionJobRequest

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

Class DescribeTopicsDetectionJobResponse

This is the response object from the DescribeTopicsDetectionJob operation.

Class DetectDominantLanguageRequest

Container for the parameters to the DetectDominantLanguage operation. Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.

Class DetectDominantLanguageResponse

This is the response object from the DetectDominantLanguage operation.

Class DetectEntitiesRequest

Container for the parameters to the DetectEntities operation. Inspects text for named entities, and returns information about them. For more information, about named entities, see how-entities.

Class DetectEntitiesResponse

This is the response object from the DetectEntities operation.

Class DetectKeyPhrasesRequest

Container for the parameters to the DetectKeyPhrases operation. Detects the key noun phrases found in the text.

Class DetectKeyPhrasesResponse

This is the response object from the DetectKeyPhrases operation.

Class DetectSentimentRequest

Container for the parameters to the DetectSentiment operation. Inspects text and returns an inference of the prevailing sentiment (POSITIVE, NEUTRAL, MIXED, or NEGATIVE).

Class DetectSentimentResponse

This is the response object from the DetectSentiment operation.

Class DetectSyntaxRequest

Container for the parameters to the DetectSyntax operation. Inspects text for syntax and the part of speech of words in the document. For more information, how-syntax.

Class DetectSyntaxResponse

This is the response object from the DetectSyntax operation.

Class DominantLanguage

Returns the code for the dominant language in the input text and the level of confidence that Amazon Comprehend has in the accuracy of the detection.

Class DominantLanguageDetectionJobFilter

Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.

Class DominantLanguageDetectionJobProperties

Provides information about a dominant language detection job.

Class EntitiesDetectionJobFilter

Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.

Class EntitiesDetectionJobProperties

Provides information about an entities detection job.

Class Entity

Provides information about an entity.

Class InputDataConfig

The input properties for a topic detection job.

Class InternalServerException

Comprehend exception

Class InvalidFilterException

Comprehend exception

Class InvalidRequestException

Comprehend exception

Class JobNotFoundException

Comprehend exception

Class KeyPhrase

Describes a key noun phrase.

Class KeyPhrasesDetectionJobFilter

Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.

Class KeyPhrasesDetectionJobProperties

Provides information about a key phrases detection job.

Class ListDominantLanguageDetectionJobsRequest

Container for the parameters to the ListDominantLanguageDetectionJobs operation. Gets a list of the dominant language detection jobs that you have submitted.

Class ListDominantLanguageDetectionJobsResponse

This is the response object from the ListDominantLanguageDetectionJobs operation.

Class ListEntitiesDetectionJobsRequest

Container for the parameters to the ListEntitiesDetectionJobs operation. Gets a list of the entity detection jobs that you have submitted.

Class ListEntitiesDetectionJobsResponse

This is the response object from the ListEntitiesDetectionJobs operation.

Class ListKeyPhrasesDetectionJobsRequest

Container for the parameters to the ListKeyPhrasesDetectionJobs operation. Get a list of key phrase detection jobs that you have submitted.

Class ListKeyPhrasesDetectionJobsResponse

This is the response object from the ListKeyPhrasesDetectionJobs operation.

Class ListSentimentDetectionJobsRequest

Container for the parameters to the ListSentimentDetectionJobs operation. Gets a list of sentiment detection jobs that you have submitted.

Class ListSentimentDetectionJobsResponse

This is the response object from the ListSentimentDetectionJobs operation.

Class ListTopicsDetectionJobsRequest

Container for the parameters to the ListTopicsDetectionJobs operation. Gets a list of the topic detection jobs that you have submitted.

Class ListTopicsDetectionJobsResponse

This is the response object from the ListTopicsDetectionJobs operation.

Class OutputDataConfig

Provides configuration parameters for the output of topic detection jobs.

Class PartOfSpeechTag

Identifies the part of speech represented by the token and gives the confidence that Amazon Comprehend has that the part of speech was correctly identified. For more information about the parts of speech that Amazon Comprehend can identify, see how-syntax.

Class SentimentDetectionJobFilter

Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.

Class SentimentDetectionJobProperties

Provides information about a sentiment detection job.

Class SentimentScore

Describes the level of confidence that Amazon Comprehend has in the accuracy of its detection of sentiments.

Class StartDominantLanguageDetectionJobRequest

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

Class StartDominantLanguageDetectionJobResponse

This is the response object from the StartDominantLanguageDetectionJob operation.

Class StartEntitiesDetectionJobRequest

Container for the parameters to the StartEntitiesDetectionJob operation. Starts an asynchronous entity detection job for a collection of documents. Use the operation to track the status of a job.

Class StartEntitiesDetectionJobResponse

This is the response object from the StartEntitiesDetectionJob operation.

Class StartKeyPhrasesDetectionJobRequest

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

Class StartKeyPhrasesDetectionJobResponse

This is the response object from the StartKeyPhrasesDetectionJob operation.

Class StartSentimentDetectionJobRequest

Container for the parameters to the StartSentimentDetectionJob operation. Starts an asynchronous sentiment detection job for a collection of documents. use the operation to track the status of a job.

Class StartSentimentDetectionJobResponse

This is the response object from the StartSentimentDetectionJob operation.

Class StartTopicsDetectionJobRequest

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

Class StartTopicsDetectionJobResponse

This is the response object from the StartTopicsDetectionJob operation.

Class StopDominantLanguageDetectionJobRequest

Container for the parameters to the StopDominantLanguageDetectionJob operation. 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.

Class StopDominantLanguageDetectionJobResponse

This is the response object from the StopDominantLanguageDetectionJob operation.

Class StopEntitiesDetectionJobRequest

Container for the parameters to the StopEntitiesDetectionJob operation. 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.

Class StopEntitiesDetectionJobResponse

This is the response object from the StopEntitiesDetectionJob operation.

Class StopKeyPhrasesDetectionJobRequest

Container for the parameters to the StopKeyPhrasesDetectionJob operation. 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.

Class StopKeyPhrasesDetectionJobResponse

This is the response object from the StopKeyPhrasesDetectionJob operation.

Class StopSentimentDetectionJobRequest

Container for the parameters to the StopSentimentDetectionJob operation. 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.

Class StopSentimentDetectionJobResponse

This is the response object from the StopSentimentDetectionJob operation.

Class SyntaxToken

Represents a work in the input text that was recognized and assigned a part of speech. There is one syntax token record for each word in the source text.

Class TextSizeLimitExceededException

Comprehend exception

Class TooManyRequestsException

Comprehend exception

Class TopicsDetectionJobFilter

Provides information for filtering topic detection jobs. For more information, see .

Class TopicsDetectionJobProperties

Provides information about a topic detection job.

Class UnsupportedLanguageException

Comprehend exception