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 AugmentedManifestsListItem

An augmented manifest file that provides training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.

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

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

Class BatchDetectSyntaxResponse

This is the response object from the BatchDetectSyntax operation.

Class BatchDetectTargetedSentimentItemResult

Analysis results for one of the documents in the batch.

Class BatchDetectTargetedSentimentRequest

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

Class BatchDetectTargetedSentimentResponse

This is the response object from the BatchDetectTargetedSentiment 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

The number of documents in the request exceeds the limit of 25. Try your request again with fewer documents.

Class Block

Information about each word or line of text in the input document.

For additional information, see Block in the Amazon Textract API reference.

Class BlockReference

A reference to a block.

Class BoundingBox

The bounding box around the detected page or around an element on a document page. The left (x-coordinate) and top (y-coordinate) are coordinates that represent the top and left sides of the bounding box. Note that the upper-left corner of the image is the origin (0,0).

For additional information, see BoundingBox in the Amazon Textract API reference.

Class ChildBlock

Nested block contained within a block.

Class ClassifierEvaluationMetrics

Describes the result metrics for the test data associated with an documentation classifier.

Class ClassifierMetadata

Provides information about a document classifier.

Class ClassifyDocumentRequest

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

Class ClassifyDocumentResponse

This is the response object from the ClassifyDocument operation.

Class ComprehendPaginatorFactory

Paginators for the Comprehend service

Class ConcurrentModificationException

Concurrent modification of the tags associated with an Amazon Comprehend resource is not supported.

Class ContainsPiiEntitiesRequest

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

Class ContainsPiiEntitiesResponse

This is the response object from the ContainsPiiEntities operation.

Class CreateDatasetRequest

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

Class CreateDatasetResponse

This is the response object from the CreateDataset operation.

Class CreateDocumentClassifierRequest

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

Class CreateDocumentClassifierResponse

This is the response object from the CreateDocumentClassifier operation.

Class CreateEndpointRequest

Container for the parameters to the CreateEndpoint operation. Creates a model-specific endpoint for synchronous inference for a previously trained custom model For information about endpoints, see Managing endpoints.

Class CreateEndpointResponse

This is the response object from the CreateEndpoint operation.

Class CreateEntityRecognizerRequest

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

Class CreateEntityRecognizerResponse

This is the response object from the CreateEntityRecognizer operation.

Class CreateFlywheelRequest

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

Class CreateFlywheelResponse

This is the response object from the CreateFlywheel operation.

Class DataSecurityConfig

Data security configuration.

Class DatasetAugmentedManifestsListItem

An augmented manifest file that provides training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.

Class DatasetDocumentClassifierInputDataConfig

Describes the dataset input data configuration for a document classifier model.

For more information on how the input file is formatted, see Preparing training data in the Comprehend Developer Guide.

Class DatasetEntityRecognizerAnnotations

Describes the annotations associated with a entity recognizer.

Class DatasetEntityRecognizerDocuments

Describes the documents submitted with a dataset for an entity recognizer model.

Class DatasetEntityRecognizerEntityList

Describes the dataset entity list for an entity recognizer model.

For more information on how the input file is formatted, see Preparing training data in the Comprehend Developer Guide.

Class DatasetEntityRecognizerInputDataConfig

Specifies the format and location of the input data. You must provide either the Annotations parameter or the EntityList parameter.

Class DatasetFilter

Filter the datasets based on creation time or dataset status.

Class DatasetInputDataConfig

Specifies the format and location of the input data for the dataset.

Class DatasetProperties

Properties associated with the dataset.

Class DeleteDocumentClassifierRequest

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

Class DeleteDocumentClassifierResponse

This is the response object from the DeleteDocumentClassifier operation.

Class DeleteEndpointRequest

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

Class DeleteEndpointResponse

This is the response object from the DeleteEndpoint operation.

Class DeleteEntityRecognizerRequest

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

Class DeleteEntityRecognizerResponse

This is the response object from the DeleteEntityRecognizer operation.

