com.amazonaws.services.comprehend

Interface AmazonComprehend

All Known Subinterfaces:

AmazonComprehendAsync

All Known Implementing Classes:

AmazonComprehendAsyncClient, AmazonComprehendClient

public interface AmazonComprehend

Interface for accessing Amazon 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.

Method Summary

Modifier and Type	Method and Description
BatchDetectDominantLanguageResult	batchDetectDominantLanguage(BatchDetectDominantLanguageRequest batchDetectDominantLanguageRequest) Determines the dominant language of the input text for a batch of documents.
BatchDetectEntitiesResult	batchDetectEntities(BatchDetectEntitiesRequest batchDetectEntitiesRequest) Inspects the text of a batch of documents for named entities and returns information about them.
BatchDetectKeyPhrasesResult	batchDetectKeyPhrases(BatchDetectKeyPhrasesRequest batchDetectKeyPhrasesRequest) Detects the key noun phrases found in a batch of documents.
BatchDetectSentimentResult	batchDetectSentiment(BatchDetectSentimentRequest batchDetectSentimentRequest) Inspects a batch of documents and returns an inference of the prevailing sentiment, POSITIVE, NEUTRAL, MIXED, or NEGATIVE, in each one.
BatchDetectSyntaxResult	batchDetectSyntax(BatchDetectSyntaxRequest batchDetectSyntaxRequest) 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 classifyDocumentRequest) 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.
CreateDocumentClassifierResult	createDocumentClassifier(CreateDocumentClassifierRequest createDocumentClassifierRequest) Creates a new document classifier that you can use to categorize documents.
CreateEndpointResult	createEndpoint(CreateEndpointRequest createEndpointRequest) Creates a model-specific endpoint for synchronous inference for a previously trained custom model
CreateEntityRecognizerResult	createEntityRecognizer(CreateEntityRecognizerRequest createEntityRecognizerRequest) Creates an entity recognizer using submitted files.
DeleteDocumentClassifierResult	deleteDocumentClassifier(DeleteDocumentClassifierRequest deleteDocumentClassifierRequest) Deletes a previously created document classifier
DeleteEndpointResult	deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest) Deletes a model-specific endpoint for a previously-trained custom model.
DeleteEntityRecognizerResult	deleteEntityRecognizer(DeleteEntityRecognizerRequest deleteEntityRecognizerRequest) Deletes an entity recognizer.
DescribeDocumentClassificationJobResult	describeDocumentClassificationJob(DescribeDocumentClassificationJobRequest describeDocumentClassificationJobRequest) Gets the properties associated with a document classification job.
DescribeDocumentClassifierResult	describeDocumentClassifier(DescribeDocumentClassifierRequest describeDocumentClassifierRequest) Gets the properties associated with a document classifier.
DescribeDominantLanguageDetectionJobResult	describeDominantLanguageDetectionJob(DescribeDominantLanguageDetectionJobRequest describeDominantLanguageDetectionJobRequest) Gets the properties associated with a dominant language detection job.
DescribeEndpointResult	describeEndpoint(DescribeEndpointRequest describeEndpointRequest) Gets the properties associated with a specific endpoint.
DescribeEntitiesDetectionJobResult	describeEntitiesDetectionJob(DescribeEntitiesDetectionJobRequest describeEntitiesDetectionJobRequest) Gets the properties associated with an entities detection job.
DescribeEntityRecognizerResult	describeEntityRecognizer(DescribeEntityRecognizerRequest describeEntityRecognizerRequest) Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on.
DescribeEventsDetectionJobResult	describeEventsDetectionJob(DescribeEventsDetectionJobRequest describeEventsDetectionJobRequest) Gets the status and details of an events detection job.
DescribeKeyPhrasesDetectionJobResult	describeKeyPhrasesDetectionJob(DescribeKeyPhrasesDetectionJobRequest describeKeyPhrasesDetectionJobRequest) Gets the properties associated with a key phrases detection job.
DescribePiiEntitiesDetectionJobResult	describePiiEntitiesDetectionJob(DescribePiiEntitiesDetectionJobRequest describePiiEntitiesDetectionJobRequest) Gets the properties associated with a PII entities detection job.
DescribeSentimentDetectionJobResult	describeSentimentDetectionJob(DescribeSentimentDetectionJobRequest describeSentimentDetectionJobRequest) Gets the properties associated with a sentiment detection job.
DescribeTopicsDetectionJobResult	describeTopicsDetectionJob(DescribeTopicsDetectionJobRequest describeTopicsDetectionJobRequest) Gets the properties associated with a topic detection job.
DetectDominantLanguageResult	detectDominantLanguage(DetectDominantLanguageRequest detectDominantLanguageRequest) Determines the dominant language of the input text.
DetectEntitiesResult	detectEntities(DetectEntitiesRequest detectEntitiesRequest) Inspects text for named entities, and returns information about them.
DetectKeyPhrasesResult	detectKeyPhrases(DetectKeyPhrasesRequest detectKeyPhrasesRequest) Detects the key noun phrases found in the text.
DetectPiiEntitiesResult	detectPiiEntities(DetectPiiEntitiesRequest detectPiiEntitiesRequest) Inspects the input text for entities that contain personally identifiable information (PII) and returns information about them.
DetectSentimentResult	detectSentiment(DetectSentimentRequest detectSentimentRequest) Inspects text and returns an inference of the prevailing sentiment ( POSITIVE, NEUTRAL, MIXED, or NEGATIVE).
DetectSyntaxResult	detectSyntax(DetectSyntaxRequest detectSyntaxRequest) 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.
ListDocumentClassificationJobsResult	listDocumentClassificationJobs(ListDocumentClassificationJobsRequest listDocumentClassificationJobsRequest) Gets a list of the documentation classification jobs that you have submitted.
ListDocumentClassifiersResult	listDocumentClassifiers(ListDocumentClassifiersRequest listDocumentClassifiersRequest) Gets a list of the document classifiers that you have created.
ListDominantLanguageDetectionJobsResult	listDominantLanguageDetectionJobs(ListDominantLanguageDetectionJobsRequest listDominantLanguageDetectionJobsRequest) Gets a list of the dominant language detection jobs that you have submitted.
ListEndpointsResult	listEndpoints(ListEndpointsRequest listEndpointsRequest) Gets a list of all existing endpoints that you've created.
ListEntitiesDetectionJobsResult	listEntitiesDetectionJobs(ListEntitiesDetectionJobsRequest listEntitiesDetectionJobsRequest) Gets a list of the entity detection jobs that you have submitted.
ListEntityRecognizersResult	listEntityRecognizers(ListEntityRecognizersRequest listEntityRecognizersRequest) Gets a list of the properties of all entity recognizers that you created, including recognizers currently in training.
ListEventsDetectionJobsResult	listEventsDetectionJobs(ListEventsDetectionJobsRequest listEventsDetectionJobsRequest) Gets a list of the events detection jobs that you have submitted.
ListKeyPhrasesDetectionJobsResult	listKeyPhrasesDetectionJobs(ListKeyPhrasesDetectionJobsRequest listKeyPhrasesDetectionJobsRequest) Get a list of key phrase detection jobs that you have submitted.
ListPiiEntitiesDetectionJobsResult	listPiiEntitiesDetectionJobs(ListPiiEntitiesDetectionJobsRequest listPiiEntitiesDetectionJobsRequest) Gets a list of the PII entity detection jobs that you have submitted.
ListSentimentDetectionJobsResult	listSentimentDetectionJobs(ListSentimentDetectionJobsRequest listSentimentDetectionJobsRequest) Gets a list of sentiment detection jobs that you have submitted.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists all tags associated with a given Amazon Comprehend resource.
ListTopicsDetectionJobsResult	listTopicsDetectionJobs(ListTopicsDetectionJobsRequest listTopicsDetectionJobsRequest) Gets a list of the topic detection jobs that you have submitted.
void	setEndpoint(java.lang.String endpoint) Overrides the default endpoint for this client ("https://comprehend.us-east-1.amazonaws.com").
void	setRegion(Region region) An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartDocumentClassificationJobResult	startDocumentClassificationJob(StartDocumentClassificationJobRequest startDocumentClassificationJobRequest) Starts an asynchronous document classification job.
StartDominantLanguageDetectionJobResult	startDominantLanguageDetectionJob(StartDominantLanguageDetectionJobRequest startDominantLanguageDetectionJobRequest) Starts an asynchronous dominant language detection job for a collection of documents.
StartEntitiesDetectionJobResult	startEntitiesDetectionJob(StartEntitiesDetectionJobRequest startEntitiesDetectionJobRequest) Starts an asynchronous entity detection job for a collection of documents.
StartEventsDetectionJobResult	startEventsDetectionJob(StartEventsDetectionJobRequest startEventsDetectionJobRequest) Starts an asynchronous event detection job for a collection of documents.
StartKeyPhrasesDetectionJobResult	startKeyPhrasesDetectionJob(StartKeyPhrasesDetectionJobRequest startKeyPhrasesDetectionJobRequest) Starts an asynchronous key phrase detection job for a collection of documents.
StartPiiEntitiesDetectionJobResult	startPiiEntitiesDetectionJob(StartPiiEntitiesDetectionJobRequest startPiiEntitiesDetectionJobRequest) Starts an asynchronous PII entity detection job for a collection of documents.
StartSentimentDetectionJobResult	startSentimentDetectionJob(StartSentimentDetectionJobRequest startSentimentDetectionJobRequest) Starts an asynchronous sentiment detection job for a collection of documents.
StartTopicsDetectionJobResult	startTopicsDetectionJob(StartTopicsDetectionJobRequest startTopicsDetectionJobRequest) Starts an asynchronous topic detection job.
StopDominantLanguageDetectionJobResult	stopDominantLanguageDetectionJob(StopDominantLanguageDetectionJobRequest stopDominantLanguageDetectionJobRequest) Stops a dominant language detection job in progress.
StopEntitiesDetectionJobResult	stopEntitiesDetectionJob(StopEntitiesDetectionJobRequest stopEntitiesDetectionJobRequest) Stops an entities detection job in progress.
StopEventsDetectionJobResult	stopEventsDetectionJob(StopEventsDetectionJobRequest stopEventsDetectionJobRequest) Stops an events detection job in progress.
StopKeyPhrasesDetectionJobResult	stopKeyPhrasesDetectionJob(StopKeyPhrasesDetectionJobRequest stopKeyPhrasesDetectionJobRequest) Stops a key phrases detection job in progress.
StopPiiEntitiesDetectionJobResult	stopPiiEntitiesDetectionJob(StopPiiEntitiesDetectionJobRequest stopPiiEntitiesDetectionJobRequest) Stops a PII entities detection job in progress.
StopSentimentDetectionJobResult	stopSentimentDetectionJob(StopSentimentDetectionJobRequest stopSentimentDetectionJobRequest) Stops a sentiment detection job in progress.
StopTrainingDocumentClassifierResult	stopTrainingDocumentClassifier(StopTrainingDocumentClassifierRequest stopTrainingDocumentClassifierRequest) Stops a document classifier training job while in progress.
StopTrainingEntityRecognizerResult	stopTrainingEntityRecognizer(StopTrainingEntityRecognizerRequest stopTrainingEntityRecognizerRequest) Stops an entity recognizer training job while in progress.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Associates a specific tag with an Amazon Comprehend resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes a specific tag associated with an Amazon Comprehend resource.
UpdateEndpointResult	updateEndpoint(UpdateEndpointRequest updateEndpointRequest) Updates information about the specified endpoint.

