@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonComprehend extends Object implements AmazonComprehend
AmazonComprehend. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
BatchDetectDominantLanguageResult |
batchDetectDominantLanguage(BatchDetectDominantLanguageRequest request)
Determines the dominant language of the input text for a batch of documents.
|
BatchDetectEntitiesResult |
batchDetectEntities(BatchDetectEntitiesRequest request)
Inspects the text of a batch of documents for named entities and returns information about them.
|
BatchDetectKeyPhrasesResult |
batchDetectKeyPhrases(BatchDetectKeyPhrasesRequest request)
Detects the key noun phrases found in a batch of documents.
|
BatchDetectSentimentResult |
batchDetectSentiment(BatchDetectSentimentRequest request)
Inspects a batch of documents and returns an inference of the prevailing sentiment,
POSITIVE,
NEUTRAL, MIXED, or NEGATIVE, in each one. |
BatchDetectSyntaxResult |
batchDetectSyntax(BatchDetectSyntaxRequest request)
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.
|
ClassifyDocumentResult |
classifyDocument(ClassifyDocumentRequest request)
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.
|
ContainsPiiEntitiesResult |
containsPiiEntities(ContainsPiiEntitiesRequest request)
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.
|
CreateDocumentClassifierResult |
createDocumentClassifier(CreateDocumentClassifierRequest request)
Creates a new document classifier that you can use to categorize documents.
|
CreateEndpointResult |
createEndpoint(CreateEndpointRequest request)
Creates a model-specific endpoint for synchronous inference for a previously trained custom model For information
about endpoints, see Managing
endpoints.
|
CreateEntityRecognizerResult |
createEntityRecognizer(CreateEntityRecognizerRequest request)
Creates an entity recognizer using submitted files.
|
DeleteDocumentClassifierResult |
deleteDocumentClassifier(DeleteDocumentClassifierRequest request)
Deletes a previously created document classifier
|
DeleteEndpointResult |
deleteEndpoint(DeleteEndpointRequest request)
Deletes a model-specific endpoint for a previously-trained custom model.
|
DeleteEntityRecognizerResult |
deleteEntityRecognizer(DeleteEntityRecognizerRequest request)
Deletes an entity recognizer.
|
DeleteResourcePolicyResult |
deleteResourcePolicy(DeleteResourcePolicyRequest request)
Deletes a resource-based policy that is attached to a custom model.
|
DescribeDocumentClassificationJobResult |
describeDocumentClassificationJob(DescribeDocumentClassificationJobRequest request)
Gets the properties associated with a document classification job.
|
DescribeDocumentClassifierResult |
describeDocumentClassifier(DescribeDocumentClassifierRequest request)
Gets the properties associated with a document classifier.
|
DescribeDominantLanguageDetectionJobResult |
describeDominantLanguageDetectionJob(DescribeDominantLanguageDetectionJobRequest request)
Gets the properties associated with a dominant language detection job.
|
DescribeEndpointResult |
describeEndpoint(DescribeEndpointRequest request)
Gets the properties associated with a specific endpoint.
|
DescribeEntitiesDetectionJobResult |
describeEntitiesDetectionJob(DescribeEntitiesDetectionJobRequest request)
Gets the properties associated with an entities detection job.
|
DescribeEntityRecognizerResult |
describeEntityRecognizer(DescribeEntityRecognizerRequest request)
Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer
metadata, metrics, and so on.
|
DescribeEventsDetectionJobResult |
describeEventsDetectionJob(DescribeEventsDetectionJobRequest request)
Gets the status and details of an events detection job.
|
DescribeKeyPhrasesDetectionJobResult |
describeKeyPhrasesDetectionJob(DescribeKeyPhrasesDetectionJobRequest request)
Gets the properties associated with a key phrases detection job.
|
DescribePiiEntitiesDetectionJobResult |
describePiiEntitiesDetectionJob(DescribePiiEntitiesDetectionJobRequest request)
Gets the properties associated with a PII entities detection job.
|
DescribeResourcePolicyResult |
describeResourcePolicy(DescribeResourcePolicyRequest request)
Gets the details of a resource-based policy that is attached to a custom model, including the JSON body of the
policy.
|
DescribeSentimentDetectionJobResult |
describeSentimentDetectionJob(DescribeSentimentDetectionJobRequest request)
Gets the properties associated with a sentiment detection job.
|
DescribeTargetedSentimentDetectionJobResult |
describeTargetedSentimentDetectionJob(DescribeTargetedSentimentDetectionJobRequest request)
Gets the properties associated with a targeted sentiment detection job.
|
DescribeTopicsDetectionJobResult |
describeTopicsDetectionJob(DescribeTopicsDetectionJobRequest request)
Gets the properties associated with a topic detection job.
|
DetectDominantLanguageResult |
detectDominantLanguage(DetectDominantLanguageRequest request)
Determines the dominant language of the input text.
|
DetectEntitiesResult |
detectEntities(DetectEntitiesRequest request)
Inspects text for named entities, and returns information about them.
|
DetectKeyPhrasesResult |
detectKeyPhrases(DetectKeyPhrasesRequest request)
Detects the key noun phrases found in the text.
|
DetectPiiEntitiesResult |
detectPiiEntities(DetectPiiEntitiesRequest request)
Inspects the input text for entities that contain personally identifiable information (PII) and returns
information about them.
|
DetectSentimentResult |
detectSentiment(DetectSentimentRequest request)
Inspects text and returns an inference of the prevailing sentiment (
POSITIVE, NEUTRAL,
MIXED, or NEGATIVE). |
DetectSyntaxResult |
detectSyntax(DetectSyntaxRequest request)
Inspects text for syntax and the part of speech of words in the document.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
ImportModelResult |
importModel(ImportModelRequest request)
Creates a new custom model that replicates a source custom model that you import.
|
ListDocumentClassificationJobsResult |
listDocumentClassificationJobs(ListDocumentClassificationJobsRequest request)
Gets a list of the documentation classification jobs that you have submitted.
|
ListDocumentClassifiersResult |
listDocumentClassifiers(ListDocumentClassifiersRequest request)
Gets a list of the document classifiers that you have created.
|
ListDocumentClassifierSummariesResult |
listDocumentClassifierSummaries(ListDocumentClassifierSummariesRequest request)
Gets a list of summaries of the document classifiers that you have created
|
ListDominantLanguageDetectionJobsResult |
listDominantLanguageDetectionJobs(ListDominantLanguageDetectionJobsRequest request)
Gets a list of the dominant language detection jobs that you have submitted.
|
ListEndpointsResult |
listEndpoints(ListEndpointsRequest request)
Gets a list of all existing endpoints that you've created.
|
ListEntitiesDetectionJobsResult |
listEntitiesDetectionJobs(ListEntitiesDetectionJobsRequest request)
Gets a list of the entity detection jobs that you have submitted.
|
ListEntityRecognizersResult |
listEntityRecognizers(ListEntityRecognizersRequest request)
Gets a list of the properties of all entity recognizers that you created, including recognizers currently in
training.
|
ListEntityRecognizerSummariesResult |
listEntityRecognizerSummaries(ListEntityRecognizerSummariesRequest request)
Gets a list of summaries for the entity recognizers that you have created.
|
ListEventsDetectionJobsResult |
listEventsDetectionJobs(ListEventsDetectionJobsRequest request)
Gets a list of the events detection jobs that you have submitted.
|
ListKeyPhrasesDetectionJobsResult |
listKeyPhrasesDetectionJobs(ListKeyPhrasesDetectionJobsRequest request)
Get a list of key phrase detection jobs that you have submitted.
|
ListPiiEntitiesDetectionJobsResult |
listPiiEntitiesDetectionJobs(ListPiiEntitiesDetectionJobsRequest request)
Gets a list of the PII entity detection jobs that you have submitted.
|
ListSentimentDetectionJobsResult |
listSentimentDetectionJobs(ListSentimentDetectionJobsRequest request)
Gets a list of sentiment detection jobs that you have submitted.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Lists all tags associated with a given Amazon Comprehend resource.
|
ListTargetedSentimentDetectionJobsResult |
listTargetedSentimentDetectionJobs(ListTargetedSentimentDetectionJobsRequest request)
Gets a list of targeted sentiment detection jobs that you have submitted.
|
ListTopicsDetectionJobsResult |
listTopicsDetectionJobs(ListTopicsDetectionJobsRequest request)
Gets a list of the topic detection jobs that you have submitted.
|
PutResourcePolicyResult |
putResourcePolicy(PutResourcePolicyRequest request)
Attaches a resource-based policy to a custom model.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartDocumentClassificationJobResult |
startDocumentClassificationJob(StartDocumentClassificationJobRequest request)
Starts an asynchronous document classification job.
|
StartDominantLanguageDetectionJobResult |
startDominantLanguageDetectionJob(StartDominantLanguageDetectionJobRequest request)
Starts an asynchronous dominant language detection job for a collection of documents.
|
StartEntitiesDetectionJobResult |
startEntitiesDetectionJob(StartEntitiesDetectionJobRequest request)
Starts an asynchronous entity detection job for a collection of documents.
|
StartEventsDetectionJobResult |
startEventsDetectionJob(StartEventsDetectionJobRequest request)
Starts an asynchronous event detection job for a collection of documents.
|
StartKeyPhrasesDetectionJobResult |
startKeyPhrasesDetectionJob(StartKeyPhrasesDetectionJobRequest request)
Starts an asynchronous key phrase detection job for a collection of documents.
|
StartPiiEntitiesDetectionJobResult |
startPiiEntitiesDetectionJob(StartPiiEntitiesDetectionJobRequest request)
Starts an asynchronous PII entity detection job for a collection of documents.
|
StartSentimentDetectionJobResult |
startSentimentDetectionJob(StartSentimentDetectionJobRequest request)
Starts an asynchronous sentiment detection job for a collection of documents.
|
StartTargetedSentimentDetectionJobResult |
startTargetedSentimentDetectionJob(StartTargetedSentimentDetectionJobRequest request)
Starts an asynchronous targeted sentiment detection job for a collection of documents.
|
StartTopicsDetectionJobResult |
startTopicsDetectionJob(StartTopicsDetectionJobRequest request)
Starts an asynchronous topic detection job.
|
StopDominantLanguageDetectionJobResult |
stopDominantLanguageDetectionJob(StopDominantLanguageDetectionJobRequest request)
Stops a dominant language detection job in progress.
|
StopEntitiesDetectionJobResult |
stopEntitiesDetectionJob(StopEntitiesDetectionJobRequest request)
Stops an entities detection job in progress.
|
StopEventsDetectionJobResult |
stopEventsDetectionJob(StopEventsDetectionJobRequest request)
Stops an events detection job in progress.
|
StopKeyPhrasesDetectionJobResult |
stopKeyPhrasesDetectionJob(StopKeyPhrasesDetectionJobRequest request)
Stops a key phrases detection job in progress.
|
StopPiiEntitiesDetectionJobResult |
stopPiiEntitiesDetectionJob(StopPiiEntitiesDetectionJobRequest request)
Stops a PII entities detection job in progress.
|
StopSentimentDetectionJobResult |
stopSentimentDetectionJob(StopSentimentDetectionJobRequest request)
Stops a sentiment detection job in progress.
|
StopTargetedSentimentDetectionJobResult |
stopTargetedSentimentDetectionJob(StopTargetedSentimentDetectionJobRequest request)
Stops a targeted sentiment detection job in progress.
|
StopTrainingDocumentClassifierResult |
stopTrainingDocumentClassifier(StopTrainingDocumentClassifierRequest request)
Stops a document classifier training job while in progress.
|
StopTrainingEntityRecognizerResult |
stopTrainingEntityRecognizer(StopTrainingEntityRecognizerRequest request)
Stops an entity recognizer training job while in progress.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Associates a specific tag with an Amazon Comprehend resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes a specific tag associated with an Amazon Comprehend resource.
|
UpdateEndpointResult |
updateEndpoint(UpdateEndpointRequest request)
Updates information about the specified endpoint.
|
public BatchDetectDominantLanguageResult batchDetectDominantLanguage(BatchDetectDominantLanguageRequest request)
AmazonComprehendDetermines 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.
batchDetectDominantLanguage in interface AmazonComprehendpublic BatchDetectEntitiesResult batchDetectEntities(BatchDetectEntitiesRequest request)
AmazonComprehendInspects the text of a batch of documents for named entities and returns information about them. For more information about named entities, see how-entities
batchDetectEntities in interface AmazonComprehendpublic BatchDetectKeyPhrasesResult batchDetectKeyPhrases(BatchDetectKeyPhrasesRequest request)
AmazonComprehendDetects the key noun phrases found in a batch of documents.
batchDetectKeyPhrases in interface AmazonComprehendpublic BatchDetectSentimentResult batchDetectSentiment(BatchDetectSentimentRequest request)
AmazonComprehend
Inspects a batch of documents and returns an inference of the prevailing sentiment, POSITIVE,
NEUTRAL, MIXED, or NEGATIVE, in each one.
batchDetectSentiment in interface AmazonComprehendpublic BatchDetectSyntaxResult batchDetectSyntax(BatchDetectSyntaxRequest request)
AmazonComprehendInspects 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.
batchDetectSyntax in interface AmazonComprehendpublic ClassifyDocumentResult classifyDocument(ClassifyDocumentRequest request)
AmazonComprehendCreates a new document classification request to analyze a single document in real-time, using a previously created and trained custom model and an endpoint.
classifyDocument in interface AmazonComprehendpublic ContainsPiiEntitiesResult containsPiiEntities(ContainsPiiEntitiesRequest request)
AmazonComprehendAnalyzes 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.
containsPiiEntities in interface AmazonComprehendpublic CreateDocumentClassifierResult createDocumentClassifier(CreateDocumentClassifierRequest request)
AmazonComprehendCreates 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.
createDocumentClassifier in interface AmazonComprehendpublic CreateEndpointResult createEndpoint(CreateEndpointRequest request)
AmazonComprehendCreates a model-specific endpoint for synchronous inference for a previously trained custom model For information about endpoints, see Managing endpoints.
createEndpoint in interface AmazonComprehendpublic CreateEntityRecognizerResult createEntityRecognizer(CreateEntityRecognizerRequest request)
AmazonComprehend
Creates an entity recognizer using submitted files. After your CreateEntityRecognizer request is
submitted, you can check job status using the API.
createEntityRecognizer in interface AmazonComprehendpublic DeleteDocumentClassifierResult deleteDocumentClassifier(DeleteDocumentClassifierRequest request)
AmazonComprehendDeletes 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.
deleteDocumentClassifier in interface AmazonComprehendpublic DeleteEndpointResult deleteEndpoint(DeleteEndpointRequest request)
AmazonComprehendDeletes 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.
deleteEndpoint in interface AmazonComprehendpublic DeleteEntityRecognizerResult deleteEntityRecognizer(DeleteEntityRecognizerRequest request)
AmazonComprehendDeletes 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.
deleteEntityRecognizer in interface AmazonComprehendpublic DeleteResourcePolicyResult deleteResourcePolicy(DeleteResourcePolicyRequest request)
AmazonComprehendDeletes a resource-based policy that is attached to a custom model.
deleteResourcePolicy in interface AmazonComprehendpublic DescribeDocumentClassificationJobResult describeDocumentClassificationJob(DescribeDocumentClassificationJobRequest request)
AmazonComprehendGets the properties associated with a document classification job. Use this operation to get the status of a classification job.
describeDocumentClassificationJob in interface AmazonComprehendpublic DescribeDocumentClassifierResult describeDocumentClassifier(DescribeDocumentClassifierRequest request)
AmazonComprehendGets the properties associated with a document classifier.
describeDocumentClassifier in interface AmazonComprehendpublic DescribeDominantLanguageDetectionJobResult describeDominantLanguageDetectionJob(DescribeDominantLanguageDetectionJobRequest request)
AmazonComprehendGets the properties associated with a dominant language detection job. Use this operation to get the status of a detection job.
describeDominantLanguageDetectionJob in interface AmazonComprehendpublic DescribeEndpointResult describeEndpoint(DescribeEndpointRequest request)
AmazonComprehendGets the properties associated with a specific endpoint. Use this operation to get the status of an endpoint. For information about endpoints, see Managing endpoints.
describeEndpoint in interface AmazonComprehendpublic DescribeEntitiesDetectionJobResult describeEntitiesDetectionJob(DescribeEntitiesDetectionJobRequest request)
AmazonComprehendGets the properties associated with an entities detection job. Use this operation to get the status of a detection job.
describeEntitiesDetectionJob in interface AmazonComprehendpublic DescribeEntityRecognizerResult describeEntityRecognizer(DescribeEntityRecognizerRequest request)
AmazonComprehendProvides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on.
describeEntityRecognizer in interface AmazonComprehendpublic DescribeEventsDetectionJobResult describeEventsDetectionJob(DescribeEventsDetectionJobRequest request)
AmazonComprehendGets the status and details of an events detection job.
describeEventsDetectionJob in interface AmazonComprehendpublic DescribeKeyPhrasesDetectionJobResult describeKeyPhrasesDetectionJob(DescribeKeyPhrasesDetectionJobRequest request)
AmazonComprehendGets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job.
describeKeyPhrasesDetectionJob in interface AmazonComprehendpublic DescribePiiEntitiesDetectionJobResult describePiiEntitiesDetectionJob(DescribePiiEntitiesDetectionJobRequest request)
AmazonComprehendGets the properties associated with a PII entities detection job. For example, you can use this operation to get the job status.
describePiiEntitiesDetectionJob in interface AmazonComprehendpublic DescribeResourcePolicyResult describeResourcePolicy(DescribeResourcePolicyRequest request)
AmazonComprehendGets the details of a resource-based policy that is attached to a custom model, including the JSON body of the policy.
describeResourcePolicy in interface AmazonComprehendpublic DescribeSentimentDetectionJobResult describeSentimentDetectionJob(DescribeSentimentDetectionJobRequest request)
AmazonComprehendGets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job.
describeSentimentDetectionJob in interface AmazonComprehendpublic DescribeTargetedSentimentDetectionJobResult describeTargetedSentimentDetectionJob(DescribeTargetedSentimentDetectionJobRequest request)
AmazonComprehendGets the properties associated with a targeted sentiment detection job. Use this operation to get the status of the job.
describeTargetedSentimentDetectionJob in interface AmazonComprehendpublic DescribeTopicsDetectionJobResult describeTopicsDetectionJob(DescribeTopicsDetectionJobRequest request)
AmazonComprehendGets the properties associated with a topic detection job. Use this operation to get the status of a detection job.
describeTopicsDetectionJob in interface AmazonComprehendpublic DetectDominantLanguageResult detectDominantLanguage(DetectDominantLanguageRequest request)
AmazonComprehendDetermines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.
detectDominantLanguage in interface AmazonComprehendpublic DetectEntitiesResult detectEntities(DetectEntitiesRequest request)
AmazonComprehendInspects text for named entities, and returns information about them. For more information, about named entities, see how-entities.
detectEntities in interface AmazonComprehendpublic DetectKeyPhrasesResult detectKeyPhrases(DetectKeyPhrasesRequest request)
AmazonComprehendDetects the key noun phrases found in the text.
detectKeyPhrases in interface AmazonComprehendpublic DetectPiiEntitiesResult detectPiiEntities(DetectPiiEntitiesRequest request)
AmazonComprehendInspects the input text for entities that contain personally identifiable information (PII) and returns information about them.
detectPiiEntities in interface AmazonComprehendpublic DetectSentimentResult detectSentiment(DetectSentimentRequest request)
AmazonComprehend
Inspects text and returns an inference of the prevailing sentiment (POSITIVE, NEUTRAL,
MIXED, or NEGATIVE).
detectSentiment in interface AmazonComprehendpublic DetectSyntaxResult detectSyntax(DetectSyntaxRequest request)
AmazonComprehendInspects text for syntax and the part of speech of words in the document. For more information, how-syntax.
detectSyntax in interface AmazonComprehendpublic ImportModelResult importModel(ImportModelRequest request)
AmazonComprehendCreates a new custom model that replicates a source custom model that you import. The source model can be in your AWS account or another one.
If the source model is in another AWS account, then it must have a resource-based policy that authorizes you to import it.
The source model must be in the same AWS region that you're using when you import. You can't import a model that's in a different region.
importModel in interface AmazonComprehendpublic ListDocumentClassificationJobsResult listDocumentClassificationJobs(ListDocumentClassificationJobsRequest request)
AmazonComprehendGets a list of the documentation classification jobs that you have submitted.
listDocumentClassificationJobs in interface AmazonComprehendpublic ListDocumentClassifierSummariesResult listDocumentClassifierSummaries(ListDocumentClassifierSummariesRequest request)
AmazonComprehendGets a list of summaries of the document classifiers that you have created
listDocumentClassifierSummaries in interface AmazonComprehendpublic ListDocumentClassifiersResult listDocumentClassifiers(ListDocumentClassifiersRequest request)
AmazonComprehendGets a list of the document classifiers that you have created.
listDocumentClassifiers in interface AmazonComprehendpublic ListDominantLanguageDetectionJobsResult listDominantLanguageDetectionJobs(ListDominantLanguageDetectionJobsRequest request)
AmazonComprehendGets a list of the dominant language detection jobs that you have submitted.
listDominantLanguageDetectionJobs in interface AmazonComprehendpublic ListEndpointsResult listEndpoints(ListEndpointsRequest request)
AmazonComprehendGets a list of all existing endpoints that you've created. For information about endpoints, see Managing endpoints.
listEndpoints in interface AmazonComprehendpublic ListEntitiesDetectionJobsResult listEntitiesDetectionJobs(ListEntitiesDetectionJobsRequest request)
AmazonComprehendGets a list of the entity detection jobs that you have submitted.
listEntitiesDetectionJobs in interface AmazonComprehendpublic ListEntityRecognizerSummariesResult listEntityRecognizerSummaries(ListEntityRecognizerSummariesRequest request)
AmazonComprehendGets a list of summaries for the entity recognizers that you have created.
listEntityRecognizerSummaries in interface AmazonComprehendpublic ListEntityRecognizersResult listEntityRecognizers(ListEntityRecognizersRequest request)
AmazonComprehendGets 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.
listEntityRecognizers in interface AmazonComprehendpublic ListEventsDetectionJobsResult listEventsDetectionJobs(ListEventsDetectionJobsRequest request)
AmazonComprehendGets a list of the events detection jobs that you have submitted.
listEventsDetectionJobs in interface AmazonComprehendpublic ListKeyPhrasesDetectionJobsResult listKeyPhrasesDetectionJobs(ListKeyPhrasesDetectionJobsRequest request)
AmazonComprehendGet a list of key phrase detection jobs that you have submitted.
listKeyPhrasesDetectionJobs in interface AmazonComprehendpublic ListPiiEntitiesDetectionJobsResult listPiiEntitiesDetectionJobs(ListPiiEntitiesDetectionJobsRequest request)
AmazonComprehendGets a list of the PII entity detection jobs that you have submitted.
listPiiEntitiesDetectionJobs in interface AmazonComprehendpublic ListSentimentDetectionJobsResult listSentimentDetectionJobs(ListSentimentDetectionJobsRequest request)
AmazonComprehendGets a list of sentiment detection jobs that you have submitted.
listSentimentDetectionJobs in interface AmazonComprehendpublic ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AmazonComprehendLists all tags associated with a given Amazon Comprehend resource.
listTagsForResource in interface AmazonComprehendpublic ListTargetedSentimentDetectionJobsResult listTargetedSentimentDetectionJobs(ListTargetedSentimentDetectionJobsRequest request)
AmazonComprehendGets a list of targeted sentiment detection jobs that you have submitted.
listTargetedSentimentDetectionJobs in interface AmazonComprehendpublic ListTopicsDetectionJobsResult listTopicsDetectionJobs(ListTopicsDetectionJobsRequest request)
AmazonComprehendGets a list of the topic detection jobs that you have submitted.
listTopicsDetectionJobs in interface AmazonComprehendpublic PutResourcePolicyResult putResourcePolicy(PutResourcePolicyRequest request)
AmazonComprehendAttaches a resource-based policy to a custom model. You can use this policy to authorize an entity in another AWS account to import the custom model, which replicates it in Amazon Comprehend in their account.
putResourcePolicy in interface AmazonComprehendpublic StartDocumentClassificationJobResult startDocumentClassificationJob(StartDocumentClassificationJobRequest request)
AmazonComprehendStarts an asynchronous document classification job. Use the operation to track the progress of the job.
startDocumentClassificationJob in interface AmazonComprehendpublic StartDominantLanguageDetectionJobResult startDominantLanguageDetectionJob(StartDominantLanguageDetectionJobRequest request)
AmazonComprehendStarts an asynchronous dominant language detection job for a collection of documents. Use the operation to track the status of a job.
startDominantLanguageDetectionJob in interface AmazonComprehendpublic StartEntitiesDetectionJobResult startEntitiesDetectionJob(StartEntitiesDetectionJobRequest request)
AmazonComprehendStarts 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.
startEntitiesDetectionJob in interface AmazonComprehendpublic StartEventsDetectionJobResult startEventsDetectionJob(StartEventsDetectionJobRequest request)
AmazonComprehendStarts an asynchronous event detection job for a collection of documents.
startEventsDetectionJob in interface AmazonComprehendpublic StartKeyPhrasesDetectionJobResult startKeyPhrasesDetectionJob(StartKeyPhrasesDetectionJobRequest request)
AmazonComprehendStarts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the status of a job.
startKeyPhrasesDetectionJob in interface AmazonComprehendpublic StartPiiEntitiesDetectionJobResult startPiiEntitiesDetectionJob(StartPiiEntitiesDetectionJobRequest request)
AmazonComprehendStarts an asynchronous PII entity detection job for a collection of documents.
startPiiEntitiesDetectionJob in interface AmazonComprehendpublic StartSentimentDetectionJobResult startSentimentDetectionJob(StartSentimentDetectionJobRequest request)
AmazonComprehendStarts an asynchronous sentiment detection job for a collection of documents. Use the operation to track the status of a job.
startSentimentDetectionJob in interface AmazonComprehendpublic StartTargetedSentimentDetectionJobResult startTargetedSentimentDetectionJob(StartTargetedSentimentDetectionJobRequest request)
AmazonComprehendStarts an asynchronous targeted sentiment detection job for a collection of documents. Use the operation to track the status of a job.
startTargetedSentimentDetectionJob in interface AmazonComprehendpublic StartTopicsDetectionJobResult startTopicsDetectionJob(StartTopicsDetectionJobRequest request)
AmazonComprehend
Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob operation to track the
status of a job.
startTopicsDetectionJob in interface AmazonComprehendpublic StopDominantLanguageDetectionJobResult stopDominantLanguageDetectionJob(StopDominantLanguageDetectionJobRequest request)
AmazonComprehendStops 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.
stopDominantLanguageDetectionJob in interface AmazonComprehendpublic StopEntitiesDetectionJobResult stopEntitiesDetectionJob(StopEntitiesDetectionJobRequest request)
AmazonComprehendStops 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.
stopEntitiesDetectionJob in interface AmazonComprehendpublic StopEventsDetectionJobResult stopEventsDetectionJob(StopEventsDetectionJobRequest request)
AmazonComprehendStops an events detection job in progress.
stopEventsDetectionJob in interface AmazonComprehendpublic StopKeyPhrasesDetectionJobResult stopKeyPhrasesDetectionJob(StopKeyPhrasesDetectionJobRequest request)
AmazonComprehendStops 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.
stopKeyPhrasesDetectionJob in interface AmazonComprehendpublic StopPiiEntitiesDetectionJobResult stopPiiEntitiesDetectionJob(StopPiiEntitiesDetectionJobRequest request)
AmazonComprehendStops a PII entities detection job in progress.
stopPiiEntitiesDetectionJob in interface AmazonComprehendpublic StopSentimentDetectionJobResult stopSentimentDetectionJob(StopSentimentDetectionJobRequest request)
AmazonComprehendStops 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.
stopSentimentDetectionJob in interface AmazonComprehendpublic StopTargetedSentimentDetectionJobResult stopTargetedSentimentDetectionJob(StopTargetedSentimentDetectionJobRequest request)
AmazonComprehendStops 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.
stopTargetedSentimentDetectionJob in interface AmazonComprehendpublic StopTrainingDocumentClassifierResult stopTrainingDocumentClassifier(StopTrainingDocumentClassifierRequest request)
AmazonComprehendStops 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.
stopTrainingDocumentClassifier in interface AmazonComprehendpublic StopTrainingEntityRecognizerResult stopTrainingEntityRecognizer(StopTrainingEntityRecognizerRequest request)
AmazonComprehendStops 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.
stopTrainingEntityRecognizer in interface AmazonComprehendpublic TagResourceResult tagResource(TagResourceRequest request)
AmazonComprehendAssociates 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.
tagResource in interface AmazonComprehendpublic UntagResourceResult untagResource(UntagResourceRequest request)
AmazonComprehendRemoves a specific tag associated with an Amazon Comprehend resource.
untagResource in interface AmazonComprehendpublic UpdateEndpointResult updateEndpoint(UpdateEndpointRequest request)
AmazonComprehendUpdates information about the specified endpoint. For information about endpoints, see Managing endpoints.
updateEndpoint in interface AmazonComprehendpublic void shutdown()
AmazonComprehendshutdown in interface AmazonComprehendpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonComprehendResponse metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata in interface AmazonComprehendrequest - The originally executed request.