Class DeleteFlywheelRequest

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

Class DeleteFlywheelResponse

This is the response object from the DeleteFlywheel operation.

Class DeleteResourcePolicyRequest

Container for the parameters to the DeleteResourcePolicy operation. Deletes a resource-based policy that is attached to a custom model.

Class DeleteResourcePolicyResponse

This is the response object from the DeleteResourcePolicy operation.

Class DescribeDatasetRequest

Container for the parameters to the DescribeDataset operation. Returns information about the dataset that you specify. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.

Class DescribeDatasetResponse

This is the response object from the DescribeDataset operation.

Class DescribeDocumentClassificationJobRequest

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

Class DescribeDocumentClassificationJobResponse

This is the response object from the DescribeDocumentClassificationJob operation.

Class DescribeDocumentClassifierRequest

Container for the parameters to the DescribeDocumentClassifier operation. Gets the properties associated with a document classifier.

Class DescribeDocumentClassifierResponse

This is the response object from the DescribeDocumentClassifier operation.

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 DescribeEndpointRequest

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

Class DescribeEndpointResponse

This is the response object from the DescribeEndpoint 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 DescribeEntityRecognizerRequest

Container for the parameters to the DescribeEntityRecognizer operation. Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on.

Class DescribeEntityRecognizerResponse

This is the response object from the DescribeEntityRecognizer operation.

Class DescribeEventsDetectionJobRequest

Container for the parameters to the DescribeEventsDetectionJob operation. Gets the status and details of an events detection job.

Class DescribeEventsDetectionJobResponse

This is the response object from the DescribeEventsDetectionJob operation.

Class DescribeFlywheelIterationRequest

Container for the parameters to the DescribeFlywheelIteration operation. Retrieve the configuration properties of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.

Class DescribeFlywheelIterationResponse

This is the response object from the DescribeFlywheelIteration operation.

Class DescribeFlywheelRequest

Container for the parameters to the DescribeFlywheel operation. Provides configuration information about the flywheel. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.

Class DescribeFlywheelResponse

This is the response object from the DescribeFlywheel 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 DescribePiiEntitiesDetectionJobRequest

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

Class DescribePiiEntitiesDetectionJobResponse

This is the response object from the DescribePiiEntitiesDetectionJob operation.

Class DescribeResourcePolicyRequest

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

Class DescribeResourcePolicyResponse

This is the response object from the DescribeResourcePolicy 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 DescribeTargetedSentimentDetectionJobRequest

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

Class DescribeTargetedSentimentDetectionJobResponse

This is the response object from the DescribeTargetedSentimentDetectionJob 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. 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.

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 DetectPiiEntitiesRequest

Container for the parameters to the DetectPiiEntities operation. Inspects the input text for entities that contain personally identifiable information (PII) and returns information about them.

Class DetectPiiEntitiesResponse

This is the response object from the DetectPiiEntities 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, see Syntax in the Comprehend Developer Guide.

Class DetectSyntaxResponse

This is the response object from the DetectSyntax operation.

Class DetectTargetedSentimentRequest

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

Class DetectTargetedSentimentResponse

This is the response object from the DetectTargetedSentiment operation.

Class DetectToxicContentRequest

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

Class DetectToxicContentResponse

This is the response object from the DetectToxicContent operation.

Class DocumentClass

Specifies the class that categorizes the document being analyzed

Class DocumentClassificationConfig

Configuration required for a document classification model.

Class DocumentClassificationJobFilter

Provides information for filtering a list of document classification jobs. For more information, see the operation. You can provide only one filter parameter in each request.

Class DocumentClassificationJobProperties

Provides information about a document classification job.

Class DocumentClassifierDocuments

The location of the training documents. This parameter is required in a request to create a semi-structured document classification model.

Class DocumentClassifierFilter

Provides information for filtering a list of document classifiers. You can only specify one filtering parameter in a request. For more information, see the ListDocumentClassifiers operation.

Class DocumentClassifierInputDataConfig

The input properties for training a document classifier.