Method Detail

setEndpoint

void setEndpoint(java.lang.String endpoint)
          throws java.lang.IllegalArgumentException

Overrides the default endpoint for this client ("https://comprehend.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "comprehend.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://comprehend.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

endpoint - The endpoint (ex: "comprehend.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://comprehend.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

Throws:

java.lang.IllegalArgumentException - If any problems are detected with the specified endpoint.

setRegion

void setRegion(Region region)
        throws java.lang.IllegalArgumentException

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region.

Throws:

java.lang.IllegalArgumentException - If the given region is null, or if this service isn't available in the given region. See Region.isServiceSupported(String)

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)

batchDetectDominantLanguage

BatchDetectDominantLanguageResult batchDetectDominantLanguage(BatchDetectDominantLanguageRequest batchDetectDominantLanguageRequest)
                                                       throws AmazonClientException,
                                                              AmazonServiceException

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.

Parameters:

batchDetectDominantLanguageRequest -

Returns:

batchDetectDominantLanguageResult The response from the BatchDetectDominantLanguage service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

TextSizeLimitExceededException

BatchSizeLimitExceededException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

batchDetectEntities

BatchDetectEntitiesResult batchDetectEntities(BatchDetectEntitiesRequest batchDetectEntitiesRequest)
                                       throws AmazonClientException,
                                              AmazonServiceException

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

Parameters:

batchDetectEntitiesRequest -

Returns:

batchDetectEntitiesResult The response from the BatchDetectEntities service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

TextSizeLimitExceededException

UnsupportedLanguageException

BatchSizeLimitExceededException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

batchDetectKeyPhrases

BatchDetectKeyPhrasesResult batchDetectKeyPhrases(BatchDetectKeyPhrasesRequest batchDetectKeyPhrasesRequest)
                                           throws AmazonClientException,
                                                  AmazonServiceException

Detects the key noun phrases found in a batch of documents.

Parameters:

batchDetectKeyPhrasesRequest -

Returns:

batchDetectKeyPhrasesResult The response from the BatchDetectKeyPhrases service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

TextSizeLimitExceededException

UnsupportedLanguageException

BatchSizeLimitExceededException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

batchDetectSentiment

BatchDetectSentimentResult batchDetectSentiment(BatchDetectSentimentRequest batchDetectSentimentRequest)
                                         throws AmazonClientException,
                                                AmazonServiceException

Inspects a batch of documents and returns an inference of the prevailing sentiment, POSITIVE, NEUTRAL, MIXED, or NEGATIVE, in each one.

Parameters:

batchDetectSentimentRequest -

Returns:

batchDetectSentimentResult The response from the BatchDetectSentiment service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

TextSizeLimitExceededException

UnsupportedLanguageException

BatchSizeLimitExceededException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

batchDetectSyntax

BatchDetectSyntaxResult batchDetectSyntax(BatchDetectSyntaxRequest batchDetectSyntaxRequest)
                                   throws AmazonClientException,
                                          AmazonServiceException

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.

Parameters:

batchDetectSyntaxRequest -

Returns:

batchDetectSyntaxResult The response from the BatchDetectSyntax service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

TextSizeLimitExceededException

UnsupportedLanguageException

BatchSizeLimitExceededException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

classifyDocument

ClassifyDocumentResult classifyDocument(ClassifyDocumentRequest classifyDocumentRequest)
                                 throws AmazonClientException,
                                        AmazonServiceException

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.

Parameters:

classifyDocumentRequest -

Returns:

classifyDocumentResult The response from the ClassifyDocument service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

ResourceUnavailableException

TextSizeLimitExceededException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

createDocumentClassifier

CreateDocumentClassifierResult createDocumentClassifier(CreateDocumentClassifierRequest createDocumentClassifierRequest)
                                                 throws AmazonClientException,
                                                        AmazonServiceException

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.

Parameters:

createDocumentClassifierRequest -

Returns:

createDocumentClassifierResult The response from the CreateDocumentClassifier service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

ResourceInUseException

TooManyTagsException

TooManyRequestsException

ResourceLimitExceededException

UnsupportedLanguageException

KmsKeyValidationException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

createEndpoint

CreateEndpointResult createEndpoint(CreateEndpointRequest createEndpointRequest)
                             throws AmazonClientException,
                                    AmazonServiceException

Creates a model-specific endpoint for synchronous inference for a previously trained custom model

Parameters:

createEndpointRequest -

Returns:

createEndpointResult The response from the CreateEndpoint service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

ResourceInUseException

ResourceLimitExceededException

ResourceNotFoundException

ResourceUnavailableException

TooManyRequestsException

TooManyTagsException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

createEntityRecognizer

CreateEntityRecognizerResult createEntityRecognizer(CreateEntityRecognizerRequest createEntityRecognizerRequest)
                                             throws AmazonClientException,
                                                    AmazonServiceException

Creates an entity recognizer using submitted files. After your CreateEntityRecognizer request is submitted, you can check job status using the API.

Parameters:

createEntityRecognizerRequest -

Returns:

createEntityRecognizerResult The response from the CreateEntityRecognizer service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

ResourceInUseException

TooManyTagsException

TooManyRequestsException

ResourceLimitExceededException

UnsupportedLanguageException

KmsKeyValidationException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

deleteDocumentClassifier

DeleteDocumentClassifierResult deleteDocumentClassifier(DeleteDocumentClassifierRequest deleteDocumentClassifierRequest)
                                                 throws AmazonClientException,
                                                        AmazonServiceException

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.

Parameters:

deleteDocumentClassifierRequest -

Returns:

deleteDocumentClassifierResult The response from the DeleteDocumentClassifier service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

TooManyRequestsException

ResourceNotFoundException

ResourceUnavailableException

ResourceInUseException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

deleteEndpoint

DeleteEndpointResult deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest)
                             throws AmazonClientException,
                                    AmazonServiceException

