AmazonComprehendClient (AWS SDK for Android

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.comprehend.AmazonComprehendClient

All Implemented Interfaces:

AmazonComprehend

Direct Known Subclasses:

AmazonComprehendAsyncClient
```
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

Constructor Summary

Constructors
Constructor and Description
`AmazonComprehendClient()` Deprecated.
`AmazonComprehendClient(AWSCredentials awsCredentials)` Constructs a new client to invoke service methods on AmazonComprehend using the specified AWS account credentials.
`AmazonComprehendClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)` Constructs a new client to invoke service methods on AmazonComprehend using the specified AWS account credentials and client configuration options.
`AmazonComprehendClient(AWSCredentialsProvider awsCredentialsProvider)` Constructs a new client to invoke service methods on AmazonComprehend using the specified AWS account credentials provider.
`AmazonComprehendClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)` Constructs a new client to invoke service methods on AmazonComprehend using the specified AWS account credentials provider and client configuration options.
`AmazonComprehendClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, HttpClient httpClient)` Constructs a new client to invoke service methods on AmazonComprehend using the specified AWS account credentials provider, client configuration options and request metric collector.
`AmazonComprehendClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, com.amazonaws.metrics.RequestMetricCollector requestMetricCollector)` Deprecated.
`AmazonComprehendClient(ClientConfiguration clientConfiguration)` Deprecated.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
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)` Deprecated. ResponseMetadata cache can hold up to 50 requests and responses in memory and will cause memory issue. This method now always returns null.
`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.
`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.

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
setEndpoint, setRegion, shutdown

- Constructor Detail
  - AmazonComprehendClient
```
@Deprecated
public AmazonComprehendClient()
```
    Deprecated.
    Constructs a new client to invoke service methods on AmazonComprehend. A credentials provider chain will be used that searches for credentials in this order:
    - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
    - Java System Properties - aws.accessKeyId and aws.secretKey
    - Instance profile credentials delivered through the Amazon EC2 metadata service
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    See Also:
    
    DefaultAWSCredentialsProviderChain
  - AmazonComprehendClient
```
@Deprecated
public AmazonComprehendClient(ClientConfiguration clientConfiguration)
```
    Deprecated.
    Constructs a new client to invoke service methods on AmazonComprehend. A credentials provider chain will be used that searches for credentials in this order:
    - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
    - Java System Properties - aws.accessKeyId and aws.secretKey
    - Instance profile credentials delivered through the Amazon EC2 metadata service
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    Parameters:
    
    clientConfiguration - The client configuration options controlling how this client connects to AmazonComprehend (ex: proxy settings, retry counts, etc.).
    
    See Also:
    
    DefaultAWSCredentialsProviderChain
  - AmazonComprehendClient
```
public AmazonComprehendClient(AWSCredentials awsCredentials)
```
    Constructs a new client to invoke service methods on AmazonComprehend using the specified AWS account credentials.
    The client requests are authenticated using the AWSCredentials provided in this constructor. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.
```
 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonComprehendClient client = new AmazonComprehendClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 
```
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    Parameters:
    
    awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
  - AmazonComprehendClient
```
public AmazonComprehendClient(AWSCredentials awsCredentials,
                              ClientConfiguration clientConfiguration)
```
    Constructs a new client to invoke service methods on AmazonComprehend using the specified AWS account credentials and client configuration options.
    The client requests are authenticated using the AWSCredentials provided in this constructor. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.
```
 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonComprehendClient client = new AmazonComprehendClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 
```
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    Parameters:
    
    awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
    
    clientConfiguration - The client configuration options controlling how this client connects to AmazonComprehend (ex: proxy settings, retry counts, etc.).
  - AmazonComprehendClient
```
public AmazonComprehendClient(AWSCredentialsProvider awsCredentialsProvider)
```
    Constructs a new client to invoke service methods on AmazonComprehend using the specified AWS account credentials provider.
    The client requests are authenticated using the AWSCredentials provided by the AWSCredentialsProvider. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.
```
 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonComprehendClient client = new AmazonComprehendClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 
```
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    Parameters:
    
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
  - AmazonComprehendClient
```
public AmazonComprehendClient(AWSCredentialsProvider awsCredentialsProvider,
                              ClientConfiguration clientConfiguration)
```
    Constructs a new client to invoke service methods on AmazonComprehend using the specified AWS account credentials provider and client configuration options.
    The client requests are authenticated using the AWSCredentials provided by the AWSCredentialsProvider. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.