For more information on how the input file is formatted, see Preparing training data in the Comprehend Developer Guide.

Class DocumentClassifierOutputDataConfig

Provide the location for output data from a custom classifier job. This field is mandatory if you are training a native document model.

Class DocumentClassifierProperties

Provides information about a document classifier.

Class DocumentClassifierSummary

Describes information about a document classifier and its versions.

Class DocumentLabel

Specifies one of the label or labels that categorize the document being analyzed.

Class DocumentMetadata

Information about the document, discovered during text extraction.

Class DocumentReaderConfig

Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

By default, Amazon Comprehend performs the following actions to extract text from files, based on the input file type:

  • Word files - Amazon Comprehend parser extracts the text.

  • Digital PDF files - Amazon Comprehend parser extracts the text.

  • Image files and scanned PDF files - Amazon Comprehend uses the Amazon Textract DetectDocumentText API to extract the text.

DocumentReaderConfig does not apply to plain text files or Word files.

For image files and PDF documents, you can override these default actions using the fields listed below. For more information, see Setting text extraction options in the Comprehend Developer Guide.

Class DocumentTypeListItem

Document type for each page in the document.

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 EndpointFilter

The filter used to determine which endpoints are returned. You can filter jobs on their name, model, status, or the date and time that they were created. You can only set one filter at a time.

Class EndpointProperties

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

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 EntityLabel

Specifies one of the label or labels that categorize the personally identifiable information (PII) entity being analyzed.

Class EntityRecognitionConfig

Configuration required for an entity recognition model.

Class EntityRecognizerAnnotations

Describes the annotations associated with a entity recognizer.

Class EntityRecognizerDocuments

Describes the training documents submitted with an entity recognizer.

Class EntityRecognizerEntityList

Describes the entity list submitted with an entity recognizer.

Class EntityRecognizerEvaluationMetrics

Detailed information about the accuracy of an entity recognizer.

Class EntityRecognizerFilter

Provides information for filtering a list of entity recognizers. You can only specify one filtering parameter in a request. For more information, see the ListEntityRecognizers operation./>

Class EntityRecognizerInputDataConfig

Specifies the format and location of the input data.

Class EntityRecognizerMetadata

Detailed information about an entity recognizer.

Class EntityRecognizerMetadataEntityTypesListItem

Individual item from the list of entity types in the metadata of an entity recognizer.

Class EntityRecognizerOutputDataConfig

Output data configuration.

Class EntityRecognizerProperties

Describes information about an entity recognizer.

Class EntityRecognizerSummary

Describes the information about an entity recognizer and its versions.

Class EntityTypesEvaluationMetrics

Detailed information about the accuracy of an entity recognizer for a specific entity type.

Class EntityTypesListItem

An entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer.

Class ErrorsListItem

Text extraction encountered one or more page-level errors in the input document.

The ErrorCode contains one of the following values:

  • TEXTRACT_BAD_PAGE - Amazon Textract cannot read the page. For more information about page limits in Amazon Textract, see Page Quotas in Amazon Textract.

  • TEXTRACT_PROVISIONED_THROUGHPUT_EXCEEDED - The number of requests exceeded your throughput limit. For more information about throughput quotas in Amazon Textract, see Default quotas in Amazon Textract.

  • PAGE_CHARACTERS_EXCEEDED - Too many text characters on the page (10,000 characters maximum).

  • PAGE_SIZE_EXCEEDED - The maximum page size is 10 MB.

  • INTERNAL_SERVER_ERROR - The request encountered a service issue. Try the API request again.

Class EventsDetectionJobFilter

Provides information for filtering a list of event detection jobs.

Class EventsDetectionJobProperties

Provides information about an events detection job.

Class ExtractedCharactersListItem

Array of the number of characters extracted from each page.

Class FlywheelFilter

Filter the flywheels based on creation time or flywheel status.

Class FlywheelIterationFilter

Filter the flywheel iterations based on creation time.

Class FlywheelIterationProperties

The configuration properties of a flywheel iteration.