Deletes a model-specific endpoint for a previously-trained custom model. All endpoints must be deleted in order for the model to be deleted.

Parameters:

deleteEndpointRequest -

Returns:

deleteEndpointResult The response from the DeleteEndpoint service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

ResourceInUseException

ResourceNotFoundException

TooManyRequestsException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

deleteEntityRecognizer

DeleteEntityRecognizerResult deleteEntityRecognizer(DeleteEntityRecognizerRequest deleteEntityRecognizerRequest)
                                             throws AmazonClientException,
                                                    AmazonServiceException

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.

Parameters:

deleteEntityRecognizerRequest -

Returns:

deleteEntityRecognizerResult The response from the DeleteEntityRecognizer service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

TooManyRequestsException

ResourceNotFoundException

ResourceUnavailableException

ResourceInUseException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

describeDocumentClassificationJob

DescribeDocumentClassificationJobResult describeDocumentClassificationJob(DescribeDocumentClassificationJobRequest describeDocumentClassificationJobRequest)
                                                                   throws AmazonClientException,
                                                                          AmazonServiceException

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

Parameters:

describeDocumentClassificationJobRequest -

Returns:

describeDocumentClassificationJobResult The response from the DescribeDocumentClassificationJob service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

TooManyRequestsException

JobNotFoundException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