```
 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonComprehendClient client = new AmazonComprehendClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 
```
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    Parameters:
    
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
    
    clientConfiguration - The client configuration options controlling how this client connects to AmazonComprehend (ex: proxy settings, retry counts, etc.).
  - AmazonComprehendClient
```
@Deprecated
public AmazonComprehendClient(AWSCredentialsProvider awsCredentialsProvider,
                                          ClientConfiguration clientConfiguration,
                                          com.amazonaws.metrics.RequestMetricCollector requestMetricCollector)
```
    Deprecated.
    
    Constructs a new client to invoke service methods on AmazonComprehend using the specified AWS account credentials provider, client configuration options and request metric collector.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
    
    clientConfiguration - The client configuration options controlling how this client connects to AmazonComprehend (ex: proxy settings, retry counts, etc.).
    
    requestMetricCollector - optional request metric collector
  - AmazonComprehendClient
```
public AmazonComprehendClient(AWSCredentialsProvider awsCredentialsProvider,
                              ClientConfiguration clientConfiguration,
                              HttpClient httpClient)
```
    Constructs a new client to invoke service methods on AmazonComprehend using the specified AWS account credentials provider, client configuration options and request metric collector.
    The client requests are authenticated using the AWSCredentials provided by the AWSCredentialsProvider. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.
```
 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonComprehendClient client = new AmazonComprehendClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 
```
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    Parameters:
    
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
    
    clientConfiguration - The client configuration options controlling how this client connects to AmazonComprehend (ex: proxy settings, retry counts, etc.).
    
    httpClient - A http client
- Method Detail
  - batchDetectDominantLanguage
```
public BatchDetectDominantLanguageResult batchDetectDominantLanguage(BatchDetectDominantLanguageRequest batchDetectDominantLanguageRequest)
                                                              throws AmazonServiceException,
                                                                     AmazonClientException
```
    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:
    
    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
```
public BatchDetectEntitiesResult batchDetectEntities(BatchDetectEntitiesRequest batchDetectEntitiesRequest)
                                              throws AmazonServiceException,
                                                     AmazonClientException
```
    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:
    
    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
```
public BatchDetectKeyPhrasesResult batchDetectKeyPhrases(BatchDetectKeyPhrasesRequest batchDetectKeyPhrasesRequest)
                                                  throws AmazonServiceException,
                                                         AmazonClientException
```
    Detects the key noun phrases found in a batch of documents.
    
    Specified by:
    
    batchDetectKeyPhrases in interface AmazonComprehend
    
    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
```
public BatchDetectSentimentResult batchDetectSentiment(BatchDetectSentimentRequest batchDetectSentimentRequest)
                                                throws AmazonServiceException,
                                                       AmazonClientException
```
    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:
    
    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
```
public BatchDetectSyntaxResult batchDetectSyntax(BatchDetectSyntaxRequest batchDetectSyntaxRequest)
                                          throws AmazonServiceException,
                                                 AmazonClientException
```
    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:
    
    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
```
public ClassifyDocumentResult classifyDocument(ClassifyDocumentRequest classifyDocumentRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException
```
    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.
    
    Specified by:
    
    classifyDocument in interface AmazonComprehend
    
    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
```
public CreateDocumentClassifierResult createDocumentClassifier(CreateDocumentClassifierRequest createDocumentClassifierRequest)
                                                        throws AmazonServiceException,
                                                               AmazonClientException
```
    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:
    
    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
```
public CreateEndpointResult createEndpoint(CreateEndpointRequest createEndpointRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException
```
    Creates a model-specific endpoint for synchronous inference for a previously trained custom model
    
    Specified by:
    
    createEndpoint in interface AmazonComprehend
    
    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
```
public CreateEntityRecognizerResult createEntityRecognizer(CreateEntityRecognizerRequest createEntityRecognizerRequest)
                                                    throws AmazonServiceException,
                                                           AmazonClientException
```
    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:
    
    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
```
public DeleteDocumentClassifierResult deleteDocumentClassifier(DeleteDocumentClassifierRequest deleteDocumentClassifierRequest)
                                                        throws AmazonServiceException,
                                                               AmazonClientException
```
    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:
    
    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
