@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonComprehendClient extends AmazonWebServiceClient implements AmazonComprehend
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.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
BatchDetectDominantLanguageResult |
batchDetectDominantLanguage(BatchDetectDominantLanguageRequest request)
Determines the dominant language of the input text for a batch of documents.
|
BatchDetectEntitiesResult |
batchDetectEntities(BatchDetectEntitiesRequest request)
Inspects the text of a batch of documents for named entities and returns information about them.
|
BatchDetectKeyPhrasesResult |
batchDetectKeyPhrases(BatchDetectKeyPhrasesRequest request)
Detects the key noun phrases found in a batch of documents.
|
BatchDetectSentimentResult |
batchDetectSentiment(BatchDetectSentimentRequest request)
Inspects a batch of documents and returns an inference of the prevailing sentiment,
POSITIVE ,
NEUTRAL , MIXED , or NEGATIVE , in each one. |
BatchDetectSyntaxResult |
batchDetectSyntax(BatchDetectSyntaxRequest request)
Inspects the text of a batch of documents for the syntax and part of speech of the words in the document and
returns information about them.
|
static AmazonComprehendClientBuilder |
builder() |
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 ). |
DetectSyntaxResult |
detectSyntax(DetectSyntaxRequest request)
Inspects text for syntax and the part of speech of words in the document.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
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.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
shutdown
public static AmazonComprehendClientBuilder builder()
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.
batchDetectDominantLanguage
in interface AmazonComprehend
batchDetectDominantLanguageRequest
- 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.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
batchDetectEntities
in interface AmazonComprehend
batchDetectEntitiesRequest
- 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-languagesBatchSizeLimitExceededException
- 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.public BatchDetectKeyPhrasesResult batchDetectKeyPhrases(BatchDetectKeyPhrasesRequest request)
Detects the key noun phrases found in a batch of documents.
batchDetectKeyPhrases
in interface AmazonComprehend
batchDetectKeyPhrasesRequest
- 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-languagesBatchSizeLimitExceededException
- 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.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.
batchDetectSentiment
in interface AmazonComprehend
batchDetectSentimentRequest
- 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-languagesBatchSizeLimitExceededException
- 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.public BatchDetectSyntaxResult batchDetectSyntax(BatchDetectSyntaxRequest request)
Inspects the text of a batch of documents for the syntax and part of speech of the words in the document and returns information about them. For more information, see how-syntax.
batchDetectSyntax
in interface AmazonComprehend
batchDetectSyntaxRequest
- 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-languagesBatchSizeLimitExceededException
- 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.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.
describeDominantLanguageDetectionJob
in interface AmazonComprehend
describeDominantLanguageDetectionJobRequest
- 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.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.
describeEntitiesDetectionJob
in interface AmazonComprehend
describeEntitiesDetectionJobRequest
- 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.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.
describeKeyPhrasesDetectionJob
in interface AmazonComprehend
describeKeyPhrasesDetectionJobRequest
- 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.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.
describeSentimentDetectionJob
in interface AmazonComprehend
describeSentimentDetectionJobRequest
- 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.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.
describeTopicsDetectionJob
in interface AmazonComprehend
describeTopicsDetectionJobRequest
- 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.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.
detectDominantLanguage
in interface AmazonComprehend
detectDominantLanguageRequest
- 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.public DetectEntitiesResult detectEntities(DetectEntitiesRequest request)
Inspects text for named entities, and returns information about them. For more information, about named entities, see how-entities.
detectEntities
in interface AmazonComprehend
detectEntitiesRequest
- 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-languagesInternalServerException
- An internal server error occurred. Retry your request.public DetectKeyPhrasesResult detectKeyPhrases(DetectKeyPhrasesRequest request)
Detects the key noun phrases found in the text.
detectKeyPhrases
in interface AmazonComprehend
detectKeyPhrasesRequest
- 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-languagesInternalServerException
- An internal server error occurred. Retry your request.public DetectSentimentResult detectSentiment(DetectSentimentRequest request)
Inspects text and returns an inference of the prevailing sentiment (POSITIVE
, NEUTRAL
,
MIXED
, or NEGATIVE
).
detectSentiment
in interface AmazonComprehend
detectSentimentRequest
- 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-languagesInternalServerException
- An internal server error occurred. Retry your request.public DetectSyntaxResult detectSyntax(DetectSyntaxRequest request)
Inspects text for syntax and the part of speech of words in the document. For more information, how-syntax.
detectSyntax
in interface AmazonComprehend
detectSyntaxRequest
- 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-languagesInternalServerException
- An internal server error occurred. Retry your request.public ListDominantLanguageDetectionJobsResult listDominantLanguageDetectionJobs(ListDominantLanguageDetectionJobsRequest request)
Gets a list of the dominant language detection jobs that you have submitted.
listDominantLanguageDetectionJobs
in interface AmazonComprehend
listDominantLanguageDetectionJobsRequest
- 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.public ListEntitiesDetectionJobsResult listEntitiesDetectionJobs(ListEntitiesDetectionJobsRequest request)
Gets a list of the entity detection jobs that you have submitted.
listEntitiesDetectionJobs
in interface AmazonComprehend
listEntitiesDetectionJobsRequest
- 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.public ListKeyPhrasesDetectionJobsResult listKeyPhrasesDetectionJobs(ListKeyPhrasesDetectionJobsRequest request)
Get a list of key phrase detection jobs that you have submitted.
listKeyPhrasesDetectionJobs
in interface AmazonComprehend
listKeyPhrasesDetectionJobsRequest
- 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.public ListSentimentDetectionJobsResult listSentimentDetectionJobs(ListSentimentDetectionJobsRequest request)
Gets a list of sentiment detection jobs that you have submitted.
listSentimentDetectionJobs
in interface AmazonComprehend
listSentimentDetectionJobsRequest
- 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.public ListTopicsDetectionJobsResult listTopicsDetectionJobs(ListTopicsDetectionJobsRequest request)
Gets a list of the topic detection jobs that you have submitted.
listTopicsDetectionJobs
in interface AmazonComprehend
listTopicsDetectionJobsRequest
- 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.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.
startDominantLanguageDetectionJob
in interface AmazonComprehend
startDominantLanguageDetectionJobRequest
- 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.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.
startEntitiesDetectionJob
in interface AmazonComprehend
startEntitiesDetectionJobRequest
- 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.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.
startKeyPhrasesDetectionJob
in interface AmazonComprehend
startKeyPhrasesDetectionJobRequest
- 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.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.
startSentimentDetectionJob
in interface AmazonComprehend
startSentimentDetectionJobRequest
- 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.public StartTopicsDetectionJobResult startTopicsDetectionJob(StartTopicsDetectionJobRequest request)
Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob
operation to track the
status of a job.
startTopicsDetectionJob
in interface AmazonComprehend
startTopicsDetectionJobRequest
- 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.public StopDominantLanguageDetectionJobResult stopDominantLanguageDetectionJob(StopDominantLanguageDetectionJobRequest request)
Stops a dominant language detection job in progress.
If the job state is IN_PROGRESS
the job is marked for termination and put into the
STOP_REQUESTED
state. If the job completes before it can be stopped, it is put into the
COMPLETED
state; otherwise the job is stopped and put into the STOPPED
state.
If the job is in the COMPLETED
or FAILED
state when you call the
StopDominantLanguageDetectionJob
operation, the operation returns a 400 Internal Request Exception.
When a job is stopped, any documents already processed are written to the output location.
stopDominantLanguageDetectionJob
in interface AmazonComprehend
stopDominantLanguageDetectionJobRequest
- 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.public StopEntitiesDetectionJobResult stopEntitiesDetectionJob(StopEntitiesDetectionJobRequest request)
Stops an entities detection job in progress.
If the job state is IN_PROGRESS
the job is marked for termination and put into the
STOP_REQUESTED
state. If the job completes before it can be stopped, it is put into the
COMPLETED
state; otherwise the job is stopped and put into the STOPPED
state.
If the job is in the COMPLETED
or FAILED
state when you call the
StopDominantLanguageDetectionJob
operation, the operation returns a 400 Internal Request Exception.
When a job is stopped, any documents already processed are written to the output location.
stopEntitiesDetectionJob
in interface AmazonComprehend
stopEntitiesDetectionJobRequest
- 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.public StopKeyPhrasesDetectionJobResult stopKeyPhrasesDetectionJob(StopKeyPhrasesDetectionJobRequest request)
Stops a key phrases detection job in progress.
If the job state is IN_PROGRESS
the job is marked for termination and put into the
STOP_REQUESTED
state. If the job completes before it can be stopped, it is put into the
COMPLETED
state; otherwise the job is stopped and put into the STOPPED
state.
If the job is in the COMPLETED
or FAILED
state when you call the
StopDominantLanguageDetectionJob
operation, the operation returns a 400 Internal Request Exception.
When a job is stopped, any documents already processed are written to the output location.
stopKeyPhrasesDetectionJob
in interface AmazonComprehend
stopKeyPhrasesDetectionJobRequest
- 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.public StopSentimentDetectionJobResult stopSentimentDetectionJob(StopSentimentDetectionJobRequest request)
Stops a sentiment detection job in progress.
If the job state is IN_PROGRESS
the job is marked for termination and put into the
STOP_REQUESTED
state. If the job completes before it can be stopped, it is put into the
COMPLETED
state; otherwise the job is be stopped and put into the STOPPED
state.
If the job is in the COMPLETED
or FAILED
state when you call the
StopDominantLanguageDetectionJob
operation, the operation returns a 400 Internal Request Exception.
When a job is stopped, any documents already processed are written to the output location.
stopSentimentDetectionJob
in interface AmazonComprehend
stopSentimentDetectionJobRequest
- 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.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
getCachedResponseMetadata
in interface AmazonComprehend
request
- The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.