com.amazonaws.services.comprehend

Class AmazonComprehendClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.comprehend.AmazonComprehendClient

All Implemented Interfaces:

AmazonComprehend

Direct Known Subclasses:

AmazonComprehendAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonComprehendClient
extends AmazonWebServiceClient
implements AmazonComprehend

Client for accessing Amazon Comprehend. All service calls made using this client are blocking, and will not return until the service call completes.

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.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.comprehend.AmazonComprehend

ENDPOINT_PREFIX

Method Summary

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.
static AmazonComprehendClientBuilder	builder()
CreateDocumentClassifierResult	createDocumentClassifier(CreateDocumentClassifierRequest request) Creates a new document classifier that you can use to categorize documents.
CreateEntityRecognizerResult	createEntityRecognizer(CreateEntityRecognizerRequest request) Creates an entity recognizer using submitted files.
DeleteDocumentClassifierResult	deleteDocumentClassifier(DeleteDocumentClassifierRequest request) Deletes a previously created document classifier
DeleteEntityRecognizerResult	deleteEntityRecognizer(DeleteEntityRecognizerRequest request) Deletes an entity recognizer.
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.
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.
DescribeKeyPhrasesDetectionJobResult	describeKeyPhrasesDetectionJob(DescribeKeyPhrasesDetectionJobRequest request) Gets the properties associated with a key phrases detection job.
DescribeSentimentDetectionJobResult	describeSentimentDetectionJob(DescribeSentimentDetectionJobRequest request) Gets the properties associated with a 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.
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.
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.
ListDominantLanguageDetectionJobsResult	listDominantLanguageDetectionJobs(ListDominantLanguageDetectionJobsRequest request) Gets a list of the dominant language detection jobs that you have submitted.
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.
ListKeyPhrasesDetectionJobsResult	listKeyPhrasesDetectionJobs(ListKeyPhrasesDetectionJobsRequest request) Get a list of key phrase 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.
ListTopicsDetectionJobsResult	listTopicsDetectionJobs(ListTopicsDetectionJobsRequest request) Gets a list of the topic detection jobs that you have submitted.
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.
StartKeyPhrasesDetectionJobResult	startKeyPhrasesDetectionJob(StartKeyPhrasesDetectionJobRequest request) Starts an asynchronous key phrase detection job for a collection of documents.
StartSentimentDetectionJobResult	startSentimentDetectionJob(StartSentimentDetectionJobRequest request) Starts an asynchronous 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.
StopKeyPhrasesDetectionJobResult	stopKeyPhrasesDetectionJob(StopKeyPhrasesDetectionJobRequest request) Stops a key phrases detection job in progress.
StopSentimentDetectionJobResult	stopSentimentDetectionJob(StopSentimentDetectionJobRequest request) Stops a 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.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.comprehend.AmazonComprehend

shutdown

Method Detail

builder

public static AmazonComprehendClientBuilder builder()

batchDetectDominantLanguage

public BatchDetectDominantLanguageResult batchDetectDominantLanguage(BatchDetectDominantLanguageRequest request)

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.

Specified by:

batchDetectDominantLanguage in interface AmazonComprehend

Parameters:

batchDetectDominantLanguageRequest -

Returns:

Result of the BatchDetectDominantLanguage operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

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

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

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

batchDetectEntities

public BatchDetectEntitiesResult batchDetectEntities(BatchDetectEntitiesRequest request)

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

Specified by:

batchDetectEntities in interface AmazonComprehend

Parameters:

batchDetectEntitiesRequest -

Returns:

Result of the BatchDetectEntities operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

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

UnsupportedLanguageException - Amazon Comprehend can't process the language of the input text. For all custom entity recognition APIs (such as CreateEntityRecognizer), only English is accepted. For most other APIs, Amazon Comprehend accepts only English or Spanish text.

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

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

batchDetectKeyPhrases

public BatchDetectKeyPhrasesResult batchDetectKeyPhrases(BatchDetectKeyPhrasesRequest request)

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

Specified by:

batchDetectKeyPhrases in interface AmazonComprehend

Parameters:

batchDetectKeyPhrasesRequest -

Returns:

Result of the BatchDetectKeyPhrases operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

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

UnsupportedLanguageException - Amazon Comprehend can't process the language of the input text. For all custom entity recognition APIs (such as CreateEntityRecognizer), only English is accepted. For most other APIs, Amazon Comprehend accepts only English or Spanish text.

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

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