```
public DeleteEndpointResult deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException
```
    Deletes a model-specific endpoint for a previously-trained custom model. All endpoints must be deleted in order for the model to be deleted.
    
    Specified by:
    
    deleteEndpoint in interface AmazonComprehend
    
    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
```
public DeleteEntityRecognizerResult deleteEntityRecognizer(DeleteEntityRecognizerRequest deleteEntityRecognizerRequest)
                                                    throws AmazonServiceException,
                                                           AmazonClientException
```
    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:
    
    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
```
public DescribeDocumentClassificationJobResult describeDocumentClassificationJob(DescribeDocumentClassificationJobRequest describeDocumentClassificationJobRequest)
                                                                          throws AmazonServiceException,
                                                                                 AmazonClientException
```
    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:
    
    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
```
public DescribeDocumentClassifierResult describeDocumentClassifier(DescribeDocumentClassifierRequest describeDocumentClassifierRequest)
                                                            throws AmazonServiceException,
                                                                   AmazonClientException
```
    Gets the properties associated with a document classifier.
    
    Specified by:
    
    describeDocumentClassifier in interface AmazonComprehend
    
    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
```
public DescribeDominantLanguageDetectionJobResult describeDominantLanguageDetectionJob(DescribeDominantLanguageDetectionJobRequest describeDominantLanguageDetectionJobRequest)
                                                                                throws AmazonServiceException,
                                                                                       AmazonClientException
```
    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:
    
    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
```
public DescribeEndpointResult describeEndpoint(DescribeEndpointRequest describeEndpointRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException
```
    Gets the properties associated with a specific endpoint. Use this operation to get the status of an endpoint.
    
    Specified by:
    
    describeEndpoint in interface AmazonComprehend
    
    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
```
public DescribeEntitiesDetectionJobResult describeEntitiesDetectionJob(DescribeEntitiesDetectionJobRequest describeEntitiesDetectionJobRequest)
                                                                throws AmazonServiceException,
                                                                       AmazonClientException
```
    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:
    
    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
```
public DescribeEntityRecognizerResult describeEntityRecognizer(DescribeEntityRecognizerRequest describeEntityRecognizerRequest)
                                                        throws AmazonServiceException,
                                                               AmazonClientException
```
    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:
    
    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
```
public DescribeEventsDetectionJobResult describeEventsDetectionJob(DescribeEventsDetectionJobRequest describeEventsDetectionJobRequest)
                                                            throws AmazonServiceException,
                                                                   AmazonClientException
```
    Gets the status and details of an events detection job.
    
    Specified by:
    
    describeEventsDetectionJob in interface AmazonComprehend
    
    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
```
public DescribeKeyPhrasesDetectionJobResult describeKeyPhrasesDetectionJob(DescribeKeyPhrasesDetectionJobRequest describeKeyPhrasesDetectionJobRequest)
                                                                    throws AmazonServiceException,
                                                                           AmazonClientException
```
    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:
    
    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
```
public DescribePiiEntitiesDetectionJobResult describePiiEntitiesDetectionJob(DescribePiiEntitiesDetectionJobRequest describePiiEntitiesDetectionJobRequest)
                                                                      throws AmazonServiceException,
                                                                             AmazonClientException
```
    Gets the properties associated with a PII entities detection job. For example, you can use this operation to get the job status.
    
    Specified by:
    
    describePiiEntitiesDetectionJob in interface AmazonComprehend
    
    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
```
public DescribeSentimentDetectionJobResult describeSentimentDetectionJob(DescribeSentimentDetectionJobRequest describeSentimentDetectionJobRequest)
                                                                  throws AmazonServiceException,
                                                                         AmazonClientException
```
    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:
    
    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
```
public DescribeTopicsDetectionJobResult describeTopicsDetectionJob(DescribeTopicsDetectionJobRequest describeTopicsDetectionJobRequest)
                                                            throws AmazonServiceException,
                                                                   AmazonClientException
```
    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:
    
    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
```
public DetectDominantLanguageResult detectDominantLanguage(DetectDominantLanguageRequest detectDominantLanguageRequest)
                                                    throws AmazonServiceException,
                                                           AmazonClientException
```
    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:
    
    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
```
public DetectEntitiesResult detectEntities(DetectEntitiesRequest detectEntitiesRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException
```
    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:
    
    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
```
public DetectKeyPhrasesResult detectKeyPhrases(DetectKeyPhrasesRequest detectKeyPhrasesRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException
```
    Detects the key noun phrases found in the text.
    
    Specified by:
    
    detectKeyPhrases in interface AmazonComprehend
    
    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