describeDocumentClassifier

DescribeDocumentClassifierResult describeDocumentClassifier(DescribeDocumentClassifierRequest describeDocumentClassifierRequest)
                                                     throws AmazonClientException,
                                                            AmazonServiceException

Gets the properties associated with a document classifier.

Parameters:

describeDocumentClassifierRequest -

Returns:

describeDocumentClassifierResult The response from the DescribeDocumentClassifier service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

TooManyRequestsException

ResourceNotFoundException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

describeDominantLanguageDetectionJob

DescribeDominantLanguageDetectionJobResult describeDominantLanguageDetectionJob(DescribeDominantLanguageDetectionJobRequest describeDominantLanguageDetectionJobRequest)
                                                                         throws AmazonClientException,
                                                                                AmazonServiceException

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

Parameters:

describeDominantLanguageDetectionJobRequest -

Returns:

describeDominantLanguageDetectionJobResult The response from the DescribeDominantLanguageDetectionJob service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

JobNotFoundException

TooManyRequestsException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

describeEndpoint

DescribeEndpointResult describeEndpoint(DescribeEndpointRequest describeEndpointRequest)
                                 throws AmazonClientException,
                                        AmazonServiceException

Gets the properties associated with a specific endpoint. Use this operation to get the status of an endpoint.

Parameters:

describeEndpointRequest -

Returns:

describeEndpointResult The response from the DescribeEndpoint service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

TooManyRequestsException

ResourceNotFoundException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

describeEntitiesDetectionJob

DescribeEntitiesDetectionJobResult describeEntitiesDetectionJob(DescribeEntitiesDetectionJobRequest describeEntitiesDetectionJobRequest)
                                                         throws AmazonClientException,
                                                                AmazonServiceException

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

Parameters:

describeEntitiesDetectionJobRequest -

Returns:

describeEntitiesDetectionJobResult The response from the DescribeEntitiesDetectionJob service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

JobNotFoundException

TooManyRequestsException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

describeEntityRecognizer