batchDetectSentiment

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

Specified by:

batchDetectSentiment in interface AmazonComprehend

Parameters:

batchDetectSentimentRequest -

Returns:

Result of the BatchDetectSentiment operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

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

UnsupportedLanguageException - Amazon Comprehend can't process the language of the input text. For all custom entity recognition APIs (such as CreateEntityRecognizer), only English is accepted. For most other APIs, Amazon Comprehend accepts only English or Spanish text.

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

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

batchDetectSyntax

public 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. For more information, see how-syntax.

Specified by:

batchDetectSyntax in interface AmazonComprehend

Parameters:

batchDetectSyntaxRequest -

Returns:

Result of the BatchDetectSyntax operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

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

UnsupportedLanguageException - Amazon Comprehend can't process the language of the input text. For all custom entity recognition APIs (such as CreateEntityRecognizer), only English is accepted. For most other APIs, Amazon Comprehend accepts only English or Spanish text.

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

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

createDocumentClassifier

public CreateDocumentClassifierResult createDocumentClassifier(CreateDocumentClassifierRequest request)

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.

Specified by:

createDocumentClassifier in interface AmazonComprehend

Parameters:

createDocumentClassifierRequest -

Returns:

Result of the CreateDocumentClassifier operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

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

TooManyTagsException - The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

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

ResourceLimitExceededException - The maximum number of recognizers per account has been exceeded. Review the recognizers, perform cleanup, and then try your request again.

UnsupportedLanguageException - Amazon Comprehend can't process the language of the input text. For all custom entity recognition APIs (such as CreateEntityRecognizer), only English is accepted. For most other APIs, Amazon Comprehend accepts only English or Spanish text.

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

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

createEntityRecognizer

public CreateEntityRecognizerResult createEntityRecognizer(CreateEntityRecognizerRequest request)

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

Specified by:

createEntityRecognizer in interface AmazonComprehend

Parameters:

createEntityRecognizerRequest -

Returns:

Result of the CreateEntityRecognizer operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

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

TooManyTagsException - The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

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

ResourceLimitExceededException - The maximum number of recognizers per account has been exceeded. Review the recognizers, perform cleanup, and then try your request again.

UnsupportedLanguageException - Amazon Comprehend can't process the language of the input text. For all custom entity recognition APIs (such as CreateEntityRecognizer), only English is accepted. For most other APIs, Amazon Comprehend accepts only English or Spanish text.

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

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

deleteDocumentClassifier

public DeleteDocumentClassifierResult deleteDocumentClassifier(DeleteDocumentClassifierRequest request)

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.

Specified by:

deleteDocumentClassifier in interface AmazonComprehend

Parameters:

deleteDocumentClassifierRequest -

Returns:

Result of the DeleteDocumentClassifier operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

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

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

ResourceUnavailableException - The specified resource is not available. Check to see if the resource is in the TRAINED state and try your request again.

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

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

deleteEntityRecognizer

public DeleteEntityRecognizerResult deleteEntityRecognizer(DeleteEntityRecognizerRequest request)

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.

Specified by:

deleteEntityRecognizer in interface AmazonComprehend

Parameters:

deleteEntityRecognizerRequest -

Returns:

Result of the DeleteEntityRecognizer operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

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

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

ResourceUnavailableException - The specified resource is not available. Check to see if the resource is in the TRAINED state and try your request again.

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

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

describeDocumentClassificationJob

public DescribeDocumentClassificationJobResult describeDocumentClassificationJob(DescribeDocumentClassificationJobRequest request)

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

Specified by:

describeDocumentClassificationJob in interface AmazonComprehend

Parameters:

describeDocumentClassificationJobRequest -

Returns:

Result of the DescribeDocumentClassificationJob operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

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

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

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

describeDocumentClassifier

public DescribeDocumentClassifierResult describeDocumentClassifier(DescribeDocumentClassifierRequest request)

Gets the properties associated with a document classifier.

Specified by:

describeDocumentClassifier in interface AmazonComprehend

Parameters:

describeDocumentClassifierRequest -

Returns:

Result of the DescribeDocumentClassifier operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

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

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

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

describeDominantLanguageDetectionJob

public DescribeDominantLanguageDetectionJobResult describeDominantLanguageDetectionJob(DescribeDominantLanguageDetectionJobRequest request)

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