```
public DetectPiiEntitiesResult detectPiiEntities(DetectPiiEntitiesRequest detectPiiEntitiesRequest)
                                          throws AmazonServiceException,
                                                 AmazonClientException
```
    Inspects the input text for entities that contain personally identifiable information (PII) and returns information about them.
    
    Specified by:
    
    detectPiiEntities in interface AmazonComprehend
    
    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
```
public DetectSentimentResult detectSentiment(DetectSentimentRequest detectSentimentRequest)
                                      throws AmazonServiceException,
                                             AmazonClientException
```
    Inspects text and returns an inference of the prevailing sentiment ( POSITIVE, NEUTRAL, MIXED, or NEGATIVE).
    
    Specified by:
    
    detectSentiment in interface AmazonComprehend
    
    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
```
public DetectSyntaxResult detectSyntax(DetectSyntaxRequest detectSyntaxRequest)
                                throws AmazonServiceException,
                                       AmazonClientException
```
    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:
    
    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
```
public ListDocumentClassificationJobsResult listDocumentClassificationJobs(ListDocumentClassificationJobsRequest listDocumentClassificationJobsRequest)
                                                                    throws AmazonServiceException,
                                                                           AmazonClientException
```
    Gets a list of the documentation classification jobs that you have submitted.
    
    Specified by:
    
    listDocumentClassificationJobs in interface AmazonComprehend
    
    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
```
public ListDocumentClassifiersResult listDocumentClassifiers(ListDocumentClassifiersRequest listDocumentClassifiersRequest)
                                                      throws AmazonServiceException,
                                                             AmazonClientException
```
    Gets a list of the document classifiers that you have created.
    
    Specified by:
    
    listDocumentClassifiers in interface AmazonComprehend
    
    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
```
public ListDominantLanguageDetectionJobsResult listDominantLanguageDetectionJobs(ListDominantLanguageDetectionJobsRequest listDominantLanguageDetectionJobsRequest)
                                                                          throws AmazonServiceException,
                                                                                 AmazonClientException
```
    Gets a list of the dominant language detection jobs that you have submitted.
    
    Specified by:
    
    listDominantLanguageDetectionJobs in interface AmazonComprehend
    
    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
```
public ListEndpointsResult listEndpoints(ListEndpointsRequest listEndpointsRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException
```
    Gets a list of all existing endpoints that you've created.
    
    Specified by:
    
    listEndpoints in interface AmazonComprehend
    
    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
```
public ListEntitiesDetectionJobsResult listEntitiesDetectionJobs(ListEntitiesDetectionJobsRequest listEntitiesDetectionJobsRequest)
                                                          throws AmazonServiceException,
                                                                 AmazonClientException
```
    Gets a list of the entity detection jobs that you have submitted.
    
    Specified by:
    
    listEntitiesDetectionJobs in interface AmazonComprehend
    
    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
```
public ListEntityRecognizersResult listEntityRecognizers(ListEntityRecognizersRequest listEntityRecognizersRequest)
                                                  throws AmazonServiceException,
                                                         AmazonClientException
```
    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:
    
    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
```
public ListEventsDetectionJobsResult listEventsDetectionJobs(ListEventsDetectionJobsRequest listEventsDetectionJobsRequest)
                                                      throws AmazonServiceException,
                                                             AmazonClientException
```
    Gets a list of the events detection jobs that you have submitted.
    
    Specified by:
    
    listEventsDetectionJobs in interface AmazonComprehend
    
    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
```
public ListKeyPhrasesDetectionJobsResult listKeyPhrasesDetectionJobs(ListKeyPhrasesDetectionJobsRequest listKeyPhrasesDetectionJobsRequest)
                                                              throws AmazonServiceException,
                                                                     AmazonClientException
```
    Get a list of key phrase detection jobs that you have submitted.
    
    Specified by:
    
    listKeyPhrasesDetectionJobs in interface AmazonComprehend
    
    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
```
public ListPiiEntitiesDetectionJobsResult listPiiEntitiesDetectionJobs(ListPiiEntitiesDetectionJobsRequest listPiiEntitiesDetectionJobsRequest)
                                                                throws AmazonServiceException,
                                                                       AmazonClientException
```
    Gets a list of the PII entity detection jobs that you have submitted.
    
    Specified by:
    
    listPiiEntitiesDetectionJobs in interface AmazonComprehend
    
    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
