AmazonComprehend (AWS SDK for Java

All Known Subinterfaces:

AmazonComprehendAsync

All Known Implementing Classes:

AbstractAmazonComprehend, AbstractAmazonComprehendAsync, AmazonComprehendAsyncClient, AmazonComprehendClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonComprehend
```
Interface for accessing Amazon Comprehend.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonComprehend instead.

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
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract 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.
`DescribeDominantLanguageDetectionJobResult`	`describeDominantLanguageDetectionJob(DescribeDominantLanguageDetectionJobRequest describeDominantLanguageDetectionJobRequest)` Gets the properties associated with a dominant language detection job.
`DescribeEntitiesDetectionJobResult`	`describeEntitiesDetectionJob(DescribeEntitiesDetectionJobRequest describeEntitiesDetectionJobRequest)` Gets the properties associated with an entities detection job.
`DescribeKeyPhrasesDetectionJobResult`	`describeKeyPhrasesDetectionJob(DescribeKeyPhrasesDetectionJobRequest describeKeyPhrasesDetectionJobRequest)` Gets the properties associated with a key phrases 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.
`DetectSentimentResult`	`detectSentiment(DetectSentimentRequest detectSentimentRequest)` 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 listDominantLanguageDetectionJobsRequest)` Gets a list of the dominant language detection jobs that you have submitted.
`ListEntitiesDetectionJobsResult`	`listEntitiesDetectionJobs(ListEntitiesDetectionJobsRequest listEntitiesDetectionJobsRequest)` Gets a list of the entity detection jobs that you have submitted.
`ListKeyPhrasesDetectionJobsResult`	`listKeyPhrasesDetectionJobs(ListKeyPhrasesDetectionJobsRequest listKeyPhrasesDetectionJobsRequest)` Get a list of key phrase detection jobs that you have submitted.
`ListSentimentDetectionJobsResult`	`listSentimentDetectionJobs(ListSentimentDetectionJobsRequest listSentimentDetectionJobsRequest)` Gets a list of sentiment detection jobs that you have submitted.
`ListTopicsDetectionJobsResult`	`listTopicsDetectionJobs(ListTopicsDetectionJobsRequest listTopicsDetectionJobsRequest)` Gets a list of the topic detection jobs that you have submitted.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`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.
`StartKeyPhrasesDetectionJobResult`	`startKeyPhrasesDetectionJob(StartKeyPhrasesDetectionJobRequest startKeyPhrasesDetectionJobRequest)` Starts an asynchronous key phrase 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.
`StopKeyPhrasesDetectionJobResult`	`stopKeyPhrasesDetectionJob(StopKeyPhrasesDetectionJobRequest stopKeyPhrasesDetectionJobRequest)` Stops a key phrases detection job in progress.
`StopSentimentDetectionJobResult`	`stopSentimentDetectionJob(StopSentimentDetectionJobRequest stopSentimentDetectionJobRequest)` Stops a sentiment detection job in progress.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - batchDetectDominantLanguage
```
BatchDetectDominantLanguageResult batchDetectDominantLanguage(BatchDetectDominantLanguageRequest batchDetectDominantLanguageRequest)
```
    Determines the dominant language of the input text for a batch of documents. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.
    
    Parameters:
    
    batchDetectDominantLanguageRequest -
    
    Returns:
    
    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
```
BatchDetectEntitiesResult batchDetectEntities(BatchDetectEntitiesRequest batchDetectEntitiesRequest)
```
    Inspects the text of a batch of documents for named entities and returns information about them. For more information about named entities, see how-entities
    
    Parameters:
    
    batchDetectEntitiesRequest -
    
    Returns:
    
    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
```
BatchDetectKeyPhrasesResult batchDetectKeyPhrases(BatchDetectKeyPhrasesRequest batchDetectKeyPhrasesRequest)
```
    Detects the key noun phrases found in a batch of documents.
    
    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
```
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.
    
    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
```
DescribeDominantLanguageDetectionJobResult describeDominantLanguageDetectionJob(DescribeDominantLanguageDetectionJobRequest describeDominantLanguageDetectionJobRequest)
```
    Gets the properties associated with a dominant language detection job. Use this operation to get the status of a detection job.
    
    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
```
DescribeEntitiesDetectionJobResult describeEntitiesDetectionJob(DescribeEntitiesDetectionJobRequest describeEntitiesDetectionJobRequest)
```
    Gets the properties associated with an entities detection job. Use this operation to get the status of a detection job.
    
    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
```
DescribeKeyPhrasesDetectionJobResult describeKeyPhrasesDetectionJob(DescribeKeyPhrasesDetectionJobRequest describeKeyPhrasesDetectionJobRequest)
```
    Gets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job.
    
    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
```
DescribeSentimentDetectionJobResult describeSentimentDetectionJob(DescribeSentimentDetectionJobRequest describeSentimentDetectionJobRequest)
```
    Gets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job.
    
    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
```
DescribeTopicsDetectionJobResult describeTopicsDetectionJob(DescribeTopicsDetectionJobRequest describeTopicsDetectionJobRequest)
```
    Gets the properties associated with a topic detection job. Use this operation to get the status of a detection job.
    
    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
```
DetectDominantLanguageResult detectDominantLanguage(DetectDominantLanguageRequest detectDominantLanguageRequest)
```
    Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.
    
    Parameters:
    
    detectDominantLanguageRequest -
    
    Returns:
    
    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
```
DetectEntitiesResult detectEntities(DetectEntitiesRequest detectEntitiesRequest)
```
    Inspects text for named entities, and returns information about them. For more information, about named entities, see how-entities.
    
    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
```
DetectKeyPhrasesResult detectKeyPhrases(DetectKeyPhrasesRequest detectKeyPhrasesRequest)
```
    Detects the key noun phrases found in the text.
    
    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
```
DetectSentimentResult detectSentiment(DetectSentimentRequest detectSentimentRequest)
```
    Inspects text and returns an inference of the prevailing sentiment (POSITIVE, NEUTRAL, MIXED, or NEGATIVE).
    
    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
```
ListDominantLanguageDetectionJobsResult listDominantLanguageDetectionJobs(ListDominantLanguageDetectionJobsRequest listDominantLanguageDetectionJobsRequest)
```
    Gets a list of the dominant language detection jobs that you have submitted.
    
    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
```
ListEntitiesDetectionJobsResult listEntitiesDetectionJobs(ListEntitiesDetectionJobsRequest listEntitiesDetectionJobsRequest)
```
    Gets a list of the entity detection jobs that you have submitted.
    
    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
```
ListKeyPhrasesDetectionJobsResult listKeyPhrasesDetectionJobs(ListKeyPhrasesDetectionJobsRequest listKeyPhrasesDetectionJobsRequest)
```
    Get a list of key phrase detection jobs that you have submitted.
    
    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
```
ListSentimentDetectionJobsResult listSentimentDetectionJobs(ListSentimentDetectionJobsRequest listSentimentDetectionJobsRequest)
```
    Gets a list of sentiment detection jobs that you have submitted.
    
    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
```
ListTopicsDetectionJobsResult listTopicsDetectionJobs(ListTopicsDetectionJobsRequest listTopicsDetectionJobsRequest)
```
    Gets a list of the topic detection jobs that you have submitted.
    
    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
```
StartDominantLanguageDetectionJobResult startDominantLanguageDetectionJob(StartDominantLanguageDetectionJobRequest startDominantLanguageDetectionJobRequest)
```
    Starts an asynchronous dominant language detection job for a collection of documents. Use the operation to track the status of a job.
    
    Parameters:
    
    startDominantLanguageDetectionJobRequest -
    
    Returns:
    
    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
```
StartEntitiesDetectionJobResult startEntitiesDetectionJob(StartEntitiesDetectionJobRequest startEntitiesDetectionJobRequest)
```
    Starts an asynchronous entity detection job for a collection of documents. Use the operation to track the status of a job.
    
    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
```
StartKeyPhrasesDetectionJobResult startKeyPhrasesDetectionJob(StartKeyPhrasesDetectionJobRequest startKeyPhrasesDetectionJobRequest)
```
    Starts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the status of a job.
    
    Parameters:
    
    startKeyPhrasesDetectionJobRequest -
    
    Returns:
    
    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
```
StartSentimentDetectionJobResult startSentimentDetectionJob(StartSentimentDetectionJobRequest startSentimentDetectionJobRequest)
```
    Starts an asynchronous sentiment detection job for a collection of documents. use the operation to track the status of a job.
    
    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
```
StartTopicsDetectionJobResult startTopicsDetectionJob(StartTopicsDetectionJobRequest startTopicsDetectionJobRequest)
```
    Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob operation to track the status of a job.
    
    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
```
StopDominantLanguageDetectionJobResult stopDominantLanguageDetectionJob(StopDominantLanguageDetectionJobRequest stopDominantLanguageDetectionJobRequest)
```
    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.
    
    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
```
StopEntitiesDetectionJobResult stopEntitiesDetectionJob(StopEntitiesDetectionJobRequest stopEntitiesDetectionJobRequest)
```
    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.
    
    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
```
StopKeyPhrasesDetectionJobResult stopKeyPhrasesDetectionJob(StopKeyPhrasesDetectionJobRequest stopKeyPhrasesDetectionJobRequest)
```
    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.
    
    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
```
StopSentimentDetectionJobResult stopSentimentDetectionJob(StopSentimentDetectionJobRequest stopSentimentDetectionJobRequest)
```
    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.
    
    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
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Interface AmazonComprehend

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

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

shutdown

getCachedResponseMetadata