Specified by:

describeDominantLanguageDetectionJob in interface AmazonComprehend

Parameters:

describeDominantLanguageDetectionJobRequest -

Returns:

Result of the DescribeDominantLanguageDetectionJob operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

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

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

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

describeEntitiesDetectionJob

public DescribeEntitiesDetectionJobResult describeEntitiesDetectionJob(DescribeEntitiesDetectionJobRequest request)

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

Specified by:

describeEntitiesDetectionJob in interface AmazonComprehend

Parameters:

describeEntitiesDetectionJobRequest -

Returns:

Result of the DescribeEntitiesDetectionJob operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

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

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

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

describeEntityRecognizer

public DescribeEntityRecognizerResult describeEntityRecognizer(DescribeEntityRecognizerRequest request)

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

Specified by:

describeEntityRecognizer in interface AmazonComprehend

Parameters:

describeEntityRecognizerRequest -

Returns:

Result of the DescribeEntityRecognizer operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

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

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

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

describeKeyPhrasesDetectionJob

public DescribeKeyPhrasesDetectionJobResult describeKeyPhrasesDetectionJob(DescribeKeyPhrasesDetectionJobRequest request)

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

Specified by:

describeKeyPhrasesDetectionJob in interface AmazonComprehend

Parameters:

describeKeyPhrasesDetectionJobRequest -

Returns:

Result of the DescribeKeyPhrasesDetectionJob operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

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

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

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

describeSentimentDetectionJob

public DescribeSentimentDetectionJobResult describeSentimentDetectionJob(DescribeSentimentDetectionJobRequest request)

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

Specified by:

describeSentimentDetectionJob in interface AmazonComprehend

Parameters:

describeSentimentDetectionJobRequest -

Returns:

Result of the DescribeSentimentDetectionJob operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

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

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

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

describeTopicsDetectionJob

public DescribeTopicsDetectionJobResult describeTopicsDetectionJob(DescribeTopicsDetectionJobRequest request)

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

Specified by:

describeTopicsDetectionJob in interface AmazonComprehend

Parameters:

describeTopicsDetectionJobRequest -

Returns:

Result of the DescribeTopicsDetectionJob operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

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

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

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

detectDominantLanguage

public DetectDominantLanguageResult detectDominantLanguage(DetectDominantLanguageRequest request)

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

Specified by:

detectDominantLanguage in interface AmazonComprehend

Parameters:

detectDominantLanguageRequest -

Returns:

Result of the DetectDominantLanguage operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

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

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

detectEntities

public DetectEntitiesResult detectEntities(DetectEntitiesRequest request)

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

Specified by:

detectEntities in interface AmazonComprehend

Parameters:

detectEntitiesRequest -

Returns:

Result of the DetectEntities operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

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

UnsupportedLanguageException - Amazon Comprehend can't process the language of the input text. For all custom entity recognition APIs (such as CreateEntityRecognizer), only English is accepted. For most other APIs, Amazon Comprehend accepts only English or Spanish text.

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

detectKeyPhrases

public DetectKeyPhrasesResult detectKeyPhrases(DetectKeyPhrasesRequest request)

Detects the key noun phrases found in the text.

Specified by:

detectKeyPhrases in interface AmazonComprehend

Parameters:

detectKeyPhrasesRequest -

Returns:

Result of the DetectKeyPhrases operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

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

UnsupportedLanguageException - Amazon Comprehend can't process the language of the input text. For all custom entity recognition APIs (such as CreateEntityRecognizer), only English is accepted. For most other APIs, Amazon Comprehend accepts only English or Spanish text.

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

detectSentiment

public DetectSentimentResult detectSentiment(DetectSentimentRequest request)

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

Specified by:

detectSentiment in interface AmazonComprehend

Parameters:

detectSentimentRequest -

Returns:

Result of the DetectSentiment operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

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

UnsupportedLanguageException - Amazon Comprehend can't process the language of the input text. For all custom entity recognition APIs (such as CreateEntityRecognizer), only English is accepted. For most other APIs, Amazon Comprehend accepts only English or Spanish text.

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

detectSyntax

public DetectSyntaxResult detectSyntax(DetectSyntaxRequest request)

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

Specified by:

detectSyntax in interface AmazonComprehend

Parameters:

detectSyntaxRequest -

Returns:

Result of the DetectSyntax operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

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

UnsupportedLanguageException - Amazon Comprehend can't process the language of the input text. For all custom entity recognition APIs (such as CreateEntityRecognizer), only English is accepted. For most other APIs, Amazon Comprehend accepts only English or Spanish text.

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

listDocumentClassificationJobs

public ListDocumentClassificationJobsResult listDocumentClassificationJobs(ListDocumentClassificationJobsRequest request)

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

Specified by:

listDocumentClassificationJobs in interface AmazonComprehend

Parameters:

listDocumentClassificationJobsRequest -

Returns:

Result of the ListDocumentClassificationJobs operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

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

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

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

listDocumentClassifiers

public ListDocumentClassifiersResult listDocumentClassifiers(ListDocumentClassifiersRequest request)

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

Specified by:

listDocumentClassifiers in interface AmazonComprehend

Parameters:

listDocumentClassifiersRequest -

Returns:

Result of the ListDocumentClassifiers operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

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

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

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

listDominantLanguageDetectionJobs

public ListDominantLanguageDetectionJobsResult listDominantLanguageDetectionJobs(ListDominantLanguageDetectionJobsRequest request)

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

Specified by:

listDominantLanguageDetectionJobs in interface AmazonComprehend

Parameters:

listDominantLanguageDetectionJobsRequest -

Returns:

Result of the ListDominantLanguageDetectionJobs operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

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

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

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

listEntitiesDetectionJobs

public ListEntitiesDetectionJobsResult listEntitiesDetectionJobs(ListEntitiesDetectionJobsRequest request)

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

Specified by:

listEntitiesDetectionJobs in interface AmazonComprehend

Parameters:

listEntitiesDetectionJobsRequest -

Returns:

Result of the ListEntitiesDetectionJobs operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

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

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

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

listEntityRecognizers

public ListEntityRecognizersResult listEntityRecognizers(ListEntityRecognizersRequest request)

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.

Specified by:

listEntityRecognizers in interface AmazonComprehend

Parameters:

listEntityRecognizersRequest -

Returns:

Result of the ListEntityRecognizers operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

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

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

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

listKeyPhrasesDetectionJobs

public ListKeyPhrasesDetectionJobsResult listKeyPhrasesDetectionJobs(ListKeyPhrasesDetectionJobsRequest request)

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

Specified by:

listKeyPhrasesDetectionJobs in interface AmazonComprehend

Parameters:

listKeyPhrasesDetectionJobsRequest -

Returns:

Result of the ListKeyPhrasesDetectionJobs operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

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

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

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

listSentimentDetectionJobs

public ListSentimentDetectionJobsResult listSentimentDetectionJobs(ListSentimentDetectionJobsRequest request)

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

Specified by:

listSentimentDetectionJobs in interface AmazonComprehend

Parameters:

listSentimentDetectionJobsRequest -

Returns:

Result of the ListSentimentDetectionJobs operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

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

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

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Lists all tags associated with a given Amazon Comprehend resource.

Specified by:

listTagsForResource in interface AmazonComprehend

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

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

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

listTopicsDetectionJobs

public ListTopicsDetectionJobsResult listTopicsDetectionJobs(ListTopicsDetectionJobsRequest request)

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

Specified by:

listTopicsDetectionJobs in interface AmazonComprehend

Parameters:

listTopicsDetectionJobsRequest -

Returns:

Result of the ListTopicsDetectionJobs operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

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

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

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

startDocumentClassificationJob

public StartDocumentClassificationJobResult startDocumentClassificationJob(StartDocumentClassificationJobRequest request)

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

Specified by:

startDocumentClassificationJob in interface AmazonComprehend

Parameters:

startDocumentClassificationJobRequest -

Returns:

Result of the StartDocumentClassificationJob operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

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

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

ResourceUnavailableException - The specified resource is not available. Check to see if the resource is in the TRAINED state and try your request again.

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

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

startDominantLanguageDetectionJob

public StartDominantLanguageDetectionJobResult startDominantLanguageDetectionJob(StartDominantLanguageDetectionJobRequest request)

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

Specified by:

startDominantLanguageDetectionJob in interface AmazonComprehend

Parameters:

startDominantLanguageDetectionJobRequest -

Returns:

Result of the StartDominantLanguageDetectionJob operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

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

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

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

startEntitiesDetectionJob