```
public ListSentimentDetectionJobsResult listSentimentDetectionJobs(ListSentimentDetectionJobsRequest listSentimentDetectionJobsRequest)
                                                            throws AmazonServiceException,
                                                                   AmazonClientException
```
    Gets a list of sentiment detection jobs that you have submitted.
    
    Specified by:
    
    listSentimentDetectionJobs in interface AmazonComprehend
    
    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
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                              throws AmazonServiceException,
                                                     AmazonClientException
```
    Lists all tags associated with a given Amazon Comprehend resource.
    
    Specified by:
    
    listTagsForResource in interface AmazonComprehend
    
    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
```
public ListTopicsDetectionJobsResult listTopicsDetectionJobs(ListTopicsDetectionJobsRequest listTopicsDetectionJobsRequest)
                                                      throws AmazonServiceException,
                                                             AmazonClientException
```
    Gets a list of the topic detection jobs that you have submitted.
    
    Specified by:
    
    listTopicsDetectionJobs in interface AmazonComprehend
    
    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
```
public StartDocumentClassificationJobResult startDocumentClassificationJob(StartDocumentClassificationJobRequest startDocumentClassificationJobRequest)
                                                                    throws AmazonServiceException,
                                                                           AmazonClientException
```
    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:
    
    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
```
public StartDominantLanguageDetectionJobResult startDominantLanguageDetectionJob(StartDominantLanguageDetectionJobRequest startDominantLanguageDetectionJobRequest)
                                                                          throws AmazonServiceException,
                                                                                 AmazonClientException
```
    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:
    
    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
```
public StartEntitiesDetectionJobResult startEntitiesDetectionJob(StartEntitiesDetectionJobRequest startEntitiesDetectionJobRequest)
                                                          throws AmazonServiceException,
                                                                 AmazonClientException
```
    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:
    
    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
```
public StartEventsDetectionJobResult startEventsDetectionJob(StartEventsDetectionJobRequest startEventsDetectionJobRequest)
                                                      throws AmazonServiceException,
                                                             AmazonClientException
```
    Starts an asynchronous event detection job for a collection of documents.
    
    Specified by:
    
    startEventsDetectionJob in interface AmazonComprehend
    
    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
```
public StartKeyPhrasesDetectionJobResult startKeyPhrasesDetectionJob(StartKeyPhrasesDetectionJobRequest startKeyPhrasesDetectionJobRequest)
                                                              throws AmazonServiceException,
                                                                     AmazonClientException
```
    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:
    
    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
```
public StartPiiEntitiesDetectionJobResult startPiiEntitiesDetectionJob(StartPiiEntitiesDetectionJobRequest startPiiEntitiesDetectionJobRequest)
                                                                throws AmazonServiceException,
                                                                       AmazonClientException
```
    Starts an asynchronous PII entity detection job for a collection of documents.
    
    Specified by:
    
    startPiiEntitiesDetectionJob in interface AmazonComprehend
    
    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
```
public StartSentimentDetectionJobResult startSentimentDetectionJob(StartSentimentDetectionJobRequest startSentimentDetectionJobRequest)
                                                            throws AmazonServiceException,
                                                                   AmazonClientException
```
    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:
    
    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
```
public StartTopicsDetectionJobResult startTopicsDetectionJob(StartTopicsDetectionJobRequest startTopicsDetectionJobRequest)
                                                      throws AmazonServiceException,
                                                             AmazonClientException
```
    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:
    
    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
```
public StopDominantLanguageDetectionJobResult stopDominantLanguageDetectionJob(StopDominantLanguageDetectionJobRequest stopDominantLanguageDetectionJobRequest)
                                                                        throws AmazonServiceException,
                                                                               AmazonClientException
```
    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:
    
    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
```
public StopEntitiesDetectionJobResult stopEntitiesDetectionJob(StopEntitiesDetectionJobRequest stopEntitiesDetectionJobRequest)
                                                        throws AmazonServiceException,
                                                               AmazonClientException
```
    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:
    
    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
```
public StopEventsDetectionJobResult stopEventsDetectionJob(StopEventsDetectionJobRequest stopEventsDetectionJobRequest)
                                                    throws AmazonServiceException,
                                                           AmazonClientException
