aws comprehend
Amazon Comprehend is an AWS 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
Subcommands
| Name | Description |
|---|---|
batch-detect-dominant-language | 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 |
batch-detect-entities | 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 |
batch-detect-key-phrases | Detects the key noun phrases found in a batch of documents |
batch-detect-sentiment | Inspects a batch of documents and returns an inference of the prevailing sentiment, POSITIVE, NEUTRAL, MIXED, or NEGATIVE, in each one |
batch-detect-syntax | 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 |
classify-document | Creates a new document classification request to analyze a single document in real-time, using a previously created and trained custom model and an endpoint |
contains-pii-entities | 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 |
create-document-classifier | Creates a new document classifier that you can use to categorize documents. To create a classifier, you provide a set of training documents that labeled with the categories that you want to use. After the classifier is trained you can use it to categorize a set of labeled documents into the categories. For more information, see how-document-classification |
create-endpoint | Creates a model-specific endpoint for synchronous inference for a previously trained custom model |
create-entity-recognizer | Creates an entity recognizer using submitted files. After your CreateEntityRecognizer request is submitted, you can check job status using the API |
delete-document-classifier | 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 |
delete-endpoint | Deletes a model-specific endpoint for a previously-trained custom model. All endpoints must be deleted in order for the model to be deleted |
delete-entity-recognizer | 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 |
describe-document-classification-job | Gets the properties associated with a document classification job. Use this operation to get the status of a classification job |
describe-document-classifier | Gets the properties associated with a document classifier |
describe-dominant-language-detection-job | Gets the properties associated with a dominant language detection job. Use this operation to get the status of a detection job |
describe-endpoint | Gets the properties associated with a specific endpoint. Use this operation to get the status of an endpoint |
describe-entities-detection-job | Gets the properties associated with an entities detection job. Use this operation to get the status of a detection job |
describe-entity-recognizer | Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on |
describe-events-detection-job | Gets the status and details of an events detection job |
describe-key-phrases-detection-job | Gets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job |
describe-pii-entities-detection-job | Gets the properties associated with a PII entities detection job. For example, you can use this operation to get the job status |
describe-sentiment-detection-job | Gets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job |
describe-topics-detection-job | Gets the properties associated with a topic detection job. Use this operation to get the status of a detection job |
detect-dominant-language | Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages |
detect-entities | Inspects text for named entities, and returns information about them. For more information, about named entities, see how-entities |
detect-key-phrases | Detects the key noun phrases found in the text |
detect-pii-entities | Inspects the input text for entities that contain personally identifiable information (PII) and returns information about them |
detect-sentiment | Inspects text and returns an inference of the prevailing sentiment (POSITIVE, NEUTRAL, MIXED, or NEGATIVE) |
detect-syntax | Inspects text for syntax and the part of speech of words in the document. For more information, how-syntax |
list-document-classification-jobs | Gets a list of the documentation classification jobs that you have submitted |
list-document-classifiers | Gets a list of the document classifiers that you have created |
list-dominant-language-detection-jobs | Gets a list of the dominant language detection jobs that you have submitted |
list-endpoints | Gets a list of all existing endpoints that you've created |
list-entities-detection-jobs | Gets a list of the entity detection jobs that you have submitted |
list-entity-recognizers | 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 |
list-events-detection-jobs | Gets a list of the events detection jobs that you have submitted |
list-key-phrases-detection-jobs | Get a list of key phrase detection jobs that you have submitted |
list-pii-entities-detection-jobs | Gets a list of the PII entity detection jobs that you have submitted |
list-sentiment-detection-jobs | Gets a list of sentiment detection jobs that you have submitted |
list-tags-for-resource | Lists all tags associated with a given Amazon Comprehend resource |
list-topics-detection-jobs | Gets a list of the topic detection jobs that you have submitted |
start-document-classification-job | Starts an asynchronous document classification job. Use the operation to track the progress of the job |
start-dominant-language-detection-job | Starts an asynchronous dominant language detection job for a collection of documents. Use the operation to track the status of a job |
start-entities-detection-job | 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 |
start-events-detection-job | Starts an asynchronous event detection job for a collection of documents |
start-key-phrases-detection-job | Starts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the status of a job |
start-pii-entities-detection-job | Starts an asynchronous PII entity detection job for a collection of documents |
start-sentiment-detection-job | Starts an asynchronous sentiment detection job for a collection of documents. use the operation to track the status of a job |
start-topics-detection-job | Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob operation to track the status of a job |
stop-dominant-language-detection-job | 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 |
stop-entities-detection-job | 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 |
stop-events-detection-job | Stops an events detection job in progress |
stop-key-phrases-detection-job | 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 |
stop-pii-entities-detection-job | Stops a PII entities detection job in progress |
stop-sentiment-detection-job | 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 |
stop-training-document-classifier | 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 |
stop-training-entity-recognizer | 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 |
tag-resource | 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 |
untag-resource | Removes a specific tag associated with an Amazon Comprehend resource |
update-endpoint | Updates information about the specified endpoint |