@Generated(value="software.amazon.awssdk:codegen") public interface ComprehendClient extends SdkClient
builder()
method.
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.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
default BatchDetectDominantLanguageResponse |
batchDetectDominantLanguage(BatchDetectDominantLanguageRequest batchDetectDominantLanguageRequest)
Determines the dominant language of the input text for a batch of documents.
|
default BatchDetectDominantLanguageResponse |
batchDetectDominantLanguage(Consumer<BatchDetectDominantLanguageRequest.Builder> batchDetectDominantLanguageRequest)
Determines the dominant language of the input text for a batch of documents.
|
default BatchDetectEntitiesResponse |
batchDetectEntities(BatchDetectEntitiesRequest batchDetectEntitiesRequest)
Inspects the text of a batch of documents for named entities and returns information about them.
|
default BatchDetectEntitiesResponse |
batchDetectEntities(Consumer<BatchDetectEntitiesRequest.Builder> batchDetectEntitiesRequest)
Inspects the text of a batch of documents for named entities and returns information about them.
|
default BatchDetectKeyPhrasesResponse |
batchDetectKeyPhrases(BatchDetectKeyPhrasesRequest batchDetectKeyPhrasesRequest)
Detects the key noun phrases found in a batch of documents.
|
default BatchDetectKeyPhrasesResponse |
batchDetectKeyPhrases(Consumer<BatchDetectKeyPhrasesRequest.Builder> batchDetectKeyPhrasesRequest)
Detects the key noun phrases found in a batch of documents.
|
default BatchDetectSentimentResponse |
batchDetectSentiment(BatchDetectSentimentRequest batchDetectSentimentRequest)
Inspects a batch of documents and returns an inference of the prevailing sentiment,
POSITIVE ,
NEUTRAL , MIXED , or NEGATIVE , in each one. |
default BatchDetectSentimentResponse |
batchDetectSentiment(Consumer<BatchDetectSentimentRequest.Builder> batchDetectSentimentRequest)
Inspects a batch of documents and returns an inference of the prevailing sentiment,
POSITIVE ,
NEUTRAL , MIXED , or NEGATIVE , in each one. |
default BatchDetectSyntaxResponse |
batchDetectSyntax(BatchDetectSyntaxRequest batchDetectSyntaxRequest)
Inspects the text of a batch of documents for the syntax and part of speech of the words in the document and
returns information about them.
|
default BatchDetectSyntaxResponse |
batchDetectSyntax(Consumer<BatchDetectSyntaxRequest.Builder> batchDetectSyntaxRequest)
Inspects the text of a batch of documents for the syntax and part of speech of the words in the document and
returns information about them.
|
static ComprehendClientBuilder |
builder()
Create a builder that can be used to configure and create a
ComprehendClient . |
static ComprehendClient |
create()
Create a
ComprehendClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CreateDocumentClassifierResponse |
createDocumentClassifier(Consumer<CreateDocumentClassifierRequest.Builder> createDocumentClassifierRequest)
Creates a new document classifier that you can use to categorize documents.
|
default CreateDocumentClassifierResponse |
createDocumentClassifier(CreateDocumentClassifierRequest createDocumentClassifierRequest)
Creates a new document classifier that you can use to categorize documents.
|
default CreateEntityRecognizerResponse |
createEntityRecognizer(Consumer<CreateEntityRecognizerRequest.Builder> createEntityRecognizerRequest)
Creates an entity recognizer using submitted files.
|
default CreateEntityRecognizerResponse |
createEntityRecognizer(CreateEntityRecognizerRequest createEntityRecognizerRequest)
Creates an entity recognizer using submitted files.
|
default DeleteDocumentClassifierResponse |
deleteDocumentClassifier(Consumer<DeleteDocumentClassifierRequest.Builder> deleteDocumentClassifierRequest)
Deletes a previously created document classifier
|
default DeleteDocumentClassifierResponse |
deleteDocumentClassifier(DeleteDocumentClassifierRequest deleteDocumentClassifierRequest)
Deletes a previously created document classifier
|
default DeleteEntityRecognizerResponse |
deleteEntityRecognizer(Consumer<DeleteEntityRecognizerRequest.Builder> deleteEntityRecognizerRequest)
Deletes an entity recognizer.
|
default DeleteEntityRecognizerResponse |
deleteEntityRecognizer(DeleteEntityRecognizerRequest deleteEntityRecognizerRequest)
Deletes an entity recognizer.
|
default DescribeDocumentClassificationJobResponse |
describeDocumentClassificationJob(Consumer<DescribeDocumentClassificationJobRequest.Builder> describeDocumentClassificationJobRequest)
Gets the properties associated with a document classification job.
|
default DescribeDocumentClassificationJobResponse |
describeDocumentClassificationJob(DescribeDocumentClassificationJobRequest describeDocumentClassificationJobRequest)
Gets the properties associated with a document classification job.
|
default DescribeDocumentClassifierResponse |
describeDocumentClassifier(Consumer<DescribeDocumentClassifierRequest.Builder> describeDocumentClassifierRequest)
Gets the properties associated with a document classifier.
|
default DescribeDocumentClassifierResponse |
describeDocumentClassifier(DescribeDocumentClassifierRequest describeDocumentClassifierRequest)
Gets the properties associated with a document classifier.
|
default DescribeDominantLanguageDetectionJobResponse |
describeDominantLanguageDetectionJob(Consumer<DescribeDominantLanguageDetectionJobRequest.Builder> describeDominantLanguageDetectionJobRequest)
Gets the properties associated with a dominant language detection job.
|
default DescribeDominantLanguageDetectionJobResponse |
describeDominantLanguageDetectionJob(DescribeDominantLanguageDetectionJobRequest describeDominantLanguageDetectionJobRequest)
Gets the properties associated with a dominant language detection job.
|
default DescribeEntitiesDetectionJobResponse |
describeEntitiesDetectionJob(Consumer<DescribeEntitiesDetectionJobRequest.Builder> describeEntitiesDetectionJobRequest)
Gets the properties associated with an entities detection job.
|
default DescribeEntitiesDetectionJobResponse |
describeEntitiesDetectionJob(DescribeEntitiesDetectionJobRequest describeEntitiesDetectionJobRequest)
Gets the properties associated with an entities detection job.
|
default DescribeEntityRecognizerResponse |
describeEntityRecognizer(Consumer<DescribeEntityRecognizerRequest.Builder> describeEntityRecognizerRequest)
Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer
metadata, metrics, and so on.
|
default DescribeEntityRecognizerResponse |
describeEntityRecognizer(DescribeEntityRecognizerRequest describeEntityRecognizerRequest)
Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer
metadata, metrics, and so on.
|
default DescribeKeyPhrasesDetectionJobResponse |
describeKeyPhrasesDetectionJob(Consumer<DescribeKeyPhrasesDetectionJobRequest.Builder> describeKeyPhrasesDetectionJobRequest)
Gets the properties associated with a key phrases detection job.
|
default DescribeKeyPhrasesDetectionJobResponse |
describeKeyPhrasesDetectionJob(DescribeKeyPhrasesDetectionJobRequest describeKeyPhrasesDetectionJobRequest)
Gets the properties associated with a key phrases detection job.
|
default DescribeSentimentDetectionJobResponse |
describeSentimentDetectionJob(Consumer<DescribeSentimentDetectionJobRequest.Builder> describeSentimentDetectionJobRequest)
Gets the properties associated with a sentiment detection job.
|
default DescribeSentimentDetectionJobResponse |
describeSentimentDetectionJob(DescribeSentimentDetectionJobRequest describeSentimentDetectionJobRequest)
Gets the properties associated with a sentiment detection job.
|
default DescribeTopicsDetectionJobResponse |
describeTopicsDetectionJob(Consumer<DescribeTopicsDetectionJobRequest.Builder> describeTopicsDetectionJobRequest)
Gets the properties associated with a topic detection job.
|
default DescribeTopicsDetectionJobResponse |
describeTopicsDetectionJob(DescribeTopicsDetectionJobRequest describeTopicsDetectionJobRequest)
Gets the properties associated with a topic detection job.
|
default DetectDominantLanguageResponse |
detectDominantLanguage(Consumer<DetectDominantLanguageRequest.Builder> detectDominantLanguageRequest)
Determines the dominant language of the input text.
|
default DetectDominantLanguageResponse |
detectDominantLanguage(DetectDominantLanguageRequest detectDominantLanguageRequest)
Determines the dominant language of the input text.
|
default DetectEntitiesResponse |
detectEntities(Consumer<DetectEntitiesRequest.Builder> detectEntitiesRequest)
Inspects text for named entities, and returns information about them.
|
default DetectEntitiesResponse |
detectEntities(DetectEntitiesRequest detectEntitiesRequest)
Inspects text for named entities, and returns information about them.
|
default DetectKeyPhrasesResponse |
detectKeyPhrases(Consumer<DetectKeyPhrasesRequest.Builder> detectKeyPhrasesRequest)
Detects the key noun phrases found in the text.
|
default DetectKeyPhrasesResponse |
detectKeyPhrases(DetectKeyPhrasesRequest detectKeyPhrasesRequest)
Detects the key noun phrases found in the text.
|
default DetectSentimentResponse |
detectSentiment(Consumer<DetectSentimentRequest.Builder> detectSentimentRequest)
Inspects text and returns an inference of the prevailing sentiment (
POSITIVE , NEUTRAL ,
MIXED , or NEGATIVE ). |
default DetectSentimentResponse |
detectSentiment(DetectSentimentRequest detectSentimentRequest)
Inspects text and returns an inference of the prevailing sentiment (
POSITIVE , NEUTRAL ,
MIXED , or NEGATIVE ). |
default DetectSyntaxResponse |
detectSyntax(Consumer<DetectSyntaxRequest.Builder> detectSyntaxRequest)
Inspects text for syntax and the part of speech of words in the document.
|
default DetectSyntaxResponse |
detectSyntax(DetectSyntaxRequest detectSyntaxRequest)
Inspects text for syntax and the part of speech of words in the document.
|
default ListDocumentClassificationJobsResponse |
listDocumentClassificationJobs()
Gets a list of the documentation classification jobs that you have submitted.
|
default ListDocumentClassificationJobsResponse |
listDocumentClassificationJobs(Consumer<ListDocumentClassificationJobsRequest.Builder> listDocumentClassificationJobsRequest)
Gets a list of the documentation classification jobs that you have submitted.
|
default ListDocumentClassificationJobsResponse |
listDocumentClassificationJobs(ListDocumentClassificationJobsRequest listDocumentClassificationJobsRequest)
Gets a list of the documentation classification jobs that you have submitted.
|
default ListDocumentClassifiersResponse |
listDocumentClassifiers()
Gets a list of the document classifiers that you have created.
|
default ListDocumentClassifiersResponse |
listDocumentClassifiers(Consumer<ListDocumentClassifiersRequest.Builder> listDocumentClassifiersRequest)
Gets a list of the document classifiers that you have created.
|
default ListDocumentClassifiersResponse |
listDocumentClassifiers(ListDocumentClassifiersRequest listDocumentClassifiersRequest)
Gets a list of the document classifiers that you have created.
|
default ListDominantLanguageDetectionJobsResponse |
listDominantLanguageDetectionJobs()
Gets a list of the dominant language detection jobs that you have submitted.
|
default ListDominantLanguageDetectionJobsResponse |
listDominantLanguageDetectionJobs(Consumer<ListDominantLanguageDetectionJobsRequest.Builder> listDominantLanguageDetectionJobsRequest)
Gets a list of the dominant language detection jobs that you have submitted.
|
default ListDominantLanguageDetectionJobsResponse |
listDominantLanguageDetectionJobs(ListDominantLanguageDetectionJobsRequest listDominantLanguageDetectionJobsRequest)
Gets a list of the dominant language detection jobs that you have submitted.
|
default ListDominantLanguageDetectionJobsIterable |
listDominantLanguageDetectionJobsPaginator()
Gets a list of the dominant language detection jobs that you have submitted.
|
default ListDominantLanguageDetectionJobsIterable |
listDominantLanguageDetectionJobsPaginator(Consumer<ListDominantLanguageDetectionJobsRequest.Builder> listDominantLanguageDetectionJobsRequest)
Gets a list of the dominant language detection jobs that you have submitted.
|
default ListDominantLanguageDetectionJobsIterable |
listDominantLanguageDetectionJobsPaginator(ListDominantLanguageDetectionJobsRequest listDominantLanguageDetectionJobsRequest)
Gets a list of the dominant language detection jobs that you have submitted.
|
default ListEntitiesDetectionJobsResponse |
listEntitiesDetectionJobs()
Gets a list of the entity detection jobs that you have submitted.
|
default ListEntitiesDetectionJobsResponse |
listEntitiesDetectionJobs(Consumer<ListEntitiesDetectionJobsRequest.Builder> listEntitiesDetectionJobsRequest)
Gets a list of the entity detection jobs that you have submitted.
|
default ListEntitiesDetectionJobsResponse |
listEntitiesDetectionJobs(ListEntitiesDetectionJobsRequest listEntitiesDetectionJobsRequest)
Gets a list of the entity detection jobs that you have submitted.
|
default ListEntitiesDetectionJobsIterable |
listEntitiesDetectionJobsPaginator()
Gets a list of the entity detection jobs that you have submitted.
|
default ListEntitiesDetectionJobsIterable |
listEntitiesDetectionJobsPaginator(Consumer<ListEntitiesDetectionJobsRequest.Builder> listEntitiesDetectionJobsRequest)
Gets a list of the entity detection jobs that you have submitted.
|
default ListEntitiesDetectionJobsIterable |
listEntitiesDetectionJobsPaginator(ListEntitiesDetectionJobsRequest listEntitiesDetectionJobsRequest)
Gets a list of the entity detection jobs that you have submitted.
|
default ListEntityRecognizersResponse |
listEntityRecognizers()
Gets a list of the properties of all entity recognizers that you created, including recognizers currently in
training.
|
default ListEntityRecognizersResponse |
listEntityRecognizers(Consumer<ListEntityRecognizersRequest.Builder> listEntityRecognizersRequest)
Gets a list of the properties of all entity recognizers that you created, including recognizers currently in
training.
|
default ListEntityRecognizersResponse |
listEntityRecognizers(ListEntityRecognizersRequest listEntityRecognizersRequest)
Gets a list of the properties of all entity recognizers that you created, including recognizers currently in
training.
|
default ListKeyPhrasesDetectionJobsResponse |
listKeyPhrasesDetectionJobs()
Get a list of key phrase detection jobs that you have submitted.
|
default ListKeyPhrasesDetectionJobsResponse |
listKeyPhrasesDetectionJobs(Consumer<ListKeyPhrasesDetectionJobsRequest.Builder> listKeyPhrasesDetectionJobsRequest)
Get a list of key phrase detection jobs that you have submitted.
|
default ListKeyPhrasesDetectionJobsResponse |
listKeyPhrasesDetectionJobs(ListKeyPhrasesDetectionJobsRequest listKeyPhrasesDetectionJobsRequest)
Get a list of key phrase detection jobs that you have submitted.
|
default ListKeyPhrasesDetectionJobsIterable |
listKeyPhrasesDetectionJobsPaginator()
Get a list of key phrase detection jobs that you have submitted.
|
default ListKeyPhrasesDetectionJobsIterable |
listKeyPhrasesDetectionJobsPaginator(Consumer<ListKeyPhrasesDetectionJobsRequest.Builder> listKeyPhrasesDetectionJobsRequest)
Get a list of key phrase detection jobs that you have submitted.
|
default ListKeyPhrasesDetectionJobsIterable |
listKeyPhrasesDetectionJobsPaginator(ListKeyPhrasesDetectionJobsRequest listKeyPhrasesDetectionJobsRequest)
Get a list of key phrase detection jobs that you have submitted.
|
default ListSentimentDetectionJobsResponse |
listSentimentDetectionJobs()
Gets a list of sentiment detection jobs that you have submitted.
|
default ListSentimentDetectionJobsResponse |
listSentimentDetectionJobs(Consumer<ListSentimentDetectionJobsRequest.Builder> listSentimentDetectionJobsRequest)
Gets a list of sentiment detection jobs that you have submitted.
|
default ListSentimentDetectionJobsResponse |
listSentimentDetectionJobs(ListSentimentDetectionJobsRequest listSentimentDetectionJobsRequest)
Gets a list of sentiment detection jobs that you have submitted.
|
default ListSentimentDetectionJobsIterable |
listSentimentDetectionJobsPaginator()
Gets a list of sentiment detection jobs that you have submitted.
|
default ListSentimentDetectionJobsIterable |
listSentimentDetectionJobsPaginator(Consumer<ListSentimentDetectionJobsRequest.Builder> listSentimentDetectionJobsRequest)
Gets a list of sentiment detection jobs that you have submitted.
|
default ListSentimentDetectionJobsIterable |
listSentimentDetectionJobsPaginator(ListSentimentDetectionJobsRequest listSentimentDetectionJobsRequest)
Gets a list of sentiment detection jobs that you have submitted.
|
default ListTopicsDetectionJobsResponse |
listTopicsDetectionJobs()
Gets a list of the topic detection jobs that you have submitted.
|
default ListTopicsDetectionJobsResponse |
listTopicsDetectionJobs(Consumer<ListTopicsDetectionJobsRequest.Builder> listTopicsDetectionJobsRequest)
Gets a list of the topic detection jobs that you have submitted.
|
default ListTopicsDetectionJobsResponse |
listTopicsDetectionJobs(ListTopicsDetectionJobsRequest listTopicsDetectionJobsRequest)
Gets a list of the topic detection jobs that you have submitted.
|
default ListTopicsDetectionJobsIterable |
listTopicsDetectionJobsPaginator()
Gets a list of the topic detection jobs that you have submitted.
|
default ListTopicsDetectionJobsIterable |
listTopicsDetectionJobsPaginator(Consumer<ListTopicsDetectionJobsRequest.Builder> listTopicsDetectionJobsRequest)
Gets a list of the topic detection jobs that you have submitted.
|
default ListTopicsDetectionJobsIterable |
listTopicsDetectionJobsPaginator(ListTopicsDetectionJobsRequest listTopicsDetectionJobsRequest)
Gets a list of the topic detection jobs that you have submitted.
|
static ServiceMetadata |
serviceMetadata() |
default StartDocumentClassificationJobResponse |
startDocumentClassificationJob(Consumer<StartDocumentClassificationJobRequest.Builder> startDocumentClassificationJobRequest)
Starts an asynchronous document classification job.
|
default StartDocumentClassificationJobResponse |
startDocumentClassificationJob(StartDocumentClassificationJobRequest startDocumentClassificationJobRequest)
Starts an asynchronous document classification job.
|
default StartDominantLanguageDetectionJobResponse |
startDominantLanguageDetectionJob(Consumer<StartDominantLanguageDetectionJobRequest.Builder> startDominantLanguageDetectionJobRequest)
Starts an asynchronous dominant language detection job for a collection of documents.
|
default StartDominantLanguageDetectionJobResponse |
startDominantLanguageDetectionJob(StartDominantLanguageDetectionJobRequest startDominantLanguageDetectionJobRequest)
Starts an asynchronous dominant language detection job for a collection of documents.
|
default StartEntitiesDetectionJobResponse |
startEntitiesDetectionJob(Consumer<StartEntitiesDetectionJobRequest.Builder> startEntitiesDetectionJobRequest)
Starts an asynchronous entity detection job for a collection of documents.
|
default StartEntitiesDetectionJobResponse |
startEntitiesDetectionJob(StartEntitiesDetectionJobRequest startEntitiesDetectionJobRequest)
Starts an asynchronous entity detection job for a collection of documents.
|
default StartKeyPhrasesDetectionJobResponse |
startKeyPhrasesDetectionJob(Consumer<StartKeyPhrasesDetectionJobRequest.Builder> startKeyPhrasesDetectionJobRequest)
Starts an asynchronous key phrase detection job for a collection of documents.
|
default StartKeyPhrasesDetectionJobResponse |
startKeyPhrasesDetectionJob(StartKeyPhrasesDetectionJobRequest startKeyPhrasesDetectionJobRequest)
Starts an asynchronous key phrase detection job for a collection of documents.
|
default StartSentimentDetectionJobResponse |
startSentimentDetectionJob(Consumer<StartSentimentDetectionJobRequest.Builder> startSentimentDetectionJobRequest)
Starts an asynchronous sentiment detection job for a collection of documents.
|
default StartSentimentDetectionJobResponse |
startSentimentDetectionJob(StartSentimentDetectionJobRequest startSentimentDetectionJobRequest)
Starts an asynchronous sentiment detection job for a collection of documents.
|
default StartTopicsDetectionJobResponse |
startTopicsDetectionJob(Consumer<StartTopicsDetectionJobRequest.Builder> startTopicsDetectionJobRequest)
Starts an asynchronous topic detection job.
|
default StartTopicsDetectionJobResponse |
startTopicsDetectionJob(StartTopicsDetectionJobRequest startTopicsDetectionJobRequest)
Starts an asynchronous topic detection job.
|
default StopDominantLanguageDetectionJobResponse |
stopDominantLanguageDetectionJob(Consumer<StopDominantLanguageDetectionJobRequest.Builder> stopDominantLanguageDetectionJobRequest)
Stops a dominant language detection job in progress.
|
default StopDominantLanguageDetectionJobResponse |
stopDominantLanguageDetectionJob(StopDominantLanguageDetectionJobRequest stopDominantLanguageDetectionJobRequest)
Stops a dominant language detection job in progress.
|
default StopEntitiesDetectionJobResponse |
stopEntitiesDetectionJob(Consumer<StopEntitiesDetectionJobRequest.Builder> stopEntitiesDetectionJobRequest)
Stops an entities detection job in progress.
|
default StopEntitiesDetectionJobResponse |
stopEntitiesDetectionJob(StopEntitiesDetectionJobRequest stopEntitiesDetectionJobRequest)
Stops an entities detection job in progress.
|
default StopKeyPhrasesDetectionJobResponse |
stopKeyPhrasesDetectionJob(Consumer<StopKeyPhrasesDetectionJobRequest.Builder> stopKeyPhrasesDetectionJobRequest)
Stops a key phrases detection job in progress.
|
default StopKeyPhrasesDetectionJobResponse |
stopKeyPhrasesDetectionJob(StopKeyPhrasesDetectionJobRequest stopKeyPhrasesDetectionJobRequest)
Stops a key phrases detection job in progress.
|
default StopSentimentDetectionJobResponse |
stopSentimentDetectionJob(Consumer<StopSentimentDetectionJobRequest.Builder> stopSentimentDetectionJobRequest)
Stops a sentiment detection job in progress.
|
default StopSentimentDetectionJobResponse |
stopSentimentDetectionJob(StopSentimentDetectionJobRequest stopSentimentDetectionJobRequest)
Stops a sentiment detection job in progress.
|
serviceName
close
static final String SERVICE_NAME
static ComprehendClient create()
ComprehendClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static ComprehendClientBuilder builder()
ComprehendClient
.default BatchDetectDominantLanguageResponse batchDetectDominantLanguage(BatchDetectDominantLanguageRequest batchDetectDominantLanguageRequest) throws InvalidRequestException, TextSizeLimitExceededException, BatchSizeLimitExceededException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default BatchDetectDominantLanguageResponse batchDetectDominantLanguage(Consumer<BatchDetectDominantLanguageRequest.Builder> batchDetectDominantLanguageRequest) throws InvalidRequestException, TextSizeLimitExceededException, BatchSizeLimitExceededException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.
This is a convenience which creates an instance of the BatchDetectDominantLanguageRequest.Builder
avoiding the need to create one manually via BatchDetectDominantLanguageRequest.builder()
batchDetectDominantLanguageRequest
- A Consumer
that will call methods on BatchDetectDominantLanguageRequest.Builder
to create
a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default BatchDetectEntitiesResponse batchDetectEntities(BatchDetectEntitiesRequest batchDetectEntitiesRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, BatchSizeLimitExceededException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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
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 custom entity recognition APIs
(such as CreateEntityRecognizer
), only English is accepted. For most other APIs, Amazon
Comprehend accepts only English or Spanish text.BatchSizeLimitExceededException
- The number of documents in the request exceeds the limit of 25. Try your request again with fewer
documents.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default BatchDetectEntitiesResponse batchDetectEntities(Consumer<BatchDetectEntitiesRequest.Builder> batchDetectEntitiesRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, BatchSizeLimitExceededException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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
This is a convenience which creates an instance of the BatchDetectEntitiesRequest.Builder
avoiding the
need to create one manually via BatchDetectEntitiesRequest.builder()
batchDetectEntitiesRequest
- A Consumer
that will call methods on BatchDetectEntitiesRequest.Builder
to create a
request.InvalidRequestException
- The request is invalid.TextSizeLimitExceededException
- The size of the input text exceeds the limit. Use a smaller document.UnsupportedLanguageException
- Amazon Comprehend can't process the language of the input text. For all custom entity recognition APIs
(such as CreateEntityRecognizer
), only English is accepted. For most other APIs, Amazon
Comprehend accepts only English or Spanish text.BatchSizeLimitExceededException
- The number of documents in the request exceeds the limit of 25. Try your request again with fewer
documents.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default BatchDetectKeyPhrasesResponse batchDetectKeyPhrases(BatchDetectKeyPhrasesRequest batchDetectKeyPhrasesRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, BatchSizeLimitExceededException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Detects the key noun phrases found in a batch of documents.
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 custom entity recognition APIs
(such as CreateEntityRecognizer
), only English is accepted. For most other APIs, Amazon
Comprehend accepts only English or Spanish text.BatchSizeLimitExceededException
- The number of documents in the request exceeds the limit of 25. Try your request again with fewer
documents.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default BatchDetectKeyPhrasesResponse batchDetectKeyPhrases(Consumer<BatchDetectKeyPhrasesRequest.Builder> batchDetectKeyPhrasesRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, BatchSizeLimitExceededException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Detects the key noun phrases found in a batch of documents.
This is a convenience which creates an instance of the BatchDetectKeyPhrasesRequest.Builder
avoiding the
need to create one manually via BatchDetectKeyPhrasesRequest.builder()
batchDetectKeyPhrasesRequest
- A Consumer
that will call methods on BatchDetectKeyPhrasesRequest.Builder
to create a
request.InvalidRequestException
- The request is invalid.TextSizeLimitExceededException
- The size of the input text exceeds the limit. Use a smaller document.UnsupportedLanguageException
- Amazon Comprehend can't process the language of the input text. For all custom entity recognition APIs
(such as CreateEntityRecognizer
), only English is accepted. For most other APIs, Amazon
Comprehend accepts only English or Spanish text.BatchSizeLimitExceededException
- The number of documents in the request exceeds the limit of 25. Try your request again with fewer
documents.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default BatchDetectSentimentResponse batchDetectSentiment(BatchDetectSentimentRequest batchDetectSentimentRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, BatchSizeLimitExceededException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Inspects a batch of documents and returns an inference of the prevailing sentiment, POSITIVE
,
NEUTRAL
, MIXED
, or NEGATIVE
, in each one.
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 custom entity recognition APIs
(such as CreateEntityRecognizer
), only English is accepted. For most other APIs, Amazon
Comprehend accepts only English or Spanish text.BatchSizeLimitExceededException
- The number of documents in the request exceeds the limit of 25. Try your request again with fewer
documents.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default BatchDetectSentimentResponse batchDetectSentiment(Consumer<BatchDetectSentimentRequest.Builder> batchDetectSentimentRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, BatchSizeLimitExceededException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Inspects a batch of documents and returns an inference of the prevailing sentiment, POSITIVE
,
NEUTRAL
, MIXED
, or NEGATIVE
, in each one.
This is a convenience which creates an instance of the BatchDetectSentimentRequest.Builder
avoiding the
need to create one manually via BatchDetectSentimentRequest.builder()
batchDetectSentimentRequest
- A Consumer
that will call methods on BatchDetectSentimentRequest.Builder
to create a
request.InvalidRequestException
- The request is invalid.TextSizeLimitExceededException
- The size of the input text exceeds the limit. Use a smaller document.UnsupportedLanguageException
- Amazon Comprehend can't process the language of the input text. For all custom entity recognition APIs
(such as CreateEntityRecognizer
), only English is accepted. For most other APIs, Amazon
Comprehend accepts only English or Spanish text.BatchSizeLimitExceededException
- The number of documents in the request exceeds the limit of 25. Try your request again with fewer
documents.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default BatchDetectSyntaxResponse batchDetectSyntax(BatchDetectSyntaxRequest batchDetectSyntaxRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, BatchSizeLimitExceededException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.
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 custom entity recognition APIs
(such as CreateEntityRecognizer
), only English is accepted. For most other APIs, Amazon
Comprehend accepts only English or Spanish text.BatchSizeLimitExceededException
- The number of documents in the request exceeds the limit of 25. Try your request again with fewer
documents.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default BatchDetectSyntaxResponse batchDetectSyntax(Consumer<BatchDetectSyntaxRequest.Builder> batchDetectSyntaxRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, BatchSizeLimitExceededException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.
This is a convenience which creates an instance of the BatchDetectSyntaxRequest.Builder
avoiding the need
to create one manually via BatchDetectSyntaxRequest.builder()
batchDetectSyntaxRequest
- A Consumer
that will call methods on BatchDetectSyntaxRequest.Builder
to create a request.InvalidRequestException
- The request is invalid.TextSizeLimitExceededException
- The size of the input text exceeds the limit. Use a smaller document.UnsupportedLanguageException
- Amazon Comprehend can't process the language of the input text. For all custom entity recognition APIs
(such as CreateEntityRecognizer
), only English is accepted. For most other APIs, Amazon
Comprehend accepts only English or Spanish text.BatchSizeLimitExceededException
- The number of documents in the request exceeds the limit of 25. Try your request again with fewer
documents.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateDocumentClassifierResponse createDocumentClassifier(CreateDocumentClassifierRequest createDocumentClassifierRequest) throws InvalidRequestException, ResourceInUseException, TooManyRequestsException, ResourceLimitExceededException, UnsupportedLanguageException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Creates a new document classifier that you can use to categorize documents. To create a classifier you provide a set of training documents that labeled with the categories that you want to use. After the classifier is trained you can use it to categorize a set of labeled documents into the categories.
createDocumentClassifierRequest
- InvalidRequestException
- The request is invalid.ResourceInUseException
- The specified name is already in use. Use a different name and try your request again.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.ResourceLimitExceededException
- The maximum number of recognizers per account has been exceeded. Review the recognizers, perform cleanup,
and then try your request again.UnsupportedLanguageException
- Amazon Comprehend can't process the language of the input text. For all custom entity recognition APIs
(such as CreateEntityRecognizer
), only English is accepted. For most other APIs, Amazon
Comprehend accepts only English or Spanish text.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateDocumentClassifierResponse createDocumentClassifier(Consumer<CreateDocumentClassifierRequest.Builder> createDocumentClassifierRequest) throws InvalidRequestException, ResourceInUseException, TooManyRequestsException, ResourceLimitExceededException, UnsupportedLanguageException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Creates a new document classifier that you can use to categorize documents. To create a classifier you provide a set of training documents that labeled with the categories that you want to use. After the classifier is trained you can use it to categorize a set of labeled documents into the categories.
This is a convenience which creates an instance of the CreateDocumentClassifierRequest.Builder
avoiding
the need to create one manually via CreateDocumentClassifierRequest.builder()
createDocumentClassifierRequest
- A Consumer
that will call methods on CreateDocumentClassifierRequest.Builder
to create a
request.InvalidRequestException
- The request is invalid.ResourceInUseException
- The specified name is already in use. Use a different name and try your request again.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.ResourceLimitExceededException
- The maximum number of recognizers per account has been exceeded. Review the recognizers, perform cleanup,
and then try your request again.UnsupportedLanguageException
- Amazon Comprehend can't process the language of the input text. For all custom entity recognition APIs
(such as CreateEntityRecognizer
), only English is accepted. For most other APIs, Amazon
Comprehend accepts only English or Spanish text.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateEntityRecognizerResponse createEntityRecognizer(CreateEntityRecognizerRequest createEntityRecognizerRequest) throws InvalidRequestException, ResourceInUseException, TooManyRequestsException, ResourceLimitExceededException, UnsupportedLanguageException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Creates an entity recognizer using submitted files. After your CreateEntityRecognizer
request is
submitted, you can check job status using the API.
createEntityRecognizerRequest
- InvalidRequestException
- The request is invalid.ResourceInUseException
- The specified name is already in use. Use a different name and try your request again.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.ResourceLimitExceededException
- The maximum number of recognizers per account has been exceeded. Review the recognizers, perform cleanup,
and then try your request again.UnsupportedLanguageException
- Amazon Comprehend can't process the language of the input text. For all custom entity recognition APIs
(such as CreateEntityRecognizer
), only English is accepted. For most other APIs, Amazon
Comprehend accepts only English or Spanish text.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateEntityRecognizerResponse createEntityRecognizer(Consumer<CreateEntityRecognizerRequest.Builder> createEntityRecognizerRequest) throws InvalidRequestException, ResourceInUseException, TooManyRequestsException, ResourceLimitExceededException, UnsupportedLanguageException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Creates an entity recognizer using submitted files. After your CreateEntityRecognizer
request is
submitted, you can check job status using the API.
This is a convenience which creates an instance of the CreateEntityRecognizerRequest.Builder
avoiding the
need to create one manually via CreateEntityRecognizerRequest.builder()
createEntityRecognizerRequest
- A Consumer
that will call methods on CreateEntityRecognizerRequest.Builder
to create a
request.InvalidRequestException
- The request is invalid.ResourceInUseException
- The specified name is already in use. Use a different name and try your request again.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.ResourceLimitExceededException
- The maximum number of recognizers per account has been exceeded. Review the recognizers, perform cleanup,
and then try your request again.UnsupportedLanguageException
- Amazon Comprehend can't process the language of the input text. For all custom entity recognition APIs
(such as CreateEntityRecognizer
), only English is accepted. For most other APIs, Amazon
Comprehend accepts only English or Spanish text.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteDocumentClassifierResponse deleteDocumentClassifier(DeleteDocumentClassifierRequest deleteDocumentClassifierRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, ResourceUnavailableException, ResourceInUseException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Deletes a previously created document classifier
Only those classifiers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference
job is using the model, a ResourceInUseException
will be returned.
This is an asynchronous action that puts the classifier into a DELETING state, and it is then removed by a background job. Once removed, the classifier disappears from your account and is no longer available for use.
deleteDocumentClassifierRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.ResourceNotFoundException
- The specified resource ARN was not found. Check the ARN and try your request again.ResourceUnavailableException
- The specified resource is not available. Check to see if the resource is in the TRAINED
state and try your request again.ResourceInUseException
- The specified name is already in use. Use a different name and try your request again.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteDocumentClassifierResponse deleteDocumentClassifier(Consumer<DeleteDocumentClassifierRequest.Builder> deleteDocumentClassifierRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, ResourceUnavailableException, ResourceInUseException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Deletes a previously created document classifier
Only those classifiers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference
job is using the model, a ResourceInUseException
will be returned.
This is an asynchronous action that puts the classifier into a DELETING state, and it is then removed by a background job. Once removed, the classifier disappears from your account and is no longer available for use.
This is a convenience which creates an instance of the DeleteDocumentClassifierRequest.Builder
avoiding
the need to create one manually via DeleteDocumentClassifierRequest.builder()
deleteDocumentClassifierRequest
- A Consumer
that will call methods on DeleteDocumentClassifierRequest.Builder
to create a
request.InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.ResourceNotFoundException
- The specified resource ARN was not found. Check the ARN and try your request again.ResourceUnavailableException
- The specified resource is not available. Check to see if the resource is in the TRAINED
state and try your request again.ResourceInUseException
- The specified name is already in use. Use a different name and try your request again.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteEntityRecognizerResponse deleteEntityRecognizer(DeleteEntityRecognizerRequest deleteEntityRecognizerRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, ResourceUnavailableException, ResourceInUseException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Deletes an entity recognizer.
Only those recognizers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference
job is using the model, a ResourceInUseException
will be returned.
This is an asynchronous action that puts the recognizer into a DELETING state, and it is then removed by a background job. Once removed, the recognizer disappears from your account and is no longer available for use.
deleteEntityRecognizerRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.ResourceNotFoundException
- The specified resource ARN was not found. Check the ARN and try your request again.ResourceUnavailableException
- The specified resource is not available. Check to see if the resource is in the TRAINED
state and try your request again.ResourceInUseException
- The specified name is already in use. Use a different name and try your request again.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteEntityRecognizerResponse deleteEntityRecognizer(Consumer<DeleteEntityRecognizerRequest.Builder> deleteEntityRecognizerRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, ResourceUnavailableException, ResourceInUseException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Deletes an entity recognizer.
Only those recognizers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference
job is using the model, a ResourceInUseException
will be returned.
This is an asynchronous action that puts the recognizer into a DELETING state, and it is then removed by a background job. Once removed, the recognizer disappears from your account and is no longer available for use.
This is a convenience which creates an instance of the DeleteEntityRecognizerRequest.Builder
avoiding the
need to create one manually via DeleteEntityRecognizerRequest.builder()
deleteEntityRecognizerRequest
- A Consumer
that will call methods on DeleteEntityRecognizerRequest.Builder
to create a
request.InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.ResourceNotFoundException
- The specified resource ARN was not found. Check the ARN and try your request again.ResourceUnavailableException
- The specified resource is not available. Check to see if the resource is in the TRAINED
state and try your request again.ResourceInUseException
- The specified name is already in use. Use a different name and try your request again.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDocumentClassificationJobResponse describeDocumentClassificationJob(DescribeDocumentClassificationJobRequest describeDocumentClassificationJobRequest) throws InvalidRequestException, TooManyRequestsException, JobNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets the properties associated with a document classification job. Use this operation to get the status of a classification job.
describeDocumentClassificationJobRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.JobNotFoundException
- The specified job was not found. Check the job ID and try again.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDocumentClassificationJobResponse describeDocumentClassificationJob(Consumer<DescribeDocumentClassificationJobRequest.Builder> describeDocumentClassificationJobRequest) throws InvalidRequestException, TooManyRequestsException, JobNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets the properties associated with a document classification job. Use this operation to get the status of a classification job.
This is a convenience which creates an instance of the DescribeDocumentClassificationJobRequest.Builder
avoiding the need to create one manually via DescribeDocumentClassificationJobRequest.builder()
describeDocumentClassificationJobRequest
- A Consumer
that will call methods on DescribeDocumentClassificationJobRequest.Builder
to
create a request.InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.JobNotFoundException
- The specified job was not found. Check the job ID and try again.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDocumentClassifierResponse describeDocumentClassifier(DescribeDocumentClassifierRequest describeDocumentClassifierRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets the properties associated with a document classifier.
describeDocumentClassifierRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.ResourceNotFoundException
- The specified resource ARN was not found. Check the ARN and try your request again.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDocumentClassifierResponse describeDocumentClassifier(Consumer<DescribeDocumentClassifierRequest.Builder> describeDocumentClassifierRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets the properties associated with a document classifier.
This is a convenience which creates an instance of the DescribeDocumentClassifierRequest.Builder
avoiding
the need to create one manually via DescribeDocumentClassifierRequest.builder()
describeDocumentClassifierRequest
- A Consumer
that will call methods on DescribeDocumentClassifierRequest.Builder
to create a
request.InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.ResourceNotFoundException
- The specified resource ARN was not found. Check the ARN and try your request again.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDominantLanguageDetectionJobResponse describeDominantLanguageDetectionJob(DescribeDominantLanguageDetectionJobRequest describeDominantLanguageDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets the properties associated with a dominant language detection job. Use this operation to get the status of a detection job.
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDominantLanguageDetectionJobResponse describeDominantLanguageDetectionJob(Consumer<DescribeDominantLanguageDetectionJobRequest.Builder> describeDominantLanguageDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets the properties associated with a dominant language detection job. Use this operation to get the status of a detection job.
This is a convenience which creates an instance of the
DescribeDominantLanguageDetectionJobRequest.Builder
avoiding the need to create one manually via
DescribeDominantLanguageDetectionJobRequest.builder()
describeDominantLanguageDetectionJobRequest
- A Consumer
that will call methods on DescribeDominantLanguageDetectionJobRequest.Builder
to create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEntitiesDetectionJobResponse describeEntitiesDetectionJob(DescribeEntitiesDetectionJobRequest describeEntitiesDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets the properties associated with an entities detection job. Use this operation to get the status of a detection job.
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEntitiesDetectionJobResponse describeEntitiesDetectionJob(Consumer<DescribeEntitiesDetectionJobRequest.Builder> describeEntitiesDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets the properties associated with an entities detection job. Use this operation to get the status of a detection job.
This is a convenience which creates an instance of the DescribeEntitiesDetectionJobRequest.Builder
avoiding the need to create one manually via DescribeEntitiesDetectionJobRequest.builder()
describeEntitiesDetectionJobRequest
- A Consumer
that will call methods on DescribeEntitiesDetectionJobRequest.Builder
to create
a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEntityRecognizerResponse describeEntityRecognizer(DescribeEntityRecognizerRequest describeEntityRecognizerRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on.
describeEntityRecognizerRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.ResourceNotFoundException
- The specified resource ARN was not found. Check the ARN and try your request again.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEntityRecognizerResponse describeEntityRecognizer(Consumer<DescribeEntityRecognizerRequest.Builder> describeEntityRecognizerRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on.
This is a convenience which creates an instance of the DescribeEntityRecognizerRequest.Builder
avoiding
the need to create one manually via DescribeEntityRecognizerRequest.builder()
describeEntityRecognizerRequest
- A Consumer
that will call methods on DescribeEntityRecognizerRequest.Builder
to create a
request.InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.ResourceNotFoundException
- The specified resource ARN was not found. Check the ARN and try your request again.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeKeyPhrasesDetectionJobResponse describeKeyPhrasesDetectionJob(DescribeKeyPhrasesDetectionJobRequest describeKeyPhrasesDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job.
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeKeyPhrasesDetectionJobResponse describeKeyPhrasesDetectionJob(Consumer<DescribeKeyPhrasesDetectionJobRequest.Builder> describeKeyPhrasesDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job.
This is a convenience which creates an instance of the DescribeKeyPhrasesDetectionJobRequest.Builder
avoiding the need to create one manually via DescribeKeyPhrasesDetectionJobRequest.builder()
describeKeyPhrasesDetectionJobRequest
- A Consumer
that will call methods on DescribeKeyPhrasesDetectionJobRequest.Builder
to
create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeSentimentDetectionJobResponse describeSentimentDetectionJob(DescribeSentimentDetectionJobRequest describeSentimentDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job.
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeSentimentDetectionJobResponse describeSentimentDetectionJob(Consumer<DescribeSentimentDetectionJobRequest.Builder> describeSentimentDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job.
This is a convenience which creates an instance of the DescribeSentimentDetectionJobRequest.Builder
avoiding the need to create one manually via DescribeSentimentDetectionJobRequest.builder()
describeSentimentDetectionJobRequest
- A Consumer
that will call methods on DescribeSentimentDetectionJobRequest.Builder
to
create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeTopicsDetectionJobResponse describeTopicsDetectionJob(DescribeTopicsDetectionJobRequest describeTopicsDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets the properties associated with a topic detection job. Use this operation to get the status of a detection job.
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeTopicsDetectionJobResponse describeTopicsDetectionJob(Consumer<DescribeTopicsDetectionJobRequest.Builder> describeTopicsDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets the properties associated with a topic detection job. Use this operation to get the status of a detection job.
This is a convenience which creates an instance of the DescribeTopicsDetectionJobRequest.Builder
avoiding
the need to create one manually via DescribeTopicsDetectionJobRequest.builder()
describeTopicsDetectionJobRequest
- A Consumer
that will call methods on DescribeTopicsDetectionJobRequest.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DetectDominantLanguageResponse detectDominantLanguage(DetectDominantLanguageRequest detectDominantLanguageRequest) throws InvalidRequestException, TextSizeLimitExceededException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DetectDominantLanguageResponse detectDominantLanguage(Consumer<DetectDominantLanguageRequest.Builder> detectDominantLanguageRequest) throws InvalidRequestException, TextSizeLimitExceededException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.
This is a convenience which creates an instance of the DetectDominantLanguageRequest.Builder
avoiding the
need to create one manually via DetectDominantLanguageRequest.builder()
detectDominantLanguageRequest
- A Consumer
that will call methods on DetectDominantLanguageRequest.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DetectEntitiesResponse detectEntities(DetectEntitiesRequest detectEntitiesRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Inspects text for named entities, and returns information about them. For more information, about named entities, see how-entities.
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 custom entity recognition APIs
(such as CreateEntityRecognizer
), only English is accepted. For most other APIs, Amazon
Comprehend accepts only English or Spanish text.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DetectEntitiesResponse detectEntities(Consumer<DetectEntitiesRequest.Builder> detectEntitiesRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Inspects text for named entities, and returns information about them. For more information, about named entities, see how-entities.
This is a convenience which creates an instance of the DetectEntitiesRequest.Builder
avoiding the need to
create one manually via DetectEntitiesRequest.builder()
detectEntitiesRequest
- A Consumer
that will call methods on DetectEntitiesRequest.Builder
to create a request.InvalidRequestException
- The request is invalid.TextSizeLimitExceededException
- The size of the input text exceeds the limit. Use a smaller document.UnsupportedLanguageException
- Amazon Comprehend can't process the language of the input text. For all custom entity recognition APIs
(such as CreateEntityRecognizer
), only English is accepted. For most other APIs, Amazon
Comprehend accepts only English or Spanish text.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DetectKeyPhrasesResponse detectKeyPhrases(DetectKeyPhrasesRequest detectKeyPhrasesRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Detects the key noun phrases found in the text.
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 custom entity recognition APIs
(such as CreateEntityRecognizer
), only English is accepted. For most other APIs, Amazon
Comprehend accepts only English or Spanish text.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DetectKeyPhrasesResponse detectKeyPhrases(Consumer<DetectKeyPhrasesRequest.Builder> detectKeyPhrasesRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Detects the key noun phrases found in the text.
This is a convenience which creates an instance of the DetectKeyPhrasesRequest.Builder
avoiding the need
to create one manually via DetectKeyPhrasesRequest.builder()
detectKeyPhrasesRequest
- A Consumer
that will call methods on DetectKeyPhrasesRequest.Builder
to create a request.InvalidRequestException
- The request is invalid.TextSizeLimitExceededException
- The size of the input text exceeds the limit. Use a smaller document.UnsupportedLanguageException
- Amazon Comprehend can't process the language of the input text. For all custom entity recognition APIs
(such as CreateEntityRecognizer
), only English is accepted. For most other APIs, Amazon
Comprehend accepts only English or Spanish text.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DetectSentimentResponse detectSentiment(DetectSentimentRequest detectSentimentRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Inspects text and returns an inference of the prevailing sentiment (POSITIVE
, NEUTRAL
,
MIXED
, or NEGATIVE
).
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 custom entity recognition APIs
(such as CreateEntityRecognizer
), only English is accepted. For most other APIs, Amazon
Comprehend accepts only English or Spanish text.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DetectSentimentResponse detectSentiment(Consumer<DetectSentimentRequest.Builder> detectSentimentRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Inspects text and returns an inference of the prevailing sentiment (POSITIVE
, NEUTRAL
,
MIXED
, or NEGATIVE
).
This is a convenience which creates an instance of the DetectSentimentRequest.Builder
avoiding the need
to create one manually via DetectSentimentRequest.builder()
detectSentimentRequest
- A Consumer
that will call methods on DetectSentimentRequest.Builder
to create a request.InvalidRequestException
- The request is invalid.TextSizeLimitExceededException
- The size of the input text exceeds the limit. Use a smaller document.UnsupportedLanguageException
- Amazon Comprehend can't process the language of the input text. For all custom entity recognition APIs
(such as CreateEntityRecognizer
), only English is accepted. For most other APIs, Amazon
Comprehend accepts only English or Spanish text.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DetectSyntaxResponse detectSyntax(DetectSyntaxRequest detectSyntaxRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Inspects text for syntax and the part of speech of words in the document. For more information, how-syntax.
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 custom entity recognition APIs
(such as CreateEntityRecognizer
), only English is accepted. For most other APIs, Amazon
Comprehend accepts only English or Spanish text.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DetectSyntaxResponse detectSyntax(Consumer<DetectSyntaxRequest.Builder> detectSyntaxRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Inspects text for syntax and the part of speech of words in the document. For more information, how-syntax.
This is a convenience which creates an instance of the DetectSyntaxRequest.Builder
avoiding the need to
create one manually via DetectSyntaxRequest.builder()
detectSyntaxRequest
- A Consumer
that will call methods on DetectSyntaxRequest.Builder
to create a request.InvalidRequestException
- The request is invalid.TextSizeLimitExceededException
- The size of the input text exceeds the limit. Use a smaller document.UnsupportedLanguageException
- Amazon Comprehend can't process the language of the input text. For all custom entity recognition APIs
(such as CreateEntityRecognizer
), only English is accepted. For most other APIs, Amazon
Comprehend accepts only English or Spanish text.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListDocumentClassificationJobsResponse listDocumentClassificationJobs() throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the documentation classification jobs that you have submitted.
InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the ListDocumentClassificationJobs
operation is invalid. Specify a
different filter.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listDocumentClassificationJobs(ListDocumentClassificationJobsRequest)
,
AWS API Documentationdefault ListDocumentClassificationJobsResponse listDocumentClassificationJobs(ListDocumentClassificationJobsRequest listDocumentClassificationJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the documentation classification jobs that you have submitted.
listDocumentClassificationJobsRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the ListDocumentClassificationJobs
operation is invalid. Specify a
different filter.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListDocumentClassificationJobsResponse listDocumentClassificationJobs(Consumer<ListDocumentClassificationJobsRequest.Builder> listDocumentClassificationJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the documentation classification jobs that you have submitted.
This is a convenience which creates an instance of the ListDocumentClassificationJobsRequest.Builder
avoiding the need to create one manually via ListDocumentClassificationJobsRequest.builder()
listDocumentClassificationJobsRequest
- A Consumer
that will call methods on ListDocumentClassificationJobsRequest.Builder
to
create a request.InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the ListDocumentClassificationJobs
operation is invalid. Specify a
different filter.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListDocumentClassifiersResponse listDocumentClassifiers() throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the document classifiers that you have created.
InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the ListDocumentClassificationJobs
operation is invalid. Specify a
different filter.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listDocumentClassifiers(ListDocumentClassifiersRequest)
,
AWS API Documentationdefault ListDocumentClassifiersResponse listDocumentClassifiers(ListDocumentClassifiersRequest listDocumentClassifiersRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the document classifiers that you have created.
listDocumentClassifiersRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the ListDocumentClassificationJobs
operation is invalid. Specify a
different filter.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListDocumentClassifiersResponse listDocumentClassifiers(Consumer<ListDocumentClassifiersRequest.Builder> listDocumentClassifiersRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the document classifiers that you have created.
This is a convenience which creates an instance of the ListDocumentClassifiersRequest.Builder
avoiding
the need to create one manually via ListDocumentClassifiersRequest.builder()
listDocumentClassifiersRequest
- A Consumer
that will call methods on ListDocumentClassifiersRequest.Builder
to create a
request.InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the ListDocumentClassificationJobs
operation is invalid. Specify a
different filter.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListDominantLanguageDetectionJobsResponse listDominantLanguageDetectionJobs() throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the dominant language detection jobs that you have submitted.
InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the ListDocumentClassificationJobs
operation is invalid. Specify a
different filter.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listDominantLanguageDetectionJobs(ListDominantLanguageDetectionJobsRequest)
,
AWS API Documentationdefault ListDominantLanguageDetectionJobsResponse listDominantLanguageDetectionJobs(ListDominantLanguageDetectionJobsRequest listDominantLanguageDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the dominant language detection jobs that you have submitted.
listDominantLanguageDetectionJobsRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the ListDocumentClassificationJobs
operation is invalid. Specify a
different filter.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListDominantLanguageDetectionJobsResponse listDominantLanguageDetectionJobs(Consumer<ListDominantLanguageDetectionJobsRequest.Builder> listDominantLanguageDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the dominant language detection jobs that you have submitted.
This is a convenience which creates an instance of the ListDominantLanguageDetectionJobsRequest.Builder
avoiding the need to create one manually via ListDominantLanguageDetectionJobsRequest.builder()
listDominantLanguageDetectionJobsRequest
- A Consumer
that will call methods on ListDominantLanguageDetectionJobsRequest.Builder
to
create a request.InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the ListDocumentClassificationJobs
operation is invalid. Specify a
different filter.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListDominantLanguageDetectionJobsIterable listDominantLanguageDetectionJobsPaginator() throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the dominant language detection jobs that you have submitted.
This is a variant of
listDominantLanguageDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListDominantLanguageDetectionJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.comprehend.paginators.ListDominantLanguageDetectionJobsIterable responses = client.listDominantLanguageDetectionJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.comprehend.paginators.ListDominantLanguageDetectionJobsIterable responses = client .listDominantLanguageDetectionJobsPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListDominantLanguageDetectionJobsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.comprehend.paginators.ListDominantLanguageDetectionJobsIterable responses = client.listDominantLanguageDetectionJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listDominantLanguageDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListDominantLanguageDetectionJobsRequest)
operation.
InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the ListDocumentClassificationJobs
operation is invalid. Specify a
different filter.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listDominantLanguageDetectionJobsPaginator(ListDominantLanguageDetectionJobsRequest)
,
AWS API Documentationdefault ListDominantLanguageDetectionJobsIterable listDominantLanguageDetectionJobsPaginator(ListDominantLanguageDetectionJobsRequest listDominantLanguageDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the dominant language detection jobs that you have submitted.
This is a variant of
listDominantLanguageDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListDominantLanguageDetectionJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.comprehend.paginators.ListDominantLanguageDetectionJobsIterable responses = client.listDominantLanguageDetectionJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.comprehend.paginators.ListDominantLanguageDetectionJobsIterable responses = client .listDominantLanguageDetectionJobsPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListDominantLanguageDetectionJobsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.comprehend.paginators.ListDominantLanguageDetectionJobsIterable responses = client.listDominantLanguageDetectionJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listDominantLanguageDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListDominantLanguageDetectionJobsRequest)
operation.
listDominantLanguageDetectionJobsRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the ListDocumentClassificationJobs
operation is invalid. Specify a
different filter.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListDominantLanguageDetectionJobsIterable listDominantLanguageDetectionJobsPaginator(Consumer<ListDominantLanguageDetectionJobsRequest.Builder> listDominantLanguageDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the dominant language detection jobs that you have submitted.
This is a variant of
listDominantLanguageDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListDominantLanguageDetectionJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.comprehend.paginators.ListDominantLanguageDetectionJobsIterable responses = client.listDominantLanguageDetectionJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.comprehend.paginators.ListDominantLanguageDetectionJobsIterable responses = client .listDominantLanguageDetectionJobsPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListDominantLanguageDetectionJobsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.comprehend.paginators.ListDominantLanguageDetectionJobsIterable responses = client.listDominantLanguageDetectionJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listDominantLanguageDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListDominantLanguageDetectionJobsRequest)
operation.
This is a convenience which creates an instance of the ListDominantLanguageDetectionJobsRequest.Builder
avoiding the need to create one manually via ListDominantLanguageDetectionJobsRequest.builder()
listDominantLanguageDetectionJobsRequest
- A Consumer
that will call methods on ListDominantLanguageDetectionJobsRequest.Builder
to
create a request.InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the ListDocumentClassificationJobs
operation is invalid. Specify a
different filter.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListEntitiesDetectionJobsResponse listEntitiesDetectionJobs() throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the entity detection jobs that you have submitted.
InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the ListDocumentClassificationJobs
operation is invalid. Specify a
different filter.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listEntitiesDetectionJobs(ListEntitiesDetectionJobsRequest)
,
AWS API Documentationdefault ListEntitiesDetectionJobsResponse listEntitiesDetectionJobs(ListEntitiesDetectionJobsRequest listEntitiesDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the entity detection jobs that you have submitted.
listEntitiesDetectionJobsRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the ListDocumentClassificationJobs
operation is invalid. Specify a
different filter.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListEntitiesDetectionJobsResponse listEntitiesDetectionJobs(Consumer<ListEntitiesDetectionJobsRequest.Builder> listEntitiesDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the entity detection jobs that you have submitted.
This is a convenience which creates an instance of the ListEntitiesDetectionJobsRequest.Builder
avoiding
the need to create one manually via ListEntitiesDetectionJobsRequest.builder()
listEntitiesDetectionJobsRequest
- A Consumer
that will call methods on ListEntitiesDetectionJobsRequest.Builder
to create a
request.InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the ListDocumentClassificationJobs
operation is invalid. Specify a
different filter.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListEntitiesDetectionJobsIterable listEntitiesDetectionJobsPaginator() throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the entity detection jobs that you have submitted.
This is a variant of
listEntitiesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListEntitiesDetectionJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.comprehend.paginators.ListEntitiesDetectionJobsIterable responses = client.listEntitiesDetectionJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.comprehend.paginators.ListEntitiesDetectionJobsIterable responses = client .listEntitiesDetectionJobsPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListEntitiesDetectionJobsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.comprehend.paginators.ListEntitiesDetectionJobsIterable responses = client.listEntitiesDetectionJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listEntitiesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListEntitiesDetectionJobsRequest)
operation.
InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the ListDocumentClassificationJobs
operation is invalid. Specify a
different filter.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listEntitiesDetectionJobsPaginator(ListEntitiesDetectionJobsRequest)
,
AWS API Documentationdefault ListEntitiesDetectionJobsIterable listEntitiesDetectionJobsPaginator(ListEntitiesDetectionJobsRequest listEntitiesDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the entity detection jobs that you have submitted.
This is a variant of
listEntitiesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListEntitiesDetectionJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.comprehend.paginators.ListEntitiesDetectionJobsIterable responses = client.listEntitiesDetectionJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.comprehend.paginators.ListEntitiesDetectionJobsIterable responses = client .listEntitiesDetectionJobsPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListEntitiesDetectionJobsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.comprehend.paginators.ListEntitiesDetectionJobsIterable responses = client.listEntitiesDetectionJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listEntitiesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListEntitiesDetectionJobsRequest)
operation.
listEntitiesDetectionJobsRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the ListDocumentClassificationJobs
operation is invalid. Specify a
different filter.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListEntitiesDetectionJobsIterable listEntitiesDetectionJobsPaginator(Consumer<ListEntitiesDetectionJobsRequest.Builder> listEntitiesDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the entity detection jobs that you have submitted.
This is a variant of
listEntitiesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListEntitiesDetectionJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.comprehend.paginators.ListEntitiesDetectionJobsIterable responses = client.listEntitiesDetectionJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.comprehend.paginators.ListEntitiesDetectionJobsIterable responses = client .listEntitiesDetectionJobsPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListEntitiesDetectionJobsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.comprehend.paginators.ListEntitiesDetectionJobsIterable responses = client.listEntitiesDetectionJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listEntitiesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListEntitiesDetectionJobsRequest)
operation.
This is a convenience which creates an instance of the ListEntitiesDetectionJobsRequest.Builder
avoiding
the need to create one manually via ListEntitiesDetectionJobsRequest.builder()
listEntitiesDetectionJobsRequest
- A Consumer
that will call methods on ListEntitiesDetectionJobsRequest.Builder
to create a
request.InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the ListDocumentClassificationJobs
operation is invalid. Specify a
different filter.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListEntityRecognizersResponse listEntityRecognizers() throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the properties of all entity recognizers that you created, including recognizers currently in training. Allows you to filter the list of recognizers based on criteria such as status and submission time. This call returns up to 500 entity recognizers in the list, with a default number of 100 recognizers in the list.
The results of this list are not in any particular order. Please get the list and sort locally if needed.
InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the ListDocumentClassificationJobs
operation is invalid. Specify a
different filter.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listEntityRecognizers(ListEntityRecognizersRequest)
,
AWS API Documentationdefault ListEntityRecognizersResponse listEntityRecognizers(ListEntityRecognizersRequest listEntityRecognizersRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the properties of all entity recognizers that you created, including recognizers currently in training. Allows you to filter the list of recognizers based on criteria such as status and submission time. This call returns up to 500 entity recognizers in the list, with a default number of 100 recognizers in the list.
The results of this list are not in any particular order. Please get the list and sort locally if needed.
listEntityRecognizersRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the ListDocumentClassificationJobs
operation is invalid. Specify a
different filter.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListEntityRecognizersResponse listEntityRecognizers(Consumer<ListEntityRecognizersRequest.Builder> listEntityRecognizersRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the properties of all entity recognizers that you created, including recognizers currently in training. Allows you to filter the list of recognizers based on criteria such as status and submission time. This call returns up to 500 entity recognizers in the list, with a default number of 100 recognizers in the list.
The results of this list are not in any particular order. Please get the list and sort locally if needed.
This is a convenience which creates an instance of the ListEntityRecognizersRequest.Builder
avoiding the
need to create one manually via ListEntityRecognizersRequest.builder()
listEntityRecognizersRequest
- A Consumer
that will call methods on ListEntityRecognizersRequest.Builder
to create a
request.InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the ListDocumentClassificationJobs
operation is invalid. Specify a
different filter.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListKeyPhrasesDetectionJobsResponse listKeyPhrasesDetectionJobs() throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Get a list of key phrase detection jobs that you have submitted.
InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the ListDocumentClassificationJobs
operation is invalid. Specify a
different filter.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listKeyPhrasesDetectionJobs(ListKeyPhrasesDetectionJobsRequest)
,
AWS API Documentationdefault ListKeyPhrasesDetectionJobsResponse listKeyPhrasesDetectionJobs(ListKeyPhrasesDetectionJobsRequest listKeyPhrasesDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Get a list of key phrase detection jobs that you have submitted.
listKeyPhrasesDetectionJobsRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the ListDocumentClassificationJobs
operation is invalid. Specify a
different filter.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListKeyPhrasesDetectionJobsResponse listKeyPhrasesDetectionJobs(Consumer<ListKeyPhrasesDetectionJobsRequest.Builder> listKeyPhrasesDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Get a list of key phrase detection jobs that you have submitted.
This is a convenience which creates an instance of the ListKeyPhrasesDetectionJobsRequest.Builder
avoiding the need to create one manually via ListKeyPhrasesDetectionJobsRequest.builder()
listKeyPhrasesDetectionJobsRequest
- A Consumer
that will call methods on ListKeyPhrasesDetectionJobsRequest.Builder
to create
a request.InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the ListDocumentClassificationJobs
operation is invalid. Specify a
different filter.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListKeyPhrasesDetectionJobsIterable listKeyPhrasesDetectionJobsPaginator() throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Get a list of key phrase detection jobs that you have submitted.
This is a variant of
listKeyPhrasesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListKeyPhrasesDetectionJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.comprehend.paginators.ListKeyPhrasesDetectionJobsIterable responses = client.listKeyPhrasesDetectionJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.comprehend.paginators.ListKeyPhrasesDetectionJobsIterable responses = client .listKeyPhrasesDetectionJobsPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListKeyPhrasesDetectionJobsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.comprehend.paginators.ListKeyPhrasesDetectionJobsIterable responses = client.listKeyPhrasesDetectionJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listKeyPhrasesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListKeyPhrasesDetectionJobsRequest)
operation.
InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the ListDocumentClassificationJobs
operation is invalid. Specify a
different filter.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listKeyPhrasesDetectionJobsPaginator(ListKeyPhrasesDetectionJobsRequest)
,
AWS API Documentationdefault ListKeyPhrasesDetectionJobsIterable listKeyPhrasesDetectionJobsPaginator(ListKeyPhrasesDetectionJobsRequest listKeyPhrasesDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Get a list of key phrase detection jobs that you have submitted.
This is a variant of
listKeyPhrasesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListKeyPhrasesDetectionJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.comprehend.paginators.ListKeyPhrasesDetectionJobsIterable responses = client.listKeyPhrasesDetectionJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.comprehend.paginators.ListKeyPhrasesDetectionJobsIterable responses = client .listKeyPhrasesDetectionJobsPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListKeyPhrasesDetectionJobsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.comprehend.paginators.ListKeyPhrasesDetectionJobsIterable responses = client.listKeyPhrasesDetectionJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listKeyPhrasesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListKeyPhrasesDetectionJobsRequest)
operation.
listKeyPhrasesDetectionJobsRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the ListDocumentClassificationJobs
operation is invalid. Specify a
different filter.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListKeyPhrasesDetectionJobsIterable listKeyPhrasesDetectionJobsPaginator(Consumer<ListKeyPhrasesDetectionJobsRequest.Builder> listKeyPhrasesDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Get a list of key phrase detection jobs that you have submitted.
This is a variant of
listKeyPhrasesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListKeyPhrasesDetectionJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.comprehend.paginators.ListKeyPhrasesDetectionJobsIterable responses = client.listKeyPhrasesDetectionJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.comprehend.paginators.ListKeyPhrasesDetectionJobsIterable responses = client .listKeyPhrasesDetectionJobsPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListKeyPhrasesDetectionJobsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.comprehend.paginators.ListKeyPhrasesDetectionJobsIterable responses = client.listKeyPhrasesDetectionJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listKeyPhrasesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListKeyPhrasesDetectionJobsRequest)
operation.
This is a convenience which creates an instance of the ListKeyPhrasesDetectionJobsRequest.Builder
avoiding the need to create one manually via ListKeyPhrasesDetectionJobsRequest.builder()
listKeyPhrasesDetectionJobsRequest
- A Consumer
that will call methods on ListKeyPhrasesDetectionJobsRequest.Builder
to create
a request.InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the ListDocumentClassificationJobs
operation is invalid. Specify a
different filter.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListSentimentDetectionJobsResponse listSentimentDetectionJobs() throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of sentiment detection jobs that you have submitted.
InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the ListDocumentClassificationJobs
operation is invalid. Specify a
different filter.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listSentimentDetectionJobs(ListSentimentDetectionJobsRequest)
,
AWS API Documentationdefault ListSentimentDetectionJobsResponse listSentimentDetectionJobs(ListSentimentDetectionJobsRequest listSentimentDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of sentiment detection jobs that you have submitted.
listSentimentDetectionJobsRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the ListDocumentClassificationJobs
operation is invalid. Specify a
different filter.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListSentimentDetectionJobsResponse listSentimentDetectionJobs(Consumer<ListSentimentDetectionJobsRequest.Builder> listSentimentDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of sentiment detection jobs that you have submitted.
This is a convenience which creates an instance of the ListSentimentDetectionJobsRequest.Builder
avoiding
the need to create one manually via ListSentimentDetectionJobsRequest.builder()
listSentimentDetectionJobsRequest
- A Consumer
that will call methods on ListSentimentDetectionJobsRequest.Builder
to create a
request.InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the ListDocumentClassificationJobs
operation is invalid. Specify a
different filter.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListSentimentDetectionJobsIterable listSentimentDetectionJobsPaginator() throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of sentiment detection jobs that you have submitted.
This is a variant of
listSentimentDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListSentimentDetectionJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.comprehend.paginators.ListSentimentDetectionJobsIterable responses = client.listSentimentDetectionJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.comprehend.paginators.ListSentimentDetectionJobsIterable responses = client .listSentimentDetectionJobsPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListSentimentDetectionJobsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.comprehend.paginators.ListSentimentDetectionJobsIterable responses = client.listSentimentDetectionJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listSentimentDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListSentimentDetectionJobsRequest)
operation.
InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the ListDocumentClassificationJobs
operation is invalid. Specify a
different filter.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listSentimentDetectionJobsPaginator(ListSentimentDetectionJobsRequest)
,
AWS API Documentationdefault ListSentimentDetectionJobsIterable listSentimentDetectionJobsPaginator(ListSentimentDetectionJobsRequest listSentimentDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of sentiment detection jobs that you have submitted.
This is a variant of
listSentimentDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListSentimentDetectionJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.comprehend.paginators.ListSentimentDetectionJobsIterable responses = client.listSentimentDetectionJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.comprehend.paginators.ListSentimentDetectionJobsIterable responses = client .listSentimentDetectionJobsPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListSentimentDetectionJobsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.comprehend.paginators.ListSentimentDetectionJobsIterable responses = client.listSentimentDetectionJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listSentimentDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListSentimentDetectionJobsRequest)
operation.
listSentimentDetectionJobsRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the ListDocumentClassificationJobs
operation is invalid. Specify a
different filter.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListSentimentDetectionJobsIterable listSentimentDetectionJobsPaginator(Consumer<ListSentimentDetectionJobsRequest.Builder> listSentimentDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of sentiment detection jobs that you have submitted.
This is a variant of
listSentimentDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListSentimentDetectionJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.comprehend.paginators.ListSentimentDetectionJobsIterable responses = client.listSentimentDetectionJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.comprehend.paginators.ListSentimentDetectionJobsIterable responses = client .listSentimentDetectionJobsPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListSentimentDetectionJobsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.comprehend.paginators.ListSentimentDetectionJobsIterable responses = client.listSentimentDetectionJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listSentimentDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListSentimentDetectionJobsRequest)
operation.
This is a convenience which creates an instance of the ListSentimentDetectionJobsRequest.Builder
avoiding
the need to create one manually via ListSentimentDetectionJobsRequest.builder()
listSentimentDetectionJobsRequest
- A Consumer
that will call methods on ListSentimentDetectionJobsRequest.Builder
to create a
request.InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the ListDocumentClassificationJobs
operation is invalid. Specify a
different filter.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTopicsDetectionJobsResponse listTopicsDetectionJobs() throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the topic detection jobs that you have submitted.
InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the ListDocumentClassificationJobs
operation is invalid. Specify a
different filter.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listTopicsDetectionJobs(ListTopicsDetectionJobsRequest)
,
AWS API Documentationdefault ListTopicsDetectionJobsResponse listTopicsDetectionJobs(ListTopicsDetectionJobsRequest listTopicsDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the topic detection jobs that you have submitted.
listTopicsDetectionJobsRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the ListDocumentClassificationJobs
operation is invalid. Specify a
different filter.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTopicsDetectionJobsResponse listTopicsDetectionJobs(Consumer<ListTopicsDetectionJobsRequest.Builder> listTopicsDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the topic detection jobs that you have submitted.
This is a convenience which creates an instance of the ListTopicsDetectionJobsRequest.Builder
avoiding
the need to create one manually via ListTopicsDetectionJobsRequest.builder()
listTopicsDetectionJobsRequest
- A Consumer
that will call methods on ListTopicsDetectionJobsRequest.Builder
to create a
request.InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the ListDocumentClassificationJobs
operation is invalid. Specify a
different filter.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTopicsDetectionJobsIterable listTopicsDetectionJobsPaginator() throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the topic detection jobs that you have submitted.
This is a variant of
listTopicsDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListTopicsDetectionJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.comprehend.paginators.ListTopicsDetectionJobsIterable responses = client.listTopicsDetectionJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.comprehend.paginators.ListTopicsDetectionJobsIterable responses = client .listTopicsDetectionJobsPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListTopicsDetectionJobsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.comprehend.paginators.ListTopicsDetectionJobsIterable responses = client.listTopicsDetectionJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listTopicsDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListTopicsDetectionJobsRequest)
operation.
InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the ListDocumentClassificationJobs
operation is invalid. Specify a
different filter.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listTopicsDetectionJobsPaginator(ListTopicsDetectionJobsRequest)
,
AWS API Documentationdefault ListTopicsDetectionJobsIterable listTopicsDetectionJobsPaginator(ListTopicsDetectionJobsRequest listTopicsDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the topic detection jobs that you have submitted.
This is a variant of
listTopicsDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListTopicsDetectionJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.comprehend.paginators.ListTopicsDetectionJobsIterable responses = client.listTopicsDetectionJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.comprehend.paginators.ListTopicsDetectionJobsIterable responses = client .listTopicsDetectionJobsPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListTopicsDetectionJobsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.comprehend.paginators.ListTopicsDetectionJobsIterable responses = client.listTopicsDetectionJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listTopicsDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListTopicsDetectionJobsRequest)
operation.
listTopicsDetectionJobsRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the ListDocumentClassificationJobs
operation is invalid. Specify a
different filter.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTopicsDetectionJobsIterable listTopicsDetectionJobsPaginator(Consumer<ListTopicsDetectionJobsRequest.Builder> listTopicsDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the topic detection jobs that you have submitted.
This is a variant of
listTopicsDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListTopicsDetectionJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.comprehend.paginators.ListTopicsDetectionJobsIterable responses = client.listTopicsDetectionJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.comprehend.paginators.ListTopicsDetectionJobsIterable responses = client .listTopicsDetectionJobsPaginator(request); for (software.amazon.awssdk.services.comprehend.model.ListTopicsDetectionJobsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.comprehend.paginators.ListTopicsDetectionJobsIterable responses = client.listTopicsDetectionJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listTopicsDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListTopicsDetectionJobsRequest)
operation.
This is a convenience which creates an instance of the ListTopicsDetectionJobsRequest.Builder
avoiding
the need to create one manually via ListTopicsDetectionJobsRequest.builder()
listTopicsDetectionJobsRequest
- A Consumer
that will call methods on ListTopicsDetectionJobsRequest.Builder
to create a
request.InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the ListDocumentClassificationJobs
operation is invalid. Specify a
different filter.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartDocumentClassificationJobResponse startDocumentClassificationJob(StartDocumentClassificationJobRequest startDocumentClassificationJobRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, ResourceUnavailableException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Starts an asynchronous document classification job. Use the operation to track the progress of the job.
startDocumentClassificationJobRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.ResourceNotFoundException
- The specified resource ARN was not found. Check the ARN and try your request again.ResourceUnavailableException
- The specified resource is not available. Check to see if the resource is in the TRAINED
state and try your request again.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartDocumentClassificationJobResponse startDocumentClassificationJob(Consumer<StartDocumentClassificationJobRequest.Builder> startDocumentClassificationJobRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, ResourceUnavailableException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Starts an asynchronous document classification job. Use the operation to track the progress of the job.
This is a convenience which creates an instance of the StartDocumentClassificationJobRequest.Builder
avoiding the need to create one manually via StartDocumentClassificationJobRequest.builder()
startDocumentClassificationJobRequest
- A Consumer
that will call methods on StartDocumentClassificationJobRequest.Builder
to
create a request.InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.ResourceNotFoundException
- The specified resource ARN was not found. Check the ARN and try your request again.ResourceUnavailableException
- The specified resource is not available. Check to see if the resource is in the TRAINED
state and try your request again.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartDominantLanguageDetectionJobResponse startDominantLanguageDetectionJob(StartDominantLanguageDetectionJobRequest startDominantLanguageDetectionJobRequest) throws InvalidRequestException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Starts an asynchronous dominant language detection job for a collection of documents. Use the operation to track the status of a job.
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartDominantLanguageDetectionJobResponse startDominantLanguageDetectionJob(Consumer<StartDominantLanguageDetectionJobRequest.Builder> startDominantLanguageDetectionJobRequest) throws InvalidRequestException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Starts an asynchronous dominant language detection job for a collection of documents. Use the operation to track the status of a job.
This is a convenience which creates an instance of the StartDominantLanguageDetectionJobRequest.Builder
avoiding the need to create one manually via StartDominantLanguageDetectionJobRequest.builder()
startDominantLanguageDetectionJobRequest
- A Consumer
that will call methods on StartDominantLanguageDetectionJobRequest.Builder
to
create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartEntitiesDetectionJobResponse startEntitiesDetectionJob(StartEntitiesDetectionJobRequest startEntitiesDetectionJobRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, ResourceUnavailableException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Starts an asynchronous entity detection job for a collection of documents. Use the operation to track the status of a job.
This API can be used for either standard entity detection or custom entity recognition. In order to be used for
custom entity recognition, the optional EntityRecognizerArn
must be used in order to provide access
to the recognizer being used to detect the custom entity.
startEntitiesDetectionJobRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.ResourceNotFoundException
- The specified resource ARN was not found. Check the ARN and try your request again.ResourceUnavailableException
- The specified resource is not available. Check to see if the resource is in the TRAINED
state and try your request again.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartEntitiesDetectionJobResponse startEntitiesDetectionJob(Consumer<StartEntitiesDetectionJobRequest.Builder> startEntitiesDetectionJobRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, ResourceUnavailableException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Starts an asynchronous entity detection job for a collection of documents. Use the operation to track the status of a job.
This API can be used for either standard entity detection or custom entity recognition. In order to be used for
custom entity recognition, the optional EntityRecognizerArn
must be used in order to provide access
to the recognizer being used to detect the custom entity.
This is a convenience which creates an instance of the StartEntitiesDetectionJobRequest.Builder
avoiding
the need to create one manually via StartEntitiesDetectionJobRequest.builder()
startEntitiesDetectionJobRequest
- A Consumer
that will call methods on StartEntitiesDetectionJobRequest.Builder
to create a
request.InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.ResourceNotFoundException
- The specified resource ARN was not found. Check the ARN and try your request again.ResourceUnavailableException
- The specified resource is not available. Check to see if the resource is in the TRAINED
state and try your request again.InternalServerException
- An internal server error occurred. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartKeyPhrasesDetectionJobResponse startKeyPhrasesDetectionJob(StartKeyPhrasesDetectionJobRequest startKeyPhrasesDetectionJobRequest) throws InvalidRequestException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Starts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the status of a job.
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartKeyPhrasesDetectionJobResponse startKeyPhrasesDetectionJob(Consumer<StartKeyPhrasesDetectionJobRequest.Builder> startKeyPhrasesDetectionJobRequest) throws InvalidRequestException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Starts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the status of a job.
This is a convenience which creates an instance of the StartKeyPhrasesDetectionJobRequest.Builder
avoiding the need to create one manually via StartKeyPhrasesDetectionJobRequest.builder()
startKeyPhrasesDetectionJobRequest
- A Consumer
that will call methods on StartKeyPhrasesDetectionJobRequest.Builder
to create
a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartSentimentDetectionJobResponse startSentimentDetectionJob(StartSentimentDetectionJobRequest startSentimentDetectionJobRequest) throws InvalidRequestException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Starts an asynchronous sentiment detection job for a collection of documents. use the operation to track the status of a job.
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartSentimentDetectionJobResponse startSentimentDetectionJob(Consumer<StartSentimentDetectionJobRequest.Builder> startSentimentDetectionJobRequest) throws InvalidRequestException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Starts an asynchronous sentiment detection job for a collection of documents. use the operation to track the status of a job.
This is a convenience which creates an instance of the StartSentimentDetectionJobRequest.Builder
avoiding
the need to create one manually via StartSentimentDetectionJobRequest.builder()
startSentimentDetectionJobRequest
- A Consumer
that will call methods on StartSentimentDetectionJobRequest.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartTopicsDetectionJobResponse startTopicsDetectionJob(StartTopicsDetectionJobRequest startTopicsDetectionJobRequest) throws InvalidRequestException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob
operation to track the
status of a job.
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartTopicsDetectionJobResponse startTopicsDetectionJob(Consumer<StartTopicsDetectionJobRequest.Builder> startTopicsDetectionJobRequest) throws InvalidRequestException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob
operation to track the
status of a job.
This is a convenience which creates an instance of the StartTopicsDetectionJobRequest.Builder
avoiding
the need to create one manually via StartTopicsDetectionJobRequest.builder()
startTopicsDetectionJobRequest
- A Consumer
that will call methods on StartTopicsDetectionJobRequest.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StopDominantLanguageDetectionJobResponse stopDominantLanguageDetectionJob(StopDominantLanguageDetectionJobRequest stopDominantLanguageDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StopDominantLanguageDetectionJobResponse stopDominantLanguageDetectionJob(Consumer<StopDominantLanguageDetectionJobRequest.Builder> stopDominantLanguageDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.
This is a convenience which creates an instance of the StopDominantLanguageDetectionJobRequest.Builder
avoiding the need to create one manually via StopDominantLanguageDetectionJobRequest.builder()
stopDominantLanguageDetectionJobRequest
- A Consumer
that will call methods on StopDominantLanguageDetectionJobRequest.Builder
to
create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StopEntitiesDetectionJobResponse stopEntitiesDetectionJob(StopEntitiesDetectionJobRequest stopEntitiesDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StopEntitiesDetectionJobResponse stopEntitiesDetectionJob(Consumer<StopEntitiesDetectionJobRequest.Builder> stopEntitiesDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.
This is a convenience which creates an instance of the StopEntitiesDetectionJobRequest.Builder
avoiding
the need to create one manually via StopEntitiesDetectionJobRequest.builder()
stopEntitiesDetectionJobRequest
- A Consumer
that will call methods on StopEntitiesDetectionJobRequest.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StopKeyPhrasesDetectionJobResponse stopKeyPhrasesDetectionJob(StopKeyPhrasesDetectionJobRequest stopKeyPhrasesDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StopKeyPhrasesDetectionJobResponse stopKeyPhrasesDetectionJob(Consumer<StopKeyPhrasesDetectionJobRequest.Builder> stopKeyPhrasesDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.
This is a convenience which creates an instance of the StopKeyPhrasesDetectionJobRequest.Builder
avoiding
the need to create one manually via StopKeyPhrasesDetectionJobRequest.builder()
stopKeyPhrasesDetectionJobRequest
- A Consumer
that will call methods on StopKeyPhrasesDetectionJobRequest.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StopSentimentDetectionJobResponse stopSentimentDetectionJob(StopSentimentDetectionJobRequest stopSentimentDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StopSentimentDetectionJobResponse stopSentimentDetectionJob(Consumer<StopSentimentDetectionJobRequest.Builder> stopSentimentDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
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.
This is a convenience which creates an instance of the StopSentimentDetectionJobRequest.Builder
avoiding
the need to create one manually via StopSentimentDetectionJobRequest.builder()
stopSentimentDetectionJobRequest
- A Consumer
that will call methods on StopSentimentDetectionJobRequest.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ComprehendException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
static ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.