```
    Stops an events detection job in progress.
    
    Specified by:
    
    stopEventsDetectionJob in interface AmazonComprehend
    
    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
```
public StopKeyPhrasesDetectionJobResult stopKeyPhrasesDetectionJob(StopKeyPhrasesDetectionJobRequest stopKeyPhrasesDetectionJobRequest)
                                                            throws AmazonServiceException,
                                                                   AmazonClientException
```
    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:
    
    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
```
public StopPiiEntitiesDetectionJobResult stopPiiEntitiesDetectionJob(StopPiiEntitiesDetectionJobRequest stopPiiEntitiesDetectionJobRequest)
                                                              throws AmazonServiceException,
                                                                     AmazonClientException
```
    Stops a PII entities detection job in progress.
    
    Specified by:
    
    stopPiiEntitiesDetectionJob in interface AmazonComprehend
    
    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
```
public StopSentimentDetectionJobResult stopSentimentDetectionJob(StopSentimentDetectionJobRequest stopSentimentDetectionJobRequest)
                                                          throws AmazonServiceException,
                                                                 AmazonClientException
```
    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:
    
    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
```
public StopTrainingDocumentClassifierResult stopTrainingDocumentClassifier(StopTrainingDocumentClassifierRequest stopTrainingDocumentClassifierRequest)
                                                                    throws AmazonServiceException,
                                                                           AmazonClientException
```
    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:
    
    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
```
public StopTrainingEntityRecognizerResult stopTrainingEntityRecognizer(StopTrainingEntityRecognizerRequest stopTrainingEntityRecognizerRequest)
                                                                throws AmazonServiceException,
                                                                       AmazonClientException
```
    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:
    
    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
```
public TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
                              throws AmazonServiceException,
                                     AmazonClientException
```
    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:
    
    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
```
public UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException
```
    Removes a specific tag associated with an Amazon Comprehend resource.
    
    Specified by:
    
    untagResource in interface AmazonComprehend
    
    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
```
public UpdateEndpointResult updateEndpoint(UpdateEndpointRequest updateEndpointRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException
```
    Updates information about the specified endpoint.
    
    Specified by:
    
    updateEndpoint in interface AmazonComprehend
    
    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.
  - getCachedResponseMetadata
```
@Deprecated
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Deprecated. ResponseMetadata cache can hold up to 50 requests and responses in memory and will cause memory issue. This method now always returns null.
    
    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.

Class AmazonComprehendClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

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

Constructor Detail

AmazonComprehendClient

AmazonComprehendClient

AmazonComprehendClient

AmazonComprehendClient

AmazonComprehendClient

AmazonComprehendClient

AmazonComprehendClient

AmazonComprehendClient

Method Detail

batchDetectDominantLanguage

batchDetectEntities

batchDetectKeyPhrases

batchDetectSentiment

batchDetectSyntax

classifyDocument

createDocumentClassifier

createEndpoint

createEntityRecognizer

deleteDocumentClassifier

deleteEndpoint

deleteEntityRecognizer

describeDocumentClassificationJob

describeDocumentClassifier

describeDominantLanguageDetectionJob

describeEndpoint

describeEntitiesDetectionJob

describeEntityRecognizer

describeEventsDetectionJob

describeKeyPhrasesDetectionJob

describePiiEntitiesDetectionJob

describeSentimentDetectionJob

describeTopicsDetectionJob

detectDominantLanguage

detectEntities

detectKeyPhrases

detectPiiEntities

detectSentiment

detectSyntax

listDocumentClassificationJobs

listDocumentClassifiers

listDominantLanguageDetectionJobs

listEndpoints

listEntitiesDetectionJobs

listEntityRecognizers

listEventsDetectionJobs

listKeyPhrasesDetectionJobs

listPiiEntitiesDetectionJobs

listSentimentDetectionJobs

listTagsForResource

listTopicsDetectionJobs

startDocumentClassificationJob

startDominantLanguageDetectionJob

startEntitiesDetectionJob

startEventsDetectionJob

startKeyPhrasesDetectionJob

startPiiEntitiesDetectionJob

startSentimentDetectionJob

startTopicsDetectionJob

stopDominantLanguageDetectionJob

stopEntitiesDetectionJob

stopEventsDetectionJob

stopKeyPhrasesDetectionJob

stopPiiEntitiesDetectionJob

stopSentimentDetectionJob

stopTrainingDocumentClassifier

stopTrainingEntityRecognizer

tagResource

untagResource

updateEndpoint

getCachedResponseMetadata