@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface ComprehendClient extends AwsClient
builder() method.
Amazon Comprehend is an Amazon Web Services 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_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
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.
|
default BatchDetectTargetedSentimentResponse |
batchDetectTargetedSentiment(BatchDetectTargetedSentimentRequest batchDetectTargetedSentimentRequest)
Inspects a batch of documents and returns a sentiment analysis for each entity identified in the documents.
|
default BatchDetectTargetedSentimentResponse |
batchDetectTargetedSentiment(Consumer<BatchDetectTargetedSentimentRequest.Builder> batchDetectTargetedSentimentRequest)
Inspects a batch of documents and returns a sentiment analysis for each entity identified in the documents.
|
static ComprehendClientBuilder |
builder()
Create a builder that can be used to configure and create a
ComprehendClient. |
default ClassifyDocumentResponse |
classifyDocument(ClassifyDocumentRequest classifyDocumentRequest)
Creates a new document classification request to analyze a single document in real-time, using a previously
created and trained custom model and an endpoint.
|
default ClassifyDocumentResponse |
classifyDocument(Consumer<ClassifyDocumentRequest.Builder> classifyDocumentRequest)
Creates a new document classification request to analyze a single document in real-time, using a previously
created and trained custom model and an endpoint.
|
default ContainsPiiEntitiesResponse |
containsPiiEntities(Consumer<ContainsPiiEntitiesRequest.Builder> containsPiiEntitiesRequest)
Analyzes input text for the presence of personally identifiable information (PII) and returns the labels of
identified PII entity types such as name, address, bank account number, or phone number.
|
default ContainsPiiEntitiesResponse |
containsPiiEntities(ContainsPiiEntitiesRequest containsPiiEntitiesRequest)
Analyzes input text for the presence of personally identifiable information (PII) and returns the labels of
identified PII entity types such as name, address, bank account number, or phone number.
|
static ComprehendClient |
create()
Create a
ComprehendClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateDatasetResponse |
createDataset(Consumer<CreateDatasetRequest.Builder> createDatasetRequest)
Creates a dataset to upload training or test data for a model associated with a flywheel.
|
default CreateDatasetResponse |
createDataset(CreateDatasetRequest createDatasetRequest)
Creates a dataset to upload training or test data for a model associated with a flywheel.
|
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 CreateEndpointResponse |
createEndpoint(Consumer<CreateEndpointRequest.Builder> createEndpointRequest)
Creates a model-specific endpoint for synchronous inference for a previously trained custom model For information
about endpoints, see Managing
endpoints.
|
default CreateEndpointResponse |
createEndpoint(CreateEndpointRequest createEndpointRequest)
Creates a model-specific endpoint for synchronous inference for a previously trained custom model For information
about endpoints, see Managing
endpoints.
|
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 CreateFlywheelResponse |
createFlywheel(Consumer<CreateFlywheelRequest.Builder> createFlywheelRequest)
A flywheel is an Amazon Web Services resource that orchestrates the ongoing training of a model for custom
classification or custom entity recognition.
|
default CreateFlywheelResponse |
createFlywheel(CreateFlywheelRequest createFlywheelRequest)
A flywheel is an Amazon Web Services resource that orchestrates the ongoing training of a model for custom
classification or custom entity recognition.
|
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 DeleteEndpointResponse |
deleteEndpoint(Consumer<DeleteEndpointRequest.Builder> deleteEndpointRequest)
Deletes a model-specific endpoint for a previously-trained custom model.
|
default DeleteEndpointResponse |
deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest)
Deletes a model-specific endpoint for a previously-trained custom model.
|
default DeleteEntityRecognizerResponse |
deleteEntityRecognizer(Consumer<DeleteEntityRecognizerRequest.Builder> deleteEntityRecognizerRequest)
Deletes an entity recognizer.
|
default DeleteEntityRecognizerResponse |
deleteEntityRecognizer(DeleteEntityRecognizerRequest deleteEntityRecognizerRequest)
Deletes an entity recognizer.
|
default DeleteFlywheelResponse |
deleteFlywheel(Consumer<DeleteFlywheelRequest.Builder> deleteFlywheelRequest)
Deletes a flywheel.
|
default DeleteFlywheelResponse |
deleteFlywheel(DeleteFlywheelRequest deleteFlywheelRequest)
Deletes a flywheel.
|
default DeleteResourcePolicyResponse |
deleteResourcePolicy(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest)
Deletes a resource-based policy that is attached to a custom model.
|
default DeleteResourcePolicyResponse |
deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest)
Deletes a resource-based policy that is attached to a custom model.
|
default DescribeDatasetResponse |
describeDataset(Consumer<DescribeDatasetRequest.Builder> describeDatasetRequest)
Returns information about the dataset that you specify.
|
default DescribeDatasetResponse |
describeDataset(DescribeDatasetRequest describeDatasetRequest)
Returns information about the dataset that you specify.
|
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 DescribeEndpointResponse |
describeEndpoint(Consumer<DescribeEndpointRequest.Builder> describeEndpointRequest)
Gets the properties associated with a specific endpoint.
|
default DescribeEndpointResponse |
describeEndpoint(DescribeEndpointRequest describeEndpointRequest)
Gets the properties associated with a specific endpoint.
|
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 DescribeEventsDetectionJobResponse |
describeEventsDetectionJob(Consumer<DescribeEventsDetectionJobRequest.Builder> describeEventsDetectionJobRequest)
Gets the status and details of an events detection job.
|
default DescribeEventsDetectionJobResponse |
describeEventsDetectionJob(DescribeEventsDetectionJobRequest describeEventsDetectionJobRequest)
Gets the status and details of an events detection job.
|
default DescribeFlywheelResponse |
describeFlywheel(Consumer<DescribeFlywheelRequest.Builder> describeFlywheelRequest)
Provides configuration information about the flywheel.
|
default DescribeFlywheelResponse |
describeFlywheel(DescribeFlywheelRequest describeFlywheelRequest)
Provides configuration information about the flywheel.
|
default DescribeFlywheelIterationResponse |
describeFlywheelIteration(Consumer<DescribeFlywheelIterationRequest.Builder> describeFlywheelIterationRequest)
Retrieve the configuration properties of a flywheel iteration.
|
default DescribeFlywheelIterationResponse |
describeFlywheelIteration(DescribeFlywheelIterationRequest describeFlywheelIterationRequest)
Retrieve the configuration properties of a flywheel iteration.
|
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 DescribePiiEntitiesDetectionJobResponse |
describePiiEntitiesDetectionJob(Consumer<DescribePiiEntitiesDetectionJobRequest.Builder> describePiiEntitiesDetectionJobRequest)
Gets the properties associated with a PII entities detection job.
|
default DescribePiiEntitiesDetectionJobResponse |
describePiiEntitiesDetectionJob(DescribePiiEntitiesDetectionJobRequest describePiiEntitiesDetectionJobRequest)
Gets the properties associated with a PII entities detection job.
|
default DescribeResourcePolicyResponse |
describeResourcePolicy(Consumer<DescribeResourcePolicyRequest.Builder> describeResourcePolicyRequest)
Gets the details of a resource-based policy that is attached to a custom model, including the JSON body of the
policy.
|
default DescribeResourcePolicyResponse |
describeResourcePolicy(DescribeResourcePolicyRequest describeResourcePolicyRequest)
Gets the details of a resource-based policy that is attached to a custom model, including the JSON body of the
policy.
|
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 DescribeTargetedSentimentDetectionJobResponse |
describeTargetedSentimentDetectionJob(Consumer<DescribeTargetedSentimentDetectionJobRequest.Builder> describeTargetedSentimentDetectionJobRequest)
Gets the properties associated with a targeted sentiment detection job.
|
default DescribeTargetedSentimentDetectionJobResponse |
describeTargetedSentimentDetectionJob(DescribeTargetedSentimentDetectionJobRequest describeTargetedSentimentDetectionJobRequest)
Gets the properties associated with a targeted 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)
Detects named entities in input text when you use the pre-trained model.
|
default DetectEntitiesResponse |
detectEntities(DetectEntitiesRequest detectEntitiesRequest)
Detects named entities in input text when you use the pre-trained model.
|
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 DetectPiiEntitiesResponse |
detectPiiEntities(Consumer<DetectPiiEntitiesRequest.Builder> detectPiiEntitiesRequest)
Inspects the input text for entities that contain personally identifiable information (PII) and returns
information about them.
|
default DetectPiiEntitiesResponse |
detectPiiEntities(DetectPiiEntitiesRequest detectPiiEntitiesRequest)
Inspects the input text for entities that contain personally identifiable information (PII) and returns
information about them.
|
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 DetectTargetedSentimentResponse |
detectTargetedSentiment(Consumer<DetectTargetedSentimentRequest.Builder> detectTargetedSentimentRequest)
Inspects the input text and returns a sentiment analysis for each entity identified in the text.
|
default DetectTargetedSentimentResponse |
detectTargetedSentiment(DetectTargetedSentimentRequest detectTargetedSentimentRequest)
Inspects the input text and returns a sentiment analysis for each entity identified in the text.
|
default ImportModelResponse |
importModel(Consumer<ImportModelRequest.Builder> importModelRequest)
Creates a new custom model that replicates a source custom model that you import.
|
default ImportModelResponse |
importModel(ImportModelRequest importModelRequest)
Creates a new custom model that replicates a source custom model that you import.
|
default ListDatasetsResponse |
listDatasets(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest)
List the datasets that you have configured in this Region.
|
default ListDatasetsResponse |
listDatasets(ListDatasetsRequest listDatasetsRequest)
List the datasets that you have configured in this Region.
|
default ListDatasetsIterable |
listDatasetsPaginator(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest)
List the datasets that you have configured in this Region.
|
default ListDatasetsIterable |
listDatasetsPaginator(ListDatasetsRequest listDatasetsRequest)
List the datasets that you have configured in this Region.
|
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 ListDocumentClassificationJobsIterable |
listDocumentClassificationJobsPaginator()
Gets a list of the documentation classification jobs that you have submitted.
|
default ListDocumentClassificationJobsIterable |
listDocumentClassificationJobsPaginator(Consumer<ListDocumentClassificationJobsRequest.Builder> listDocumentClassificationJobsRequest)
Gets a list of the documentation classification jobs that you have submitted.
|
default ListDocumentClassificationJobsIterable |
listDocumentClassificationJobsPaginator(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 ListDocumentClassifiersIterable |
listDocumentClassifiersPaginator()
Gets a list of the document classifiers that you have created.
|
default ListDocumentClassifiersIterable |
listDocumentClassifiersPaginator(Consumer<ListDocumentClassifiersRequest.Builder> listDocumentClassifiersRequest)
Gets a list of the document classifiers that you have created.
|
default ListDocumentClassifiersIterable |
listDocumentClassifiersPaginator(ListDocumentClassifiersRequest listDocumentClassifiersRequest)
Gets a list of the document classifiers that you have created.
|
default ListDocumentClassifierSummariesResponse |
listDocumentClassifierSummaries(Consumer<ListDocumentClassifierSummariesRequest.Builder> listDocumentClassifierSummariesRequest)
Gets a list of summaries of the document classifiers that you have created
|
default ListDocumentClassifierSummariesResponse |
listDocumentClassifierSummaries(ListDocumentClassifierSummariesRequest listDocumentClassifierSummariesRequest)
Gets a list of summaries of the document classifiers that you have created
|
default ListDocumentClassifierSummariesIterable |
listDocumentClassifierSummariesPaginator(Consumer<ListDocumentClassifierSummariesRequest.Builder> listDocumentClassifierSummariesRequest)
Gets a list of summaries of the document classifiers that you have created
|
default ListDocumentClassifierSummariesIterable |
listDocumentClassifierSummariesPaginator(ListDocumentClassifierSummariesRequest listDocumentClassifierSummariesRequest)
Gets a list of summaries 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 ListEndpointsResponse |
listEndpoints(Consumer<ListEndpointsRequest.Builder> listEndpointsRequest)
Gets a list of all existing endpoints that you've created.
|
default ListEndpointsResponse |
listEndpoints(ListEndpointsRequest listEndpointsRequest)
Gets a list of all existing endpoints that you've created.
|
default ListEndpointsIterable |
listEndpointsPaginator(Consumer<ListEndpointsRequest.Builder> listEndpointsRequest)
Gets a list of all existing endpoints that you've created.
|
default ListEndpointsIterable |
listEndpointsPaginator(ListEndpointsRequest listEndpointsRequest)
Gets a list of all existing endpoints that you've created.
|
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 ListEntityRecognizersIterable |
listEntityRecognizersPaginator()
Gets a list of the properties of all entity recognizers that you created, including recognizers currently in
training.
|
default ListEntityRecognizersIterable |
listEntityRecognizersPaginator(Consumer<ListEntityRecognizersRequest.Builder> listEntityRecognizersRequest)
Gets a list of the properties of all entity recognizers that you created, including recognizers currently in
training.
|
default ListEntityRecognizersIterable |
listEntityRecognizersPaginator(ListEntityRecognizersRequest listEntityRecognizersRequest)
Gets a list of the properties of all entity recognizers that you created, including recognizers currently in
training.
|
default ListEntityRecognizerSummariesResponse |
listEntityRecognizerSummaries(Consumer<ListEntityRecognizerSummariesRequest.Builder> listEntityRecognizerSummariesRequest)
Gets a list of summaries for the entity recognizers that you have created.
|
default ListEntityRecognizerSummariesResponse |
listEntityRecognizerSummaries(ListEntityRecognizerSummariesRequest listEntityRecognizerSummariesRequest)
Gets a list of summaries for the entity recognizers that you have created.
|
default ListEntityRecognizerSummariesIterable |
listEntityRecognizerSummariesPaginator(Consumer<ListEntityRecognizerSummariesRequest.Builder> listEntityRecognizerSummariesRequest)
Gets a list of summaries for the entity recognizers that you have created.
|
default ListEntityRecognizerSummariesIterable |
listEntityRecognizerSummariesPaginator(ListEntityRecognizerSummariesRequest listEntityRecognizerSummariesRequest)
Gets a list of summaries for the entity recognizers that you have created.
|
default ListEventsDetectionJobsResponse |
listEventsDetectionJobs(Consumer<ListEventsDetectionJobsRequest.Builder> listEventsDetectionJobsRequest)
Gets a list of the events detection jobs that you have submitted.
|
default ListEventsDetectionJobsResponse |
listEventsDetectionJobs(ListEventsDetectionJobsRequest listEventsDetectionJobsRequest)
Gets a list of the events detection jobs that you have submitted.
|
default ListEventsDetectionJobsIterable |
listEventsDetectionJobsPaginator(Consumer<ListEventsDetectionJobsRequest.Builder> listEventsDetectionJobsRequest)
Gets a list of the events detection jobs that you have submitted.
|
default ListEventsDetectionJobsIterable |
listEventsDetectionJobsPaginator(ListEventsDetectionJobsRequest listEventsDetectionJobsRequest)
Gets a list of the events detection jobs that you have submitted.
|
default ListFlywheelIterationHistoryResponse |
listFlywheelIterationHistory(Consumer<ListFlywheelIterationHistoryRequest.Builder> listFlywheelIterationHistoryRequest)
Information about the history of a flywheel iteration.
|
default ListFlywheelIterationHistoryResponse |
listFlywheelIterationHistory(ListFlywheelIterationHistoryRequest listFlywheelIterationHistoryRequest)
Information about the history of a flywheel iteration.
|
default ListFlywheelIterationHistoryIterable |
listFlywheelIterationHistoryPaginator(Consumer<ListFlywheelIterationHistoryRequest.Builder> listFlywheelIterationHistoryRequest)
Information about the history of a flywheel iteration.
|
default ListFlywheelIterationHistoryIterable |
listFlywheelIterationHistoryPaginator(ListFlywheelIterationHistoryRequest listFlywheelIterationHistoryRequest)
Information about the history of a flywheel iteration.
|
default ListFlywheelsResponse |
listFlywheels(Consumer<ListFlywheelsRequest.Builder> listFlywheelsRequest)
Gets a list of the flywheels that you have created.
|
default ListFlywheelsResponse |
listFlywheels(ListFlywheelsRequest listFlywheelsRequest)
Gets a list of the flywheels that you have created.
|
default ListFlywheelsIterable |
listFlywheelsPaginator(Consumer<ListFlywheelsRequest.Builder> listFlywheelsRequest)
Gets a list of the flywheels that you have created.
|
default ListFlywheelsIterable |
listFlywheelsPaginator(ListFlywheelsRequest listFlywheelsRequest)
Gets a list of the flywheels that you have created.
|
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 ListPiiEntitiesDetectionJobsResponse |
listPiiEntitiesDetectionJobs(Consumer<ListPiiEntitiesDetectionJobsRequest.Builder> listPiiEntitiesDetectionJobsRequest)
Gets a list of the PII entity detection jobs that you have submitted.
|
default ListPiiEntitiesDetectionJobsResponse |
listPiiEntitiesDetectionJobs(ListPiiEntitiesDetectionJobsRequest listPiiEntitiesDetectionJobsRequest)
Gets a list of the PII entity detection jobs that you have submitted.
|
default ListPiiEntitiesDetectionJobsIterable |
listPiiEntitiesDetectionJobsPaginator(Consumer<ListPiiEntitiesDetectionJobsRequest.Builder> listPiiEntitiesDetectionJobsRequest)
Gets a list of the PII entity detection jobs that you have submitted.
|
default ListPiiEntitiesDetectionJobsIterable |
listPiiEntitiesDetectionJobsPaginator(ListPiiEntitiesDetectionJobsRequest listPiiEntitiesDetectionJobsRequest)
Gets a list of the PII entity 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 ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists all tags associated with a given Amazon Comprehend resource.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags associated with a given Amazon Comprehend resource.
|
default ListTargetedSentimentDetectionJobsResponse |
listTargetedSentimentDetectionJobs(Consumer<ListTargetedSentimentDetectionJobsRequest.Builder> listTargetedSentimentDetectionJobsRequest)
Gets a list of targeted sentiment detection jobs that you have submitted.
|
default ListTargetedSentimentDetectionJobsResponse |
listTargetedSentimentDetectionJobs(ListTargetedSentimentDetectionJobsRequest listTargetedSentimentDetectionJobsRequest)
Gets a list of targeted sentiment detection jobs that you have submitted.
|
default ListTargetedSentimentDetectionJobsIterable |
listTargetedSentimentDetectionJobsPaginator(Consumer<ListTargetedSentimentDetectionJobsRequest.Builder> listTargetedSentimentDetectionJobsRequest)
Gets a list of targeted sentiment detection jobs that you have submitted.
|
default ListTargetedSentimentDetectionJobsIterable |
listTargetedSentimentDetectionJobsPaginator(ListTargetedSentimentDetectionJobsRequest listTargetedSentimentDetectionJobsRequest)
Gets a list of targeted 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.
|
default PutResourcePolicyResponse |
putResourcePolicy(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest)
Attaches a resource-based policy to a custom model.
|
default PutResourcePolicyResponse |
putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest)
Attaches a resource-based policy to a custom model.
|
default ComprehendServiceClientConfiguration |
serviceClientConfiguration() |
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 StartEventsDetectionJobResponse |
startEventsDetectionJob(Consumer<StartEventsDetectionJobRequest.Builder> startEventsDetectionJobRequest)
Starts an asynchronous event detection job for a collection of documents.
|
default StartEventsDetectionJobResponse |
startEventsDetectionJob(StartEventsDetectionJobRequest startEventsDetectionJobRequest)
Starts an asynchronous event detection job for a collection of documents.
|
default StartFlywheelIterationResponse |
startFlywheelIteration(Consumer<StartFlywheelIterationRequest.Builder> startFlywheelIterationRequest)
Start the flywheel iteration.This operation uses any new datasets to train a new model version.
|
default StartFlywheelIterationResponse |
startFlywheelIteration(StartFlywheelIterationRequest startFlywheelIterationRequest)
Start the flywheel iteration.This operation uses any new datasets to train a new model version.
|
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 StartPiiEntitiesDetectionJobResponse |
startPiiEntitiesDetectionJob(Consumer<StartPiiEntitiesDetectionJobRequest.Builder> startPiiEntitiesDetectionJobRequest)
Starts an asynchronous PII entity detection job for a collection of documents.
|
default StartPiiEntitiesDetectionJobResponse |
startPiiEntitiesDetectionJob(StartPiiEntitiesDetectionJobRequest startPiiEntitiesDetectionJobRequest)
Starts an asynchronous PII entity 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 StartTargetedSentimentDetectionJobResponse |
startTargetedSentimentDetectionJob(Consumer<StartTargetedSentimentDetectionJobRequest.Builder> startTargetedSentimentDetectionJobRequest)
Starts an asynchronous targeted sentiment detection job for a collection of documents.
|
default StartTargetedSentimentDetectionJobResponse |
startTargetedSentimentDetectionJob(StartTargetedSentimentDetectionJobRequest startTargetedSentimentDetectionJobRequest)
Starts an asynchronous targeted 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 StopEventsDetectionJobResponse |
stopEventsDetectionJob(Consumer<StopEventsDetectionJobRequest.Builder> stopEventsDetectionJobRequest)
Stops an events detection job in progress.
|
default StopEventsDetectionJobResponse |
stopEventsDetectionJob(StopEventsDetectionJobRequest stopEventsDetectionJobRequest)
Stops an events 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 StopPiiEntitiesDetectionJobResponse |
stopPiiEntitiesDetectionJob(Consumer<StopPiiEntitiesDetectionJobRequest.Builder> stopPiiEntitiesDetectionJobRequest)
Stops a PII entities detection job in progress.
|
default StopPiiEntitiesDetectionJobResponse |
stopPiiEntitiesDetectionJob(StopPiiEntitiesDetectionJobRequest stopPiiEntitiesDetectionJobRequest)
Stops a PII entities 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.
|
default StopTargetedSentimentDetectionJobResponse |
stopTargetedSentimentDetectionJob(Consumer<StopTargetedSentimentDetectionJobRequest.Builder> stopTargetedSentimentDetectionJobRequest)
Stops a targeted sentiment detection job in progress.
|
default StopTargetedSentimentDetectionJobResponse |
stopTargetedSentimentDetectionJob(StopTargetedSentimentDetectionJobRequest stopTargetedSentimentDetectionJobRequest)
Stops a targeted sentiment detection job in progress.
|
default StopTrainingDocumentClassifierResponse |
stopTrainingDocumentClassifier(Consumer<StopTrainingDocumentClassifierRequest.Builder> stopTrainingDocumentClassifierRequest)
Stops a document classifier training job while in progress.
|
default StopTrainingDocumentClassifierResponse |
stopTrainingDocumentClassifier(StopTrainingDocumentClassifierRequest stopTrainingDocumentClassifierRequest)
Stops a document classifier training job while in progress.
|
default StopTrainingEntityRecognizerResponse |
stopTrainingEntityRecognizer(Consumer<StopTrainingEntityRecognizerRequest.Builder> stopTrainingEntityRecognizerRequest)
Stops an entity recognizer training job while in progress.
|
default StopTrainingEntityRecognizerResponse |
stopTrainingEntityRecognizer(StopTrainingEntityRecognizerRequest stopTrainingEntityRecognizerRequest)
Stops an entity recognizer training job while in progress.
|
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Associates a specific tag with an Amazon Comprehend resource.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Associates a specific tag with an Amazon Comprehend resource.
|
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes a specific tag associated with an Amazon Comprehend resource.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Removes a specific tag associated with an Amazon Comprehend resource.
|
default UpdateEndpointResponse |
updateEndpoint(Consumer<UpdateEndpointRequest.Builder> updateEndpointRequest)
Updates information about the specified endpoint.
|
default UpdateEndpointResponse |
updateEndpoint(UpdateEndpointRequest updateEndpointRequest)
Updates information about the specified endpoint.
|
default UpdateFlywheelResponse |
updateFlywheel(Consumer<UpdateFlywheelRequest.Builder> updateFlywheelRequest)
Update the configuration information for an existing flywheel.
|
default UpdateFlywheelResponse |
updateFlywheel(UpdateFlywheelRequest updateFlywheelRequest)
Update the configuration information for an existing flywheel.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault 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 Entities in the Comprehend Developer Guide.
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 custom entity recognition APIs, only
English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages,
Supported
languages in the Comprehend Developer Guide.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.AwsServiceExceptiondefault 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 Entities in the Comprehend Developer Guide.
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 custom entity recognition APIs, only
English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages,
Supported
languages in the Comprehend Developer Guide.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.AwsServiceExceptiondefault 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 custom entity recognition APIs, only
English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages,
Supported
languages in the Comprehend Developer Guide.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.AwsServiceExceptiondefault 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 custom entity recognition APIs, only
English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages,
Supported
languages in the Comprehend Developer Guide.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.AwsServiceExceptiondefault 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 custom entity recognition APIs, only
English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages,
Supported
languages in the Comprehend Developer Guide.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.AwsServiceExceptiondefault 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 custom entity recognition APIs, only
English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages,
Supported
languages in the Comprehend Developer Guide.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.AwsServiceExceptiondefault 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 Syntax in the Comprehend Developer Guide.
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 custom entity recognition APIs, only
English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages,
Supported
languages in the Comprehend Developer Guide.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.AwsServiceExceptiondefault 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 Syntax in the Comprehend Developer Guide.
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 custom entity recognition APIs, only
English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages,
Supported
languages in the Comprehend Developer Guide.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.AwsServiceExceptiondefault BatchDetectTargetedSentimentResponse batchDetectTargetedSentiment(BatchDetectTargetedSentimentRequest batchDetectTargetedSentimentRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, BatchSizeLimitExceededException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Inspects a batch of documents and returns a sentiment analysis for each entity identified in the documents.
For more information about targeted sentiment, see Targeted sentiment.
batchDetectTargetedSentimentRequest - 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 custom entity recognition APIs, only
English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages,
Supported
languages in the Comprehend Developer Guide.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.AwsServiceExceptiondefault BatchDetectTargetedSentimentResponse batchDetectTargetedSentiment(Consumer<BatchDetectTargetedSentimentRequest.Builder> batchDetectTargetedSentimentRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, BatchSizeLimitExceededException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Inspects a batch of documents and returns a sentiment analysis for each entity identified in the documents.
For more information about targeted sentiment, see Targeted sentiment.
This is a convenience which creates an instance of the BatchDetectTargetedSentimentRequest.Builder
avoiding the need to create one manually via BatchDetectTargetedSentimentRequest.builder()
batchDetectTargetedSentimentRequest - A Consumer that will call methods on BatchDetectTargetedSentimentRequest.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 custom entity recognition APIs, only
English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages,
Supported
languages in the Comprehend Developer Guide.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.AwsServiceExceptiondefault ClassifyDocumentResponse classifyDocument(ClassifyDocumentRequest classifyDocumentRequest) throws InvalidRequestException, ResourceUnavailableException, TextSizeLimitExceededException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Creates a new document classification request to analyze a single document in real-time, using a previously created and trained custom model and an endpoint.
You can input plain text or you can upload a single-page input document (text, PDF, Word, or image).
If the system detects errors while processing a page in the input document, the API response includes an entry in
Errors that describes the errors.
If the system detects a document-level error in your input document, the API returns an
InvalidRequestException error response. For details about this exception, see Errors in semi-structured
documents in the Comprehend Developer Guide.
classifyDocumentRequest - InvalidRequestException - The request is invalid.ResourceUnavailableException - The specified resource is not available. Check the resource and try your request again.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.AwsServiceExceptiondefault ClassifyDocumentResponse classifyDocument(Consumer<ClassifyDocumentRequest.Builder> classifyDocumentRequest) throws InvalidRequestException, ResourceUnavailableException, TextSizeLimitExceededException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Creates a new document classification request to analyze a single document in real-time, using a previously created and trained custom model and an endpoint.
You can input plain text or you can upload a single-page input document (text, PDF, Word, or image).
If the system detects errors while processing a page in the input document, the API response includes an entry in
Errors that describes the errors.
If the system detects a document-level error in your input document, the API returns an
InvalidRequestException error response. For details about this exception, see Errors in semi-structured
documents in the Comprehend Developer Guide.
This is a convenience which creates an instance of the ClassifyDocumentRequest.Builder avoiding the need
to create one manually via ClassifyDocumentRequest.builder()
classifyDocumentRequest - A Consumer that will call methods on ClassifyDocumentRequest.Builder to create a request.InvalidRequestException - The request is invalid.ResourceUnavailableException - The specified resource is not available. Check the resource and try your request again.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.AwsServiceExceptiondefault ContainsPiiEntitiesResponse containsPiiEntities(ContainsPiiEntitiesRequest containsPiiEntitiesRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Analyzes input text for the presence of personally identifiable information (PII) and returns the labels of identified PII entity types such as name, address, bank account number, or phone number.
containsPiiEntitiesRequest - 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 custom entity recognition APIs, only
English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages,
Supported
languages in the Comprehend Developer Guide.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.AwsServiceExceptiondefault ContainsPiiEntitiesResponse containsPiiEntities(Consumer<ContainsPiiEntitiesRequest.Builder> containsPiiEntitiesRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Analyzes input text for the presence of personally identifiable information (PII) and returns the labels of identified PII entity types such as name, address, bank account number, or phone number.
This is a convenience which creates an instance of the ContainsPiiEntitiesRequest.Builder avoiding the
need to create one manually via ContainsPiiEntitiesRequest.builder()
containsPiiEntitiesRequest - A Consumer that will call methods on ContainsPiiEntitiesRequest.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 custom entity recognition APIs, only
English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages,
Supported
languages in the Comprehend Developer Guide.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.AwsServiceExceptiondefault CreateDatasetResponse createDataset(CreateDatasetRequest createDatasetRequest) throws InvalidRequestException, ResourceInUseException, TooManyTagsException, TooManyRequestsException, ResourceLimitExceededException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Creates a dataset to upload training or test data for a model associated with a flywheel. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.
createDatasetRequest - InvalidRequestException - The request is invalid.ResourceInUseException - The specified resource name is already in use. Use a different name and try your request again.TooManyTagsException - The request contains more tags than can be associated with a resource (50 tags per resource). The maximum
number of tags includes both existing tags and those included in your current request.TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.ResourceLimitExceededException - The maximum number of resources per account has been exceeded. Review the resources, and then try your
request again.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.AwsServiceExceptiondefault CreateDatasetResponse createDataset(Consumer<CreateDatasetRequest.Builder> createDatasetRequest) throws InvalidRequestException, ResourceInUseException, TooManyTagsException, TooManyRequestsException, ResourceLimitExceededException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Creates a dataset to upload training or test data for a model associated with a flywheel. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.
This is a convenience which creates an instance of the CreateDatasetRequest.Builder avoiding the need to
create one manually via CreateDatasetRequest.builder()
createDatasetRequest - A Consumer that will call methods on CreateDatasetRequest.Builder to create a request.InvalidRequestException - The request is invalid.ResourceInUseException - The specified resource name is already in use. Use a different name and try your request again.TooManyTagsException - The request contains more tags than can be associated with a resource (50 tags per resource). The maximum
number of tags includes both existing tags and those included in your current request.TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.ResourceLimitExceededException - The maximum number of resources per account has been exceeded. Review the resources, and then try your
request again.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.AwsServiceExceptiondefault CreateDocumentClassifierResponse createDocumentClassifier(CreateDocumentClassifierRequest createDocumentClassifierRequest) throws InvalidRequestException, ResourceInUseException, TooManyTagsException, TooManyRequestsException, ResourceLimitExceededException, UnsupportedLanguageException, KmsKeyValidationException, 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 are labeled with the categories that you want to use. For more information, see Training classifier models in the Comprehend Developer Guide.
createDocumentClassifierRequest - InvalidRequestException - The request is invalid.ResourceInUseException - The specified resource name is already in use. Use a different name and try your request again.TooManyTagsException - The request contains more tags than can be associated with a resource (50 tags per resource). The maximum
number of tags includes both existing tags and those included in your current request.TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.ResourceLimitExceededException - The maximum number of resources per account has been exceeded. Review the resources, and then try your
request again.UnsupportedLanguageException - Amazon Comprehend can't process the language of the input text. For custom entity recognition APIs, only
English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages,
Supported
languages in the Comprehend Developer Guide.KmsKeyValidationException - The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.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.AwsServiceExceptiondefault CreateDocumentClassifierResponse createDocumentClassifier(Consumer<CreateDocumentClassifierRequest.Builder> createDocumentClassifierRequest) throws InvalidRequestException, ResourceInUseException, TooManyTagsException, TooManyRequestsException, ResourceLimitExceededException, UnsupportedLanguageException, KmsKeyValidationException, 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 are labeled with the categories that you want to use. For more information, see Training classifier models in the Comprehend Developer Guide.
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 resource name is already in use. Use a different name and try your request again.TooManyTagsException - The request contains more tags than can be associated with a resource (50 tags per resource). The maximum
number of tags includes both existing tags and those included in your current request.TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.ResourceLimitExceededException - The maximum number of resources per account has been exceeded. Review the resources, and then try your
request again.UnsupportedLanguageException - Amazon Comprehend can't process the language of the input text. For custom entity recognition APIs, only
English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages,
Supported
languages in the Comprehend Developer Guide.KmsKeyValidationException - The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.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.AwsServiceExceptiondefault CreateEndpointResponse createEndpoint(CreateEndpointRequest createEndpointRequest) throws InvalidRequestException, ResourceInUseException, ResourceLimitExceededException, ResourceNotFoundException, ResourceUnavailableException, TooManyRequestsException, TooManyTagsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Creates a model-specific endpoint for synchronous inference for a previously trained custom model For information about endpoints, see Managing endpoints.
createEndpointRequest - InvalidRequestException - The request is invalid.ResourceInUseException - The specified resource name is already in use. Use a different name and try your request again.ResourceLimitExceededException - The maximum number of resources per account has been exceeded. Review the resources, and then try your
request again.ResourceNotFoundException - The specified resource ARN was not found. Check the ARN and try your request again.ResourceUnavailableException - The specified resource is not available. Check the resource and try your request again.TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.TooManyTagsException - The request contains more tags than can be associated with a resource (50 tags per resource). The maximum
number of tags includes both existing tags and those included in your current request.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.AwsServiceExceptiondefault CreateEndpointResponse createEndpoint(Consumer<CreateEndpointRequest.Builder> createEndpointRequest) throws InvalidRequestException, ResourceInUseException, ResourceLimitExceededException, ResourceNotFoundException, ResourceUnavailableException, TooManyRequestsException, TooManyTagsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Creates a model-specific endpoint for synchronous inference for a previously trained custom model For information about endpoints, see Managing endpoints.
This is a convenience which creates an instance of the CreateEndpointRequest.Builder avoiding the need to
create one manually via CreateEndpointRequest.builder()
createEndpointRequest - A Consumer that will call methods on CreateEndpointRequest.Builder to create a request.InvalidRequestException - The request is invalid.ResourceInUseException - The specified resource name is already in use. Use a different name and try your request again.ResourceLimitExceededException - The maximum number of resources per account has been exceeded. Review the resources, and then try your
request again.ResourceNotFoundException - The specified resource ARN was not found. Check the ARN and try your request again.ResourceUnavailableException - The specified resource is not available. Check the resource and try your request again.TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.TooManyTagsException - The request contains more tags than can be associated with a resource (50 tags per resource). The maximum
number of tags includes both existing tags and those included in your current request.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.AwsServiceExceptiondefault CreateEntityRecognizerResponse createEntityRecognizer(CreateEntityRecognizerRequest createEntityRecognizerRequest) throws InvalidRequestException, ResourceInUseException, TooManyTagsException, TooManyRequestsException, ResourceLimitExceededException, UnsupportedLanguageException, KmsKeyValidationException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Creates an entity recognizer using submitted files. After your CreateEntityRecognizer request is
submitted, you can check job status using the DescribeEntityRecognizer API.
createEntityRecognizerRequest - InvalidRequestException - The request is invalid.ResourceInUseException - The specified resource name is already in use. Use a different name and try your request again.TooManyTagsException - The request contains more tags than can be associated with a resource (50 tags per resource). The maximum
number of tags includes both existing tags and those included in your current request.TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.ResourceLimitExceededException - The maximum number of resources per account has been exceeded. Review the resources, and then try your
request again.UnsupportedLanguageException - Amazon Comprehend can't process the language of the input text. For custom entity recognition APIs, only
English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages,
Supported
languages in the Comprehend Developer Guide.KmsKeyValidationException - The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.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.AwsServiceExceptiondefault CreateEntityRecognizerResponse createEntityRecognizer(Consumer<CreateEntityRecognizerRequest.Builder> createEntityRecognizerRequest) throws InvalidRequestException, ResourceInUseException, TooManyTagsException, TooManyRequestsException, ResourceLimitExceededException, UnsupportedLanguageException, KmsKeyValidationException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Creates an entity recognizer using submitted files. After your CreateEntityRecognizer request is
submitted, you can check job status using the DescribeEntityRecognizer 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 resource name is already in use. Use a different name and try your request again.TooManyTagsException - The request contains more tags than can be associated with a resource (50 tags per resource). The maximum
number of tags includes both existing tags and those included in your current request.TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.ResourceLimitExceededException - The maximum number of resources per account has been exceeded. Review the resources, and then try your
request again.UnsupportedLanguageException - Amazon Comprehend can't process the language of the input text. For custom entity recognition APIs, only
English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages,
Supported
languages in the Comprehend Developer Guide.KmsKeyValidationException - The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.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.AwsServiceExceptiondefault CreateFlywheelResponse createFlywheel(CreateFlywheelRequest createFlywheelRequest) throws InvalidRequestException, ResourceInUseException, TooManyTagsException, TooManyRequestsException, ResourceLimitExceededException, UnsupportedLanguageException, KmsKeyValidationException, ResourceNotFoundException, ResourceUnavailableException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
A flywheel is an Amazon Web Services resource that orchestrates the ongoing training of a model for custom classification or custom entity recognition. You can create a flywheel to start with an existing trained model, or Comprehend can create and train a new model.
When you create the flywheel, Comprehend creates a data lake in your account. The data lake holds the training data and test data for all versions of the model.
To use a flywheel with an existing trained model, you specify the active model version. Comprehend copies the model's training data and test data into the flywheel's data lake.
To use the flywheel with a new model, you need to provide a dataset for training data (and optional test data) when you create the flywheel.
For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
createFlywheelRequest - InvalidRequestException - The request is invalid.ResourceInUseException - The specified resource name is already in use. Use a different name and try your request again.TooManyTagsException - The request contains more tags than can be associated with a resource (50 tags per resource). The maximum
number of tags includes both existing tags and those included in your current request.TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.ResourceLimitExceededException - The maximum number of resources per account has been exceeded. Review the resources, and then try your
request again.UnsupportedLanguageException - Amazon Comprehend can't process the language of the input text. For custom entity recognition APIs, only
English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages,
Supported
languages in the Comprehend Developer Guide.KmsKeyValidationException - The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.ResourceNotFoundException - The specified resource ARN was not found. Check the ARN and try your request again.ResourceUnavailableException - The specified resource is not available. Check the resource 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.AwsServiceExceptiondefault CreateFlywheelResponse createFlywheel(Consumer<CreateFlywheelRequest.Builder> createFlywheelRequest) throws InvalidRequestException, ResourceInUseException, TooManyTagsException, TooManyRequestsException, ResourceLimitExceededException, UnsupportedLanguageException, KmsKeyValidationException, ResourceNotFoundException, ResourceUnavailableException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
A flywheel is an Amazon Web Services resource that orchestrates the ongoing training of a model for custom classification or custom entity recognition. You can create a flywheel to start with an existing trained model, or Comprehend can create and train a new model.
When you create the flywheel, Comprehend creates a data lake in your account. The data lake holds the training data and test data for all versions of the model.
To use a flywheel with an existing trained model, you specify the active model version. Comprehend copies the model's training data and test data into the flywheel's data lake.
To use the flywheel with a new model, you need to provide a dataset for training data (and optional test data) when you create the flywheel.
For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
This is a convenience which creates an instance of the CreateFlywheelRequest.Builder avoiding the need to
create one manually via CreateFlywheelRequest.builder()
createFlywheelRequest - A Consumer that will call methods on CreateFlywheelRequest.Builder to create a request.InvalidRequestException - The request is invalid.ResourceInUseException - The specified resource name is already in use. Use a different name and try your request again.TooManyTagsException - The request contains more tags than can be associated with a resource (50 tags per resource). The maximum
number of tags includes both existing tags and those included in your current request.TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.ResourceLimitExceededException - The maximum number of resources per account has been exceeded. Review the resources, and then try your
request again.UnsupportedLanguageException - Amazon Comprehend can't process the language of the input text. For custom entity recognition APIs, only
English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages,
Supported
languages in the Comprehend Developer Guide.KmsKeyValidationException - The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.ResourceNotFoundException - The specified resource ARN was not found. Check the ARN and try your request again.ResourceUnavailableException - The specified resource is not available. Check the resource 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.AwsServiceExceptiondefault 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 the resource and try your request again.ResourceInUseException - The specified resource 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.AwsServiceExceptiondefault 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 the resource and try your request again.ResourceInUseException - The specified resource 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.AwsServiceExceptiondefault DeleteEndpointResponse deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest) throws InvalidRequestException, ResourceInUseException, ResourceNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Deletes a model-specific endpoint for a previously-trained custom model. All endpoints must be deleted in order for the model to be deleted. For information about endpoints, see Managing endpoints.
deleteEndpointRequest - InvalidRequestException - The request is invalid.ResourceInUseException - The specified resource name is already in use. Use a different name and try your request again.ResourceNotFoundException - The specified resource ARN was not found. Check the ARN and try your request 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.AwsServiceExceptiondefault DeleteEndpointResponse deleteEndpoint(Consumer<DeleteEndpointRequest.Builder> deleteEndpointRequest) throws InvalidRequestException, ResourceInUseException, ResourceNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Deletes a model-specific endpoint for a previously-trained custom model. All endpoints must be deleted in order for the model to be deleted. For information about endpoints, see Managing endpoints.
This is a convenience which creates an instance of the DeleteEndpointRequest.Builder avoiding the need to
create one manually via DeleteEndpointRequest.builder()
deleteEndpointRequest - A Consumer that will call methods on DeleteEndpointRequest.Builder to create a request.InvalidRequestException - The request is invalid.ResourceInUseException - The specified resource name is already in use. Use a different name and try your request again.ResourceNotFoundException - The specified resource ARN was not found. Check the ARN and try your request 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.AwsServiceExceptiondefault 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 the resource and try your request again.ResourceInUseException - The specified resource 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.AwsServiceExceptiondefault 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 the resource and try your request again.ResourceInUseException - The specified resource 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.AwsServiceExceptiondefault DeleteFlywheelResponse deleteFlywheel(DeleteFlywheelRequest deleteFlywheelRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, ResourceUnavailableException, ResourceInUseException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Deletes a flywheel. When you delete the flywheel, Amazon Comprehend does not delete the data lake or the model associated with the flywheel.
For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
deleteFlywheelRequest - 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 the resource and try your request again.ResourceInUseException - The specified resource 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.AwsServiceExceptiondefault DeleteFlywheelResponse deleteFlywheel(Consumer<DeleteFlywheelRequest.Builder> deleteFlywheelRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, ResourceUnavailableException, ResourceInUseException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Deletes a flywheel. When you delete the flywheel, Amazon Comprehend does not delete the data lake or the model associated with the flywheel.
For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
This is a convenience which creates an instance of the DeleteFlywheelRequest.Builder avoiding the need to
create one manually via DeleteFlywheelRequest.builder()
deleteFlywheelRequest - A Consumer that will call methods on DeleteFlywheelRequest.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 the resource and try your request again.ResourceInUseException - The specified resource 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.AwsServiceExceptiondefault DeleteResourcePolicyResponse deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest) throws InvalidRequestException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Deletes a resource-based policy that is attached to a custom model.
deleteResourcePolicyRequest - InvalidRequestException - The request is invalid.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.AwsServiceExceptiondefault DeleteResourcePolicyResponse deleteResourcePolicy(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest) throws InvalidRequestException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Deletes a resource-based policy that is attached to a custom model.
This is a convenience which creates an instance of the DeleteResourcePolicyRequest.Builder avoiding the
need to create one manually via DeleteResourcePolicyRequest.builder()
deleteResourcePolicyRequest - A Consumer that will call methods on DeleteResourcePolicyRequest.Builder to create a
request.InvalidRequestException - The request is invalid.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.AwsServiceExceptiondefault DescribeDatasetResponse describeDataset(DescribeDatasetRequest describeDatasetRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Returns information about the dataset that you specify. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.
describeDatasetRequest - 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.AwsServiceExceptiondefault DescribeDatasetResponse describeDataset(Consumer<DescribeDatasetRequest.Builder> describeDatasetRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Returns information about the dataset that you specify. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.
This is a convenience which creates an instance of the DescribeDatasetRequest.Builder avoiding the need
to create one manually via DescribeDatasetRequest.builder()
describeDatasetRequest - A Consumer that will call methods on DescribeDatasetRequest.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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault DescribeEndpointResponse describeEndpoint(DescribeEndpointRequest describeEndpointRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets the properties associated with a specific endpoint. Use this operation to get the status of an endpoint. For information about endpoints, see Managing endpoints.
describeEndpointRequest - 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.AwsServiceExceptiondefault DescribeEndpointResponse describeEndpoint(Consumer<DescribeEndpointRequest.Builder> describeEndpointRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets the properties associated with a specific endpoint. Use this operation to get the status of an endpoint. For information about endpoints, see Managing endpoints.
This is a convenience which creates an instance of the DescribeEndpointRequest.Builder avoiding the need
to create one manually via DescribeEndpointRequest.builder()
describeEndpointRequest - A Consumer that will call methods on DescribeEndpointRequest.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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault DescribeEventsDetectionJobResponse describeEventsDetectionJob(DescribeEventsDetectionJobRequest describeEventsDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets the status and details of an events detection job.
describeEventsDetectionJobRequest - 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.AwsServiceExceptiondefault DescribeEventsDetectionJobResponse describeEventsDetectionJob(Consumer<DescribeEventsDetectionJobRequest.Builder> describeEventsDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets the status and details of an events detection job.
This is a convenience which creates an instance of the DescribeEventsDetectionJobRequest.Builder avoiding
the need to create one manually via DescribeEventsDetectionJobRequest.builder()
describeEventsDetectionJobRequest - A Consumer that will call methods on DescribeEventsDetectionJobRequest.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.AwsServiceExceptiondefault DescribeFlywheelResponse describeFlywheel(DescribeFlywheelRequest describeFlywheelRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Provides configuration information about the flywheel. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
describeFlywheelRequest - 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.AwsServiceExceptiondefault DescribeFlywheelResponse describeFlywheel(Consumer<DescribeFlywheelRequest.Builder> describeFlywheelRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Provides configuration information about the flywheel. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
This is a convenience which creates an instance of the DescribeFlywheelRequest.Builder avoiding the need
to create one manually via DescribeFlywheelRequest.builder()
describeFlywheelRequest - A Consumer that will call methods on DescribeFlywheelRequest.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.AwsServiceExceptiondefault DescribeFlywheelIterationResponse describeFlywheelIteration(DescribeFlywheelIterationRequest describeFlywheelIterationRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Retrieve the configuration properties of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
describeFlywheelIterationRequest - 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.AwsServiceExceptiondefault DescribeFlywheelIterationResponse describeFlywheelIteration(Consumer<DescribeFlywheelIterationRequest.Builder> describeFlywheelIterationRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Retrieve the configuration properties of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
This is a convenience which creates an instance of the DescribeFlywheelIterationRequest.Builder avoiding
the need to create one manually via DescribeFlywheelIterationRequest.builder()
describeFlywheelIterationRequest - A Consumer that will call methods on DescribeFlywheelIterationRequest.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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault DescribePiiEntitiesDetectionJobResponse describePiiEntitiesDetectionJob(DescribePiiEntitiesDetectionJobRequest describePiiEntitiesDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets the properties associated with a PII entities detection job. For example, you can use this operation to get the job status.
describePiiEntitiesDetectionJobRequest - 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.AwsServiceExceptiondefault DescribePiiEntitiesDetectionJobResponse describePiiEntitiesDetectionJob(Consumer<DescribePiiEntitiesDetectionJobRequest.Builder> describePiiEntitiesDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets the properties associated with a PII entities detection job. For example, you can use this operation to get the job status.
This is a convenience which creates an instance of the DescribePiiEntitiesDetectionJobRequest.Builder
avoiding the need to create one manually via DescribePiiEntitiesDetectionJobRequest.builder()
describePiiEntitiesDetectionJobRequest - A Consumer that will call methods on DescribePiiEntitiesDetectionJobRequest.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.AwsServiceExceptiondefault DescribeResourcePolicyResponse describeResourcePolicy(DescribeResourcePolicyRequest describeResourcePolicyRequest) throws InvalidRequestException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets the details of a resource-based policy that is attached to a custom model, including the JSON body of the policy.
describeResourcePolicyRequest - InvalidRequestException - The request is invalid.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.AwsServiceExceptiondefault DescribeResourcePolicyResponse describeResourcePolicy(Consumer<DescribeResourcePolicyRequest.Builder> describeResourcePolicyRequest) throws InvalidRequestException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets the details of a resource-based policy that is attached to a custom model, including the JSON body of the policy.
This is a convenience which creates an instance of the DescribeResourcePolicyRequest.Builder avoiding the
need to create one manually via DescribeResourcePolicyRequest.builder()
describeResourcePolicyRequest - A Consumer that will call methods on DescribeResourcePolicyRequest.Builder to create a
request.InvalidRequestException - The request is invalid.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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault DescribeTargetedSentimentDetectionJobResponse describeTargetedSentimentDetectionJob(DescribeTargetedSentimentDetectionJobRequest describeTargetedSentimentDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets the properties associated with a targeted sentiment detection job. Use this operation to get the status of the job.
describeTargetedSentimentDetectionJobRequest - 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.AwsServiceExceptiondefault DescribeTargetedSentimentDetectionJobResponse describeTargetedSentimentDetectionJob(Consumer<DescribeTargetedSentimentDetectionJobRequest.Builder> describeTargetedSentimentDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets the properties associated with a targeted sentiment detection job. Use this operation to get the status of the job.
This is a convenience which creates an instance of the
DescribeTargetedSentimentDetectionJobRequest.Builder avoiding the need to create one manually via
DescribeTargetedSentimentDetectionJobRequest.builder()
describeTargetedSentimentDetectionJobRequest - A Consumer that will call methods on DescribeTargetedSentimentDetectionJobRequest.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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault DetectEntitiesResponse detectEntities(DetectEntitiesRequest detectEntitiesRequest) throws InvalidRequestException, ResourceUnavailableException, TextSizeLimitExceededException, UnsupportedLanguageException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Detects named entities in input text when you use the pre-trained model. Detects custom entities if you have a custom entity recognition model.
When detecting named entities using the pre-trained model, use plain text as the input. For more information about named entities, see Entities in the Comprehend Developer Guide.
When you use a custom entity recognition model, you can input plain text or you can upload a single-page input document (text, PDF, Word, or image).
If the system detects errors while processing a page in the input document, the API response includes an entry in
Errors for each error.
If the system detects a document-level error in your input document, the API returns an
InvalidRequestException error response. For details about this exception, see Errors in semi-structured
documents in the Comprehend Developer Guide.
detectEntitiesRequest - InvalidRequestException - The request is invalid.ResourceUnavailableException - The specified resource is not available. Check the resource and try your request again.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 custom entity recognition APIs, only
English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages,
Supported
languages in the Comprehend Developer Guide.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.AwsServiceExceptiondefault DetectEntitiesResponse detectEntities(Consumer<DetectEntitiesRequest.Builder> detectEntitiesRequest) throws InvalidRequestException, ResourceUnavailableException, TextSizeLimitExceededException, UnsupportedLanguageException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Detects named entities in input text when you use the pre-trained model. Detects custom entities if you have a custom entity recognition model.
When detecting named entities using the pre-trained model, use plain text as the input. For more information about named entities, see Entities in the Comprehend Developer Guide.
When you use a custom entity recognition model, you can input plain text or you can upload a single-page input document (text, PDF, Word, or image).
If the system detects errors while processing a page in the input document, the API response includes an entry in
Errors for each error.
If the system detects a document-level error in your input document, the API returns an
InvalidRequestException error response. For details about this exception, see Errors in semi-structured
documents in the Comprehend Developer Guide.
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.ResourceUnavailableException - The specified resource is not available. Check the resource and try your request again.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 custom entity recognition APIs, only
English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages,
Supported
languages in the Comprehend Developer Guide.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.AwsServiceExceptiondefault 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 custom entity recognition APIs, only
English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages,
Supported
languages in the Comprehend Developer Guide.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.AwsServiceExceptiondefault 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 custom entity recognition APIs, only
English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages,
Supported
languages in the Comprehend Developer Guide.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.AwsServiceExceptiondefault DetectPiiEntitiesResponse detectPiiEntities(DetectPiiEntitiesRequest detectPiiEntitiesRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Inspects the input text for entities that contain personally identifiable information (PII) and returns information about them.
detectPiiEntitiesRequest - 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 custom entity recognition APIs, only
English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages,
Supported
languages in the Comprehend Developer Guide.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.AwsServiceExceptiondefault DetectPiiEntitiesResponse detectPiiEntities(Consumer<DetectPiiEntitiesRequest.Builder> detectPiiEntitiesRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Inspects the input text for entities that contain personally identifiable information (PII) and returns information about them.
This is a convenience which creates an instance of the DetectPiiEntitiesRequest.Builder avoiding the need
to create one manually via DetectPiiEntitiesRequest.builder()
detectPiiEntitiesRequest - A Consumer that will call methods on DetectPiiEntitiesRequest.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 custom entity recognition APIs, only
English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages,
Supported
languages in the Comprehend Developer Guide.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.AwsServiceExceptiondefault 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 custom entity recognition APIs, only
English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages,
Supported
languages in the Comprehend Developer Guide.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.AwsServiceExceptiondefault 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 custom entity recognition APIs, only
English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages,
Supported
languages in the Comprehend Developer Guide.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.AwsServiceExceptiondefault 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, see Syntax in the Comprehend Developer Guide.
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 custom entity recognition APIs, only
English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages,
Supported
languages in the Comprehend Developer Guide.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.AwsServiceExceptiondefault 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, see Syntax in the Comprehend Developer Guide.
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 custom entity recognition APIs, only
English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages,
Supported
languages in the Comprehend Developer Guide.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.AwsServiceExceptiondefault DetectTargetedSentimentResponse detectTargetedSentiment(DetectTargetedSentimentRequest detectTargetedSentimentRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Inspects the input text and returns a sentiment analysis for each entity identified in the text.
For more information about targeted sentiment, see Targeted sentiment.
detectTargetedSentimentRequest - 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 custom entity recognition APIs, only
English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages,
Supported
languages in the Comprehend Developer Guide.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.AwsServiceExceptiondefault DetectTargetedSentimentResponse detectTargetedSentiment(Consumer<DetectTargetedSentimentRequest.Builder> detectTargetedSentimentRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Inspects the input text and returns a sentiment analysis for each entity identified in the text.
For more information about targeted sentiment, see Targeted sentiment.
This is a convenience which creates an instance of the DetectTargetedSentimentRequest.Builder avoiding
the need to create one manually via DetectTargetedSentimentRequest.builder()
detectTargetedSentimentRequest - A Consumer that will call methods on DetectTargetedSentimentRequest.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 custom entity recognition APIs, only
English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages,
Supported
languages in the Comprehend Developer Guide.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.AwsServiceExceptiondefault ImportModelResponse importModel(ImportModelRequest importModelRequest) throws InvalidRequestException, ResourceNotFoundException, ResourceInUseException, ResourceUnavailableException, TooManyTagsException, TooManyRequestsException, ResourceLimitExceededException, KmsKeyValidationException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Creates a new custom model that replicates a source custom model that you import. The source model can be in your Amazon Web Services account or another one.
If the source model is in another Amazon Web Services account, then it must have a resource-based policy that authorizes you to import it.
The source model must be in the same Amazon Web Services Region that you're using when you import. You can't import a model that's in a different Region.
importModelRequest - InvalidRequestException - The request is invalid.ResourceNotFoundException - The specified resource ARN was not found. Check the ARN and try your request again.ResourceInUseException - The specified resource name is already in use. Use a different name and try your request again.ResourceUnavailableException - The specified resource is not available. Check the resource and try your request again.TooManyTagsException - The request contains more tags than can be associated with a resource (50 tags per resource). The maximum
number of tags includes both existing tags and those included in your current request.TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.ResourceLimitExceededException - The maximum number of resources per account has been exceeded. Review the resources, and then try your
request again.KmsKeyValidationException - The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.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.AwsServiceExceptiondefault ImportModelResponse importModel(Consumer<ImportModelRequest.Builder> importModelRequest) throws InvalidRequestException, ResourceNotFoundException, ResourceInUseException, ResourceUnavailableException, TooManyTagsException, TooManyRequestsException, ResourceLimitExceededException, KmsKeyValidationException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Creates a new custom model that replicates a source custom model that you import. The source model can be in your Amazon Web Services account or another one.
If the source model is in another Amazon Web Services account, then it must have a resource-based policy that authorizes you to import it.
The source model must be in the same Amazon Web Services Region that you're using when you import. You can't import a model that's in a different Region.
This is a convenience which creates an instance of the ImportModelRequest.Builder avoiding the need to
create one manually via ImportModelRequest.builder()
importModelRequest - A Consumer that will call methods on ImportModelRequest.Builder to create a request.InvalidRequestException - The request is invalid.ResourceNotFoundException - The specified resource ARN was not found. Check the ARN and try your request again.ResourceInUseException - The specified resource name is already in use. Use a different name and try your request again.ResourceUnavailableException - The specified resource is not available. Check the resource and try your request again.TooManyTagsException - The request contains more tags than can be associated with a resource (50 tags per resource). The maximum
number of tags includes both existing tags and those included in your current request.TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.ResourceLimitExceededException - The maximum number of resources per account has been exceeded. Review the resources, and then try your
request again.KmsKeyValidationException - The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.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.AwsServiceExceptiondefault ListDatasetsResponse listDatasets(ListDatasetsRequest listDatasetsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
List the datasets that you have configured in this Region. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.
listDatasetsRequest - InvalidRequestException - The request is invalid.TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException - The filter specified for the operation is invalid. Specify a different filter.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.AwsServiceExceptiondefault ListDatasetsResponse listDatasets(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
List the datasets that you have configured in this Region. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.
This is a convenience which creates an instance of the ListDatasetsRequest.Builder avoiding the need to
create one manually via ListDatasetsRequest.builder()
listDatasetsRequest - A Consumer that will call methods on ListDatasetsRequest.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 operation is invalid. Specify a different filter.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.AwsServiceExceptiondefault ListDatasetsIterable listDatasetsPaginator(ListDatasetsRequest listDatasetsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
List the datasets that you have configured in this Region. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.
This is a variant of listDatasets(software.amazon.awssdk.services.comprehend.model.ListDatasetsRequest)
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.ListDatasetsIterable responses = client.listDatasetsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.comprehend.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request);
for (software.amazon.awssdk.services.comprehend.model.ListDatasetsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.comprehend.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatasets(software.amazon.awssdk.services.comprehend.model.ListDatasetsRequest) operation.
listDatasetsRequest - InvalidRequestException - The request is invalid.TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException - The filter specified for the operation is invalid. Specify a different filter.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.AwsServiceExceptiondefault ListDatasetsIterable listDatasetsPaginator(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
List the datasets that you have configured in this Region. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.
This is a variant of listDatasets(software.amazon.awssdk.services.comprehend.model.ListDatasetsRequest)
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.ListDatasetsIterable responses = client.listDatasetsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.comprehend.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request);
for (software.amazon.awssdk.services.comprehend.model.ListDatasetsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.comprehend.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatasets(software.amazon.awssdk.services.comprehend.model.ListDatasetsRequest) operation.
This is a convenience which creates an instance of the ListDatasetsRequest.Builder avoiding the need to
create one manually via ListDatasetsRequest.builder()
listDatasetsRequest - A Consumer that will call methods on ListDatasetsRequest.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 operation is invalid. Specify a different filter.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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptionlistDocumentClassificationJobs(ListDocumentClassificationJobsRequest),
AWS API Documentationdefault ListDocumentClassificationJobsIterable listDocumentClassificationJobsPaginator() throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the documentation classification jobs that you have submitted.
This is a variant of
listDocumentClassificationJobs(software.amazon.awssdk.services.comprehend.model.ListDocumentClassificationJobsRequest)
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.ListDocumentClassificationJobsIterable responses = client.listDocumentClassificationJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.comprehend.paginators.ListDocumentClassificationJobsIterable responses = client
.listDocumentClassificationJobsPaginator(request);
for (software.amazon.awssdk.services.comprehend.model.ListDocumentClassificationJobsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.comprehend.paginators.ListDocumentClassificationJobsIterable responses = client.listDocumentClassificationJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDocumentClassificationJobs(software.amazon.awssdk.services.comprehend.model.ListDocumentClassificationJobsRequest)
operation.
InvalidRequestException - The request is invalid.TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException - The filter specified for the 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.AwsServiceExceptionlistDocumentClassificationJobsPaginator(ListDocumentClassificationJobsRequest),
AWS API Documentationdefault ListDocumentClassificationJobsIterable listDocumentClassificationJobsPaginator(ListDocumentClassificationJobsRequest listDocumentClassificationJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the documentation classification jobs that you have submitted.
This is a variant of
listDocumentClassificationJobs(software.amazon.awssdk.services.comprehend.model.ListDocumentClassificationJobsRequest)
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.ListDocumentClassificationJobsIterable responses = client.listDocumentClassificationJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.comprehend.paginators.ListDocumentClassificationJobsIterable responses = client
.listDocumentClassificationJobsPaginator(request);
for (software.amazon.awssdk.services.comprehend.model.ListDocumentClassificationJobsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.comprehend.paginators.ListDocumentClassificationJobsIterable responses = client.listDocumentClassificationJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDocumentClassificationJobs(software.amazon.awssdk.services.comprehend.model.ListDocumentClassificationJobsRequest)
operation.
listDocumentClassificationJobsRequest - InvalidRequestException - The request is invalid.TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException - The filter specified for the 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.AwsServiceExceptiondefault ListDocumentClassificationJobsIterable listDocumentClassificationJobsPaginator(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 variant of
listDocumentClassificationJobs(software.amazon.awssdk.services.comprehend.model.ListDocumentClassificationJobsRequest)
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.ListDocumentClassificationJobsIterable responses = client.listDocumentClassificationJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.comprehend.paginators.ListDocumentClassificationJobsIterable responses = client
.listDocumentClassificationJobsPaginator(request);
for (software.amazon.awssdk.services.comprehend.model.ListDocumentClassificationJobsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.comprehend.paginators.ListDocumentClassificationJobsIterable responses = client.listDocumentClassificationJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDocumentClassificationJobs(software.amazon.awssdk.services.comprehend.model.ListDocumentClassificationJobsRequest)
operation.
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 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.AwsServiceExceptiondefault ListDocumentClassifierSummariesResponse listDocumentClassifierSummaries(ListDocumentClassifierSummariesRequest listDocumentClassifierSummariesRequest) throws InvalidRequestException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of summaries of the document classifiers that you have created
listDocumentClassifierSummariesRequest - 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.AwsServiceExceptiondefault ListDocumentClassifierSummariesResponse listDocumentClassifierSummaries(Consumer<ListDocumentClassifierSummariesRequest.Builder> listDocumentClassifierSummariesRequest) throws InvalidRequestException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of summaries of the document classifiers that you have created
This is a convenience which creates an instance of the ListDocumentClassifierSummariesRequest.Builder
avoiding the need to create one manually via ListDocumentClassifierSummariesRequest.builder()
listDocumentClassifierSummariesRequest - A Consumer that will call methods on ListDocumentClassifierSummariesRequest.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.AwsServiceExceptiondefault ListDocumentClassifierSummariesIterable listDocumentClassifierSummariesPaginator(ListDocumentClassifierSummariesRequest listDocumentClassifierSummariesRequest) throws InvalidRequestException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of summaries of the document classifiers that you have created
This is a variant of
listDocumentClassifierSummaries(software.amazon.awssdk.services.comprehend.model.ListDocumentClassifierSummariesRequest)
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.ListDocumentClassifierSummariesIterable responses = client.listDocumentClassifierSummariesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.comprehend.paginators.ListDocumentClassifierSummariesIterable responses = client
.listDocumentClassifierSummariesPaginator(request);
for (software.amazon.awssdk.services.comprehend.model.ListDocumentClassifierSummariesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.comprehend.paginators.ListDocumentClassifierSummariesIterable responses = client.listDocumentClassifierSummariesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDocumentClassifierSummaries(software.amazon.awssdk.services.comprehend.model.ListDocumentClassifierSummariesRequest)
operation.
listDocumentClassifierSummariesRequest - 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.AwsServiceExceptiondefault ListDocumentClassifierSummariesIterable listDocumentClassifierSummariesPaginator(Consumer<ListDocumentClassifierSummariesRequest.Builder> listDocumentClassifierSummariesRequest) throws InvalidRequestException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of summaries of the document classifiers that you have created
This is a variant of
listDocumentClassifierSummaries(software.amazon.awssdk.services.comprehend.model.ListDocumentClassifierSummariesRequest)
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.ListDocumentClassifierSummariesIterable responses = client.listDocumentClassifierSummariesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.comprehend.paginators.ListDocumentClassifierSummariesIterable responses = client
.listDocumentClassifierSummariesPaginator(request);
for (software.amazon.awssdk.services.comprehend.model.ListDocumentClassifierSummariesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.comprehend.paginators.ListDocumentClassifierSummariesIterable responses = client.listDocumentClassifierSummariesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDocumentClassifierSummaries(software.amazon.awssdk.services.comprehend.model.ListDocumentClassifierSummariesRequest)
operation.
This is a convenience which creates an instance of the ListDocumentClassifierSummariesRequest.Builder
avoiding the need to create one manually via ListDocumentClassifierSummariesRequest.builder()
listDocumentClassifierSummariesRequest - A Consumer that will call methods on ListDocumentClassifierSummariesRequest.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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptionlistDocumentClassifiers(ListDocumentClassifiersRequest),
AWS API Documentationdefault ListDocumentClassifiersIterable listDocumentClassifiersPaginator() throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the document classifiers that you have created.
This is a variant of
listDocumentClassifiers(software.amazon.awssdk.services.comprehend.model.ListDocumentClassifiersRequest)
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.ListDocumentClassifiersIterable responses = client.listDocumentClassifiersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.comprehend.paginators.ListDocumentClassifiersIterable responses = client
.listDocumentClassifiersPaginator(request);
for (software.amazon.awssdk.services.comprehend.model.ListDocumentClassifiersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.comprehend.paginators.ListDocumentClassifiersIterable responses = client.listDocumentClassifiersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDocumentClassifiers(software.amazon.awssdk.services.comprehend.model.ListDocumentClassifiersRequest)
operation.
InvalidRequestException - The request is invalid.TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException - The filter specified for the 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.AwsServiceExceptionlistDocumentClassifiersPaginator(ListDocumentClassifiersRequest),
AWS API Documentationdefault ListDocumentClassifiersIterable listDocumentClassifiersPaginator(ListDocumentClassifiersRequest listDocumentClassifiersRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the document classifiers that you have created.
This is a variant of
listDocumentClassifiers(software.amazon.awssdk.services.comprehend.model.ListDocumentClassifiersRequest)
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.ListDocumentClassifiersIterable responses = client.listDocumentClassifiersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.comprehend.paginators.ListDocumentClassifiersIterable responses = client
.listDocumentClassifiersPaginator(request);
for (software.amazon.awssdk.services.comprehend.model.ListDocumentClassifiersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.comprehend.paginators.ListDocumentClassifiersIterable responses = client.listDocumentClassifiersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDocumentClassifiers(software.amazon.awssdk.services.comprehend.model.ListDocumentClassifiersRequest)
operation.
listDocumentClassifiersRequest - InvalidRequestException - The request is invalid.TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException - The filter specified for the 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.AwsServiceExceptiondefault ListDocumentClassifiersIterable listDocumentClassifiersPaginator(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 variant of
listDocumentClassifiers(software.amazon.awssdk.services.comprehend.model.ListDocumentClassifiersRequest)
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.ListDocumentClassifiersIterable responses = client.listDocumentClassifiersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.comprehend.paginators.ListDocumentClassifiersIterable responses = client
.listDocumentClassifiersPaginator(request);
for (software.amazon.awssdk.services.comprehend.model.ListDocumentClassifiersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.comprehend.paginators.ListDocumentClassifiersIterable responses = client.listDocumentClassifiersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDocumentClassifiers(software.amazon.awssdk.services.comprehend.model.ListDocumentClassifiersRequest)
operation.
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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptionlistDominantLanguageDetectionJobs(ListDominantLanguageDetectionJobsRequest),
AWS API Documentationdefault 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(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 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.AwsServiceExceptionlistDominantLanguageDetectionJobsPaginator(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(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 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.AwsServiceExceptiondefault 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(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 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.AwsServiceExceptiondefault ListEndpointsResponse listEndpoints(ListEndpointsRequest listEndpointsRequest) throws InvalidRequestException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of all existing endpoints that you've created. For information about endpoints, see Managing endpoints.
listEndpointsRequest - 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.AwsServiceExceptiondefault ListEndpointsResponse listEndpoints(Consumer<ListEndpointsRequest.Builder> listEndpointsRequest) throws InvalidRequestException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of all existing endpoints that you've created. For information about endpoints, see Managing endpoints.
This is a convenience which creates an instance of the ListEndpointsRequest.Builder avoiding the need to
create one manually via ListEndpointsRequest.builder()
listEndpointsRequest - A Consumer that will call methods on ListEndpointsRequest.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.AwsServiceExceptiondefault ListEndpointsIterable listEndpointsPaginator(ListEndpointsRequest listEndpointsRequest) throws InvalidRequestException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of all existing endpoints that you've created. For information about endpoints, see Managing endpoints.
This is a variant of
listEndpoints(software.amazon.awssdk.services.comprehend.model.ListEndpointsRequest) 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.ListEndpointsIterable responses = client.listEndpointsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.comprehend.paginators.ListEndpointsIterable responses = client
.listEndpointsPaginator(request);
for (software.amazon.awssdk.services.comprehend.model.ListEndpointsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.comprehend.paginators.ListEndpointsIterable responses = client.listEndpointsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEndpoints(software.amazon.awssdk.services.comprehend.model.ListEndpointsRequest) operation.
listEndpointsRequest - 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.AwsServiceExceptiondefault ListEndpointsIterable listEndpointsPaginator(Consumer<ListEndpointsRequest.Builder> listEndpointsRequest) throws InvalidRequestException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of all existing endpoints that you've created. For information about endpoints, see Managing endpoints.
This is a variant of
listEndpoints(software.amazon.awssdk.services.comprehend.model.ListEndpointsRequest) 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.ListEndpointsIterable responses = client.listEndpointsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.comprehend.paginators.ListEndpointsIterable responses = client
.listEndpointsPaginator(request);
for (software.amazon.awssdk.services.comprehend.model.ListEndpointsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.comprehend.paginators.ListEndpointsIterable responses = client.listEndpointsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEndpoints(software.amazon.awssdk.services.comprehend.model.ListEndpointsRequest) operation.
This is a convenience which creates an instance of the ListEndpointsRequest.Builder avoiding the need to
create one manually via ListEndpointsRequest.builder()
listEndpointsRequest - A Consumer that will call methods on ListEndpointsRequest.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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptionlistEntitiesDetectionJobs(ListEntitiesDetectionJobsRequest),
AWS API Documentationdefault 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(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 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.AwsServiceExceptionlistEntitiesDetectionJobsPaginator(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(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 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.AwsServiceExceptiondefault 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(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 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.AwsServiceExceptiondefault ListEntityRecognizerSummariesResponse listEntityRecognizerSummaries(ListEntityRecognizerSummariesRequest listEntityRecognizerSummariesRequest) throws InvalidRequestException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of summaries for the entity recognizers that you have created.
listEntityRecognizerSummariesRequest - 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.AwsServiceExceptiondefault ListEntityRecognizerSummariesResponse listEntityRecognizerSummaries(Consumer<ListEntityRecognizerSummariesRequest.Builder> listEntityRecognizerSummariesRequest) throws InvalidRequestException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of summaries for the entity recognizers that you have created.
This is a convenience which creates an instance of the ListEntityRecognizerSummariesRequest.Builder
avoiding the need to create one manually via ListEntityRecognizerSummariesRequest.builder()
listEntityRecognizerSummariesRequest - A Consumer that will call methods on ListEntityRecognizerSummariesRequest.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.AwsServiceExceptiondefault ListEntityRecognizerSummariesIterable listEntityRecognizerSummariesPaginator(ListEntityRecognizerSummariesRequest listEntityRecognizerSummariesRequest) throws InvalidRequestException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of summaries for the entity recognizers that you have created.
This is a variant of
listEntityRecognizerSummaries(software.amazon.awssdk.services.comprehend.model.ListEntityRecognizerSummariesRequest)
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.ListEntityRecognizerSummariesIterable responses = client.listEntityRecognizerSummariesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.comprehend.paginators.ListEntityRecognizerSummariesIterable responses = client
.listEntityRecognizerSummariesPaginator(request);
for (software.amazon.awssdk.services.comprehend.model.ListEntityRecognizerSummariesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.comprehend.paginators.ListEntityRecognizerSummariesIterable responses = client.listEntityRecognizerSummariesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEntityRecognizerSummaries(software.amazon.awssdk.services.comprehend.model.ListEntityRecognizerSummariesRequest)
operation.
listEntityRecognizerSummariesRequest - 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.AwsServiceExceptiondefault ListEntityRecognizerSummariesIterable listEntityRecognizerSummariesPaginator(Consumer<ListEntityRecognizerSummariesRequest.Builder> listEntityRecognizerSummariesRequest) throws InvalidRequestException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of summaries for the entity recognizers that you have created.
This is a variant of
listEntityRecognizerSummaries(software.amazon.awssdk.services.comprehend.model.ListEntityRecognizerSummariesRequest)
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.ListEntityRecognizerSummariesIterable responses = client.listEntityRecognizerSummariesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.comprehend.paginators.ListEntityRecognizerSummariesIterable responses = client
.listEntityRecognizerSummariesPaginator(request);
for (software.amazon.awssdk.services.comprehend.model.ListEntityRecognizerSummariesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.comprehend.paginators.ListEntityRecognizerSummariesIterable responses = client.listEntityRecognizerSummariesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEntityRecognizerSummaries(software.amazon.awssdk.services.comprehend.model.ListEntityRecognizerSummariesRequest)
operation.
This is a convenience which creates an instance of the ListEntityRecognizerSummariesRequest.Builder
avoiding the need to create one manually via ListEntityRecognizerSummariesRequest.builder()
listEntityRecognizerSummariesRequest - A Consumer that will call methods on ListEntityRecognizerSummariesRequest.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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptionlistEntityRecognizers(ListEntityRecognizersRequest),
AWS API Documentationdefault ListEntityRecognizersIterable listEntityRecognizersPaginator() 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 variant of
listEntityRecognizers(software.amazon.awssdk.services.comprehend.model.ListEntityRecognizersRequest)
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.ListEntityRecognizersIterable responses = client.listEntityRecognizersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.comprehend.paginators.ListEntityRecognizersIterable responses = client
.listEntityRecognizersPaginator(request);
for (software.amazon.awssdk.services.comprehend.model.ListEntityRecognizersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.comprehend.paginators.ListEntityRecognizersIterable responses = client.listEntityRecognizersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEntityRecognizers(software.amazon.awssdk.services.comprehend.model.ListEntityRecognizersRequest)
operation.
InvalidRequestException - The request is invalid.TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException - The filter specified for the 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.AwsServiceExceptionlistEntityRecognizersPaginator(ListEntityRecognizersRequest),
AWS API Documentationdefault ListEntityRecognizersIterable listEntityRecognizersPaginator(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.
This is a variant of
listEntityRecognizers(software.amazon.awssdk.services.comprehend.model.ListEntityRecognizersRequest)
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.ListEntityRecognizersIterable responses = client.listEntityRecognizersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.comprehend.paginators.ListEntityRecognizersIterable responses = client
.listEntityRecognizersPaginator(request);
for (software.amazon.awssdk.services.comprehend.model.ListEntityRecognizersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.comprehend.paginators.ListEntityRecognizersIterable responses = client.listEntityRecognizersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEntityRecognizers(software.amazon.awssdk.services.comprehend.model.ListEntityRecognizersRequest)
operation.
listEntityRecognizersRequest - InvalidRequestException - The request is invalid.TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException - The filter specified for the 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.AwsServiceExceptiondefault ListEntityRecognizersIterable listEntityRecognizersPaginator(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 variant of
listEntityRecognizers(software.amazon.awssdk.services.comprehend.model.ListEntityRecognizersRequest)
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.ListEntityRecognizersIterable responses = client.listEntityRecognizersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.comprehend.paginators.ListEntityRecognizersIterable responses = client
.listEntityRecognizersPaginator(request);
for (software.amazon.awssdk.services.comprehend.model.ListEntityRecognizersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.comprehend.paginators.ListEntityRecognizersIterable responses = client.listEntityRecognizersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEntityRecognizers(software.amazon.awssdk.services.comprehend.model.ListEntityRecognizersRequest)
operation.
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 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.AwsServiceExceptiondefault ListEventsDetectionJobsResponse listEventsDetectionJobs(ListEventsDetectionJobsRequest listEventsDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the events detection jobs that you have submitted.
listEventsDetectionJobsRequest - InvalidRequestException - The request is invalid.TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException - The filter specified for the 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.AwsServiceExceptiondefault ListEventsDetectionJobsResponse listEventsDetectionJobs(Consumer<ListEventsDetectionJobsRequest.Builder> listEventsDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the events detection jobs that you have submitted.
This is a convenience which creates an instance of the ListEventsDetectionJobsRequest.Builder avoiding
the need to create one manually via ListEventsDetectionJobsRequest.builder()
listEventsDetectionJobsRequest - A Consumer that will call methods on ListEventsDetectionJobsRequest.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 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.AwsServiceExceptiondefault ListEventsDetectionJobsIterable listEventsDetectionJobsPaginator(ListEventsDetectionJobsRequest listEventsDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the events detection jobs that you have submitted.
This is a variant of
listEventsDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListEventsDetectionJobsRequest)
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.ListEventsDetectionJobsIterable responses = client.listEventsDetectionJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.comprehend.paginators.ListEventsDetectionJobsIterable responses = client
.listEventsDetectionJobsPaginator(request);
for (software.amazon.awssdk.services.comprehend.model.ListEventsDetectionJobsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.comprehend.paginators.ListEventsDetectionJobsIterable responses = client.listEventsDetectionJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEventsDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListEventsDetectionJobsRequest)
operation.
listEventsDetectionJobsRequest - InvalidRequestException - The request is invalid.TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException - The filter specified for the 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.AwsServiceExceptiondefault ListEventsDetectionJobsIterable listEventsDetectionJobsPaginator(Consumer<ListEventsDetectionJobsRequest.Builder> listEventsDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the events detection jobs that you have submitted.
This is a variant of
listEventsDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListEventsDetectionJobsRequest)
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.ListEventsDetectionJobsIterable responses = client.listEventsDetectionJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.comprehend.paginators.ListEventsDetectionJobsIterable responses = client
.listEventsDetectionJobsPaginator(request);
for (software.amazon.awssdk.services.comprehend.model.ListEventsDetectionJobsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.comprehend.paginators.ListEventsDetectionJobsIterable responses = client.listEventsDetectionJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEventsDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListEventsDetectionJobsRequest)
operation.
This is a convenience which creates an instance of the ListEventsDetectionJobsRequest.Builder avoiding
the need to create one manually via ListEventsDetectionJobsRequest.builder()
listEventsDetectionJobsRequest - A Consumer that will call methods on ListEventsDetectionJobsRequest.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 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.AwsServiceExceptiondefault ListFlywheelIterationHistoryResponse listFlywheelIterationHistory(ListFlywheelIterationHistoryRequest listFlywheelIterationHistoryRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Information about the history of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
listFlywheelIterationHistoryRequest - InvalidRequestException - The request is invalid.TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException - The filter specified for the operation is invalid. Specify a different filter.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.AwsServiceExceptiondefault ListFlywheelIterationHistoryResponse listFlywheelIterationHistory(Consumer<ListFlywheelIterationHistoryRequest.Builder> listFlywheelIterationHistoryRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Information about the history of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
This is a convenience which creates an instance of the ListFlywheelIterationHistoryRequest.Builder
avoiding the need to create one manually via ListFlywheelIterationHistoryRequest.builder()
listFlywheelIterationHistoryRequest - A Consumer that will call methods on ListFlywheelIterationHistoryRequest.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 operation is invalid. Specify a different filter.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.AwsServiceExceptiondefault ListFlywheelIterationHistoryIterable listFlywheelIterationHistoryPaginator(ListFlywheelIterationHistoryRequest listFlywheelIterationHistoryRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Information about the history of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
This is a variant of
listFlywheelIterationHistory(software.amazon.awssdk.services.comprehend.model.ListFlywheelIterationHistoryRequest)
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.ListFlywheelIterationHistoryIterable responses = client.listFlywheelIterationHistoryPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.comprehend.paginators.ListFlywheelIterationHistoryIterable responses = client
.listFlywheelIterationHistoryPaginator(request);
for (software.amazon.awssdk.services.comprehend.model.ListFlywheelIterationHistoryResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.comprehend.paginators.ListFlywheelIterationHistoryIterable responses = client.listFlywheelIterationHistoryPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFlywheelIterationHistory(software.amazon.awssdk.services.comprehend.model.ListFlywheelIterationHistoryRequest)
operation.
listFlywheelIterationHistoryRequest - InvalidRequestException - The request is invalid.TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException - The filter specified for the operation is invalid. Specify a different filter.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.AwsServiceExceptiondefault ListFlywheelIterationHistoryIterable listFlywheelIterationHistoryPaginator(Consumer<ListFlywheelIterationHistoryRequest.Builder> listFlywheelIterationHistoryRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Information about the history of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
This is a variant of
listFlywheelIterationHistory(software.amazon.awssdk.services.comprehend.model.ListFlywheelIterationHistoryRequest)
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.ListFlywheelIterationHistoryIterable responses = client.listFlywheelIterationHistoryPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.comprehend.paginators.ListFlywheelIterationHistoryIterable responses = client
.listFlywheelIterationHistoryPaginator(request);
for (software.amazon.awssdk.services.comprehend.model.ListFlywheelIterationHistoryResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.comprehend.paginators.ListFlywheelIterationHistoryIterable responses = client.listFlywheelIterationHistoryPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFlywheelIterationHistory(software.amazon.awssdk.services.comprehend.model.ListFlywheelIterationHistoryRequest)
operation.
This is a convenience which creates an instance of the ListFlywheelIterationHistoryRequest.Builder
avoiding the need to create one manually via ListFlywheelIterationHistoryRequest.builder()
listFlywheelIterationHistoryRequest - A Consumer that will call methods on ListFlywheelIterationHistoryRequest.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 operation is invalid. Specify a different filter.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.AwsServiceExceptiondefault ListFlywheelsResponse listFlywheels(ListFlywheelsRequest listFlywheelsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the flywheels that you have created.
listFlywheelsRequest - InvalidRequestException - The request is invalid.TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException - The filter specified for the 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.AwsServiceExceptiondefault ListFlywheelsResponse listFlywheels(Consumer<ListFlywheelsRequest.Builder> listFlywheelsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the flywheels that you have created.
This is a convenience which creates an instance of the ListFlywheelsRequest.Builder avoiding the need to
create one manually via ListFlywheelsRequest.builder()
listFlywheelsRequest - A Consumer that will call methods on ListFlywheelsRequest.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 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.AwsServiceExceptiondefault ListFlywheelsIterable listFlywheelsPaginator(ListFlywheelsRequest listFlywheelsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the flywheels that you have created.
This is a variant of
listFlywheels(software.amazon.awssdk.services.comprehend.model.ListFlywheelsRequest) 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.ListFlywheelsIterable responses = client.listFlywheelsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.comprehend.paginators.ListFlywheelsIterable responses = client
.listFlywheelsPaginator(request);
for (software.amazon.awssdk.services.comprehend.model.ListFlywheelsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.comprehend.paginators.ListFlywheelsIterable responses = client.listFlywheelsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFlywheels(software.amazon.awssdk.services.comprehend.model.ListFlywheelsRequest) operation.
listFlywheelsRequest - InvalidRequestException - The request is invalid.TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException - The filter specified for the 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.AwsServiceExceptiondefault ListFlywheelsIterable listFlywheelsPaginator(Consumer<ListFlywheelsRequest.Builder> listFlywheelsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the flywheels that you have created.
This is a variant of
listFlywheels(software.amazon.awssdk.services.comprehend.model.ListFlywheelsRequest) 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.ListFlywheelsIterable responses = client.listFlywheelsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.comprehend.paginators.ListFlywheelsIterable responses = client
.listFlywheelsPaginator(request);
for (software.amazon.awssdk.services.comprehend.model.ListFlywheelsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.comprehend.paginators.ListFlywheelsIterable responses = client.listFlywheelsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFlywheels(software.amazon.awssdk.services.comprehend.model.ListFlywheelsRequest) operation.
This is a convenience which creates an instance of the ListFlywheelsRequest.Builder avoiding the need to
create one manually via ListFlywheelsRequest.builder()
listFlywheelsRequest - A Consumer that will call methods on ListFlywheelsRequest.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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptionlistKeyPhrasesDetectionJobs(ListKeyPhrasesDetectionJobsRequest),
AWS API Documentationdefault 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(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 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.AwsServiceExceptionlistKeyPhrasesDetectionJobsPaginator(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(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 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.AwsServiceExceptiondefault 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(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 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.AwsServiceExceptiondefault ListPiiEntitiesDetectionJobsResponse listPiiEntitiesDetectionJobs(ListPiiEntitiesDetectionJobsRequest listPiiEntitiesDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the PII entity detection jobs that you have submitted.
listPiiEntitiesDetectionJobsRequest - InvalidRequestException - The request is invalid.TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException - The filter specified for the 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.AwsServiceExceptiondefault ListPiiEntitiesDetectionJobsResponse listPiiEntitiesDetectionJobs(Consumer<ListPiiEntitiesDetectionJobsRequest.Builder> listPiiEntitiesDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the PII entity detection jobs that you have submitted.
This is a convenience which creates an instance of the ListPiiEntitiesDetectionJobsRequest.Builder
avoiding the need to create one manually via ListPiiEntitiesDetectionJobsRequest.builder()
listPiiEntitiesDetectionJobsRequest - A Consumer that will call methods on ListPiiEntitiesDetectionJobsRequest.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 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.AwsServiceExceptiondefault ListPiiEntitiesDetectionJobsIterable listPiiEntitiesDetectionJobsPaginator(ListPiiEntitiesDetectionJobsRequest listPiiEntitiesDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the PII entity detection jobs that you have submitted.
This is a variant of
listPiiEntitiesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListPiiEntitiesDetectionJobsRequest)
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.ListPiiEntitiesDetectionJobsIterable responses = client.listPiiEntitiesDetectionJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.comprehend.paginators.ListPiiEntitiesDetectionJobsIterable responses = client
.listPiiEntitiesDetectionJobsPaginator(request);
for (software.amazon.awssdk.services.comprehend.model.ListPiiEntitiesDetectionJobsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.comprehend.paginators.ListPiiEntitiesDetectionJobsIterable responses = client.listPiiEntitiesDetectionJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPiiEntitiesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListPiiEntitiesDetectionJobsRequest)
operation.
listPiiEntitiesDetectionJobsRequest - InvalidRequestException - The request is invalid.TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException - The filter specified for the 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.AwsServiceExceptiondefault ListPiiEntitiesDetectionJobsIterable listPiiEntitiesDetectionJobsPaginator(Consumer<ListPiiEntitiesDetectionJobsRequest.Builder> listPiiEntitiesDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of the PII entity detection jobs that you have submitted.
This is a variant of
listPiiEntitiesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListPiiEntitiesDetectionJobsRequest)
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.ListPiiEntitiesDetectionJobsIterable responses = client.listPiiEntitiesDetectionJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.comprehend.paginators.ListPiiEntitiesDetectionJobsIterable responses = client
.listPiiEntitiesDetectionJobsPaginator(request);
for (software.amazon.awssdk.services.comprehend.model.ListPiiEntitiesDetectionJobsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.comprehend.paginators.ListPiiEntitiesDetectionJobsIterable responses = client.listPiiEntitiesDetectionJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPiiEntitiesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListPiiEntitiesDetectionJobsRequest)
operation.
This is a convenience which creates an instance of the ListPiiEntitiesDetectionJobsRequest.Builder
avoiding the need to create one manually via ListPiiEntitiesDetectionJobsRequest.builder()
listPiiEntitiesDetectionJobsRequest - A Consumer that will call methods on ListPiiEntitiesDetectionJobsRequest.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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptionlistSentimentDetectionJobs(ListSentimentDetectionJobsRequest),
AWS API Documentationdefault 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(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 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.AwsServiceExceptionlistSentimentDetectionJobsPaginator(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(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 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.AwsServiceExceptiondefault 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(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 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.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InvalidRequestException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Lists all tags associated with a given Amazon Comprehend resource.
listTagsForResourceRequest - InvalidRequestException - The request is invalid.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.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InvalidRequestException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Lists all tags associated with a given Amazon Comprehend resource.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.InvalidRequestException - The request is invalid.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.AwsServiceExceptiondefault ListTargetedSentimentDetectionJobsResponse listTargetedSentimentDetectionJobs(ListTargetedSentimentDetectionJobsRequest listTargetedSentimentDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of targeted sentiment detection jobs that you have submitted.
listTargetedSentimentDetectionJobsRequest - InvalidRequestException - The request is invalid.TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException - The filter specified for the 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.AwsServiceExceptiondefault ListTargetedSentimentDetectionJobsResponse listTargetedSentimentDetectionJobs(Consumer<ListTargetedSentimentDetectionJobsRequest.Builder> listTargetedSentimentDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of targeted sentiment detection jobs that you have submitted.
This is a convenience which creates an instance of the ListTargetedSentimentDetectionJobsRequest.Builder
avoiding the need to create one manually via ListTargetedSentimentDetectionJobsRequest.builder()
listTargetedSentimentDetectionJobsRequest - A Consumer that will call methods on ListTargetedSentimentDetectionJobsRequest.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 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.AwsServiceExceptiondefault ListTargetedSentimentDetectionJobsIterable listTargetedSentimentDetectionJobsPaginator(ListTargetedSentimentDetectionJobsRequest listTargetedSentimentDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of targeted sentiment detection jobs that you have submitted.
This is a variant of
listTargetedSentimentDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListTargetedSentimentDetectionJobsRequest)
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.ListTargetedSentimentDetectionJobsIterable responses = client.listTargetedSentimentDetectionJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.comprehend.paginators.ListTargetedSentimentDetectionJobsIterable responses = client
.listTargetedSentimentDetectionJobsPaginator(request);
for (software.amazon.awssdk.services.comprehend.model.ListTargetedSentimentDetectionJobsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.comprehend.paginators.ListTargetedSentimentDetectionJobsIterable responses = client.listTargetedSentimentDetectionJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTargetedSentimentDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListTargetedSentimentDetectionJobsRequest)
operation.
listTargetedSentimentDetectionJobsRequest - InvalidRequestException - The request is invalid.TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException - The filter specified for the 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.AwsServiceExceptiondefault ListTargetedSentimentDetectionJobsIterable listTargetedSentimentDetectionJobsPaginator(Consumer<ListTargetedSentimentDetectionJobsRequest.Builder> listTargetedSentimentDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Gets a list of targeted sentiment detection jobs that you have submitted.
This is a variant of
listTargetedSentimentDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListTargetedSentimentDetectionJobsRequest)
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.ListTargetedSentimentDetectionJobsIterable responses = client.listTargetedSentimentDetectionJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.comprehend.paginators.ListTargetedSentimentDetectionJobsIterable responses = client
.listTargetedSentimentDetectionJobsPaginator(request);
for (software.amazon.awssdk.services.comprehend.model.ListTargetedSentimentDetectionJobsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.comprehend.paginators.ListTargetedSentimentDetectionJobsIterable responses = client.listTargetedSentimentDetectionJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTargetedSentimentDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListTargetedSentimentDetectionJobsRequest)
operation.
This is a convenience which creates an instance of the ListTargetedSentimentDetectionJobsRequest.Builder
avoiding the need to create one manually via ListTargetedSentimentDetectionJobsRequest.builder()
listTargetedSentimentDetectionJobsRequest - A Consumer that will call methods on ListTargetedSentimentDetectionJobsRequest.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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptionlistTopicsDetectionJobs(ListTopicsDetectionJobsRequest),
AWS API Documentationdefault 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(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 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.AwsServiceExceptionlistTopicsDetectionJobsPaginator(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(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 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.AwsServiceExceptiondefault 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(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 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.AwsServiceExceptiondefault PutResourcePolicyResponse putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest) throws InvalidRequestException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Attaches a resource-based policy to a custom model. You can use this policy to authorize an entity in another Amazon Web Services account to import the custom model, which replicates it in Amazon Comprehend in their account.
putResourcePolicyRequest - InvalidRequestException - The request is invalid.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.AwsServiceExceptiondefault PutResourcePolicyResponse putResourcePolicy(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest) throws InvalidRequestException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Attaches a resource-based policy to a custom model. You can use this policy to authorize an entity in another Amazon Web Services account to import the custom model, which replicates it in Amazon Comprehend in their account.
This is a convenience which creates an instance of the PutResourcePolicyRequest.Builder avoiding the need
to create one manually via PutResourcePolicyRequest.builder()
putResourcePolicyRequest - A Consumer that will call methods on PutResourcePolicyRequest.Builder to create a request.InvalidRequestException - The request is invalid.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.AwsServiceExceptiondefault StartDocumentClassificationJobResponse startDocumentClassificationJob(StartDocumentClassificationJobRequest startDocumentClassificationJobRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, ResourceUnavailableException, KmsKeyValidationException, TooManyTagsException, ResourceInUseException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Starts an asynchronous document classification job. Use the DescribeDocumentClassificationJob
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 the resource and try your request again.KmsKeyValidationException - The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.TooManyTagsException - The request contains more tags than can be associated with a resource (50 tags per resource). The maximum
number of tags includes both existing tags and those included in your current request.ResourceInUseException - The specified resource 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.AwsServiceExceptiondefault StartDocumentClassificationJobResponse startDocumentClassificationJob(Consumer<StartDocumentClassificationJobRequest.Builder> startDocumentClassificationJobRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, ResourceUnavailableException, KmsKeyValidationException, TooManyTagsException, ResourceInUseException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Starts an asynchronous document classification job. Use the DescribeDocumentClassificationJob
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 the resource and try your request again.KmsKeyValidationException - The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.TooManyTagsException - The request contains more tags than can be associated with a resource (50 tags per resource). The maximum
number of tags includes both existing tags and those included in your current request.ResourceInUseException - The specified resource 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.AwsServiceExceptiondefault StartDominantLanguageDetectionJobResponse startDominantLanguageDetectionJob(StartDominantLanguageDetectionJobRequest startDominantLanguageDetectionJobRequest) throws InvalidRequestException, TooManyRequestsException, KmsKeyValidationException, TooManyTagsException, ResourceInUseException, 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.KmsKeyValidationException - The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.TooManyTagsException - The request contains more tags than can be associated with a resource (50 tags per resource). The maximum
number of tags includes both existing tags and those included in your current request.ResourceInUseException - The specified resource 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.AwsServiceExceptiondefault StartDominantLanguageDetectionJobResponse startDominantLanguageDetectionJob(Consumer<StartDominantLanguageDetectionJobRequest.Builder> startDominantLanguageDetectionJobRequest) throws InvalidRequestException, TooManyRequestsException, KmsKeyValidationException, TooManyTagsException, ResourceInUseException, 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.KmsKeyValidationException - The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.TooManyTagsException - The request contains more tags than can be associated with a resource (50 tags per resource). The maximum
number of tags includes both existing tags and those included in your current request.ResourceInUseException - The specified resource 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.AwsServiceExceptiondefault StartEntitiesDetectionJobResponse startEntitiesDetectionJob(StartEntitiesDetectionJobRequest startEntitiesDetectionJobRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, ResourceUnavailableException, KmsKeyValidationException, TooManyTagsException, ResourceInUseException, 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 the resource and try your request again.KmsKeyValidationException - The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.TooManyTagsException - The request contains more tags than can be associated with a resource (50 tags per resource). The maximum
number of tags includes both existing tags and those included in your current request.ResourceInUseException - The specified resource 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.AwsServiceExceptiondefault StartEntitiesDetectionJobResponse startEntitiesDetectionJob(Consumer<StartEntitiesDetectionJobRequest.Builder> startEntitiesDetectionJobRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, ResourceUnavailableException, KmsKeyValidationException, TooManyTagsException, ResourceInUseException, 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 the resource and try your request again.KmsKeyValidationException - The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.TooManyTagsException - The request contains more tags than can be associated with a resource (50 tags per resource). The maximum
number of tags includes both existing tags and those included in your current request.ResourceInUseException - The specified resource 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.AwsServiceExceptiondefault StartEventsDetectionJobResponse startEventsDetectionJob(StartEventsDetectionJobRequest startEventsDetectionJobRequest) throws InvalidRequestException, TooManyRequestsException, KmsKeyValidationException, TooManyTagsException, ResourceInUseException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Starts an asynchronous event detection job for a collection of documents.
startEventsDetectionJobRequest - InvalidRequestException - The request is invalid.TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.KmsKeyValidationException - The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.TooManyTagsException - The request contains more tags than can be associated with a resource (50 tags per resource). The maximum
number of tags includes both existing tags and those included in your current request.ResourceInUseException - The specified resource 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.AwsServiceExceptiondefault StartEventsDetectionJobResponse startEventsDetectionJob(Consumer<StartEventsDetectionJobRequest.Builder> startEventsDetectionJobRequest) throws InvalidRequestException, TooManyRequestsException, KmsKeyValidationException, TooManyTagsException, ResourceInUseException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Starts an asynchronous event detection job for a collection of documents.
This is a convenience which creates an instance of the StartEventsDetectionJobRequest.Builder avoiding
the need to create one manually via StartEventsDetectionJobRequest.builder()
startEventsDetectionJobRequest - A Consumer that will call methods on StartEventsDetectionJobRequest.Builder to create a
request.InvalidRequestException - The request is invalid.TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.KmsKeyValidationException - The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.TooManyTagsException - The request contains more tags than can be associated with a resource (50 tags per resource). The maximum
number of tags includes both existing tags and those included in your current request.ResourceInUseException - The specified resource 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.AwsServiceExceptiondefault StartFlywheelIterationResponse startFlywheelIteration(StartFlywheelIterationRequest startFlywheelIterationRequest) throws InvalidRequestException, TooManyRequestsException, ResourceInUseException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Start the flywheel iteration.This operation uses any new datasets to train a new model version. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
startFlywheelIterationRequest - InvalidRequestException - The request is invalid.TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.ResourceInUseException - The specified resource name is already in use. Use a different name and try your request again.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.AwsServiceExceptiondefault StartFlywheelIterationResponse startFlywheelIteration(Consumer<StartFlywheelIterationRequest.Builder> startFlywheelIterationRequest) throws InvalidRequestException, TooManyRequestsException, ResourceInUseException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Start the flywheel iteration.This operation uses any new datasets to train a new model version. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
This is a convenience which creates an instance of the StartFlywheelIterationRequest.Builder avoiding the
need to create one manually via StartFlywheelIterationRequest.builder()
startFlywheelIterationRequest - A Consumer that will call methods on StartFlywheelIterationRequest.Builder to create a
request.InvalidRequestException - The request is invalid.TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.ResourceInUseException - The specified resource name is already in use. Use a different name and try your request again.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.AwsServiceExceptiondefault StartKeyPhrasesDetectionJobResponse startKeyPhrasesDetectionJob(StartKeyPhrasesDetectionJobRequest startKeyPhrasesDetectionJobRequest) throws InvalidRequestException, TooManyRequestsException, KmsKeyValidationException, TooManyTagsException, ResourceInUseException, 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.KmsKeyValidationException - The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.TooManyTagsException - The request contains more tags than can be associated with a resource (50 tags per resource). The maximum
number of tags includes both existing tags and those included in your current request.ResourceInUseException - The specified resource 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.AwsServiceExceptiondefault StartKeyPhrasesDetectionJobResponse startKeyPhrasesDetectionJob(Consumer<StartKeyPhrasesDetectionJobRequest.Builder> startKeyPhrasesDetectionJobRequest) throws InvalidRequestException, TooManyRequestsException, KmsKeyValidationException, TooManyTagsException, ResourceInUseException, 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.KmsKeyValidationException - The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.TooManyTagsException - The request contains more tags than can be associated with a resource (50 tags per resource). The maximum
number of tags includes both existing tags and those included in your current request.ResourceInUseException - The specified resource 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.AwsServiceExceptiondefault StartPiiEntitiesDetectionJobResponse startPiiEntitiesDetectionJob(StartPiiEntitiesDetectionJobRequest startPiiEntitiesDetectionJobRequest) throws InvalidRequestException, TooManyRequestsException, KmsKeyValidationException, TooManyTagsException, ResourceInUseException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Starts an asynchronous PII entity detection job for a collection of documents.
startPiiEntitiesDetectionJobRequest - InvalidRequestException - The request is invalid.TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.KmsKeyValidationException - The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.TooManyTagsException - The request contains more tags than can be associated with a resource (50 tags per resource). The maximum
number of tags includes both existing tags and those included in your current request.ResourceInUseException - The specified resource 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.AwsServiceExceptiondefault StartPiiEntitiesDetectionJobResponse startPiiEntitiesDetectionJob(Consumer<StartPiiEntitiesDetectionJobRequest.Builder> startPiiEntitiesDetectionJobRequest) throws InvalidRequestException, TooManyRequestsException, KmsKeyValidationException, TooManyTagsException, ResourceInUseException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Starts an asynchronous PII entity detection job for a collection of documents.
This is a convenience which creates an instance of the StartPiiEntitiesDetectionJobRequest.Builder
avoiding the need to create one manually via StartPiiEntitiesDetectionJobRequest.builder()
startPiiEntitiesDetectionJobRequest - A Consumer that will call methods on StartPiiEntitiesDetectionJobRequest.Builder to create
a request.InvalidRequestException - The request is invalid.TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.KmsKeyValidationException - The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.TooManyTagsException - The request contains more tags than can be associated with a resource (50 tags per resource). The maximum
number of tags includes both existing tags and those included in your current request.ResourceInUseException - The specified resource 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.AwsServiceExceptiondefault StartSentimentDetectionJobResponse startSentimentDetectionJob(StartSentimentDetectionJobRequest startSentimentDetectionJobRequest) throws InvalidRequestException, TooManyRequestsException, KmsKeyValidationException, TooManyTagsException, ResourceInUseException, 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.KmsKeyValidationException - The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.TooManyTagsException - The request contains more tags than can be associated with a resource (50 tags per resource). The maximum
number of tags includes both existing tags and those included in your current request.ResourceInUseException - The specified resource 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.AwsServiceExceptiondefault StartSentimentDetectionJobResponse startSentimentDetectionJob(Consumer<StartSentimentDetectionJobRequest.Builder> startSentimentDetectionJobRequest) throws InvalidRequestException, TooManyRequestsException, KmsKeyValidationException, TooManyTagsException, ResourceInUseException, 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.KmsKeyValidationException - The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.TooManyTagsException - The request contains more tags than can be associated with a resource (50 tags per resource). The maximum
number of tags includes both existing tags and those included in your current request.ResourceInUseException - The specified resource 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.AwsServiceExceptiondefault StartTargetedSentimentDetectionJobResponse startTargetedSentimentDetectionJob(StartTargetedSentimentDetectionJobRequest startTargetedSentimentDetectionJobRequest) throws InvalidRequestException, TooManyRequestsException, KmsKeyValidationException, TooManyTagsException, ResourceInUseException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Starts an asynchronous targeted sentiment detection job for a collection of documents. Use the
DescribeTargetedSentimentDetectionJob operation to track the status of a job.
startTargetedSentimentDetectionJobRequest - InvalidRequestException - The request is invalid.TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.KmsKeyValidationException - The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.TooManyTagsException - The request contains more tags than can be associated with a resource (50 tags per resource). The maximum
number of tags includes both existing tags and those included in your current request.ResourceInUseException - The specified resource 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.AwsServiceExceptiondefault StartTargetedSentimentDetectionJobResponse startTargetedSentimentDetectionJob(Consumer<StartTargetedSentimentDetectionJobRequest.Builder> startTargetedSentimentDetectionJobRequest) throws InvalidRequestException, TooManyRequestsException, KmsKeyValidationException, TooManyTagsException, ResourceInUseException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Starts an asynchronous targeted sentiment detection job for a collection of documents. Use the
DescribeTargetedSentimentDetectionJob operation to track the status of a job.
This is a convenience which creates an instance of the StartTargetedSentimentDetectionJobRequest.Builder
avoiding the need to create one manually via StartTargetedSentimentDetectionJobRequest.builder()
startTargetedSentimentDetectionJobRequest - A Consumer that will call methods on StartTargetedSentimentDetectionJobRequest.Builder to
create a request.InvalidRequestException - The request is invalid.TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.KmsKeyValidationException - The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.TooManyTagsException - The request contains more tags than can be associated with a resource (50 tags per resource). The maximum
number of tags includes both existing tags and those included in your current request.ResourceInUseException - The specified resource 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.AwsServiceExceptiondefault StartTopicsDetectionJobResponse startTopicsDetectionJob(StartTopicsDetectionJobRequest startTopicsDetectionJobRequest) throws InvalidRequestException, TooManyRequestsException, KmsKeyValidationException, TooManyTagsException, ResourceInUseException, 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.KmsKeyValidationException - The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.TooManyTagsException - The request contains more tags than can be associated with a resource (50 tags per resource). The maximum
number of tags includes both existing tags and those included in your current request.ResourceInUseException - The specified resource 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.AwsServiceExceptiondefault StartTopicsDetectionJobResponse startTopicsDetectionJob(Consumer<StartTopicsDetectionJobRequest.Builder> startTopicsDetectionJobRequest) throws InvalidRequestException, TooManyRequestsException, KmsKeyValidationException, TooManyTagsException, ResourceInUseException, 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.KmsKeyValidationException - The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.TooManyTagsException - The request contains more tags than can be associated with a resource (50 tags per resource). The maximum
number of tags includes both existing tags and those included in your current request.ResourceInUseException - The specified resource 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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault StopEventsDetectionJobResponse stopEventsDetectionJob(StopEventsDetectionJobRequest stopEventsDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Stops an events detection job in progress.
stopEventsDetectionJobRequest - 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.AwsServiceExceptiondefault StopEventsDetectionJobResponse stopEventsDetectionJob(Consumer<StopEventsDetectionJobRequest.Builder> stopEventsDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Stops an events detection job in progress.
This is a convenience which creates an instance of the StopEventsDetectionJobRequest.Builder avoiding the
need to create one manually via StopEventsDetectionJobRequest.builder()
stopEventsDetectionJobRequest - A Consumer that will call methods on StopEventsDetectionJobRequest.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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault StopPiiEntitiesDetectionJobResponse stopPiiEntitiesDetectionJob(StopPiiEntitiesDetectionJobRequest stopPiiEntitiesDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Stops a PII entities detection job in progress.
stopPiiEntitiesDetectionJobRequest - 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.AwsServiceExceptiondefault StopPiiEntitiesDetectionJobResponse stopPiiEntitiesDetectionJob(Consumer<StopPiiEntitiesDetectionJobRequest.Builder> stopPiiEntitiesDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Stops a PII entities detection job in progress.
This is a convenience which creates an instance of the StopPiiEntitiesDetectionJobRequest.Builder
avoiding the need to create one manually via StopPiiEntitiesDetectionJobRequest.builder()
stopPiiEntitiesDetectionJobRequest - A Consumer that will call methods on StopPiiEntitiesDetectionJobRequest.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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault StopTargetedSentimentDetectionJobResponse stopTargetedSentimentDetectionJob(StopTargetedSentimentDetectionJobRequest stopTargetedSentimentDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Stops a targeted 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.
stopTargetedSentimentDetectionJobRequest - 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.AwsServiceExceptiondefault StopTargetedSentimentDetectionJobResponse stopTargetedSentimentDetectionJob(Consumer<StopTargetedSentimentDetectionJobRequest.Builder> stopTargetedSentimentDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Stops a targeted 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 StopTargetedSentimentDetectionJobRequest.Builder
avoiding the need to create one manually via StopTargetedSentimentDetectionJobRequest.builder()
stopTargetedSentimentDetectionJobRequest - A Consumer that will call methods on StopTargetedSentimentDetectionJobRequest.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.AwsServiceExceptiondefault StopTrainingDocumentClassifierResponse stopTrainingDocumentClassifier(StopTrainingDocumentClassifierRequest stopTrainingDocumentClassifierRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Stops a document classifier training job while in progress.
If the training job state is TRAINING, the job is marked for termination and put into the
STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the
TRAINED; otherwise the training job is stopped and put into the STOPPED state and the
service sends back an HTTP 200 response with an empty HTTP body.
stopTrainingDocumentClassifierRequest - 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.AwsServiceExceptiondefault StopTrainingDocumentClassifierResponse stopTrainingDocumentClassifier(Consumer<StopTrainingDocumentClassifierRequest.Builder> stopTrainingDocumentClassifierRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Stops a document classifier training job while in progress.
If the training job state is TRAINING, the job is marked for termination and put into the
STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the
TRAINED; otherwise the training job is stopped and put into the STOPPED state and the
service sends back an HTTP 200 response with an empty HTTP body.
This is a convenience which creates an instance of the StopTrainingDocumentClassifierRequest.Builder
avoiding the need to create one manually via StopTrainingDocumentClassifierRequest.builder()
stopTrainingDocumentClassifierRequest - A Consumer that will call methods on StopTrainingDocumentClassifierRequest.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.AwsServiceExceptiondefault StopTrainingEntityRecognizerResponse stopTrainingEntityRecognizer(StopTrainingEntityRecognizerRequest stopTrainingEntityRecognizerRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Stops an entity recognizer training job while in progress.
If the training job state is TRAINING, the job is marked for termination and put into the
STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the
TRAINED; otherwise the training job is stopped and putted into the STOPPED state and
the service sends back an HTTP 200 response with an empty HTTP body.
stopTrainingEntityRecognizerRequest - 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.AwsServiceExceptiondefault StopTrainingEntityRecognizerResponse stopTrainingEntityRecognizer(Consumer<StopTrainingEntityRecognizerRequest.Builder> stopTrainingEntityRecognizerRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Stops an entity recognizer training job while in progress.
If the training job state is TRAINING, the job is marked for termination and put into the
STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the
TRAINED; otherwise the training job is stopped and putted into the STOPPED state and
the service sends back an HTTP 200 response with an empty HTTP body.
This is a convenience which creates an instance of the StopTrainingEntityRecognizerRequest.Builder
avoiding the need to create one manually via StopTrainingEntityRecognizerRequest.builder()
stopTrainingEntityRecognizerRequest - A Consumer that will call methods on StopTrainingEntityRecognizerRequest.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.AwsServiceExceptiondefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InvalidRequestException, ConcurrentModificationException, ResourceNotFoundException, TooManyTagsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Associates a specific tag with an Amazon Comprehend resource. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
tagResourceRequest - InvalidRequestException - The request is invalid.ConcurrentModificationException - Concurrent modification of the tags associated with an Amazon Comprehend resource is not supported.ResourceNotFoundException - The specified resource ARN was not found. Check the ARN and try your request again.TooManyTagsException - The request contains more tags than can be associated with a resource (50 tags per resource). The maximum
number of tags includes both existing tags and those included in your current request.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.AwsServiceExceptiondefault TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InvalidRequestException, ConcurrentModificationException, ResourceNotFoundException, TooManyTagsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Associates a specific tag with an Amazon Comprehend resource. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.InvalidRequestException - The request is invalid.ConcurrentModificationException - Concurrent modification of the tags associated with an Amazon Comprehend resource is not supported.ResourceNotFoundException - The specified resource ARN was not found. Check the ARN and try your request again.TooManyTagsException - The request contains more tags than can be associated with a resource (50 tags per resource). The maximum
number of tags includes both existing tags and those included in your current request.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.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws TooManyTagKeysException, InvalidRequestException, ConcurrentModificationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Removes a specific tag associated with an Amazon Comprehend resource.
untagResourceRequest - TooManyTagKeysException - The request contains more tag keys than can be associated with a resource (50 tag keys per resource).InvalidRequestException - The request is invalid.ConcurrentModificationException - Concurrent modification of the tags associated with an Amazon Comprehend resource is not supported.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.AwsServiceExceptiondefault UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws TooManyTagKeysException, InvalidRequestException, ConcurrentModificationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Removes a specific tag associated with an Amazon Comprehend resource.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.TooManyTagKeysException - The request contains more tag keys than can be associated with a resource (50 tag keys per resource).InvalidRequestException - The request is invalid.ConcurrentModificationException - Concurrent modification of the tags associated with an Amazon Comprehend resource is not supported.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.AwsServiceExceptiondefault UpdateEndpointResponse updateEndpoint(UpdateEndpointRequest updateEndpointRequest) throws InvalidRequestException, TooManyRequestsException, ResourceInUseException, ResourceLimitExceededException, ResourceNotFoundException, ResourceUnavailableException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Updates information about the specified endpoint. For information about endpoints, see Managing endpoints.
updateEndpointRequest - InvalidRequestException - The request is invalid.TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.ResourceInUseException - The specified resource name is already in use. Use a different name and try your request again.ResourceLimitExceededException - The maximum number of resources per account has been exceeded. Review the resources, and then try your
request again.ResourceNotFoundException - The specified resource ARN was not found. Check the ARN and try your request again.ResourceUnavailableException - The specified resource is not available. Check the resource 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.AwsServiceExceptiondefault UpdateEndpointResponse updateEndpoint(Consumer<UpdateEndpointRequest.Builder> updateEndpointRequest) throws InvalidRequestException, TooManyRequestsException, ResourceInUseException, ResourceLimitExceededException, ResourceNotFoundException, ResourceUnavailableException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Updates information about the specified endpoint. For information about endpoints, see Managing endpoints.
This is a convenience which creates an instance of the UpdateEndpointRequest.Builder avoiding the need to
create one manually via UpdateEndpointRequest.builder()
updateEndpointRequest - A Consumer that will call methods on UpdateEndpointRequest.Builder to create a request.InvalidRequestException - The request is invalid.TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.ResourceInUseException - The specified resource name is already in use. Use a different name and try your request again.ResourceLimitExceededException - The maximum number of resources per account has been exceeded. Review the resources, and then try your
request again.ResourceNotFoundException - The specified resource ARN was not found. Check the ARN and try your request again.ResourceUnavailableException - The specified resource is not available. Check the resource 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.AwsServiceExceptiondefault UpdateFlywheelResponse updateFlywheel(UpdateFlywheelRequest updateFlywheelRequest) throws InvalidRequestException, TooManyRequestsException, KmsKeyValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Update the configuration information for an existing flywheel.
updateFlywheelRequest - InvalidRequestException - The request is invalid.TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.KmsKeyValidationException - The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.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.AwsServiceExceptiondefault UpdateFlywheelResponse updateFlywheel(Consumer<UpdateFlywheelRequest.Builder> updateFlywheelRequest) throws InvalidRequestException, TooManyRequestsException, KmsKeyValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException
Update the configuration information for an existing flywheel.
This is a convenience which creates an instance of the UpdateFlywheelRequest.Builder avoiding the need to
create one manually via UpdateFlywheelRequest.builder()
updateFlywheelRequest - A Consumer that will call methods on UpdateFlywheelRequest.Builder to create a request.InvalidRequestException - The request is invalid.TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.KmsKeyValidationException - The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.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.AwsServiceExceptionstatic ComprehendClient create()
ComprehendClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static ComprehendClientBuilder builder()
ComprehendClient.static ServiceMetadata serviceMetadata()
default ComprehendServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientCopyright © 2023. All rights reserved.