Class FlywheelModelEvaluationMetrics

The evaluation metrics associated with the evaluated model.

Class FlywheelProperties

The flywheel properties.

Class FlywheelSummary

Flywheel summary information.

Class Geometry

Information about the location of items on a document page.

For additional information, see Geometry in the Amazon Textract API reference.

Class ImportModelRequest

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

Class ImportModelResponse

This is the response object from the ImportModel operation.

Class InputDataConfig

The input properties for an inference job. The document reader config field applies only to non-text inputs for custom analysis.

Class InternalServerException

An internal server error occurred. Retry your request.

Class InvalidFilterException

The filter specified for the operation is invalid. Specify a different filter.

Class InvalidRequestDetail

Provides additional detail about why the request failed.

Class InvalidRequestException

The request is invalid.

Class JobNotFoundException

The specified job was not found. Check the job ID and try again.

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 KmsKeyValidationException

The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.

Class ListDatasetsRequest

Container for the parameters to the ListDatasets operation. List the datasets that you have configured in this Region. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.

Class ListDatasetsResponse

This is the response object from the ListDatasets operation.

Class ListDocumentClassificationJobsRequest

Container for the parameters to the ListDocumentClassificationJobs operation. Gets a list of the documentation classification jobs that you have submitted.

Class ListDocumentClassificationJobsResponse

This is the response object from the ListDocumentClassificationJobs operation.

Class ListDocumentClassifiersRequest

Container for the parameters to the ListDocumentClassifiers operation. Gets a list of the document classifiers that you have created.

Class ListDocumentClassifiersResponse

This is the response object from the ListDocumentClassifiers operation.

Class ListDocumentClassifierSummariesRequest

Container for the parameters to the ListDocumentClassifierSummaries operation. Gets a list of summaries of the document classifiers that you have created

Class ListDocumentClassifierSummariesResponse

This is the response object from the ListDocumentClassifierSummaries operation.

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 ListEndpointsRequest

Container for the parameters to the ListEndpoints operation. Gets a list of all existing endpoints that you've created. For information about endpoints, see Managing endpoints.

Class ListEndpointsResponse

This is the response object from the ListEndpoints 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 ListEntityRecognizersRequest

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

Class ListEntityRecognizersResponse

This is the response object from the ListEntityRecognizers operation.

Class ListEntityRecognizerSummariesRequest

Container for the parameters to the ListEntityRecognizerSummaries operation. Gets a list of summaries for the entity recognizers that you have created.

Class ListEntityRecognizerSummariesResponse

This is the response object from the ListEntityRecognizerSummaries operation.

Class ListEventsDetectionJobsRequest

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

Class ListEventsDetectionJobsResponse

This is the response object from the ListEventsDetectionJobs operation.

Class ListFlywheelIterationHistoryRequest

Container for the parameters to the ListFlywheelIterationHistory operation. Information about the history of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.

Class ListFlywheelIterationHistoryResponse

This is the response object from the ListFlywheelIterationHistory operation.

Class ListFlywheelsRequest

Container for the parameters to the ListFlywheels operation. Gets a list of the flywheels that you have created.

Class ListFlywheelsResponse

This is the response object from the ListFlywheels 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 ListPiiEntitiesDetectionJobsRequest

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

Class ListPiiEntitiesDetectionJobsResponse

This is the response object from the ListPiiEntitiesDetectionJobs 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 ListTagsForResourceRequest

Container for the parameters to the ListTagsForResource operation. Lists all tags associated with a given Amazon Comprehend resource.

Class ListTagsForResourceResponse

This is the response object from the ListTagsForResource operation.

Class ListTargetedSentimentDetectionJobsRequest

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

Class ListTargetedSentimentDetectionJobsResponse

This is the response object from the ListTargetedSentimentDetectionJobs 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 MentionSentiment

Contains the sentiment and sentiment score for one mention of an entity.

For more information about targeted sentiment, see Targeted sentiment in the Amazon Comprehend Developer Guide.

