Data retrieval APIs for Amazon Comprehend
Amazon Comprehend provides the following APIs for data retrieval.
| Actions | Description | Access level |
|---|---|---|
| BatchDetectDominantLanguage | Detect the language or languages present in the list of text documents | Read |
| BatchDetectEntities | Detect the named entities ("People", "Places", "Locations", etc) within the given list of text documents | Read |
| BatchDetectKeyPhrases | Detect the phrases in the list of text documents that are most indicative of the content | Read |
| BatchDetectSentiment | Detect the sentiment of a text in the list of documents (Positive, Negative, Neutral, or Mixed) | Read |
| BatchDetectSyntax | Detect syntactic information (like Part of Speech, Tokens) in a list of text documents | Read |
| BatchDetectTargetedSentiment | Detect the sentiments associated with specific entities (such as brands or products) within the given list of text documents | Read |
| ClassifyDocument | Create a new document classification request to analyze a single document in real-time, using a previously created and trained custom model and an endpoint | Read |
| ContainsPiiEntities | Classify the personally identifiable information within given documents in real-time | Read |
| DescribeDataset | Get the properties associated with a dataset | Read |
| DescribeDocumentClassificationJob | Get the properties associated with a document classification job | Read |
| DescribeDocumentClassifier | Get the properties associated with a document classifier | Read |
| DescribeDominantLanguageDetectionJob | Get the properties associated with a dominant language detection job | Read |
| DescribeEndpoint | Get the properties associated with a specific endpoint. Use this operation to get the status of an endpoint | Read |
| DescribeEntitiesDetectionJob | Get the properties associated with an entities detection job | Read |
| DescribeEntityRecognizer | Provide details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on | Read |
| DescribeEventsDetectionJob | Get the properties associated with an Events detection job | Read |
| DescribeFlywheel | Get the properties associated with a flywheel | Read |
| DescribeFlywheelIteration | Get the properties associated with a flywheel iteration for a flywheel | Read |
| DescribeKeyPhrasesDetectionJob | Get the properties associated with a key phrases detection job | Read |
| DescribePiiEntitiesDetectionJob | Get the properties associated with a PII entities detection job | Read |
| DescribeResourcePolicy | Read attached policy on resource | Read |
| DescribeSentimentDetectionJob | Get the properties associated with a sentiment detection job | Read |
| DescribeTargetedSentimentDetectionJob | Get the properties associated with a targeted sentiment detection job | Read |
| DescribeTopicsDetectionJob | Get the properties associated with a topic detection job | Read |
| DetectDominantLanguage | Detect the language or languages present in the text | Read |
| DetectEntities | Detect the named entities ("People", "Places", "Locations", etc) within the given text document | Read |
| DetectKeyPhrases | Detect the phrases in the text that are most indicative of the content | Read |
| DetectPiiEntities | Detect the personally identifiable information entities ("Name", "SSN", "PIN", etc) within the given text document | Read |
| DetectSentiment | Detect the sentiment of a text in a document (Positive, Negative, Neutral, or Mixed) | Read |
| DetectSyntax | Detect syntactic information (like Part of Speech, Tokens) in a text document | Read |
| DetectTargetedSentiment | Detect the sentiments associated with specific entities (such as brands or products) in a document | Read |
| DetectToxicContent | Detect toxic content within the given list of text segments | Read |
| ListDatasets | Get a list of the Datasets associated with a flywheel | Read |
| ListDocumentClassificationJobs | Get a list of the document classification jobs that you have submitted | Read |
| ListDocumentClassifierSummaries | Get a list of summaries of the document classifiers that you have created | Read |
| ListDocumentClassifiers | Get a list of the document classifiers that you have created | Read |
| ListDominantLanguageDetectionJobs | Get a list of the dominant language detection jobs that you have submitted | Read |
| ListEndpoints | Get a list of all existing endpoints that you've created | Read |
| ListEntitiesDetectionJobs | Get a list of the entity detection jobs that you have submitted | Read |
| ListEntityRecognizerSummaries | Get a list of summaries for the entity recognizers that you have created | Read |
| ListEntityRecognizers | Get a list of the properties of all entity recognizers that you created, including recognizers currently in training | Read |
| ListEventsDetectionJobs | Get a list of Events detection jobs that you have submitted | Read |
| ListFlywheelIterationHistory | Get a list of iterations associated for a flywheel | Read |
| ListFlywheels | Get a list of the flywheels that you have created | Read |
| ListKeyPhrasesDetectionJobs | Get a list of key phrase detection jobs that you have submitted | Read |
| ListPiiEntitiesDetectionJobs | Get a list of PII entities detection jobs that you have submitted | Read |
| ListSentimentDetectionJobs | Get a list of sentiment detection jobs that you have submitted | Read |
| ListTagsForResource | List tags for a resource | Read |
| ListTargetedSentimentDetectionJobs | Get a list of targeted sentiment detection jobs that you have submitted | Read |
| ListTopicsDetectionJobs | Get a list of the topic detection jobs that you have submitted | Read |