DescribeEntityRecognizerResult describeEntityRecognizer(DescribeEntityRecognizerRequest describeEntityRecognizerRequest)
                                                 throws AmazonClientException,
                                                        AmazonServiceException

Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on.

Parameters:

describeEntityRecognizerRequest -

Returns:

describeEntityRecognizerResult The response from the DescribeEntityRecognizer service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

TooManyRequestsException

ResourceNotFoundException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

describeEventsDetectionJob

DescribeEventsDetectionJobResult describeEventsDetectionJob(DescribeEventsDetectionJobRequest describeEventsDetectionJobRequest)
                                                     throws AmazonClientException,
                                                            AmazonServiceException

Gets the status and details of an events detection job.

Parameters:

describeEventsDetectionJobRequest -

Returns:

describeEventsDetectionJobResult The response from the DescribeEventsDetectionJob service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

JobNotFoundException

TooManyRequestsException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

describeKeyPhrasesDetectionJob

DescribeKeyPhrasesDetectionJobResult describeKeyPhrasesDetectionJob(DescribeKeyPhrasesDetectionJobRequest describeKeyPhrasesDetectionJobRequest)
                                                             throws AmazonClientException,
                                                                    AmazonServiceException

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

Parameters:

describeKeyPhrasesDetectionJobRequest -

Returns:

describeKeyPhrasesDetectionJobResult The response from the DescribeKeyPhrasesDetectionJob service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

JobNotFoundException

TooManyRequestsException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

describePiiEntitiesDetectionJob

DescribePiiEntitiesDetectionJobResult describePiiEntitiesDetectionJob(DescribePiiEntitiesDetectionJobRequest describePiiEntitiesDetectionJobRequest)
                                                               throws AmazonClientException,
                                                                      AmazonServiceException

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

Parameters:

describePiiEntitiesDetectionJobRequest -

Returns:

describePiiEntitiesDetectionJobResult The response from the DescribePiiEntitiesDetectionJob service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

JobNotFoundException

TooManyRequestsException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

describeSentimentDetectionJob

DescribeSentimentDetectionJobResult describeSentimentDetectionJob(DescribeSentimentDetectionJobRequest describeSentimentDetectionJobRequest)
                                                           throws AmazonClientException,
                                                                  AmazonServiceException

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

Parameters:

describeSentimentDetectionJobRequest -

Returns:

describeSentimentDetectionJobResult The response from the DescribeSentimentDetectionJob service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

JobNotFoundException

TooManyRequestsException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

describeTopicsDetectionJob

DescribeTopicsDetectionJobResult describeTopicsDetectionJob(DescribeTopicsDetectionJobRequest describeTopicsDetectionJobRequest)
                                                     throws AmazonClientException,
                                                            AmazonServiceException

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

Parameters:

describeTopicsDetectionJobRequest -

Returns:

describeTopicsDetectionJobResult The response from the DescribeTopicsDetectionJob service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

JobNotFoundException

TooManyRequestsException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

detectDominantLanguage

DetectDominantLanguageResult detectDominantLanguage(DetectDominantLanguageRequest detectDominantLanguageRequest)
                                             throws AmazonClientException,
                                                    AmazonServiceException

Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.

Parameters:

detectDominantLanguageRequest -

Returns:

detectDominantLanguageResult The response from the DetectDominantLanguage service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

TextSizeLimitExceededException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

detectEntities

DetectEntitiesResult detectEntities(DetectEntitiesRequest detectEntitiesRequest)
                             throws AmazonClientException,
                                    AmazonServiceException

Inspects text for named entities, and returns information about them. For more information, about named entities, see how-entities.

Parameters:

detectEntitiesRequest -

Returns:

detectEntitiesResult The response from the DetectEntities service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

ResourceUnavailableException

TextSizeLimitExceededException

UnsupportedLanguageException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

detectKeyPhrases

DetectKeyPhrasesResult detectKeyPhrases(DetectKeyPhrasesRequest detectKeyPhrasesRequest)
                                 throws AmazonClientException,
                                        AmazonServiceException

Detects the key noun phrases found in the text.

Parameters:

detectKeyPhrasesRequest -

Returns:

detectKeyPhrasesResult The response from the DetectKeyPhrases service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

TextSizeLimitExceededException

UnsupportedLanguageException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

detectPiiEntities

DetectPiiEntitiesResult detectPiiEntities(DetectPiiEntitiesRequest detectPiiEntitiesRequest)
                                   throws AmazonClientException,
                                          AmazonServiceException

Inspects the input text for entities that contain personally identifiable information (PII) and returns information about them.

Parameters:

detectPiiEntitiesRequest -

Returns:

detectPiiEntitiesResult The response from the DetectPiiEntities service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

TextSizeLimitExceededException

UnsupportedLanguageException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

detectSentiment

DetectSentimentResult detectSentiment(DetectSentimentRequest detectSentimentRequest)
                               throws AmazonClientException,
                                      AmazonServiceException

Inspects text and returns an inference of the prevailing sentiment ( POSITIVE, NEUTRAL, MIXED, or NEGATIVE).

Parameters:

detectSentimentRequest -

Returns:

detectSentimentResult The response from the DetectSentiment service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

TextSizeLimitExceededException