public StartEntitiesDetectionJobResult startEntitiesDetectionJob(StartEntitiesDetectionJobRequest request)

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.

Specified by:

startEntitiesDetectionJob in interface AmazonComprehend

Parameters:

startEntitiesDetectionJobRequest -

Returns:

Result of the StartEntitiesDetectionJob operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

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

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

ResourceUnavailableException - The specified resource is not available. Check to see if the resource is in the TRAINED state and try your request again.

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

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

startKeyPhrasesDetectionJob

public StartKeyPhrasesDetectionJobResult startKeyPhrasesDetectionJob(StartKeyPhrasesDetectionJobRequest request)

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

Specified by:

startKeyPhrasesDetectionJob in interface AmazonComprehend

Parameters:

startKeyPhrasesDetectionJobRequest -

Returns:

Result of the StartKeyPhrasesDetectionJob operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

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

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

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

startSentimentDetectionJob

public StartSentimentDetectionJobResult startSentimentDetectionJob(StartSentimentDetectionJobRequest request)

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

Specified by:

startSentimentDetectionJob in interface AmazonComprehend

Parameters:

startSentimentDetectionJobRequest -

Returns:

Result of the StartSentimentDetectionJob operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

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

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

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

startTopicsDetectionJob

public StartTopicsDetectionJobResult startTopicsDetectionJob(StartTopicsDetectionJobRequest request)

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

Specified by:

startTopicsDetectionJob in interface AmazonComprehend

Parameters:

startTopicsDetectionJobRequest -

Returns:

Result of the StartTopicsDetectionJob operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

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

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

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

stopDominantLanguageDetectionJob

public StopDominantLanguageDetectionJobResult stopDominantLanguageDetectionJob(StopDominantLanguageDetectionJobRequest request)

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.

Specified by:

stopDominantLanguageDetectionJob in interface AmazonComprehend

Parameters:

stopDominantLanguageDetectionJobRequest -

Returns:

Result of the StopDominantLanguageDetectionJob operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

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

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

stopEntitiesDetectionJob

public StopEntitiesDetectionJobResult stopEntitiesDetectionJob(StopEntitiesDetectionJobRequest request)

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.

Specified by:

stopEntitiesDetectionJob in interface AmazonComprehend

Parameters:

stopEntitiesDetectionJobRequest -

Returns:

Result of the StopEntitiesDetectionJob operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

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

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

stopKeyPhrasesDetectionJob

public StopKeyPhrasesDetectionJobResult stopKeyPhrasesDetectionJob(StopKeyPhrasesDetectionJobRequest request)

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.

Specified by:

stopKeyPhrasesDetectionJob in interface AmazonComprehend

Parameters:

stopKeyPhrasesDetectionJobRequest -

Returns:

Result of the StopKeyPhrasesDetectionJob operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

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

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

stopSentimentDetectionJob

public StopSentimentDetectionJobResult stopSentimentDetectionJob(StopSentimentDetectionJobRequest request)

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.

Specified by:

stopSentimentDetectionJob in interface AmazonComprehend

Parameters:

stopSentimentDetectionJobRequest -

Returns:

Result of the StopSentimentDetectionJob operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

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

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

stopTrainingDocumentClassifier

public StopTrainingDocumentClassifierResult stopTrainingDocumentClassifier(StopTrainingDocumentClassifierRequest request)

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.

Specified by:

stopTrainingDocumentClassifier in interface AmazonComprehend

Parameters:

stopTrainingDocumentClassifierRequest -

Returns:

Result of the StopTrainingDocumentClassifier operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

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

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

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

stopTrainingEntityRecognizer

public StopTrainingEntityRecognizerResult stopTrainingEntityRecognizer(StopTrainingEntityRecognizerRequest request)

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.

Specified by:

stopTrainingEntityRecognizer in interface AmazonComprehend

Parameters:

stopTrainingEntityRecognizerRequest -

Returns:

Result of the StopTrainingEntityRecognizer operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

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

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

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

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.

Specified by:

tagResource in interface AmazonComprehend

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

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

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

TooManyTagsException - The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Removes a specific tag associated with an Amazon Comprehend resource.

Specified by:

untagResource in interface AmazonComprehend

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

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

InvalidRequestException - The request is invalid.

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

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

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AmazonComprehend

Parameters:

request - The originally executed request

Returns:

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