AmazonComprehendClient (AWS SDK for Java

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

All Implemented Interfaces:

AmazonComprehend

Direct Known Subclasses:

AmazonComprehendAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonComprehendClient
extends AmazonWebServiceClient
implements AmazonComprehend
```
Client for accessing Amazon Comprehend. All service calls made using this client are blocking, and will not return until the service call completes.

Amazon Comprehend is an AWS service for gaining insight into the content of documents. Use these actions to determine the topics contained in your documents, the topics they discuss, the predominant sentiment expressed in them, the predominant language used, and more.

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  LOGGING_AWS_REQUEST_METRIC
- Fields inherited from interface com.amazonaws.services.comprehend.AmazonComprehend
  ENDPOINT_PREFIX

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BatchDetectDominantLanguageResult`	`batchDetectDominantLanguage(BatchDetectDominantLanguageRequest request)` Determines the dominant language of the input text for a batch of documents.
`BatchDetectEntitiesResult`	`batchDetectEntities(BatchDetectEntitiesRequest request)` Inspects the text of a batch of documents for named entities and returns information about them.
`BatchDetectKeyPhrasesResult`	`batchDetectKeyPhrases(BatchDetectKeyPhrasesRequest request)` Detects the key noun phrases found in a batch of documents.
`BatchDetectSentimentResult`	`batchDetectSentiment(BatchDetectSentimentRequest request)` Inspects a batch of documents and returns an inference of the prevailing sentiment, `POSITIVE`, `NEUTRAL`, `MIXED`, or `NEGATIVE`, in each one.
`static AmazonComprehendClientBuilder`	`builder()`
`DescribeDominantLanguageDetectionJobResult`	`describeDominantLanguageDetectionJob(DescribeDominantLanguageDetectionJobRequest request)` Gets the properties associated with a dominant language detection job.
`DescribeEntitiesDetectionJobResult`	`describeEntitiesDetectionJob(DescribeEntitiesDetectionJobRequest request)` Gets the properties associated with an entities detection job.
`DescribeKeyPhrasesDetectionJobResult`	`describeKeyPhrasesDetectionJob(DescribeKeyPhrasesDetectionJobRequest request)` Gets the properties associated with a key phrases detection job.
`DescribeSentimentDetectionJobResult`	`describeSentimentDetectionJob(DescribeSentimentDetectionJobRequest request)` Gets the properties associated with a sentiment detection job.
`DescribeTopicsDetectionJobResult`	`describeTopicsDetectionJob(DescribeTopicsDetectionJobRequest request)` Gets the properties associated with a topic detection job.
`DetectDominantLanguageResult`	`detectDominantLanguage(DetectDominantLanguageRequest request)` Determines the dominant language of the input text.
`DetectEntitiesResult`	`detectEntities(DetectEntitiesRequest request)` Inspects text for named entities, and returns information about them.
`DetectKeyPhrasesResult`	`detectKeyPhrases(DetectKeyPhrasesRequest request)` Detects the key noun phrases found in the text.
`DetectSentimentResult`	`detectSentiment(DetectSentimentRequest request)` Inspects text and returns an inference of the prevailing sentiment (`POSITIVE`, `NEUTRAL`, `MIXED`, or `NEGATIVE`).
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
`ListDominantLanguageDetectionJobsResult`	`listDominantLanguageDetectionJobs(ListDominantLanguageDetectionJobsRequest request)` Gets a list of the dominant language detection jobs that you have submitted.
`ListEntitiesDetectionJobsResult`	`listEntitiesDetectionJobs(ListEntitiesDetectionJobsRequest request)` Gets a list of the entity detection jobs that you have submitted.
`ListKeyPhrasesDetectionJobsResult`	`listKeyPhrasesDetectionJobs(ListKeyPhrasesDetectionJobsRequest request)` Get a list of key phrase detection jobs that you have submitted.
`ListSentimentDetectionJobsResult`	`listSentimentDetectionJobs(ListSentimentDetectionJobsRequest request)` Gets a list of sentiment detection jobs that you have submitted.
`ListTopicsDetectionJobsResult`	`listTopicsDetectionJobs(ListTopicsDetectionJobsRequest request)` Gets a list of the topic detection jobs that you have submitted.
`StartDominantLanguageDetectionJobResult`	`startDominantLanguageDetectionJob(StartDominantLanguageDetectionJobRequest request)` Starts an asynchronous dominant language detection job for a collection of documents.
`StartEntitiesDetectionJobResult`	`startEntitiesDetectionJob(StartEntitiesDetectionJobRequest request)` Starts an asynchronous entity detection job for a collection of documents.
`StartKeyPhrasesDetectionJobResult`	`startKeyPhrasesDetectionJob(StartKeyPhrasesDetectionJobRequest request)` Starts an asynchronous key phrase detection job for a collection of documents.
`StartSentimentDetectionJobResult`	`startSentimentDetectionJob(StartSentimentDetectionJobRequest request)` Starts an asynchronous sentiment detection job for a collection of documents.
`StartTopicsDetectionJobResult`	`startTopicsDetectionJob(StartTopicsDetectionJobRequest request)` Starts an asynchronous topic detection job.
`StopDominantLanguageDetectionJobResult`	`stopDominantLanguageDetectionJob(StopDominantLanguageDetectionJobRequest request)` Stops a dominant language detection job in progress.
`StopEntitiesDetectionJobResult`	`stopEntitiesDetectionJob(StopEntitiesDetectionJobRequest request)` Stops an entities detection job in progress.
`StopKeyPhrasesDetectionJobResult`	`stopKeyPhrasesDetectionJob(StopKeyPhrasesDetectionJobRequest request)` Stops a key phrases detection job in progress.
`StopSentimentDetectionJobResult`	`stopSentimentDetectionJob(StopSentimentDetectionJobRequest request)` Stops a sentiment detection job in progress.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

- Method Detail
  - builder
```
public static AmazonComprehendClientBuilder builder()
```
  - batchDetectDominantLanguage
```
public BatchDetectDominantLanguageResult batchDetectDominantLanguage(BatchDetectDominantLanguageRequest request)
```
    Determines the dominant language of the input text for a batch of documents. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.
    
    Specified by:
    
    batchDetectDominantLanguage in interface AmazonComprehend
    
    Parameters:
    
    batchDetectDominantLanguageRequest -
    
    Returns:
    
    Result of the BatchDetectDominantLanguage operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The request is invalid.
    
    TextSizeLimitExceededException - The size of the input text exceeds the limit. Use a smaller document.
    
    BatchSizeLimitExceededException - The number of documents in the request exceeds the limit of 25. Try your request again with fewer documents.
    
    InternalServerException - An internal server error occurred. Retry your request.
    
    See Also:
    
    AWS API Documentation
  - batchDetectEntities
```
public BatchDetectEntitiesResult batchDetectEntities(BatchDetectEntitiesRequest request)
```
    Inspects the text of a batch of documents for named entities and returns information about them. For more information about named entities, see how-entities
    
    Specified by:
    
    batchDetectEntities in interface AmazonComprehend
    
    Parameters:
    
    batchDetectEntitiesRequest -
    
    Returns:
    
    Result of the BatchDetectEntities operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The request is invalid.
    
    TextSizeLimitExceededException - The size of the input text exceeds the limit. Use a smaller document.
    
    UnsupportedLanguageException - Amazon Comprehend can't process the language of the input text. For all APIs except DetectDominantLanguage, Amazon Comprehend accepts only English or Spanish text. For the DetectDominantLanguage API, Amazon Comprehend detects 100 languages. For a list of languages, see how-languages
    
    BatchSizeLimitExceededException - The number of documents in the request exceeds the limit of 25. Try your request again with fewer documents.
    
    InternalServerException - An internal server error occurred. Retry your request.
    
    See Also:
    
    AWS API Documentation
  - batchDetectKeyPhrases
```
public BatchDetectKeyPhrasesResult batchDetectKeyPhrases(BatchDetectKeyPhrasesRequest request)
```
    Detects the key noun phrases found in a batch of documents.
    
    Specified by:
    
    batchDetectKeyPhrases in interface AmazonComprehend
    
    Parameters:
    
    batchDetectKeyPhrasesRequest -
    
    Returns:
    
    Result of the BatchDetectKeyPhrases operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The request is invalid.
    
    TextSizeLimitExceededException - The size of the input text exceeds the limit. Use a smaller document.
    
    UnsupportedLanguageException - Amazon Comprehend can't process the language of the input text. For all APIs except DetectDominantLanguage, Amazon Comprehend accepts only English or Spanish text. For the DetectDominantLanguage API, Amazon Comprehend detects 100 languages. For a list of languages, see how-languages
    
    BatchSizeLimitExceededException - The number of documents in the request exceeds the limit of 25. Try your request again with fewer documents.
    
    InternalServerException - An internal server error occurred. Retry your request.
    
    See Also:
    
    AWS API Documentation
  - batchDetectSentiment
```
public BatchDetectSentimentResult batchDetectSentiment(BatchDetectSentimentRequest request)
```
    Inspects a batch of documents and returns an inference of the prevailing sentiment, POSITIVE, NEUTRAL, MIXED, or NEGATIVE, in each one.
    
    Specified by:
    
    batchDetectSentiment in interface AmazonComprehend
    
    Parameters:
    
    batchDetectSentimentRequest -
    
    Returns:
    
    Result of the BatchDetectSentiment operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The request is invalid.
    
    TextSizeLimitExceededException - The size of the input text exceeds the limit. Use a smaller document.
    
    UnsupportedLanguageException - Amazon Comprehend can't process the language of the input text. For all APIs except DetectDominantLanguage, Amazon Comprehend accepts only English or Spanish text. For the DetectDominantLanguage API, Amazon Comprehend detects 100 languages. For a list of languages, see how-languages
    
    BatchSizeLimitExceededException - The number of documents in the request exceeds the limit of 25. Try your request again with fewer documents.
    
    InternalServerException - An internal server error occurred. Retry your request.
    
    See Also:
    
    AWS API Documentation
  - describeDominantLanguageDetectionJob
```
public DescribeDominantLanguageDetectionJobResult describeDominantLanguageDetectionJob(DescribeDominantLanguageDetectionJobRequest request)
```
    Gets the properties associated with a dominant language detection job. Use this operation to get the status of a detection job.
    
    Specified by:
    
    describeDominantLanguageDetectionJob in interface AmazonComprehend
    
    Parameters:
    
    describeDominantLanguageDetectionJobRequest -
    
    Returns:
    
    Result of the DescribeDominantLanguageDetectionJob operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The request is invalid.
    
    JobNotFoundException - The specified job was not found. Check the job ID and try again.
    
    TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.
    
    InternalServerException - An internal server error occurred. Retry your request.
    
    See Also:
    
    AWS API Documentation
  - describeEntitiesDetectionJob
```
public DescribeEntitiesDetectionJobResult describeEntitiesDetectionJob(DescribeEntitiesDetectionJobRequest request)
```
    Gets the properties associated with an entities detection job. Use this operation to get the status of a detection job.
    
    Specified by:
    
    describeEntitiesDetectionJob in interface AmazonComprehend
    
    Parameters:
    
    describeEntitiesDetectionJobRequest -
    
    Returns:
    
    Result of the DescribeEntitiesDetectionJob operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The request is invalid.
    
    JobNotFoundException - The specified job was not found. Check the job ID and try again.
    
    TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.
    
    InternalServerException - An internal server error occurred. Retry your request.
    
    See Also:
    
    AWS API Documentation
  - describeKeyPhrasesDetectionJob
```
public DescribeKeyPhrasesDetectionJobResult describeKeyPhrasesDetectionJob(DescribeKeyPhrasesDetectionJobRequest request)
```
    Gets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job.
    
    Specified by:
    
    describeKeyPhrasesDetectionJob in interface AmazonComprehend
    
    Parameters:
    
    describeKeyPhrasesDetectionJobRequest -
    
    Returns:
    
    Result of the DescribeKeyPhrasesDetectionJob operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The request is invalid.
    
    JobNotFoundException - The specified job was not found. Check the job ID and try again.
    
    TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.
    
    InternalServerException - An internal server error occurred. Retry your request.
    
    See Also:
    
    AWS API Documentation
  - describeSentimentDetectionJob
```
public DescribeSentimentDetectionJobResult describeSentimentDetectionJob(DescribeSentimentDetectionJobRequest request)
```
    Gets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job.
    
    Specified by:
    
    describeSentimentDetectionJob in interface AmazonComprehend
    
    Parameters:
    
    describeSentimentDetectionJobRequest -
    
    Returns:
    
    Result of the DescribeSentimentDetectionJob operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The request is invalid.
    
    JobNotFoundException - The specified job was not found. Check the job ID and try again.
    
    TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.
    
    InternalServerException - An internal server error occurred. Retry your request.
    
    See Also:
    
    AWS API Documentation
  - describeTopicsDetectionJob
```
public DescribeTopicsDetectionJobResult describeTopicsDetectionJob(DescribeTopicsDetectionJobRequest request)
```
    Gets the properties associated with a topic detection job. Use this operation to get the status of a detection job.
    
    Specified by:
    
    describeTopicsDetectionJob in interface AmazonComprehend
    
    Parameters:
    
    describeTopicsDetectionJobRequest -
    
    Returns:
    
    Result of the DescribeTopicsDetectionJob operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The request is invalid.
    
    JobNotFoundException - The specified job was not found. Check the job ID and try again.
    
    TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.
    
    InternalServerException - An internal server error occurred. Retry your request.
    
    See Also:
    
    AWS API Documentation
  - detectDominantLanguage
```
public DetectDominantLanguageResult detectDominantLanguage(DetectDominantLanguageRequest request)
```
    Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.
    
    Specified by:
    
    detectDominantLanguage in interface AmazonComprehend
    
    Parameters:
    
    detectDominantLanguageRequest -
    
    Returns:
    
    Result of the DetectDominantLanguage operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The request is invalid.
    
    TextSizeLimitExceededException - The size of the input text exceeds the limit. Use a smaller document.
    
    InternalServerException - An internal server error occurred. Retry your request.
    
    See Also:
    
    AWS API Documentation
  - detectEntities
```
public DetectEntitiesResult detectEntities(DetectEntitiesRequest request)
```
    Inspects text for named entities, and returns information about them. For more information, about named entities, see how-entities.
    
    Specified by:
    
    detectEntities in interface AmazonComprehend
    
    Parameters:
    
    detectEntitiesRequest -
    
    Returns:
    
    Result of the DetectEntities operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The request is invalid.
    
    TextSizeLimitExceededException - The size of the input text exceeds the limit. Use a smaller document.
    
    UnsupportedLanguageException - Amazon Comprehend can't process the language of the input text. For all APIs except DetectDominantLanguage, Amazon Comprehend accepts only English or Spanish text. For the DetectDominantLanguage API, Amazon Comprehend detects 100 languages. For a list of languages, see how-languages
    
    InternalServerException - An internal server error occurred. Retry your request.
    
    See Also:
    
    AWS API Documentation
  - detectKeyPhrases
```
public DetectKeyPhrasesResult detectKeyPhrases(DetectKeyPhrasesRequest request)
```
    Detects the key noun phrases found in the text.
    
    Specified by:
    
    detectKeyPhrases in interface AmazonComprehend
    
    Parameters:
    
    detectKeyPhrasesRequest -
    
    Returns:
    
    Result of the DetectKeyPhrases operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The request is invalid.
    
    TextSizeLimitExceededException - The size of the input text exceeds the limit. Use a smaller document.
    
    UnsupportedLanguageException - Amazon Comprehend can't process the language of the input text. For all APIs except DetectDominantLanguage, Amazon Comprehend accepts only English or Spanish text. For the DetectDominantLanguage API, Amazon Comprehend detects 100 languages. For a list of languages, see how-languages
    
    InternalServerException - An internal server error occurred. Retry your request.
    
    See Also:
    
    AWS API Documentation
  - detectSentiment
```
public DetectSentimentResult detectSentiment(DetectSentimentRequest request)
```
    Inspects text and returns an inference of the prevailing sentiment (POSITIVE, NEUTRAL, MIXED, or NEGATIVE).
    
    Specified by:
    
    detectSentiment in interface AmazonComprehend
    
    Parameters:
    
    detectSentimentRequest -
    
    Returns:
    
    Result of the DetectSentiment operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The request is invalid.
    
    TextSizeLimitExceededException - The size of the input text exceeds the limit. Use a smaller document.
    
    UnsupportedLanguageException - Amazon Comprehend can't process the language of the input text. For all APIs except DetectDominantLanguage, Amazon Comprehend accepts only English or Spanish text. For the DetectDominantLanguage API, Amazon Comprehend detects 100 languages. For a list of languages, see how-languages
    
    InternalServerException - An internal server error occurred. Retry your request.
    
    See Also:
    
    AWS API Documentation
  - listDominantLanguageDetectionJobs
```
public ListDominantLanguageDetectionJobsResult listDominantLanguageDetectionJobs(ListDominantLanguageDetectionJobsRequest request)
```
    Gets a list of the dominant language detection jobs that you have submitted.
    
    Specified by:
    
    listDominantLanguageDetectionJobs in interface AmazonComprehend
    
    Parameters:
    
    listDominantLanguageDetectionJobsRequest -
    
    Returns:
    
    Result of the ListDominantLanguageDetectionJobs operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The request is invalid.
    
    TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.
    
    InvalidFilterException - The filter specified for the ListTopicDetectionJobs operation is invalid. Specify a different filter.
    
    InternalServerException - An internal server error occurred. Retry your request.
    
    See Also:
    
    AWS API Documentation
  - listEntitiesDetectionJobs
```
public ListEntitiesDetectionJobsResult listEntitiesDetectionJobs(ListEntitiesDetectionJobsRequest request)
```
    Gets a list of the entity detection jobs that you have submitted.
    
    Specified by:
    
    listEntitiesDetectionJobs in interface AmazonComprehend
    
    Parameters:
    
    listEntitiesDetectionJobsRequest -
    
    Returns:
    
    Result of the ListEntitiesDetectionJobs operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The request is invalid.
    
    TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.
    
    InvalidFilterException - The filter specified for the ListTopicDetectionJobs operation is invalid. Specify a different filter.
    
    InternalServerException - An internal server error occurred. Retry your request.
    
    See Also:
    
    AWS API Documentation
  - listKeyPhrasesDetectionJobs
```
public ListKeyPhrasesDetectionJobsResult listKeyPhrasesDetectionJobs(ListKeyPhrasesDetectionJobsRequest request)
```
    Get a list of key phrase detection jobs that you have submitted.
    
    Specified by:
    
    listKeyPhrasesDetectionJobs in interface AmazonComprehend
    
    Parameters:
    
    listKeyPhrasesDetectionJobsRequest -
    
    Returns:
    
    Result of the ListKeyPhrasesDetectionJobs operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The request is invalid.
    
    TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.
    
    InvalidFilterException - The filter specified for the ListTopicDetectionJobs operation is invalid. Specify a different filter.
    
    InternalServerException - An internal server error occurred. Retry your request.
    
    See Also:
    
    AWS API Documentation
  - listSentimentDetectionJobs
```
public ListSentimentDetectionJobsResult listSentimentDetectionJobs(ListSentimentDetectionJobsRequest request)
```
    Gets a list of sentiment detection jobs that you have submitted.
    
    Specified by:
    
    listSentimentDetectionJobs in interface AmazonComprehend
    
    Parameters:
    
    listSentimentDetectionJobsRequest -
    
    Returns:
    
    Result of the ListSentimentDetectionJobs operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The request is invalid.
    
    TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.
    
    InvalidFilterException - The filter specified for the ListTopicDetectionJobs operation is invalid. Specify a different filter.
    
    InternalServerException - An internal server error occurred. Retry your request.
    
    See Also:
    
    AWS API Documentation
  - listTopicsDetectionJobs
```
public ListTopicsDetectionJobsResult listTopicsDetectionJobs(ListTopicsDetectionJobsRequest request)
```
    Gets a list of the topic detection jobs that you have submitted.
    
    Specified by:
    
    listTopicsDetectionJobs in interface AmazonComprehend
    
    Parameters:
    
    listTopicsDetectionJobsRequest -
    
    Returns:
    
    Result of the ListTopicsDetectionJobs operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The request is invalid.
    
    TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.
    
    InvalidFilterException - The filter specified for the ListTopicDetectionJobs operation is invalid. Specify a different filter.
    
    InternalServerException - An internal server error occurred. Retry your request.
    
    See Also:
    
    AWS API Documentation
  - startDominantLanguageDetectionJob
```
public StartDominantLanguageDetectionJobResult startDominantLanguageDetectionJob(StartDominantLanguageDetectionJobRequest request)
```
    Starts an asynchronous dominant language detection job for a collection of documents. Use the operation to track the status of a job.
    
    Specified by:
    
    startDominantLanguageDetectionJob in interface AmazonComprehend
    
    Parameters:
    
    startDominantLanguageDetectionJobRequest -
    
    Returns:
    
    Result of the StartDominantLanguageDetectionJob operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The request is invalid.
    
    TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.
    
    InternalServerException - An internal server error occurred. Retry your request.
    
    See Also:
    
    AWS API Documentation
  - startEntitiesDetectionJob
```
public StartEntitiesDetectionJobResult startEntitiesDetectionJob(StartEntitiesDetectionJobRequest request)
```
    Starts an asynchronous entity detection job for a collection of documents. Use the operation to track the status of a job.
    
    Specified by:
    
    startEntitiesDetectionJob in interface AmazonComprehend
    
    Parameters:
    
    startEntitiesDetectionJobRequest -
    
    Returns:
    
    Result of the StartEntitiesDetectionJob operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The request is invalid.
    
    TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.
    
    InternalServerException - An internal server error occurred. Retry your request.
    
    See Also:
    
    AWS API Documentation
  - startKeyPhrasesDetectionJob
```
public StartKeyPhrasesDetectionJobResult startKeyPhrasesDetectionJob(StartKeyPhrasesDetectionJobRequest request)
```
    Starts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the status of a job.
    
    Specified by:
    
    startKeyPhrasesDetectionJob in interface AmazonComprehend
    
    Parameters:
    
    startKeyPhrasesDetectionJobRequest -
    
    Returns:
    
    Result of the StartKeyPhrasesDetectionJob operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The request is invalid.
    
    TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.
    
    InternalServerException - An internal server error occurred. Retry your request.
    
    See Also:
    
    AWS API Documentation
  - startSentimentDetectionJob
```
public StartSentimentDetectionJobResult startSentimentDetectionJob(StartSentimentDetectionJobRequest request)
```
    Starts an asynchronous sentiment detection job for a collection of documents. use the operation to track the status of a job.
    
    Specified by:
    
    startSentimentDetectionJob in interface AmazonComprehend
    
    Parameters:
    
    startSentimentDetectionJobRequest -
    
    Returns:
    
    Result of the StartSentimentDetectionJob operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The request is invalid.
    
    TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.
    
    InternalServerException - An internal server error occurred. Retry your request.
    
    See Also:
    
    AWS API Documentation
  - startTopicsDetectionJob
```
public StartTopicsDetectionJobResult startTopicsDetectionJob(StartTopicsDetectionJobRequest request)
```
    Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob operation to track the status of a job.
    
    Specified by:
    
    startTopicsDetectionJob in interface AmazonComprehend
    
    Parameters:
    
    startTopicsDetectionJobRequest -
    
    Returns:
    
    Result of the StartTopicsDetectionJob operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The request is invalid.
    
    TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.
    
    InternalServerException - An internal server error occurred. Retry your request.
    
    See Also:
    
    AWS API Documentation
  - stopDominantLanguageDetectionJob
```
public StopDominantLanguageDetectionJobResult stopDominantLanguageDetectionJob(StopDominantLanguageDetectionJobRequest request)
```
    Stops a dominant language detection job in progress.
    
    If the job state is IN_PROGRESS the job will be marked for termination and put into the STOPPING state.
    
    If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation will return a 400 Internal Request Exception.
    
    When a job is stopped, any document that has already been processed will be written to the output location.
    
    Specified by:
    
    stopDominantLanguageDetectionJob in interface AmazonComprehend
    
    Parameters:
    
    stopDominantLanguageDetectionJobRequest -
    
    Returns:
    
    Result of the StopDominantLanguageDetectionJob operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The request is invalid.
    
    JobNotFoundException - The specified job was not found. Check the job ID and try again.
    
    InternalServerException - An internal server error occurred. Retry your request.
    
    See Also:
    
    AWS API Documentation
  - stopEntitiesDetectionJob
```
public StopEntitiesDetectionJobResult stopEntitiesDetectionJob(StopEntitiesDetectionJobRequest request)
```
    Stops an entities detection job in progress.
    
    If the job state is IN_PROGRESS the job will be marked for termination and put into the STOPPING state.
    
    If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation will return a 400 Internal Request Exception.
    
    When a job is stopped, any document that has already been processed will be written to the output location.
    
    Specified by:
    
    stopEntitiesDetectionJob in interface AmazonComprehend
    
    Parameters:
    
    stopEntitiesDetectionJobRequest -
    
    Returns:
    
    Result of the StopEntitiesDetectionJob operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The request is invalid.
    
    JobNotFoundException - The specified job was not found. Check the job ID and try again.
    
    InternalServerException - An internal server error occurred. Retry your request.
    
    See Also:
    
    AWS API Documentation
  - stopKeyPhrasesDetectionJob
```
public StopKeyPhrasesDetectionJobResult stopKeyPhrasesDetectionJob(StopKeyPhrasesDetectionJobRequest request)
```
    Stops a key phrases detection job in progress.
    
    If the job state is IN_PROGRESS the job will be marked for termination and put into the STOPPING state.
    
    If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation will return a 400 Internal Request Exception.
    
    When a job is stopped, any document that has already been processed will be written to the output location.
    
    Specified by:
    
    stopKeyPhrasesDetectionJob in interface AmazonComprehend
    
    Parameters:
    
    stopKeyPhrasesDetectionJobRequest -
    
    Returns:
    
    Result of the StopKeyPhrasesDetectionJob operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The request is invalid.
    
    JobNotFoundException - The specified job was not found. Check the job ID and try again.
    
    InternalServerException - An internal server error occurred. Retry your request.
    
    See Also:
    
    AWS API Documentation
  - stopSentimentDetectionJob
```
public StopSentimentDetectionJobResult stopSentimentDetectionJob(StopSentimentDetectionJobRequest request)
```
    Stops a sentiment detection job in progress.
    
    If the job state is IN_PROGRESS the job will be marked for termination and put into the STOPPING state.
    
    If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation will return a 400 Internal Request Exception.
    
    When a job is stopped, any document that has already been processed will be written to the output location.
    
    Specified by:
    
    stopSentimentDetectionJob in interface AmazonComprehend
    
    Parameters:
    
    stopSentimentDetectionJobRequest -
    
    Returns:
    
    Result of the StopSentimentDetectionJob operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The request is invalid.
    
    JobNotFoundException - The specified job was not found. Check the job ID and try again.
    
    InternalServerException - An internal server error occurred. Retry your request.
    
    See Also:
    
    AWS API Documentation
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonComprehend
    
    Parameters:
    
    request - The originally executed request
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Class AmazonComprehendClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

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

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

Method Detail

builder

batchDetectDominantLanguage

batchDetectEntities

batchDetectKeyPhrases

batchDetectSentiment

describeDominantLanguageDetectionJob

describeEntitiesDetectionJob

describeKeyPhrasesDetectionJob

describeSentimentDetectionJob

describeTopicsDetectionJob

detectDominantLanguage

detectEntities

detectKeyPhrases

detectSentiment

listDominantLanguageDetectionJobs

listEntitiesDetectionJobs

listKeyPhrasesDetectionJobs

listSentimentDetectionJobs

listTopicsDetectionJobs

startDominantLanguageDetectionJob

startEntitiesDetectionJob

startKeyPhrasesDetectionJob

startSentimentDetectionJob

startTopicsDetectionJob

stopDominantLanguageDetectionJob

stopEntitiesDetectionJob

stopKeyPhrasesDetectionJob

stopSentimentDetectionJob

getCachedResponseMetadata