UnsupportedLanguageException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

detectSyntax

DetectSyntaxResult detectSyntax(DetectSyntaxRequest detectSyntaxRequest)
                         throws AmazonClientException,
                                AmazonServiceException

Inspects text for syntax and the part of speech of words in the document. For more information, how-syntax.

Parameters:

detectSyntaxRequest -

Returns:

detectSyntaxResult The response from the DetectSyntax service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

TextSizeLimitExceededException

UnsupportedLanguageException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

listDocumentClassificationJobs

ListDocumentClassificationJobsResult listDocumentClassificationJobs(ListDocumentClassificationJobsRequest listDocumentClassificationJobsRequest)
                                                             throws AmazonClientException,
                                                                    AmazonServiceException

Gets a list of the documentation classification jobs that you have submitted.

Parameters:

listDocumentClassificationJobsRequest -

Returns:

listDocumentClassificationJobsResult The response from the ListDocumentClassificationJobs service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

TooManyRequestsException

InvalidFilterException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

listDocumentClassifiers

ListDocumentClassifiersResult listDocumentClassifiers(ListDocumentClassifiersRequest listDocumentClassifiersRequest)
                                               throws AmazonClientException,
                                                      AmazonServiceException

Gets a list of the document classifiers that you have created.

Parameters:

listDocumentClassifiersRequest -

Returns:

listDocumentClassifiersResult The response from the ListDocumentClassifiers service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

TooManyRequestsException

InvalidFilterException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

listDominantLanguageDetectionJobs

ListDominantLanguageDetectionJobsResult listDominantLanguageDetectionJobs(ListDominantLanguageDetectionJobsRequest listDominantLanguageDetectionJobsRequest)
                                                                   throws AmazonClientException,
                                                                          AmazonServiceException

Gets a list of the dominant language detection jobs that you have submitted.

Parameters:

listDominantLanguageDetectionJobsRequest -

Returns:

listDominantLanguageDetectionJobsResult The response from the ListDominantLanguageDetectionJobs service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

TooManyRequestsException

InvalidFilterException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

listEndpoints

ListEndpointsResult listEndpoints(ListEndpointsRequest listEndpointsRequest)
                           throws AmazonClientException,
                                  AmazonServiceException

Gets a list of all existing endpoints that you've created.

Parameters:

listEndpointsRequest -

Returns:

listEndpointsResult The response from the ListEndpoints service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

TooManyRequestsException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

listEntitiesDetectionJobs

ListEntitiesDetectionJobsResult listEntitiesDetectionJobs(ListEntitiesDetectionJobsRequest listEntitiesDetectionJobsRequest)
                                                   throws AmazonClientException,
                                                          AmazonServiceException

Gets a list of the entity detection jobs that you have submitted.

Parameters:

listEntitiesDetectionJobsRequest -

Returns:

listEntitiesDetectionJobsResult The response from the ListEntitiesDetectionJobs service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

TooManyRequestsException

InvalidFilterException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

listEntityRecognizers

ListEntityRecognizersResult listEntityRecognizers(ListEntityRecognizersRequest listEntityRecognizersRequest)
                                           throws AmazonClientException,
                                                  AmazonServiceException

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.

Parameters:

listEntityRecognizersRequest -

Returns:

listEntityRecognizersResult The response from the ListEntityRecognizers service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

TooManyRequestsException

InvalidFilterException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

listEventsDetectionJobs

ListEventsDetectionJobsResult listEventsDetectionJobs(ListEventsDetectionJobsRequest listEventsDetectionJobsRequest)
                                               throws AmazonClientException,
                                                      AmazonServiceException

Gets a list of the events detection jobs that you have submitted.

Parameters:

listEventsDetectionJobsRequest -

Returns:

listEventsDetectionJobsResult The response from the ListEventsDetectionJobs service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

TooManyRequestsException

InvalidFilterException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

listKeyPhrasesDetectionJobs

ListKeyPhrasesDetectionJobsResult listKeyPhrasesDetectionJobs(ListKeyPhrasesDetectionJobsRequest listKeyPhrasesDetectionJobsRequest)
                                                       throws AmazonClientException,
                                                              AmazonServiceException

Get a list of key phrase detection jobs that you have submitted.

Parameters:

listKeyPhrasesDetectionJobsRequest -

Returns:

listKeyPhrasesDetectionJobsResult The response from the ListKeyPhrasesDetectionJobs service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

TooManyRequestsException

InvalidFilterException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

listPiiEntitiesDetectionJobs

ListPiiEntitiesDetectionJobsResult listPiiEntitiesDetectionJobs(ListPiiEntitiesDetectionJobsRequest listPiiEntitiesDetectionJobsRequest)
                                                         throws AmazonClientException,
                                                                AmazonServiceException

Gets a list of the PII entity detection jobs that you have submitted.

Parameters:

listPiiEntitiesDetectionJobsRequest -

Returns:

listPiiEntitiesDetectionJobsResult The response from the ListPiiEntitiesDetectionJobs service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

TooManyRequestsException

InvalidFilterException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

listSentimentDetectionJobs

ListSentimentDetectionJobsResult listSentimentDetectionJobs(ListSentimentDetectionJobsRequest listSentimentDetectionJobsRequest)
                                                     throws AmazonClientException,
                                                            AmazonServiceException