Class OutputDataConfig

Provides configuration parameters for the output of inference 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 Syntax in the Comprehend Developer Guide.

Class PiiEntitiesDetectionJobFilter

Provides information for filtering a list of PII entity detection jobs.

Class PiiEntitiesDetectionJobProperties

Provides information about a PII entities detection job.

Class PiiEntity

Provides information about a PII entity.

Class PiiOutputDataConfig

Provides configuration parameters for the output of PII entity detection jobs.

Class Point

The X and Y coordinates of a point on a document page.

For additional information, see Point in the Amazon Textract API reference.

Class PutResourcePolicyRequest

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

Class PutResourcePolicyResponse

This is the response object from the PutResourcePolicy operation.

Class RedactionConfig

Provides configuration parameters for PII entity redaction.

Class RelationshipsListItem

List of child blocks for the current block.

Class ResourceInUseException

The specified resource name is already in use. Use a different name and try your request again.

Class ResourceLimitExceededException

The maximum number of resources per account has been exceeded. Review the resources, and then try your request again.

Class ResourceNotFoundException

The specified resource ARN was not found. Check the ARN and try your request again.

Class ResourceUnavailableException

The specified resource is not available. Check the resource and try your request again.

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 StartDocumentClassificationJobRequest

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

Class StartDocumentClassificationJobResponse

This is the response object from the StartDocumentClassificationJob operation.

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.

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.

Class StartEntitiesDetectionJobResponse

This is the response object from the StartEntitiesDetectionJob operation.

Class StartEventsDetectionJobRequest

Container for the parameters to the StartEventsDetectionJob operation. Starts an asynchronous event detection job for a collection of documents.

Class StartEventsDetectionJobResponse

This is the response object from the StartEventsDetectionJob operation.

Class StartFlywheelIterationRequest

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

Class StartFlywheelIterationResponse

This is the response object from the StartFlywheelIteration 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 StartPiiEntitiesDetectionJobRequest

Container for the parameters to the StartPiiEntitiesDetectionJob operation. Starts an asynchronous PII entity detection job for a collection of documents.

Class StartPiiEntitiesDetectionJobResponse

This is the response object from the StartPiiEntitiesDetectionJob 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 StartTargetedSentimentDetectionJobRequest

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

Class StartTargetedSentimentDetectionJobResponse

This is the response object from the StartTargetedSentimentDetectionJob 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 StopEventsDetectionJobRequest

Container for the parameters to the StopEventsDetectionJob operation. Stops an events detection job in progress.

Class StopEventsDetectionJobResponse

This is the response object from the StopEventsDetectionJob 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 StopPiiEntitiesDetectionJobRequest

Container for the parameters to the StopPiiEntitiesDetectionJob operation. Stops a PII entities detection job in progress.

Class StopPiiEntitiesDetectionJobResponse

This is the response object from the StopPiiEntitiesDetectionJob 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 StopTargetedSentimentDetectionJobRequest

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

Class StopTargetedSentimentDetectionJobResponse

This is the response object from the StopTargetedSentimentDetectionJob operation.

Class StopTrainingDocumentClassifierRequest

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

Class StopTrainingDocumentClassifierResponse

This is the response object from the StopTrainingDocumentClassifier operation.

Class StopTrainingEntityRecognizerRequest

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

Class StopTrainingEntityRecognizerResponse

This is the response object from the StopTrainingEntityRecognizer 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 Tag

A key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with the key-value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by a particular department.

Class TagResourceRequest

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

Class TagResourceResponse

This is the response object from the TagResource operation.

Class TargetedSentimentDetectionJobFilter

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

Class TargetedSentimentDetectionJobProperties

Provides information about a targeted sentiment detection job.

Class TargetedSentimentEntity

Information about one of the entities found by targeted sentiment analysis.

For more information about targeted sentiment, see Targeted sentiment in the Amazon Comprehend Developer Guide.

Class TargetedSentimentMention

Information about one mention of an entity. The mention information includes the location of the mention in the text and the sentiment of the mention.