Gets a list of sentiment detection jobs that you have submitted.

Parameters:

listSentimentDetectionJobsRequest -

Returns:

listSentimentDetectionJobsResult The response from the ListSentimentDetectionJobs service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

TooManyRequestsException

InvalidFilterException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                       throws AmazonClientException,
                                              AmazonServiceException

Lists all tags associated with a given Amazon Comprehend resource.

Parameters:

listTagsForResourceRequest -

Returns:

listTagsForResourceResult The response from the ListTagsForResource service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

ResourceNotFoundException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

listTopicsDetectionJobs

ListTopicsDetectionJobsResult listTopicsDetectionJobs(ListTopicsDetectionJobsRequest listTopicsDetectionJobsRequest)
                                               throws AmazonClientException,
                                                      AmazonServiceException

Gets a list of the topic detection jobs that you have submitted.

Parameters:

listTopicsDetectionJobsRequest -

Returns:

listTopicsDetectionJobsResult The response from the ListTopicsDetectionJobs service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

TooManyRequestsException

InvalidFilterException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

startDocumentClassificationJob

StartDocumentClassificationJobResult startDocumentClassificationJob(StartDocumentClassificationJobRequest startDocumentClassificationJobRequest)
                                                             throws AmazonClientException,
                                                                    AmazonServiceException

Starts an asynchronous document classification job. Use the operation to track the progress of the job.

Parameters:

startDocumentClassificationJobRequest -

Returns:

startDocumentClassificationJobResult The response from the StartDocumentClassificationJob service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

TooManyRequestsException

ResourceNotFoundException

ResourceUnavailableException

KmsKeyValidationException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

startDominantLanguageDetectionJob

StartDominantLanguageDetectionJobResult startDominantLanguageDetectionJob(StartDominantLanguageDetectionJobRequest startDominantLanguageDetectionJobRequest)
                                                                   throws AmazonClientException,
                                                                          AmazonServiceException

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

Parameters:

startDominantLanguageDetectionJobRequest -

Returns:

startDominantLanguageDetectionJobResult The response from the StartDominantLanguageDetectionJob service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

TooManyRequestsException

KmsKeyValidationException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

startEntitiesDetectionJob

StartEntitiesDetectionJobResult startEntitiesDetectionJob(StartEntitiesDetectionJobRequest startEntitiesDetectionJobRequest)
                                                   throws AmazonClientException,
                                                          AmazonServiceException

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.

Parameters:

startEntitiesDetectionJobRequest -

Returns:

startEntitiesDetectionJobResult The response from the StartEntitiesDetectionJob service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

TooManyRequestsException

ResourceNotFoundException

ResourceUnavailableException

KmsKeyValidationException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

startEventsDetectionJob

StartEventsDetectionJobResult startEventsDetectionJob(StartEventsDetectionJobRequest startEventsDetectionJobRequest)
                                               throws AmazonClientException,
                                                      AmazonServiceException

Starts an asynchronous event detection job for a collection of documents.

Parameters:

startEventsDetectionJobRequest -

Returns:

startEventsDetectionJobResult The response from the StartEventsDetectionJob service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

TooManyRequestsException

KmsKeyValidationException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

startKeyPhrasesDetectionJob

StartKeyPhrasesDetectionJobResult startKeyPhrasesDetectionJob(StartKeyPhrasesDetectionJobRequest startKeyPhrasesDetectionJobRequest)
                                                       throws AmazonClientException,
                                                              AmazonServiceException

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

Parameters:

startKeyPhrasesDetectionJobRequest -

Returns:

startKeyPhrasesDetectionJobResult The response from the StartKeyPhrasesDetectionJob service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

TooManyRequestsException

KmsKeyValidationException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

startPiiEntitiesDetectionJob

StartPiiEntitiesDetectionJobResult startPiiEntitiesDetectionJob(StartPiiEntitiesDetectionJobRequest startPiiEntitiesDetectionJobRequest)
                                                         throws AmazonClientException,
                                                                AmazonServiceException

Starts an asynchronous PII entity detection job for a collection of documents.

Parameters:

startPiiEntitiesDetectionJobRequest -

Returns:

startPiiEntitiesDetectionJobResult The response from the StartPiiEntitiesDetectionJob service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

TooManyRequestsException

KmsKeyValidationException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

startSentimentDetectionJob

StartSentimentDetectionJobResult startSentimentDetectionJob(StartSentimentDetectionJobRequest startSentimentDetectionJobRequest)
                                                     throws AmazonClientException,
                                                            AmazonServiceException

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

Parameters:

startSentimentDetectionJobRequest -

Returns:

startSentimentDetectionJobResult The response from the StartSentimentDetectionJob service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

TooManyRequestsException

KmsKeyValidationException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

startTopicsDetectionJob

StartTopicsDetectionJobResult startTopicsDetectionJob(StartTopicsDetectionJobRequest startTopicsDetectionJobRequest)
                                               throws AmazonClientException,
                                                      AmazonServiceException

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

Parameters:

startTopicsDetectionJobRequest -

Returns:

startTopicsDetectionJobResult The response from the StartTopicsDetectionJob service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

TooManyRequestsException

KmsKeyValidationException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

stopDominantLanguageDetectionJob

StopDominantLanguageDetectionJobResult stopDominantLanguageDetectionJob(StopDominantLanguageDetectionJobRequest stopDominantLanguageDetectionJobRequest)
                                                                 throws AmazonClientException,
                                                                        AmazonServiceException

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.

Parameters:

stopDominantLanguageDetectionJobRequest -

Returns:

stopDominantLanguageDetectionJobResult The response from the StopDominantLanguageDetectionJob service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

JobNotFoundException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

stopEntitiesDetectionJob

StopEntitiesDetectionJobResult stopEntitiesDetectionJob(StopEntitiesDetectionJobRequest stopEntitiesDetectionJobRequest)
                                                 throws AmazonClientException,
                                                        AmazonServiceException

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.

Parameters:

stopEntitiesDetectionJobRequest -

Returns:

stopEntitiesDetectionJobResult The response from the StopEntitiesDetectionJob service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

JobNotFoundException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

stopEventsDetectionJob

StopEventsDetectionJobResult stopEventsDetectionJob(StopEventsDetectionJobRequest stopEventsDetectionJobRequest)
                                             throws AmazonClientException,
                                                    AmazonServiceException

Stops an events detection job in progress.

Parameters:

stopEventsDetectionJobRequest -

Returns:

stopEventsDetectionJobResult The response from the StopEventsDetectionJob service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

JobNotFoundException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

stopKeyPhrasesDetectionJob

StopKeyPhrasesDetectionJobResult stopKeyPhrasesDetectionJob(StopKeyPhrasesDetectionJobRequest stopKeyPhrasesDetectionJobRequest)
                                                     throws AmazonClientException,
                                                            AmazonServiceException

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.

Parameters:

stopKeyPhrasesDetectionJobRequest -

Returns:

stopKeyPhrasesDetectionJobResult The response from the StopKeyPhrasesDetectionJob service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

JobNotFoundException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

stopPiiEntitiesDetectionJob

StopPiiEntitiesDetectionJobResult stopPiiEntitiesDetectionJob(StopPiiEntitiesDetectionJobRequest stopPiiEntitiesDetectionJobRequest)
                                                       throws AmazonClientException,
                                                              AmazonServiceException

Stops a PII entities detection job in progress.

Parameters:

stopPiiEntitiesDetectionJobRequest -

Returns:

stopPiiEntitiesDetectionJobResult The response from the StopPiiEntitiesDetectionJob service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

JobNotFoundException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

stopSentimentDetectionJob

StopSentimentDetectionJobResult stopSentimentDetectionJob(StopSentimentDetectionJobRequest stopSentimentDetectionJobRequest)
                                                   throws AmazonClientException,
                                                          AmazonServiceException

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.

Parameters:

stopSentimentDetectionJobRequest -

Returns:

stopSentimentDetectionJobResult The response from the StopSentimentDetectionJob service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

JobNotFoundException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

stopTrainingDocumentClassifier

StopTrainingDocumentClassifierResult stopTrainingDocumentClassifier(StopTrainingDocumentClassifierRequest stopTrainingDocumentClassifierRequest)
                                                             throws AmazonClientException,
                                                                    AmazonServiceException

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.

Parameters:

stopTrainingDocumentClassifierRequest -

Returns:

stopTrainingDocumentClassifierResult The response from the StopTrainingDocumentClassifier service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

TooManyRequestsException

ResourceNotFoundException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

stopTrainingEntityRecognizer

StopTrainingEntityRecognizerResult stopTrainingEntityRecognizer(StopTrainingEntityRecognizerRequest stopTrainingEntityRecognizerRequest)
                                                         throws AmazonClientException,
                                                                AmazonServiceException

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.

Parameters:

stopTrainingEntityRecognizerRequest -

Returns:

stopTrainingEntityRecognizerResult The response from the StopTrainingEntityRecognizer service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

TooManyRequestsException

ResourceNotFoundException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
                       throws AmazonClientException,
                              AmazonServiceException

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.

Parameters:

tagResourceRequest -

Returns:

tagResourceResult The response from the TagResource service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

ConcurrentModificationException

ResourceNotFoundException

TooManyTagsException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
                           throws AmazonClientException,
                                  AmazonServiceException

Removes a specific tag associated with an Amazon Comprehend resource.

Parameters:

untagResourceRequest -

Returns:

untagResourceResult The response from the UntagResource service method, as returned by Amazon Comprehend.

Throws:

TooManyTagKeysException

InvalidRequestException

ConcurrentModificationException

ResourceNotFoundException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

updateEndpoint

UpdateEndpointResult updateEndpoint(UpdateEndpointRequest updateEndpointRequest)
                             throws AmazonClientException,
                                    AmazonServiceException

Updates information about the specified endpoint.

Parameters:

updateEndpointRequest -

Returns:

updateEndpointResult The response from the UpdateEndpoint service method, as returned by Amazon Comprehend.

Throws:

InvalidRequestException

TooManyRequestsException

ResourceInUseException

ResourceLimitExceededException

ResourceNotFoundException

ResourceUnavailableException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Comprehend indicating either a problem with the data in the request, or a server side issue.

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response 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.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.