For more information about targeted sentiment, see Targeted sentiment in the Amazon Comprehend Developer Guide.

Class TaskConfig

Configuration about the model associated with a flywheel.

Class TextSegment

One of the of text strings. Each string has a size limit of 1KB.

Class TextSizeLimitExceededException

The size of the input text exceeds the limit. Use a smaller document.

Class TooManyRequestsException

The number of requests exceeds the limit. Resubmit your request later.

Class TooManyTagKeysException

The request contains more tag keys than can be associated with a resource (50 tag keys per resource).

Class TooManyTagsException

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.

Class TopicsDetectionJobFilter

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

Class TopicsDetectionJobProperties

Provides information about a topic detection job.

Class ToxicContent

Toxic content analysis result for one string. For more information about toxicity detection, see Toxicity detection in the Amazon Comprehend Developer Guide

Class ToxicLabels

Toxicity analysis result for one string. For more information about toxicity detection, see Toxicity detection in the Amazon Comprehend Developer Guide.

Class UnsupportedLanguageException

Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.

Class UntagResourceRequest

Container for the parameters to the UntagResource operation. Removes a specific tag associated with an Amazon Comprehend resource.

Class UntagResourceResponse

This is the response object from the UntagResource operation.

Class UpdateDataSecurityConfig

Data security configuration.

Class UpdateEndpointRequest

Container for the parameters to the UpdateEndpoint operation. Updates information about the specified endpoint. For information about endpoints, see Managing endpoints.

Class UpdateEndpointResponse

This is the response object from the UpdateEndpoint operation.

Class UpdateFlywheelRequest

Container for the parameters to the UpdateFlywheel operation. Update the configuration information for an existing flywheel.

Class UpdateFlywheelResponse

This is the response object from the UpdateFlywheel operation.

Class VpcConfig

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job. For more information, see Amazon VPC.

Class WarningsListItem

The system identified one of the following warnings while processing the input document:

  • The document to classify is plain text, but the classifier is a native document model.

  • The document to classify is semi-structured, but the classifier is a plain-text model.

Interfaces

NameDescription
Interface IComprehendPaginatorFactory

Paginators for the Comprehend service

Interface IListDatasetsPaginator

Paginator for the ListDatasets operation

Interface IListDocumentClassificationJobsPaginator

Paginator for the ListDocumentClassificationJobs operation

Interface IListDocumentClassifiersPaginator

Paginator for the ListDocumentClassifiers operation

Interface IListDocumentClassifierSummariesPaginator

Paginator for the ListDocumentClassifierSummaries operation

Interface IListDominantLanguageDetectionJobsPaginator

Paginator for the ListDominantLanguageDetectionJobs operation

Interface IListEndpointsPaginator

Paginator for the ListEndpoints operation

Interface IListEntitiesDetectionJobsPaginator

Paginator for the ListEntitiesDetectionJobs operation

Interface IListEntityRecognizersPaginator

Paginator for the ListEntityRecognizers operation

Interface IListEntityRecognizerSummariesPaginator

Paginator for the ListEntityRecognizerSummaries operation

Interface IListEventsDetectionJobsPaginator

Paginator for the ListEventsDetectionJobs operation

Interface IListFlywheelIterationHistoryPaginator

Paginator for the ListFlywheelIterationHistory operation

Interface IListFlywheelsPaginator

Paginator for the ListFlywheels operation

Interface IListKeyPhrasesDetectionJobsPaginator

Paginator for the ListKeyPhrasesDetectionJobs operation

Interface IListPiiEntitiesDetectionJobsPaginator

Paginator for the ListPiiEntitiesDetectionJobs operation

Interface IListSentimentDetectionJobsPaginator

Paginator for the ListSentimentDetectionJobs operation

Interface IListTargetedSentimentDetectionJobsPaginator

Paginator for the ListTargetedSentimentDetectionJobs operation

Interface IListTopicsDetectionJobsPaginator

Paginator for the ListTopicsDetectionJobs operation