Interface ComprehendClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
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.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbatchDetectDominantLanguage
(Consumer<BatchDetectDominantLanguageRequest.Builder> batchDetectDominantLanguageRequest) Determines the dominant language of the input text for a batch of documents.batchDetectDominantLanguage
(BatchDetectDominantLanguageRequest batchDetectDominantLanguageRequest) Determines the dominant language of the input text for a batch of documents.default BatchDetectEntitiesResponse
batchDetectEntities
(Consumer<BatchDetectEntitiesRequest.Builder> batchDetectEntitiesRequest) Inspects the text of a batch of documents for named entities and returns information about them.default BatchDetectEntitiesResponse
batchDetectEntities
(BatchDetectEntitiesRequest batchDetectEntitiesRequest) Inspects the text of a batch of documents for named entities and returns information about them.default BatchDetectKeyPhrasesResponse
batchDetectKeyPhrases
(Consumer<BatchDetectKeyPhrasesRequest.Builder> batchDetectKeyPhrasesRequest) Detects the key noun phrases found in a batch of documents.default BatchDetectKeyPhrasesResponse
batchDetectKeyPhrases
(BatchDetectKeyPhrasesRequest batchDetectKeyPhrasesRequest) Detects the key noun phrases found in a batch of documents.default BatchDetectSentimentResponse
batchDetectSentiment
(Consumer<BatchDetectSentimentRequest.Builder> batchDetectSentimentRequest) Inspects a batch of documents and returns an inference of the prevailing sentiment,POSITIVE
,NEUTRAL
,MIXED
, orNEGATIVE
, in each one.default BatchDetectSentimentResponse
batchDetectSentiment
(BatchDetectSentimentRequest batchDetectSentimentRequest) Inspects a batch of documents and returns an inference of the prevailing sentiment,POSITIVE
,NEUTRAL
,MIXED
, orNEGATIVE
, in each one.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 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.batchDetectTargetedSentiment
(Consumer<BatchDetectTargetedSentimentRequest.Builder> batchDetectTargetedSentimentRequest) Inspects a batch of documents and returns a sentiment analysis for each entity identified in the documents.batchDetectTargetedSentiment
(BatchDetectTargetedSentimentRequest 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 aComprehendClient
.default ClassifyDocumentResponse
classifyDocument
(Consumer<ClassifyDocumentRequest.Builder> classifyDocumentRequest) Creates a classification request to analyze a single document in real-time.default ClassifyDocumentResponse
classifyDocument
(ClassifyDocumentRequest classifyDocumentRequest) Creates a classification request to analyze a single document in real-time.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 aComprehendClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.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 classifierdefault DeleteDocumentClassifierResponse
deleteDocumentClassifier
(DeleteDocumentClassifierRequest deleteDocumentClassifierRequest) Deletes a previously created document classifierdefault 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.describeDocumentClassificationJob
(Consumer<DescribeDocumentClassificationJobRequest.Builder> describeDocumentClassificationJobRequest) Gets the properties associated with a document classification job.describeDocumentClassificationJob
(DescribeDocumentClassificationJobRequest describeDocumentClassificationJobRequest) Gets the properties associated with a document classification job.describeDocumentClassifier
(Consumer<DescribeDocumentClassifierRequest.Builder> describeDocumentClassifierRequest) Gets the properties associated with a document classifier.describeDocumentClassifier
(DescribeDocumentClassifierRequest describeDocumentClassifierRequest) Gets the properties associated with a document classifier.describeDominantLanguageDetectionJob
(Consumer<DescribeDominantLanguageDetectionJobRequest.Builder> describeDominantLanguageDetectionJobRequest) Gets the properties associated with a dominant language detection job.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.describeEntitiesDetectionJob
(Consumer<DescribeEntitiesDetectionJobRequest.Builder> describeEntitiesDetectionJobRequest) Gets the properties associated with an entities detection job.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.describeEventsDetectionJob
(Consumer<DescribeEventsDetectionJobRequest.Builder> describeEventsDetectionJobRequest) Gets the status and details of an events detection job.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.describeFlywheelIteration
(Consumer<DescribeFlywheelIterationRequest.Builder> describeFlywheelIterationRequest) Retrieve the configuration properties of a flywheel iteration.describeFlywheelIteration
(DescribeFlywheelIterationRequest describeFlywheelIterationRequest) Retrieve the configuration properties of a flywheel iteration.describeKeyPhrasesDetectionJob
(Consumer<DescribeKeyPhrasesDetectionJobRequest.Builder> describeKeyPhrasesDetectionJobRequest) Gets the properties associated with a key phrases detection job.describeKeyPhrasesDetectionJob
(DescribeKeyPhrasesDetectionJobRequest describeKeyPhrasesDetectionJobRequest) Gets the properties associated with a key phrases detection job.describePiiEntitiesDetectionJob
(Consumer<DescribePiiEntitiesDetectionJobRequest.Builder> describePiiEntitiesDetectionJobRequest) Gets the properties associated with a PII entities detection job.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.describeSentimentDetectionJob
(Consumer<DescribeSentimentDetectionJobRequest.Builder> describeSentimentDetectionJobRequest) Gets the properties associated with a sentiment detection job.describeSentimentDetectionJob
(DescribeSentimentDetectionJobRequest describeSentimentDetectionJobRequest) Gets the properties associated with a sentiment detection job.describeTargetedSentimentDetectionJob
(Consumer<DescribeTargetedSentimentDetectionJobRequest.Builder> describeTargetedSentimentDetectionJobRequest) Gets the properties associated with a targeted sentiment detection job.describeTargetedSentimentDetectionJob
(DescribeTargetedSentimentDetectionJobRequest describeTargetedSentimentDetectionJobRequest) Gets the properties associated with a targeted sentiment detection job.describeTopicsDetectionJob
(Consumer<DescribeTopicsDetectionJobRequest.Builder> describeTopicsDetectionJobRequest) Gets the properties associated with a topic detection job.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
, orNEGATIVE
).default DetectSentimentResponse
detectSentiment
(DetectSentimentRequest detectSentimentRequest) Inspects text and returns an inference of the prevailing sentiment (POSITIVE
,NEUTRAL
,MIXED
, orNEGATIVE
).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 DetectToxicContentResponse
detectToxicContent
(Consumer<DetectToxicContentRequest.Builder> detectToxicContentRequest) Performs toxicity analysis on the list of text strings that you provide as input.default DetectToxicContentResponse
detectToxicContent
(DetectToxicContentRequest detectToxicContentRequest) Performs toxicity analysis on the list of text strings that you provide as input.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.Gets a list of the documentation classification jobs that you have submitted.listDocumentClassificationJobs
(Consumer<ListDocumentClassificationJobsRequest.Builder> listDocumentClassificationJobsRequest) Gets a list of the documentation classification jobs that you have submitted.listDocumentClassificationJobs
(ListDocumentClassificationJobsRequest listDocumentClassificationJobsRequest) Gets a list of the documentation classification jobs that you have submitted.Gets a list of the documentation classification jobs that you have submitted.listDocumentClassificationJobsPaginator
(Consumer<ListDocumentClassificationJobsRequest.Builder> listDocumentClassificationJobsRequest) Gets a list of the documentation classification jobs that you have submitted.listDocumentClassificationJobsPaginator
(ListDocumentClassificationJobsRequest listDocumentClassificationJobsRequest) Gets a list of the documentation classification jobs that you have submitted.default ListDocumentClassifiersResponse
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
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.listDocumentClassifierSummaries
(Consumer<ListDocumentClassifierSummariesRequest.Builder> listDocumentClassifierSummariesRequest) Gets a list of summaries of the document classifiers that you have createdlistDocumentClassifierSummaries
(ListDocumentClassifierSummariesRequest listDocumentClassifierSummariesRequest) Gets a list of summaries of the document classifiers that you have createdlistDocumentClassifierSummariesPaginator
(Consumer<ListDocumentClassifierSummariesRequest.Builder> listDocumentClassifierSummariesRequest) Gets a list of summaries of the document classifiers that you have createdlistDocumentClassifierSummariesPaginator
(ListDocumentClassifierSummariesRequest listDocumentClassifierSummariesRequest) Gets a list of summaries of the document classifiers that you have createdGets a list of the dominant language detection jobs that you have submitted.listDominantLanguageDetectionJobs
(Consumer<ListDominantLanguageDetectionJobsRequest.Builder> listDominantLanguageDetectionJobsRequest) Gets a list of the dominant language detection jobs that you have submitted.listDominantLanguageDetectionJobs
(ListDominantLanguageDetectionJobsRequest listDominantLanguageDetectionJobsRequest) Gets a list of the dominant language detection jobs that you have submitted.Gets a list of the dominant language detection jobs that you have submitted.listDominantLanguageDetectionJobsPaginator
(Consumer<ListDominantLanguageDetectionJobsRequest.Builder> listDominantLanguageDetectionJobsRequest) Gets a list of the dominant language detection jobs that you have submitted.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.Gets a list of the entity detection jobs that you have submitted.listEntitiesDetectionJobs
(Consumer<ListEntitiesDetectionJobsRequest.Builder> listEntitiesDetectionJobsRequest) Gets a list of the entity detection jobs that you have submitted.listEntitiesDetectionJobs
(ListEntitiesDetectionJobsRequest listEntitiesDetectionJobsRequest) Gets a list of the entity detection jobs that you have submitted.Gets a list of the entity detection jobs that you have submitted.listEntitiesDetectionJobsPaginator
(Consumer<ListEntitiesDetectionJobsRequest.Builder> listEntitiesDetectionJobsRequest) Gets a list of the entity detection jobs that you have submitted.listEntitiesDetectionJobsPaginator
(ListEntitiesDetectionJobsRequest listEntitiesDetectionJobsRequest) Gets a list of the entity detection jobs that you have submitted.default ListEntityRecognizersResponse
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
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.listEntityRecognizerSummaries
(Consumer<ListEntityRecognizerSummariesRequest.Builder> listEntityRecognizerSummariesRequest) Gets a list of summaries for the entity recognizers that you have created.listEntityRecognizerSummaries
(ListEntityRecognizerSummariesRequest listEntityRecognizerSummariesRequest) Gets a list of summaries for the entity recognizers that you have created.listEntityRecognizerSummariesPaginator
(Consumer<ListEntityRecognizerSummariesRequest.Builder> listEntityRecognizerSummariesRequest) Gets a list of summaries for the entity recognizers that you have created.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.listFlywheelIterationHistory
(Consumer<ListFlywheelIterationHistoryRequest.Builder> listFlywheelIterationHistoryRequest) Information about the history of a flywheel iteration.listFlywheelIterationHistory
(ListFlywheelIterationHistoryRequest listFlywheelIterationHistoryRequest) Information about the history of a flywheel iteration.listFlywheelIterationHistoryPaginator
(Consumer<ListFlywheelIterationHistoryRequest.Builder> listFlywheelIterationHistoryRequest) Information about the history of a flywheel iteration.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.Get a list of key phrase detection jobs that you have submitted.listKeyPhrasesDetectionJobs
(Consumer<ListKeyPhrasesDetectionJobsRequest.Builder> listKeyPhrasesDetectionJobsRequest) Get a list of key phrase detection jobs that you have submitted.listKeyPhrasesDetectionJobs
(ListKeyPhrasesDetectionJobsRequest listKeyPhrasesDetectionJobsRequest) Get a list of key phrase detection jobs that you have submitted.Get a list of key phrase detection jobs that you have submitted.listKeyPhrasesDetectionJobsPaginator
(Consumer<ListKeyPhrasesDetectionJobsRequest.Builder> listKeyPhrasesDetectionJobsRequest) Get a list of key phrase detection jobs that you have submitted.listKeyPhrasesDetectionJobsPaginator
(ListKeyPhrasesDetectionJobsRequest listKeyPhrasesDetectionJobsRequest) Get a list of key phrase detection jobs that you have submitted.listPiiEntitiesDetectionJobs
(Consumer<ListPiiEntitiesDetectionJobsRequest.Builder> listPiiEntitiesDetectionJobsRequest) Gets a list of the PII entity detection jobs that you have submitted.listPiiEntitiesDetectionJobs
(ListPiiEntitiesDetectionJobsRequest listPiiEntitiesDetectionJobsRequest) Gets a list of the PII entity detection jobs that you have submitted.listPiiEntitiesDetectionJobsPaginator
(Consumer<ListPiiEntitiesDetectionJobsRequest.Builder> listPiiEntitiesDetectionJobsRequest) Gets a list of the PII entity detection jobs that you have submitted.listPiiEntitiesDetectionJobsPaginator
(ListPiiEntitiesDetectionJobsRequest listPiiEntitiesDetectionJobsRequest) Gets a list of the PII entity detection jobs that you have submitted.Gets a list of sentiment detection jobs that you have submitted.listSentimentDetectionJobs
(Consumer<ListSentimentDetectionJobsRequest.Builder> listSentimentDetectionJobsRequest) Gets a list of sentiment detection jobs that you have submitted.listSentimentDetectionJobs
(ListSentimentDetectionJobsRequest listSentimentDetectionJobsRequest) Gets a list of sentiment detection jobs that you have submitted.Gets a list of sentiment detection jobs that you have submitted.listSentimentDetectionJobsPaginator
(Consumer<ListSentimentDetectionJobsRequest.Builder> listSentimentDetectionJobsRequest) Gets a list of sentiment detection jobs that you have submitted.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.listTargetedSentimentDetectionJobs
(Consumer<ListTargetedSentimentDetectionJobsRequest.Builder> listTargetedSentimentDetectionJobsRequest) Gets a list of targeted sentiment detection jobs that you have submitted.listTargetedSentimentDetectionJobs
(ListTargetedSentimentDetectionJobsRequest listTargetedSentimentDetectionJobsRequest) Gets a list of targeted sentiment detection jobs that you have submitted.listTargetedSentimentDetectionJobsPaginator
(Consumer<ListTargetedSentimentDetectionJobsRequest.Builder> listTargetedSentimentDetectionJobsRequest) Gets a list of targeted sentiment detection jobs that you have submitted.listTargetedSentimentDetectionJobsPaginator
(ListTargetedSentimentDetectionJobsRequest listTargetedSentimentDetectionJobsRequest) Gets a list of targeted sentiment detection jobs that you have submitted.default ListTopicsDetectionJobsResponse
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
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.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
startDocumentClassificationJob
(Consumer<StartDocumentClassificationJobRequest.Builder> startDocumentClassificationJobRequest) Starts an asynchronous document classification job.startDocumentClassificationJob
(StartDocumentClassificationJobRequest startDocumentClassificationJobRequest) Starts an asynchronous document classification job.startDominantLanguageDetectionJob
(Consumer<StartDominantLanguageDetectionJobRequest.Builder> startDominantLanguageDetectionJobRequest) Starts an asynchronous dominant language detection job for a collection of documents.startDominantLanguageDetectionJob
(StartDominantLanguageDetectionJobRequest startDominantLanguageDetectionJobRequest) Starts an asynchronous dominant language detection job for a collection of documents.startEntitiesDetectionJob
(Consumer<StartEntitiesDetectionJobRequest.Builder> startEntitiesDetectionJobRequest) Starts an asynchronous entity detection job for a collection of documents.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.startKeyPhrasesDetectionJob
(Consumer<StartKeyPhrasesDetectionJobRequest.Builder> startKeyPhrasesDetectionJobRequest) Starts an asynchronous key phrase detection job for a collection of documents.startKeyPhrasesDetectionJob
(StartKeyPhrasesDetectionJobRequest startKeyPhrasesDetectionJobRequest) Starts an asynchronous key phrase detection job for a collection of documents.startPiiEntitiesDetectionJob
(Consumer<StartPiiEntitiesDetectionJobRequest.Builder> startPiiEntitiesDetectionJobRequest) Starts an asynchronous PII entity detection job for a collection of documents.startPiiEntitiesDetectionJob
(StartPiiEntitiesDetectionJobRequest startPiiEntitiesDetectionJobRequest) Starts an asynchronous PII entity detection job for a collection of documents.startSentimentDetectionJob
(Consumer<StartSentimentDetectionJobRequest.Builder> startSentimentDetectionJobRequest) Starts an asynchronous sentiment detection job for a collection of documents.startSentimentDetectionJob
(StartSentimentDetectionJobRequest startSentimentDetectionJobRequest) Starts an asynchronous sentiment detection job for a collection of documents.startTargetedSentimentDetectionJob
(Consumer<StartTargetedSentimentDetectionJobRequest.Builder> startTargetedSentimentDetectionJobRequest) Starts an asynchronous targeted sentiment detection job for a collection of documents.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.stopDominantLanguageDetectionJob
(Consumer<StopDominantLanguageDetectionJobRequest.Builder> stopDominantLanguageDetectionJobRequest) Stops a dominant language detection job in progress.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.stopKeyPhrasesDetectionJob
(Consumer<StopKeyPhrasesDetectionJobRequest.Builder> stopKeyPhrasesDetectionJobRequest) Stops a key phrases detection job in progress.stopKeyPhrasesDetectionJob
(StopKeyPhrasesDetectionJobRequest stopKeyPhrasesDetectionJobRequest) Stops a key phrases detection job in progress.stopPiiEntitiesDetectionJob
(Consumer<StopPiiEntitiesDetectionJobRequest.Builder> stopPiiEntitiesDetectionJobRequest) Stops a PII entities detection job in progress.stopPiiEntitiesDetectionJob
(StopPiiEntitiesDetectionJobRequest stopPiiEntitiesDetectionJobRequest) Stops a PII entities detection job in progress.stopSentimentDetectionJob
(Consumer<StopSentimentDetectionJobRequest.Builder> stopSentimentDetectionJobRequest) Stops a sentiment detection job in progress.stopSentimentDetectionJob
(StopSentimentDetectionJobRequest stopSentimentDetectionJobRequest) Stops a sentiment detection job in progress.stopTargetedSentimentDetectionJob
(Consumer<StopTargetedSentimentDetectionJobRequest.Builder> stopTargetedSentimentDetectionJobRequest) Stops a targeted sentiment detection job in progress.stopTargetedSentimentDetectionJob
(StopTargetedSentimentDetectionJobRequest stopTargetedSentimentDetectionJobRequest) Stops a targeted sentiment detection job in progress.stopTrainingDocumentClassifier
(Consumer<StopTrainingDocumentClassifierRequest.Builder> stopTrainingDocumentClassifierRequest) Stops a document classifier training job while in progress.stopTrainingDocumentClassifier
(StopTrainingDocumentClassifierRequest stopTrainingDocumentClassifierRequest) Stops a document classifier training job while in progress.stopTrainingEntityRecognizer
(Consumer<StopTrainingEntityRecognizerRequest.Builder> stopTrainingEntityRecognizerRequest) Stops an entity recognizer training job while in progress.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.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
batchDetectDominantLanguage
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.
- Parameters:
batchDetectDominantLanguageRequest
-- Returns:
- Result of the BatchDetectDominantLanguage operation returned by the service.
- See Also:
-
batchDetectDominantLanguage
default BatchDetectDominantLanguageResponse batchDetectDominantLanguage(Consumer<BatchDetectDominantLanguageRequest.Builder> batchDetectDominantLanguageRequest) throws InvalidRequestException, TextSizeLimitExceededException, BatchSizeLimitExceededException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Determines the dominant language of the input text for a batch of documents. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.
This is a convenience which creates an instance of the
BatchDetectDominantLanguageRequest.Builder
avoiding the need to create one manually viaBatchDetectDominantLanguageRequest.builder()
- Parameters:
batchDetectDominantLanguageRequest
- AConsumer
that will call methods onBatchDetectDominantLanguageRequest.Builder
to create a request.- Returns:
- Result of the BatchDetectDominantLanguage operation returned by the service.
- See Also:
-
batchDetectEntities
default BatchDetectEntitiesResponse batchDetectEntities(BatchDetectEntitiesRequest batchDetectEntitiesRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, BatchSizeLimitExceededException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Inspects the text of a batch of documents for named entities and returns information about them. For more information about named entities, see Entities in the Comprehend Developer Guide.
- Parameters:
batchDetectEntitiesRequest
-- Returns:
- Result of the BatchDetectEntities operation returned by the service.
- See Also:
-
batchDetectEntities
default BatchDetectEntitiesResponse batchDetectEntities(Consumer<BatchDetectEntitiesRequest.Builder> batchDetectEntitiesRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, BatchSizeLimitExceededException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Inspects the text of a batch of documents for named entities and returns information about them. For more information about named entities, see 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 viaBatchDetectEntitiesRequest.builder()
- Parameters:
batchDetectEntitiesRequest
- AConsumer
that will call methods onBatchDetectEntitiesRequest.Builder
to create a request.- Returns:
- Result of the BatchDetectEntities operation returned by the service.
- See Also:
-
batchDetectKeyPhrases
default BatchDetectKeyPhrasesResponse batchDetectKeyPhrases(BatchDetectKeyPhrasesRequest batchDetectKeyPhrasesRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, BatchSizeLimitExceededException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Detects the key noun phrases found in a batch of documents.
- Parameters:
batchDetectKeyPhrasesRequest
-- Returns:
- Result of the BatchDetectKeyPhrases operation returned by the service.
- See Also:
-
batchDetectKeyPhrases
default BatchDetectKeyPhrasesResponse batchDetectKeyPhrases(Consumer<BatchDetectKeyPhrasesRequest.Builder> batchDetectKeyPhrasesRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, BatchSizeLimitExceededException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Detects the key noun phrases found in a batch of documents.
This is a convenience which creates an instance of the
BatchDetectKeyPhrasesRequest.Builder
avoiding the need to create one manually viaBatchDetectKeyPhrasesRequest.builder()
- Parameters:
batchDetectKeyPhrasesRequest
- AConsumer
that will call methods onBatchDetectKeyPhrasesRequest.Builder
to create a request.- Returns:
- Result of the BatchDetectKeyPhrases operation returned by the service.
- See Also:
-
batchDetectSentiment
default BatchDetectSentimentResponse batchDetectSentiment(BatchDetectSentimentRequest batchDetectSentimentRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, BatchSizeLimitExceededException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Inspects a batch of documents and returns an inference of the prevailing sentiment,
POSITIVE
,NEUTRAL
,MIXED
, orNEGATIVE
, in each one.- Parameters:
batchDetectSentimentRequest
-- Returns:
- Result of the BatchDetectSentiment operation returned by the service.
- See Also:
-
batchDetectSentiment
default BatchDetectSentimentResponse batchDetectSentiment(Consumer<BatchDetectSentimentRequest.Builder> batchDetectSentimentRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, BatchSizeLimitExceededException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Inspects a batch of documents and returns an inference of the prevailing sentiment,
POSITIVE
,NEUTRAL
,MIXED
, orNEGATIVE
, in each one.
This is a convenience which creates an instance of the
BatchDetectSentimentRequest.Builder
avoiding the need to create one manually viaBatchDetectSentimentRequest.builder()
- Parameters:
batchDetectSentimentRequest
- AConsumer
that will call methods onBatchDetectSentimentRequest.Builder
to create a request.- Returns:
- Result of the BatchDetectSentiment operation returned by the service.
- See Also:
-
batchDetectSyntax
default BatchDetectSyntaxResponse batchDetectSyntax(BatchDetectSyntaxRequest batchDetectSyntaxRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, BatchSizeLimitExceededException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Inspects the text of a batch of documents for the syntax and part of speech of the words in the document and returns information about them. For more information, see Syntax in the Comprehend Developer Guide.
- Parameters:
batchDetectSyntaxRequest
-- Returns:
- Result of the BatchDetectSyntax operation returned by the service.
- See Also:
-
batchDetectSyntax
default BatchDetectSyntaxResponse batchDetectSyntax(Consumer<BatchDetectSyntaxRequest.Builder> batchDetectSyntaxRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, BatchSizeLimitExceededException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Inspects the text of a batch of documents for the syntax and part of speech of the words in the document and returns information about them. For more information, see 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 viaBatchDetectSyntaxRequest.builder()
- Parameters:
batchDetectSyntaxRequest
- AConsumer
that will call methods onBatchDetectSyntaxRequest.Builder
to create a request.- Returns:
- Result of the BatchDetectSyntax operation returned by the service.
- See Also:
-
batchDetectTargetedSentiment
default 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 in the Amazon Comprehend Developer Guide.
- Parameters:
batchDetectTargetedSentimentRequest
-- Returns:
- Result of the BatchDetectTargetedSentiment operation returned by the service.
- See Also:
-
batchDetectTargetedSentiment
default 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 in the Amazon Comprehend Developer Guide.
This is a convenience which creates an instance of the
BatchDetectTargetedSentimentRequest.Builder
avoiding the need to create one manually viaBatchDetectTargetedSentimentRequest.builder()
- Parameters:
batchDetectTargetedSentimentRequest
- AConsumer
that will call methods onBatchDetectTargetedSentimentRequest.Builder
to create a request.- Returns:
- Result of the BatchDetectTargetedSentiment operation returned by the service.
- See Also:
-
classifyDocument
default ClassifyDocumentResponse classifyDocument(ClassifyDocumentRequest classifyDocumentRequest) throws InvalidRequestException, ResourceUnavailableException, TextSizeLimitExceededException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Creates a classification request to analyze a single document in real-time.
ClassifyDocument
supports the following model types:-
Custom classifier - a custom model that you have created and trained. For input, you can provide plain text, a single-page document (PDF, Word, or image), or Textract API output. For more information, see Custom classification in the Amazon Comprehend Developer Guide.
-
Prompt classifier - Amazon Comprehend provides a model for classifying prompts. For input, you provide English plain text input. For prompt classification, the response includes only the
Classes
field. For more information about prompt classifiers, see Prompt classifiers in the Amazon Comprehend Developer Guide.
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.- Parameters:
classifyDocumentRequest
-- Returns:
- Result of the ClassifyDocument operation returned by the service.
- See Also:
-
-
classifyDocument
default ClassifyDocumentResponse classifyDocument(Consumer<ClassifyDocumentRequest.Builder> classifyDocumentRequest) throws InvalidRequestException, ResourceUnavailableException, TextSizeLimitExceededException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Creates a classification request to analyze a single document in real-time.
ClassifyDocument
supports the following model types:-
Custom classifier - a custom model that you have created and trained. For input, you can provide plain text, a single-page document (PDF, Word, or image), or Textract API output. For more information, see Custom classification in the Amazon Comprehend Developer Guide.
-
Prompt classifier - Amazon Comprehend provides a model for classifying prompts. For input, you provide English plain text input. For prompt classification, the response includes only the
Classes
field. For more information about prompt classifiers, see Prompt classifiers in the Amazon Comprehend Developer Guide.
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 viaClassifyDocumentRequest.builder()
- Parameters:
classifyDocumentRequest
- AConsumer
that will call methods onClassifyDocumentRequest.Builder
to create a request.- Returns:
- Result of the ClassifyDocument operation returned by the service.
- See Also:
-
-
containsPiiEntities
default 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.
- Parameters:
containsPiiEntitiesRequest
-- Returns:
- Result of the ContainsPiiEntities operation returned by the service.
- See Also:
-
containsPiiEntities
default 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 viaContainsPiiEntitiesRequest.builder()
- Parameters:
containsPiiEntitiesRequest
- AConsumer
that will call methods onContainsPiiEntitiesRequest.Builder
to create a request.- Returns:
- Result of the ContainsPiiEntities operation returned by the service.
- See Also:
-
createDataset
default 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.
- Parameters:
createDatasetRequest
-- Returns:
- Result of the CreateDataset operation returned by the service.
- See Also:
-
createDataset
default 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 viaCreateDatasetRequest.builder()
- Parameters:
createDatasetRequest
- AConsumer
that will call methods onCreateDatasetRequest.Builder
to create a request.- Returns:
- Result of the CreateDataset operation returned by the service.
- See Also:
-
createDocumentClassifier
default 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.
- Parameters:
createDocumentClassifierRequest
-- Returns:
- Result of the CreateDocumentClassifier operation returned by the service.
- See Also:
-
createDocumentClassifier
default 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 viaCreateDocumentClassifierRequest.builder()
- Parameters:
createDocumentClassifierRequest
- AConsumer
that will call methods onCreateDocumentClassifierRequest.Builder
to create a request.- Returns:
- Result of the CreateDocumentClassifier operation returned by the service.
- See Also:
-
createEndpoint
default 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.
- Parameters:
createEndpointRequest
-- Returns:
- Result of the CreateEndpoint operation returned by the service.
- See Also:
-
createEndpoint
default 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 viaCreateEndpointRequest.builder()
- Parameters:
createEndpointRequest
- AConsumer
that will call methods onCreateEndpointRequest.Builder
to create a request.- Returns:
- Result of the CreateEndpoint operation returned by the service.
- See Also:
-
createEntityRecognizer
default 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 theDescribeEntityRecognizer
API.- Parameters:
createEntityRecognizerRequest
-- Returns:
- Result of the CreateEntityRecognizer operation returned by the service.
- See Also:
-
createEntityRecognizer
default 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 theDescribeEntityRecognizer
API.
This is a convenience which creates an instance of the
CreateEntityRecognizerRequest.Builder
avoiding the need to create one manually viaCreateEntityRecognizerRequest.builder()
- Parameters:
createEntityRecognizerRequest
- AConsumer
that will call methods onCreateEntityRecognizerRequest.Builder
to create a request.- Returns:
- Result of the CreateEntityRecognizer operation returned by the service.
- See Also:
-
createFlywheel
default 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.
- Parameters:
createFlywheelRequest
-- Returns:
- Result of the CreateFlywheel operation returned by the service.
- See Also:
-
createFlywheel
default 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 viaCreateFlywheelRequest.builder()
- Parameters:
createFlywheelRequest
- AConsumer
that will call methods onCreateFlywheelRequest.Builder
to create a request.- Returns:
- Result of the CreateFlywheel operation returned by the service.
- See Also:
-
deleteDocumentClassifier
default DeleteDocumentClassifierResponse deleteDocumentClassifier(DeleteDocumentClassifierRequest deleteDocumentClassifierRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, ResourceUnavailableException, ResourceInUseException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Deletes a previously created document classifier
Only those classifiers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is using the model, a
ResourceInUseException
will be returned.This is an asynchronous action that puts the classifier into a DELETING state, and it is then removed by a background job. Once removed, the classifier disappears from your account and is no longer available for use.
- Parameters:
deleteDocumentClassifierRequest
-- Returns:
- Result of the DeleteDocumentClassifier operation returned by the service.
- See Also:
-
deleteDocumentClassifier
default DeleteDocumentClassifierResponse deleteDocumentClassifier(Consumer<DeleteDocumentClassifierRequest.Builder> deleteDocumentClassifierRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, ResourceUnavailableException, ResourceInUseException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Deletes a previously created document classifier
Only those classifiers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is using the model, a
ResourceInUseException
will be returned.This is an asynchronous action that puts the classifier into a DELETING state, and it is then removed by a background job. Once removed, the classifier disappears from your account and is no longer available for use.
This is a convenience which creates an instance of the
DeleteDocumentClassifierRequest.Builder
avoiding the need to create one manually viaDeleteDocumentClassifierRequest.builder()
- Parameters:
deleteDocumentClassifierRequest
- AConsumer
that will call methods onDeleteDocumentClassifierRequest.Builder
to create a request.- Returns:
- Result of the DeleteDocumentClassifier operation returned by the service.
- See Also:
-
deleteEndpoint
default 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.
- Parameters:
deleteEndpointRequest
-- Returns:
- Result of the DeleteEndpoint operation returned by the service.
- See Also:
-
deleteEndpoint
default 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 viaDeleteEndpointRequest.builder()
- Parameters:
deleteEndpointRequest
- AConsumer
that will call methods onDeleteEndpointRequest.Builder
to create a request.- Returns:
- Result of the DeleteEndpoint operation returned by the service.
- See Also:
-
deleteEntityRecognizer
default DeleteEntityRecognizerResponse deleteEntityRecognizer(DeleteEntityRecognizerRequest deleteEntityRecognizerRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, ResourceUnavailableException, ResourceInUseException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Deletes an entity recognizer.
Only those recognizers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is using the model, a
ResourceInUseException
will be returned.This is an asynchronous action that puts the recognizer into a DELETING state, and it is then removed by a background job. Once removed, the recognizer disappears from your account and is no longer available for use.
- Parameters:
deleteEntityRecognizerRequest
-- Returns:
- Result of the DeleteEntityRecognizer operation returned by the service.
- See Also:
-
deleteEntityRecognizer
default DeleteEntityRecognizerResponse deleteEntityRecognizer(Consumer<DeleteEntityRecognizerRequest.Builder> deleteEntityRecognizerRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, ResourceUnavailableException, ResourceInUseException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Deletes an entity recognizer.
Only those recognizers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is using the model, a
ResourceInUseException
will be returned.This is an asynchronous action that puts the recognizer into a DELETING state, and it is then removed by a background job. Once removed, the recognizer disappears from your account and is no longer available for use.
This is a convenience which creates an instance of the
DeleteEntityRecognizerRequest.Builder
avoiding the need to create one manually viaDeleteEntityRecognizerRequest.builder()
- Parameters:
deleteEntityRecognizerRequest
- AConsumer
that will call methods onDeleteEntityRecognizerRequest.Builder
to create a request.- Returns:
- Result of the DeleteEntityRecognizer operation returned by the service.
- See Also:
-
deleteFlywheel
default 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.
- Parameters:
deleteFlywheelRequest
-- Returns:
- Result of the DeleteFlywheel operation returned by the service.
- See Also:
-
deleteFlywheel
default 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 viaDeleteFlywheelRequest.builder()
- Parameters:
deleteFlywheelRequest
- AConsumer
that will call methods onDeleteFlywheelRequest.Builder
to create a request.- Returns:
- Result of the DeleteFlywheel operation returned by the service.
- See Also:
-
deleteResourcePolicy
default DeleteResourcePolicyResponse deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest) throws InvalidRequestException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Deletes a resource-based policy that is attached to a custom model.
- Parameters:
deleteResourcePolicyRequest
-- Returns:
- Result of the DeleteResourcePolicy operation returned by the service.
- See Also:
-
deleteResourcePolicy
default 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 viaDeleteResourcePolicyRequest.builder()
- Parameters:
deleteResourcePolicyRequest
- AConsumer
that will call methods onDeleteResourcePolicyRequest.Builder
to create a request.- Returns:
- Result of the DeleteResourcePolicy operation returned by the service.
- See Also:
-
describeDataset
default 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.
- Parameters:
describeDatasetRequest
-- Returns:
- Result of the DescribeDataset operation returned by the service.
- See Also:
-
describeDataset
default 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 viaDescribeDatasetRequest.builder()
- Parameters:
describeDatasetRequest
- AConsumer
that will call methods onDescribeDatasetRequest.Builder
to create a request.- Returns:
- Result of the DescribeDataset operation returned by the service.
- See Also:
-
describeDocumentClassificationJob
default DescribeDocumentClassificationJobResponse describeDocumentClassificationJob(DescribeDocumentClassificationJobRequest describeDocumentClassificationJobRequest) throws InvalidRequestException, TooManyRequestsException, JobNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Gets the properties associated with a document classification job. Use this operation to get the status of a classification job.
- Parameters:
describeDocumentClassificationJobRequest
-- Returns:
- Result of the DescribeDocumentClassificationJob operation returned by the service.
- See Also:
-
describeDocumentClassificationJob
default DescribeDocumentClassificationJobResponse describeDocumentClassificationJob(Consumer<DescribeDocumentClassificationJobRequest.Builder> describeDocumentClassificationJobRequest) throws InvalidRequestException, TooManyRequestsException, JobNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Gets the properties associated with a document classification job. Use this operation to get the status of a classification job.
This is a convenience which creates an instance of the
DescribeDocumentClassificationJobRequest.Builder
avoiding the need to create one manually viaDescribeDocumentClassificationJobRequest.builder()
- Parameters:
describeDocumentClassificationJobRequest
- AConsumer
that will call methods onDescribeDocumentClassificationJobRequest.Builder
to create a request.- Returns:
- Result of the DescribeDocumentClassificationJob operation returned by the service.
- See Also:
-
describeDocumentClassifier
default DescribeDocumentClassifierResponse describeDocumentClassifier(DescribeDocumentClassifierRequest describeDocumentClassifierRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Gets the properties associated with a document classifier.
- Parameters:
describeDocumentClassifierRequest
-- Returns:
- Result of the DescribeDocumentClassifier operation returned by the service.
- See Also:
-
describeDocumentClassifier
default DescribeDocumentClassifierResponse describeDocumentClassifier(Consumer<DescribeDocumentClassifierRequest.Builder> describeDocumentClassifierRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Gets the properties associated with a document classifier.
This is a convenience which creates an instance of the
DescribeDocumentClassifierRequest.Builder
avoiding the need to create one manually viaDescribeDocumentClassifierRequest.builder()
- Parameters:
describeDocumentClassifierRequest
- AConsumer
that will call methods onDescribeDocumentClassifierRequest.Builder
to create a request.- Returns:
- Result of the DescribeDocumentClassifier operation returned by the service.
- See Also:
-
describeDominantLanguageDetectionJob
default DescribeDominantLanguageDetectionJobResponse describeDominantLanguageDetectionJob(DescribeDominantLanguageDetectionJobRequest describeDominantLanguageDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Gets the properties associated with a dominant language detection job. Use this operation to get the status of a detection job.
- Parameters:
describeDominantLanguageDetectionJobRequest
-- Returns:
- Result of the DescribeDominantLanguageDetectionJob operation returned by the service.
- See Also:
-
describeDominantLanguageDetectionJob
default DescribeDominantLanguageDetectionJobResponse describeDominantLanguageDetectionJob(Consumer<DescribeDominantLanguageDetectionJobRequest.Builder> describeDominantLanguageDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Gets the properties associated with a dominant language detection job. Use this operation to get the status of a detection job.
This is a convenience which creates an instance of the
DescribeDominantLanguageDetectionJobRequest.Builder
avoiding the need to create one manually viaDescribeDominantLanguageDetectionJobRequest.builder()
- Parameters:
describeDominantLanguageDetectionJobRequest
- AConsumer
that will call methods onDescribeDominantLanguageDetectionJobRequest.Builder
to create a request.- Returns:
- Result of the DescribeDominantLanguageDetectionJob operation returned by the service.
- See Also:
-
describeEndpoint
default 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.
- Parameters:
describeEndpointRequest
-- Returns:
- Result of the DescribeEndpoint operation returned by the service.
- See Also:
-
describeEndpoint
default 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 viaDescribeEndpointRequest.builder()
- Parameters:
describeEndpointRequest
- AConsumer
that will call methods onDescribeEndpointRequest.Builder
to create a request.- Returns:
- Result of the DescribeEndpoint operation returned by the service.
- See Also:
-
describeEntitiesDetectionJob
default DescribeEntitiesDetectionJobResponse describeEntitiesDetectionJob(DescribeEntitiesDetectionJobRequest describeEntitiesDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Gets the properties associated with an entities detection job. Use this operation to get the status of a detection job.
- Parameters:
describeEntitiesDetectionJobRequest
-- Returns:
- Result of the DescribeEntitiesDetectionJob operation returned by the service.
- See Also:
-
describeEntitiesDetectionJob
default DescribeEntitiesDetectionJobResponse describeEntitiesDetectionJob(Consumer<DescribeEntitiesDetectionJobRequest.Builder> describeEntitiesDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Gets the properties associated with an entities detection job. Use this operation to get the status of a detection job.
This is a convenience which creates an instance of the
DescribeEntitiesDetectionJobRequest.Builder
avoiding the need to create one manually viaDescribeEntitiesDetectionJobRequest.builder()
- Parameters:
describeEntitiesDetectionJobRequest
- AConsumer
that will call methods onDescribeEntitiesDetectionJobRequest.Builder
to create a request.- Returns:
- Result of the DescribeEntitiesDetectionJob operation returned by the service.
- See Also:
-
describeEntityRecognizer
default DescribeEntityRecognizerResponse describeEntityRecognizer(DescribeEntityRecognizerRequest describeEntityRecognizerRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on.
- Parameters:
describeEntityRecognizerRequest
-- Returns:
- Result of the DescribeEntityRecognizer operation returned by the service.
- See Also:
-
describeEntityRecognizer
default DescribeEntityRecognizerResponse describeEntityRecognizer(Consumer<DescribeEntityRecognizerRequest.Builder> describeEntityRecognizerRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on.
This is a convenience which creates an instance of the
DescribeEntityRecognizerRequest.Builder
avoiding the need to create one manually viaDescribeEntityRecognizerRequest.builder()
- Parameters:
describeEntityRecognizerRequest
- AConsumer
that will call methods onDescribeEntityRecognizerRequest.Builder
to create a request.- Returns:
- Result of the DescribeEntityRecognizer operation returned by the service.
- See Also:
-
describeEventsDetectionJob
default DescribeEventsDetectionJobResponse describeEventsDetectionJob(DescribeEventsDetectionJobRequest describeEventsDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Gets the status and details of an events detection job.
- Parameters:
describeEventsDetectionJobRequest
-- Returns:
- Result of the DescribeEventsDetectionJob operation returned by the service.
- See Also:
-
describeEventsDetectionJob
default 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 viaDescribeEventsDetectionJobRequest.builder()
- Parameters:
describeEventsDetectionJobRequest
- AConsumer
that will call methods onDescribeEventsDetectionJobRequest.Builder
to create a request.- Returns:
- Result of the DescribeEventsDetectionJob operation returned by the service.
- See Also:
-
describeFlywheel
default 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.
- Parameters:
describeFlywheelRequest
-- Returns:
- Result of the DescribeFlywheel operation returned by the service.
- See Also:
-
describeFlywheel
default 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 viaDescribeFlywheelRequest.builder()
- Parameters:
describeFlywheelRequest
- AConsumer
that will call methods onDescribeFlywheelRequest.Builder
to create a request.- Returns:
- Result of the DescribeFlywheel operation returned by the service.
- See Also:
-
describeFlywheelIteration
default 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.
- Parameters:
describeFlywheelIterationRequest
-- Returns:
- Result of the DescribeFlywheelIteration operation returned by the service.
- See Also:
-
describeFlywheelIteration
default 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 viaDescribeFlywheelIterationRequest.builder()
- Parameters:
describeFlywheelIterationRequest
- AConsumer
that will call methods onDescribeFlywheelIterationRequest.Builder
to create a request.- Returns:
- Result of the DescribeFlywheelIteration operation returned by the service.
- See Also:
-
describeKeyPhrasesDetectionJob
default DescribeKeyPhrasesDetectionJobResponse describeKeyPhrasesDetectionJob(DescribeKeyPhrasesDetectionJobRequest describeKeyPhrasesDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Gets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job.
- Parameters:
describeKeyPhrasesDetectionJobRequest
-- Returns:
- Result of the DescribeKeyPhrasesDetectionJob operation returned by the service.
- See Also:
-
describeKeyPhrasesDetectionJob
default DescribeKeyPhrasesDetectionJobResponse describeKeyPhrasesDetectionJob(Consumer<DescribeKeyPhrasesDetectionJobRequest.Builder> describeKeyPhrasesDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Gets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job.
This is a convenience which creates an instance of the
DescribeKeyPhrasesDetectionJobRequest.Builder
avoiding the need to create one manually viaDescribeKeyPhrasesDetectionJobRequest.builder()
- Parameters:
describeKeyPhrasesDetectionJobRequest
- AConsumer
that will call methods onDescribeKeyPhrasesDetectionJobRequest.Builder
to create a request.- Returns:
- Result of the DescribeKeyPhrasesDetectionJob operation returned by the service.
- See Also:
-
describePiiEntitiesDetectionJob
default 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.
- Parameters:
describePiiEntitiesDetectionJobRequest
-- Returns:
- Result of the DescribePiiEntitiesDetectionJob operation returned by the service.
- See Also:
-
describePiiEntitiesDetectionJob
default 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 viaDescribePiiEntitiesDetectionJobRequest.builder()
- Parameters:
describePiiEntitiesDetectionJobRequest
- AConsumer
that will call methods onDescribePiiEntitiesDetectionJobRequest.Builder
to create a request.- Returns:
- Result of the DescribePiiEntitiesDetectionJob operation returned by the service.
- See Also:
-
describeResourcePolicy
default 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.
- Parameters:
describeResourcePolicyRequest
-- Returns:
- Result of the DescribeResourcePolicy operation returned by the service.
- See Also:
-
describeResourcePolicy
default 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 viaDescribeResourcePolicyRequest.builder()
- Parameters:
describeResourcePolicyRequest
- AConsumer
that will call methods onDescribeResourcePolicyRequest.Builder
to create a request.- Returns:
- Result of the DescribeResourcePolicy operation returned by the service.
- See Also:
-
describeSentimentDetectionJob
default DescribeSentimentDetectionJobResponse describeSentimentDetectionJob(DescribeSentimentDetectionJobRequest describeSentimentDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Gets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job.
- Parameters:
describeSentimentDetectionJobRequest
-- Returns:
- Result of the DescribeSentimentDetectionJob operation returned by the service.
- See Also:
-
describeSentimentDetectionJob
default DescribeSentimentDetectionJobResponse describeSentimentDetectionJob(Consumer<DescribeSentimentDetectionJobRequest.Builder> describeSentimentDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Gets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job.
This is a convenience which creates an instance of the
DescribeSentimentDetectionJobRequest.Builder
avoiding the need to create one manually viaDescribeSentimentDetectionJobRequest.builder()
- Parameters:
describeSentimentDetectionJobRequest
- AConsumer
that will call methods onDescribeSentimentDetectionJobRequest.Builder
to create a request.- Returns:
- Result of the DescribeSentimentDetectionJob operation returned by the service.
- See Also:
-
describeTargetedSentimentDetectionJob
default 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.
- Parameters:
describeTargetedSentimentDetectionJobRequest
-- Returns:
- Result of the DescribeTargetedSentimentDetectionJob operation returned by the service.
- See Also:
-
describeTargetedSentimentDetectionJob
default 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 viaDescribeTargetedSentimentDetectionJobRequest.builder()
- Parameters:
describeTargetedSentimentDetectionJobRequest
- AConsumer
that will call methods onDescribeTargetedSentimentDetectionJobRequest.Builder
to create a request.- Returns:
- Result of the DescribeTargetedSentimentDetectionJob operation returned by the service.
- See Also:
-
describeTopicsDetectionJob
default DescribeTopicsDetectionJobResponse describeTopicsDetectionJob(DescribeTopicsDetectionJobRequest describeTopicsDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Gets the properties associated with a topic detection job. Use this operation to get the status of a detection job.
- Parameters:
describeTopicsDetectionJobRequest
-- Returns:
- Result of the DescribeTopicsDetectionJob operation returned by the service.
- See Also:
-
describeTopicsDetectionJob
default DescribeTopicsDetectionJobResponse describeTopicsDetectionJob(Consumer<DescribeTopicsDetectionJobRequest.Builder> describeTopicsDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Gets the properties associated with a topic detection job. Use this operation to get the status of a detection job.
This is a convenience which creates an instance of the
DescribeTopicsDetectionJobRequest.Builder
avoiding the need to create one manually viaDescribeTopicsDetectionJobRequest.builder()
- Parameters:
describeTopicsDetectionJobRequest
- AConsumer
that will call methods onDescribeTopicsDetectionJobRequest.Builder
to create a request.- Returns:
- Result of the DescribeTopicsDetectionJob operation returned by the service.
- See Also:
-
detectDominantLanguage
default DetectDominantLanguageResponse detectDominantLanguage(DetectDominantLanguageRequest detectDominantLanguageRequest) throws InvalidRequestException, TextSizeLimitExceededException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.
- Parameters:
detectDominantLanguageRequest
-- Returns:
- Result of the DetectDominantLanguage operation returned by the service.
- See Also:
-
detectDominantLanguage
default DetectDominantLanguageResponse detectDominantLanguage(Consumer<DetectDominantLanguageRequest.Builder> detectDominantLanguageRequest) throws InvalidRequestException, TextSizeLimitExceededException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.
This is a convenience which creates an instance of the
DetectDominantLanguageRequest.Builder
avoiding the need to create one manually viaDetectDominantLanguageRequest.builder()
- Parameters:
detectDominantLanguageRequest
- AConsumer
that will call methods onDetectDominantLanguageRequest.Builder
to create a request.- Returns:
- Result of the DetectDominantLanguage operation returned by the service.
- See Also:
-
detectEntities
default 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.- Parameters:
detectEntitiesRequest
-- Returns:
- Result of the DetectEntities operation returned by the service.
- See Also:
-
detectEntities
default 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 viaDetectEntitiesRequest.builder()
- Parameters:
detectEntitiesRequest
- AConsumer
that will call methods onDetectEntitiesRequest.Builder
to create a request.- Returns:
- Result of the DetectEntities operation returned by the service.
- See Also:
-
detectKeyPhrases
default DetectKeyPhrasesResponse detectKeyPhrases(DetectKeyPhrasesRequest detectKeyPhrasesRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Detects the key noun phrases found in the text.
- Parameters:
detectKeyPhrasesRequest
-- Returns:
- Result of the DetectKeyPhrases operation returned by the service.
- See Also:
-
detectKeyPhrases
default DetectKeyPhrasesResponse detectKeyPhrases(Consumer<DetectKeyPhrasesRequest.Builder> detectKeyPhrasesRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Detects the key noun phrases found in the text.
This is a convenience which creates an instance of the
DetectKeyPhrasesRequest.Builder
avoiding the need to create one manually viaDetectKeyPhrasesRequest.builder()
- Parameters:
detectKeyPhrasesRequest
- AConsumer
that will call methods onDetectKeyPhrasesRequest.Builder
to create a request.- Returns:
- Result of the DetectKeyPhrases operation returned by the service.
- See Also:
-
detectPiiEntities
default 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.
- Parameters:
detectPiiEntitiesRequest
-- Returns:
- Result of the DetectPiiEntities operation returned by the service.
- See Also:
-
detectPiiEntities
default 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 viaDetectPiiEntitiesRequest.builder()
- Parameters:
detectPiiEntitiesRequest
- AConsumer
that will call methods onDetectPiiEntitiesRequest.Builder
to create a request.- Returns:
- Result of the DetectPiiEntities operation returned by the service.
- See Also:
-
detectSentiment
default DetectSentimentResponse detectSentiment(DetectSentimentRequest detectSentimentRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Inspects text and returns an inference of the prevailing sentiment (
POSITIVE
,NEUTRAL
,MIXED
, orNEGATIVE
).- Parameters:
detectSentimentRequest
-- Returns:
- Result of the DetectSentiment operation returned by the service.
- See Also:
-
detectSentiment
default DetectSentimentResponse detectSentiment(Consumer<DetectSentimentRequest.Builder> detectSentimentRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Inspects text and returns an inference of the prevailing sentiment (
POSITIVE
,NEUTRAL
,MIXED
, orNEGATIVE
).
This is a convenience which creates an instance of the
DetectSentimentRequest.Builder
avoiding the need to create one manually viaDetectSentimentRequest.builder()
- Parameters:
detectSentimentRequest
- AConsumer
that will call methods onDetectSentimentRequest.Builder
to create a request.- Returns:
- Result of the DetectSentiment operation returned by the service.
- See Also:
-
detectSyntax
default DetectSyntaxResponse detectSyntax(DetectSyntaxRequest detectSyntaxRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Inspects text for syntax and the part of speech of words in the document. For more information, see Syntax in the Comprehend Developer Guide.
- Parameters:
detectSyntaxRequest
-- Returns:
- Result of the DetectSyntax operation returned by the service.
- See Also:
-
detectSyntax
default DetectSyntaxResponse detectSyntax(Consumer<DetectSyntaxRequest.Builder> detectSyntaxRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Inspects text for syntax and the part of speech of words in the document. For more information, 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 viaDetectSyntaxRequest.builder()
- Parameters:
detectSyntaxRequest
- AConsumer
that will call methods onDetectSyntaxRequest.Builder
to create a request.- Returns:
- Result of the DetectSyntax operation returned by the service.
- See Also:
-
detectTargetedSentiment
default 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 in the Amazon Comprehend Developer Guide.
- Parameters:
detectTargetedSentimentRequest
-- Returns:
- Result of the DetectTargetedSentiment operation returned by the service.
- See Also:
-
detectTargetedSentiment
default 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 in the Amazon Comprehend Developer Guide.
This is a convenience which creates an instance of the
DetectTargetedSentimentRequest.Builder
avoiding the need to create one manually viaDetectTargetedSentimentRequest.builder()
- Parameters:
detectTargetedSentimentRequest
- AConsumer
that will call methods onDetectTargetedSentimentRequest.Builder
to create a request.- Returns:
- Result of the DetectTargetedSentiment operation returned by the service.
- See Also:
-
detectToxicContent
default DetectToxicContentResponse detectToxicContent(DetectToxicContentRequest detectToxicContentRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Performs toxicity analysis on the list of text strings that you provide as input. The analysis uses the order of strings in the list to determine context when predicting toxicity. The API response contains a results list that matches the size of the input list. For more information about toxicity detection, see Toxicity detection in the Amazon Comprehend Developer Guide
- Parameters:
detectToxicContentRequest
-- Returns:
- Result of the DetectToxicContent operation returned by the service.
- See Also:
-
detectToxicContent
default DetectToxicContentResponse detectToxicContent(Consumer<DetectToxicContentRequest.Builder> detectToxicContentRequest) throws InvalidRequestException, TextSizeLimitExceededException, UnsupportedLanguageException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Performs toxicity analysis on the list of text strings that you provide as input. The analysis uses the order of strings in the list to determine context when predicting toxicity. The API response contains a results list that matches the size of the input list. For more information about toxicity detection, see Toxicity detection in the Amazon Comprehend Developer Guide
This is a convenience which creates an instance of the
DetectToxicContentRequest.Builder
avoiding the need to create one manually viaDetectToxicContentRequest.builder()
- Parameters:
detectToxicContentRequest
- AConsumer
that will call methods onDetectToxicContentRequest.Builder
to create a request.- Returns:
- Result of the DetectToxicContent operation returned by the service.
- See Also:
-
importModel
default 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.
- Parameters:
importModelRequest
-- Returns:
- Result of the ImportModel operation returned by the service.
- See Also:
-
importModel
default 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 viaImportModelRequest.builder()
- Parameters:
importModelRequest
- AConsumer
that will call methods onImportModelRequest.Builder
to create a request.- Returns:
- Result of the ImportModel operation returned by the service.
- See Also:
-
listDatasets
default 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.
- Parameters:
listDatasetsRequest
-- Returns:
- Result of the ListDatasets operation returned by the service.
- See Also:
-
listDatasets
default 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 viaListDatasetsRequest.builder()
- Parameters:
listDatasetsRequest
- AConsumer
that will call methods onListDatasetsRequest.Builder
to create a request.- Returns:
- Result of the ListDatasets operation returned by the service.
- See Also:
-
listDatasetsPaginator
default 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 Streamsoftware.amazon.awssdk.services.comprehend.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listDatasetsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDatasetsPaginator
default 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 Streamsoftware.amazon.awssdk.services.comprehend.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListDatasetsRequest.builder()
- Parameters:
listDatasetsRequest
- AConsumer
that will call methods onListDatasetsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDocumentClassificationJobs
default ListDocumentClassificationJobsResponse listDocumentClassificationJobs(ListDocumentClassificationJobsRequest listDocumentClassificationJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Gets a list of the documentation classification jobs that you have submitted.
- Parameters:
listDocumentClassificationJobsRequest
-- Returns:
- Result of the ListDocumentClassificationJobs operation returned by the service.
- See Also:
-
listDocumentClassificationJobs
default ListDocumentClassificationJobsResponse listDocumentClassificationJobs(Consumer<ListDocumentClassificationJobsRequest.Builder> listDocumentClassificationJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Gets a list of the documentation classification jobs that you have submitted.
This is a convenience which creates an instance of the
ListDocumentClassificationJobsRequest.Builder
avoiding the need to create one manually viaListDocumentClassificationJobsRequest.builder()
- Parameters:
listDocumentClassificationJobsRequest
- AConsumer
that will call methods onListDocumentClassificationJobsRequest.Builder
to create a request.- Returns:
- Result of the ListDocumentClassificationJobs operation returned by the service.
- See Also:
-
listDocumentClassificationJobs
default ListDocumentClassificationJobsResponse listDocumentClassificationJobs() throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendExceptionGets a list of the documentation classification jobs that you have submitted.
- Returns:
- Result of the ListDocumentClassificationJobs operation returned by the service.
- See Also:
-
listDocumentClassificationJobsPaginator
default ListDocumentClassificationJobsIterable listDocumentClassificationJobsPaginator() throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendExceptionGets 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 Streamsoftware.amazon.awssdk.services.comprehend.paginators.ListDocumentClassificationJobsIterable responses = client.listDocumentClassificationJobsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDocumentClassificationJobsPaginator
default 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 Streamsoftware.amazon.awssdk.services.comprehend.paginators.ListDocumentClassificationJobsIterable responses = client.listDocumentClassificationJobsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listDocumentClassificationJobsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDocumentClassificationJobsPaginator
default 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 Streamsoftware.amazon.awssdk.services.comprehend.paginators.ListDocumentClassificationJobsIterable responses = client.listDocumentClassificationJobsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListDocumentClassificationJobsRequest.builder()
- Parameters:
listDocumentClassificationJobsRequest
- AConsumer
that will call methods onListDocumentClassificationJobsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDocumentClassifierSummaries
default ListDocumentClassifierSummariesResponse listDocumentClassifierSummaries(ListDocumentClassifierSummariesRequest listDocumentClassifierSummariesRequest) throws InvalidRequestException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Gets a list of summaries of the document classifiers that you have created
- Parameters:
listDocumentClassifierSummariesRequest
-- Returns:
- Result of the ListDocumentClassifierSummaries operation returned by the service.
- See Also:
-
listDocumentClassifierSummaries
default 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 viaListDocumentClassifierSummariesRequest.builder()
- Parameters:
listDocumentClassifierSummariesRequest
- AConsumer
that will call methods onListDocumentClassifierSummariesRequest.Builder
to create a request.- Returns:
- Result of the ListDocumentClassifierSummaries operation returned by the service.
- See Also:
-
listDocumentClassifierSummariesPaginator
default 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 Streamsoftware.amazon.awssdk.services.comprehend.paginators.ListDocumentClassifierSummariesIterable responses = client.listDocumentClassifierSummariesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listDocumentClassifierSummariesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDocumentClassifierSummariesPaginator
default 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 Streamsoftware.amazon.awssdk.services.comprehend.paginators.ListDocumentClassifierSummariesIterable responses = client.listDocumentClassifierSummariesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListDocumentClassifierSummariesRequest.builder()
- Parameters:
listDocumentClassifierSummariesRequest
- AConsumer
that will call methods onListDocumentClassifierSummariesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDocumentClassifiers
default ListDocumentClassifiersResponse listDocumentClassifiers(ListDocumentClassifiersRequest listDocumentClassifiersRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Gets a list of the document classifiers that you have created.
- Parameters:
listDocumentClassifiersRequest
-- Returns:
- Result of the ListDocumentClassifiers operation returned by the service.
- See Also:
-
listDocumentClassifiers
default ListDocumentClassifiersResponse listDocumentClassifiers(Consumer<ListDocumentClassifiersRequest.Builder> listDocumentClassifiersRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Gets a list of the document classifiers that you have created.
This is a convenience which creates an instance of the
ListDocumentClassifiersRequest.Builder
avoiding the need to create one manually viaListDocumentClassifiersRequest.builder()
- Parameters:
listDocumentClassifiersRequest
- AConsumer
that will call methods onListDocumentClassifiersRequest.Builder
to create a request.- Returns:
- Result of the ListDocumentClassifiers operation returned by the service.
- See Also:
-
listDocumentClassifiers
default ListDocumentClassifiersResponse listDocumentClassifiers() throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendExceptionGets a list of the document classifiers that you have created.
- Returns:
- Result of the ListDocumentClassifiers operation returned by the service.
- See Also:
-
listDocumentClassifiersPaginator
default ListDocumentClassifiersIterable listDocumentClassifiersPaginator() throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendExceptionGets 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 Streamsoftware.amazon.awssdk.services.comprehend.paginators.ListDocumentClassifiersIterable responses = client.listDocumentClassifiersPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDocumentClassifiersPaginator
default 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 Streamsoftware.amazon.awssdk.services.comprehend.paginators.ListDocumentClassifiersIterable responses = client.listDocumentClassifiersPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listDocumentClassifiersRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDocumentClassifiersPaginator
default 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 Streamsoftware.amazon.awssdk.services.comprehend.paginators.ListDocumentClassifiersIterable responses = client.listDocumentClassifiersPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListDocumentClassifiersRequest.builder()
- Parameters:
listDocumentClassifiersRequest
- AConsumer
that will call methods onListDocumentClassifiersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDominantLanguageDetectionJobs
default 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.
- Parameters:
listDominantLanguageDetectionJobsRequest
-- Returns:
- Result of the ListDominantLanguageDetectionJobs operation returned by the service.
- See Also:
-
listDominantLanguageDetectionJobs
default ListDominantLanguageDetectionJobsResponse listDominantLanguageDetectionJobs(Consumer<ListDominantLanguageDetectionJobsRequest.Builder> listDominantLanguageDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Gets a list of the dominant language detection jobs that you have submitted.
This is a convenience which creates an instance of the
ListDominantLanguageDetectionJobsRequest.Builder
avoiding the need to create one manually viaListDominantLanguageDetectionJobsRequest.builder()
- Parameters:
listDominantLanguageDetectionJobsRequest
- AConsumer
that will call methods onListDominantLanguageDetectionJobsRequest.Builder
to create a request.- Returns:
- Result of the ListDominantLanguageDetectionJobs operation returned by the service.
- See Also:
-
listDominantLanguageDetectionJobs
default ListDominantLanguageDetectionJobsResponse listDominantLanguageDetectionJobs() throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendExceptionGets a list of the dominant language detection jobs that you have submitted.
- Returns:
- Result of the ListDominantLanguageDetectionJobs operation returned by the service.
- See Also:
-
listDominantLanguageDetectionJobsPaginator
default ListDominantLanguageDetectionJobsIterable listDominantLanguageDetectionJobsPaginator() throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendExceptionGets 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 Streamsoftware.amazon.awssdk.services.comprehend.paginators.ListDominantLanguageDetectionJobsIterable responses = client.listDominantLanguageDetectionJobsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDominantLanguageDetectionJobsPaginator
default 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 Streamsoftware.amazon.awssdk.services.comprehend.paginators.ListDominantLanguageDetectionJobsIterable responses = client.listDominantLanguageDetectionJobsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listDominantLanguageDetectionJobsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDominantLanguageDetectionJobsPaginator
default ListDominantLanguageDetectionJobsIterable listDominantLanguageDetectionJobsPaginator(Consumer<ListDominantLanguageDetectionJobsRequest.Builder> listDominantLanguageDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Gets a list of the dominant language detection jobs that you have submitted.
This is a variant of
listDominantLanguageDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListDominantLanguageDetectionJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.comprehend.paginators.ListDominantLanguageDetectionJobsIterable responses = client.listDominantLanguageDetectionJobsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListDominantLanguageDetectionJobsRequest.builder()
- Parameters:
listDominantLanguageDetectionJobsRequest
- AConsumer
that will call methods onListDominantLanguageDetectionJobsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listEndpoints
default 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.
- Parameters:
listEndpointsRequest
-- Returns:
- Result of the ListEndpoints operation returned by the service.
- See Also:
-
listEndpoints
default 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 viaListEndpointsRequest.builder()
- Parameters:
listEndpointsRequest
- AConsumer
that will call methods onListEndpointsRequest.Builder
to create a request.- Returns:
- Result of the ListEndpoints operation returned by the service.
- See Also:
-
listEndpointsPaginator
default 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 Streamsoftware.amazon.awssdk.services.comprehend.paginators.ListEndpointsIterable responses = client.listEndpointsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listEndpointsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listEndpointsPaginator
default 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 Streamsoftware.amazon.awssdk.services.comprehend.paginators.ListEndpointsIterable responses = client.listEndpointsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListEndpointsRequest.builder()
- Parameters:
listEndpointsRequest
- AConsumer
that will call methods onListEndpointsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listEntitiesDetectionJobs
default ListEntitiesDetectionJobsResponse listEntitiesDetectionJobs(ListEntitiesDetectionJobsRequest listEntitiesDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Gets a list of the entity detection jobs that you have submitted.
- Parameters:
listEntitiesDetectionJobsRequest
-- Returns:
- Result of the ListEntitiesDetectionJobs operation returned by the service.
- See Also:
-
listEntitiesDetectionJobs
default ListEntitiesDetectionJobsResponse listEntitiesDetectionJobs(Consumer<ListEntitiesDetectionJobsRequest.Builder> listEntitiesDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Gets a list of the entity detection jobs that you have submitted.
This is a convenience which creates an instance of the
ListEntitiesDetectionJobsRequest.Builder
avoiding the need to create one manually viaListEntitiesDetectionJobsRequest.builder()
- Parameters:
listEntitiesDetectionJobsRequest
- AConsumer
that will call methods onListEntitiesDetectionJobsRequest.Builder
to create a request.- Returns:
- Result of the ListEntitiesDetectionJobs operation returned by the service.
- See Also:
-
listEntitiesDetectionJobs
default ListEntitiesDetectionJobsResponse listEntitiesDetectionJobs() throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendExceptionGets a list of the entity detection jobs that you have submitted.
- Returns:
- Result of the ListEntitiesDetectionJobs operation returned by the service.
- See Also:
-
listEntitiesDetectionJobsPaginator
default ListEntitiesDetectionJobsIterable listEntitiesDetectionJobsPaginator() throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendExceptionGets 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 Streamsoftware.amazon.awssdk.services.comprehend.paginators.ListEntitiesDetectionJobsIterable responses = client.listEntitiesDetectionJobsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listEntitiesDetectionJobsPaginator
default 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 Streamsoftware.amazon.awssdk.services.comprehend.paginators.ListEntitiesDetectionJobsIterable responses = client.listEntitiesDetectionJobsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listEntitiesDetectionJobsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listEntitiesDetectionJobsPaginator
default ListEntitiesDetectionJobsIterable listEntitiesDetectionJobsPaginator(Consumer<ListEntitiesDetectionJobsRequest.Builder> listEntitiesDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Gets a list of the entity detection jobs that you have submitted.
This is a variant of
listEntitiesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListEntitiesDetectionJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.comprehend.paginators.ListEntitiesDetectionJobsIterable responses = client.listEntitiesDetectionJobsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListEntitiesDetectionJobsRequest.builder()
- Parameters:
listEntitiesDetectionJobsRequest
- AConsumer
that will call methods onListEntitiesDetectionJobsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listEntityRecognizerSummaries
default ListEntityRecognizerSummariesResponse listEntityRecognizerSummaries(ListEntityRecognizerSummariesRequest listEntityRecognizerSummariesRequest) throws InvalidRequestException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Gets a list of summaries for the entity recognizers that you have created.
- Parameters:
listEntityRecognizerSummariesRequest
-- Returns:
- Result of the ListEntityRecognizerSummaries operation returned by the service.
- See Also:
-
listEntityRecognizerSummaries
default 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 viaListEntityRecognizerSummariesRequest.builder()
- Parameters:
listEntityRecognizerSummariesRequest
- AConsumer
that will call methods onListEntityRecognizerSummariesRequest.Builder
to create a request.- Returns:
- Result of the ListEntityRecognizerSummaries operation returned by the service.
- See Also:
-
listEntityRecognizerSummariesPaginator
default 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 Streamsoftware.amazon.awssdk.services.comprehend.paginators.ListEntityRecognizerSummariesIterable responses = client.listEntityRecognizerSummariesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listEntityRecognizerSummariesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listEntityRecognizerSummariesPaginator
default 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 Streamsoftware.amazon.awssdk.services.comprehend.paginators.ListEntityRecognizerSummariesIterable responses = client.listEntityRecognizerSummariesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListEntityRecognizerSummariesRequest.builder()
- Parameters:
listEntityRecognizerSummariesRequest
- AConsumer
that will call methods onListEntityRecognizerSummariesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listEntityRecognizers
default 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.
- Parameters:
listEntityRecognizersRequest
-- Returns:
- Result of the ListEntityRecognizers operation returned by the service.
- See Also:
-
listEntityRecognizers
default ListEntityRecognizersResponse listEntityRecognizers(Consumer<ListEntityRecognizersRequest.Builder> listEntityRecognizersRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Gets a list of the properties of all entity recognizers that you created, including recognizers currently in training. Allows you to filter the list of recognizers based on criteria such as status and submission time. This call returns up to 500 entity recognizers in the list, with a default number of 100 recognizers in the list.
The results of this list are not in any particular order. Please get the list and sort locally if needed.
This is a convenience which creates an instance of the
ListEntityRecognizersRequest.Builder
avoiding the need to create one manually viaListEntityRecognizersRequest.builder()
- Parameters:
listEntityRecognizersRequest
- AConsumer
that will call methods onListEntityRecognizersRequest.Builder
to create a request.- Returns:
- Result of the ListEntityRecognizers operation returned by the service.
- See Also:
-
listEntityRecognizers
default ListEntityRecognizersResponse listEntityRecognizers() throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendExceptionGets 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.
- Returns:
- Result of the ListEntityRecognizers operation returned by the service.
- See Also:
-
listEntityRecognizersPaginator
default ListEntityRecognizersIterable listEntityRecognizersPaginator() throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendExceptionGets 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 Streamsoftware.amazon.awssdk.services.comprehend.paginators.ListEntityRecognizersIterable responses = client.listEntityRecognizersPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listEntityRecognizersPaginator
default 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 Streamsoftware.amazon.awssdk.services.comprehend.paginators.ListEntityRecognizersIterable responses = client.listEntityRecognizersPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listEntityRecognizersRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listEntityRecognizersPaginator
default 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 Streamsoftware.amazon.awssdk.services.comprehend.paginators.ListEntityRecognizersIterable responses = client.listEntityRecognizersPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListEntityRecognizersRequest.builder()
- Parameters:
listEntityRecognizersRequest
- AConsumer
that will call methods onListEntityRecognizersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listEventsDetectionJobs
default ListEventsDetectionJobsResponse listEventsDetectionJobs(ListEventsDetectionJobsRequest listEventsDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Gets a list of the events detection jobs that you have submitted.
- Parameters:
listEventsDetectionJobsRequest
-- Returns:
- Result of the ListEventsDetectionJobs operation returned by the service.
- See Also:
-
listEventsDetectionJobs
default 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 viaListEventsDetectionJobsRequest.builder()
- Parameters:
listEventsDetectionJobsRequest
- AConsumer
that will call methods onListEventsDetectionJobsRequest.Builder
to create a request.- Returns:
- Result of the ListEventsDetectionJobs operation returned by the service.
- See Also:
-
listEventsDetectionJobsPaginator
default 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 Streamsoftware.amazon.awssdk.services.comprehend.paginators.ListEventsDetectionJobsIterable responses = client.listEventsDetectionJobsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listEventsDetectionJobsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listEventsDetectionJobsPaginator
default 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 Streamsoftware.amazon.awssdk.services.comprehend.paginators.ListEventsDetectionJobsIterable responses = client.listEventsDetectionJobsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListEventsDetectionJobsRequest.builder()
- Parameters:
listEventsDetectionJobsRequest
- AConsumer
that will call methods onListEventsDetectionJobsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listFlywheelIterationHistory
default 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.
- Parameters:
listFlywheelIterationHistoryRequest
-- Returns:
- Result of the ListFlywheelIterationHistory operation returned by the service.
- See Also:
-
listFlywheelIterationHistory
default 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 viaListFlywheelIterationHistoryRequest.builder()
- Parameters:
listFlywheelIterationHistoryRequest
- AConsumer
that will call methods onListFlywheelIterationHistoryRequest.Builder
to create a request.- Returns:
- Result of the ListFlywheelIterationHistory operation returned by the service.
- See Also:
-
listFlywheelIterationHistoryPaginator
default 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 Streamsoftware.amazon.awssdk.services.comprehend.paginators.ListFlywheelIterationHistoryIterable responses = client.listFlywheelIterationHistoryPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listFlywheelIterationHistoryRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listFlywheelIterationHistoryPaginator
default 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 Streamsoftware.amazon.awssdk.services.comprehend.paginators.ListFlywheelIterationHistoryIterable responses = client.listFlywheelIterationHistoryPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListFlywheelIterationHistoryRequest.builder()
- Parameters:
listFlywheelIterationHistoryRequest
- AConsumer
that will call methods onListFlywheelIterationHistoryRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listFlywheels
default ListFlywheelsResponse listFlywheels(ListFlywheelsRequest listFlywheelsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Gets a list of the flywheels that you have created.
- Parameters:
listFlywheelsRequest
-- Returns:
- Result of the ListFlywheels operation returned by the service.
- See Also:
-
listFlywheels
default 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 viaListFlywheelsRequest.builder()
- Parameters:
listFlywheelsRequest
- AConsumer
that will call methods onListFlywheelsRequest.Builder
to create a request.- Returns:
- Result of the ListFlywheels operation returned by the service.
- See Also:
-
listFlywheelsPaginator
default 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 Streamsoftware.amazon.awssdk.services.comprehend.paginators.ListFlywheelsIterable responses = client.listFlywheelsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listFlywheelsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listFlywheelsPaginator
default 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 Streamsoftware.amazon.awssdk.services.comprehend.paginators.ListFlywheelsIterable responses = client.listFlywheelsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListFlywheelsRequest.builder()
- Parameters:
listFlywheelsRequest
- AConsumer
that will call methods onListFlywheelsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listKeyPhrasesDetectionJobs
default ListKeyPhrasesDetectionJobsResponse listKeyPhrasesDetectionJobs(ListKeyPhrasesDetectionJobsRequest listKeyPhrasesDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Get a list of key phrase detection jobs that you have submitted.
- Parameters:
listKeyPhrasesDetectionJobsRequest
-- Returns:
- Result of the ListKeyPhrasesDetectionJobs operation returned by the service.
- See Also:
-
listKeyPhrasesDetectionJobs
default ListKeyPhrasesDetectionJobsResponse listKeyPhrasesDetectionJobs(Consumer<ListKeyPhrasesDetectionJobsRequest.Builder> listKeyPhrasesDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Get a list of key phrase detection jobs that you have submitted.
This is a convenience which creates an instance of the
ListKeyPhrasesDetectionJobsRequest.Builder
avoiding the need to create one manually viaListKeyPhrasesDetectionJobsRequest.builder()
- Parameters:
listKeyPhrasesDetectionJobsRequest
- AConsumer
that will call methods onListKeyPhrasesDetectionJobsRequest.Builder
to create a request.- Returns:
- Result of the ListKeyPhrasesDetectionJobs operation returned by the service.
- See Also:
-
listKeyPhrasesDetectionJobs
default ListKeyPhrasesDetectionJobsResponse listKeyPhrasesDetectionJobs() throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendExceptionGet a list of key phrase detection jobs that you have submitted.
- Returns:
- Result of the ListKeyPhrasesDetectionJobs operation returned by the service.
- See Also:
-
listKeyPhrasesDetectionJobsPaginator
default ListKeyPhrasesDetectionJobsIterable listKeyPhrasesDetectionJobsPaginator() throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendExceptionGet 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 Streamsoftware.amazon.awssdk.services.comprehend.paginators.ListKeyPhrasesDetectionJobsIterable responses = client.listKeyPhrasesDetectionJobsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listKeyPhrasesDetectionJobsPaginator
default 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 Streamsoftware.amazon.awssdk.services.comprehend.paginators.ListKeyPhrasesDetectionJobsIterable responses = client.listKeyPhrasesDetectionJobsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listKeyPhrasesDetectionJobsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listKeyPhrasesDetectionJobsPaginator
default ListKeyPhrasesDetectionJobsIterable listKeyPhrasesDetectionJobsPaginator(Consumer<ListKeyPhrasesDetectionJobsRequest.Builder> listKeyPhrasesDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Get a list of key phrase detection jobs that you have submitted.
This is a variant of
listKeyPhrasesDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListKeyPhrasesDetectionJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.comprehend.paginators.ListKeyPhrasesDetectionJobsIterable responses = client.listKeyPhrasesDetectionJobsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListKeyPhrasesDetectionJobsRequest.builder()
- Parameters:
listKeyPhrasesDetectionJobsRequest
- AConsumer
that will call methods onListKeyPhrasesDetectionJobsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPiiEntitiesDetectionJobs
default 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.
- Parameters:
listPiiEntitiesDetectionJobsRequest
-- Returns:
- Result of the ListPiiEntitiesDetectionJobs operation returned by the service.
- See Also:
-
listPiiEntitiesDetectionJobs
default 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 viaListPiiEntitiesDetectionJobsRequest.builder()
- Parameters:
listPiiEntitiesDetectionJobsRequest
- AConsumer
that will call methods onListPiiEntitiesDetectionJobsRequest.Builder
to create a request.- Returns:
- Result of the ListPiiEntitiesDetectionJobs operation returned by the service.
- See Also:
-
listPiiEntitiesDetectionJobsPaginator
default 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 Streamsoftware.amazon.awssdk.services.comprehend.paginators.ListPiiEntitiesDetectionJobsIterable responses = client.listPiiEntitiesDetectionJobsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listPiiEntitiesDetectionJobsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPiiEntitiesDetectionJobsPaginator
default 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 Streamsoftware.amazon.awssdk.services.comprehend.paginators.ListPiiEntitiesDetectionJobsIterable responses = client.listPiiEntitiesDetectionJobsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListPiiEntitiesDetectionJobsRequest.builder()
- Parameters:
listPiiEntitiesDetectionJobsRequest
- AConsumer
that will call methods onListPiiEntitiesDetectionJobsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listSentimentDetectionJobs
default ListSentimentDetectionJobsResponse listSentimentDetectionJobs(ListSentimentDetectionJobsRequest listSentimentDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Gets a list of sentiment detection jobs that you have submitted.
- Parameters:
listSentimentDetectionJobsRequest
-- Returns:
- Result of the ListSentimentDetectionJobs operation returned by the service.
- See Also:
-
listSentimentDetectionJobs
default ListSentimentDetectionJobsResponse listSentimentDetectionJobs(Consumer<ListSentimentDetectionJobsRequest.Builder> listSentimentDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Gets a list of sentiment detection jobs that you have submitted.
This is a convenience which creates an instance of the
ListSentimentDetectionJobsRequest.Builder
avoiding the need to create one manually viaListSentimentDetectionJobsRequest.builder()
- Parameters:
listSentimentDetectionJobsRequest
- AConsumer
that will call methods onListSentimentDetectionJobsRequest.Builder
to create a request.- Returns:
- Result of the ListSentimentDetectionJobs operation returned by the service.
- See Also:
-
listSentimentDetectionJobs
default ListSentimentDetectionJobsResponse listSentimentDetectionJobs() throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendExceptionGets a list of sentiment detection jobs that you have submitted.
- Returns:
- Result of the ListSentimentDetectionJobs operation returned by the service.
- See Also:
-
listSentimentDetectionJobsPaginator
default ListSentimentDetectionJobsIterable listSentimentDetectionJobsPaginator() throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendExceptionGets 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 Streamsoftware.amazon.awssdk.services.comprehend.paginators.ListSentimentDetectionJobsIterable responses = client.listSentimentDetectionJobsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listSentimentDetectionJobsPaginator
default 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 Streamsoftware.amazon.awssdk.services.comprehend.paginators.ListSentimentDetectionJobsIterable responses = client.listSentimentDetectionJobsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listSentimentDetectionJobsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listSentimentDetectionJobsPaginator
default ListSentimentDetectionJobsIterable listSentimentDetectionJobsPaginator(Consumer<ListSentimentDetectionJobsRequest.Builder> listSentimentDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Gets a list of sentiment detection jobs that you have submitted.
This is a variant of
listSentimentDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListSentimentDetectionJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.comprehend.paginators.ListSentimentDetectionJobsIterable responses = client.listSentimentDetectionJobsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListSentimentDetectionJobsRequest.builder()
- Parameters:
listSentimentDetectionJobsRequest
- AConsumer
that will call methods onListSentimentDetectionJobsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InvalidRequestException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Lists all tags associated with a given Amazon Comprehend resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default 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 viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTargetedSentimentDetectionJobs
default ListTargetedSentimentDetectionJobsResponse listTargetedSentimentDetectionJobs(ListTargetedSentimentDetectionJobsRequest listTargetedSentimentDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Gets a list of targeted sentiment detection jobs that you have submitted.
- Parameters:
listTargetedSentimentDetectionJobsRequest
-- Returns:
- Result of the ListTargetedSentimentDetectionJobs operation returned by the service.
- See Also:
-
listTargetedSentimentDetectionJobs
default 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 viaListTargetedSentimentDetectionJobsRequest.builder()
- Parameters:
listTargetedSentimentDetectionJobsRequest
- AConsumer
that will call methods onListTargetedSentimentDetectionJobsRequest.Builder
to create a request.- Returns:
- Result of the ListTargetedSentimentDetectionJobs operation returned by the service.
- See Also:
-
listTargetedSentimentDetectionJobsPaginator
default 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 Streamsoftware.amazon.awssdk.services.comprehend.paginators.ListTargetedSentimentDetectionJobsIterable responses = client.listTargetedSentimentDetectionJobsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listTargetedSentimentDetectionJobsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTargetedSentimentDetectionJobsPaginator
default 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 Streamsoftware.amazon.awssdk.services.comprehend.paginators.ListTargetedSentimentDetectionJobsIterable responses = client.listTargetedSentimentDetectionJobsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListTargetedSentimentDetectionJobsRequest.builder()
- Parameters:
listTargetedSentimentDetectionJobsRequest
- AConsumer
that will call methods onListTargetedSentimentDetectionJobsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTopicsDetectionJobs
default ListTopicsDetectionJobsResponse listTopicsDetectionJobs(ListTopicsDetectionJobsRequest listTopicsDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Gets a list of the topic detection jobs that you have submitted.
- Parameters:
listTopicsDetectionJobsRequest
-- Returns:
- Result of the ListTopicsDetectionJobs operation returned by the service.
- See Also:
-
listTopicsDetectionJobs
default ListTopicsDetectionJobsResponse listTopicsDetectionJobs(Consumer<ListTopicsDetectionJobsRequest.Builder> listTopicsDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Gets a list of the topic detection jobs that you have submitted.
This is a convenience which creates an instance of the
ListTopicsDetectionJobsRequest.Builder
avoiding the need to create one manually viaListTopicsDetectionJobsRequest.builder()
- Parameters:
listTopicsDetectionJobsRequest
- AConsumer
that will call methods onListTopicsDetectionJobsRequest.Builder
to create a request.- Returns:
- Result of the ListTopicsDetectionJobs operation returned by the service.
- See Also:
-
listTopicsDetectionJobs
default ListTopicsDetectionJobsResponse listTopicsDetectionJobs() throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendExceptionGets a list of the topic detection jobs that you have submitted.
- Returns:
- Result of the ListTopicsDetectionJobs operation returned by the service.
- See Also:
-
listTopicsDetectionJobsPaginator
default ListTopicsDetectionJobsIterable listTopicsDetectionJobsPaginator() throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendExceptionGets 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 Streamsoftware.amazon.awssdk.services.comprehend.paginators.ListTopicsDetectionJobsIterable responses = client.listTopicsDetectionJobsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTopicsDetectionJobsPaginator
default 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 Streamsoftware.amazon.awssdk.services.comprehend.paginators.ListTopicsDetectionJobsIterable responses = client.listTopicsDetectionJobsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listTopicsDetectionJobsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTopicsDetectionJobsPaginator
default ListTopicsDetectionJobsIterable listTopicsDetectionJobsPaginator(Consumer<ListTopicsDetectionJobsRequest.Builder> listTopicsDetectionJobsRequest) throws InvalidRequestException, TooManyRequestsException, InvalidFilterException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Gets a list of the topic detection jobs that you have submitted.
This is a variant of
listTopicsDetectionJobs(software.amazon.awssdk.services.comprehend.model.ListTopicsDetectionJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.comprehend.paginators.ListTopicsDetectionJobsIterable responses = client.listTopicsDetectionJobsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListTopicsDetectionJobsRequest.builder()
- Parameters:
listTopicsDetectionJobsRequest
- AConsumer
that will call methods onListTopicsDetectionJobsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
putResourcePolicy
default 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.
- Parameters:
putResourcePolicyRequest
-- Returns:
- Result of the PutResourcePolicy operation returned by the service.
- See Also:
-
putResourcePolicy
default 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 viaPutResourcePolicyRequest.builder()
- Parameters:
putResourcePolicyRequest
- AConsumer
that will call methods onPutResourcePolicyRequest.Builder
to create a request.- Returns:
- Result of the PutResourcePolicy operation returned by the service.
- See Also:
-
startDocumentClassificationJob
default 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.- Parameters:
startDocumentClassificationJobRequest
-- Returns:
- Result of the StartDocumentClassificationJob operation returned by the service.
- See Also:
-
startDocumentClassificationJob
default 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 viaStartDocumentClassificationJobRequest.builder()
- Parameters:
startDocumentClassificationJobRequest
- AConsumer
that will call methods onStartDocumentClassificationJobRequest.Builder
to create a request.- Returns:
- Result of the StartDocumentClassificationJob operation returned by the service.
- See Also:
-
startDominantLanguageDetectionJob
default 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.
- Parameters:
startDominantLanguageDetectionJobRequest
-- Returns:
- Result of the StartDominantLanguageDetectionJob operation returned by the service.
- See Also:
-
startDominantLanguageDetectionJob
default 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 viaStartDominantLanguageDetectionJobRequest.builder()
- Parameters:
startDominantLanguageDetectionJobRequest
- AConsumer
that will call methods onStartDominantLanguageDetectionJobRequest.Builder
to create a request.- Returns:
- Result of the StartDominantLanguageDetectionJob operation returned by the service.
- See Also:
-
startEntitiesDetectionJob
default 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.- Parameters:
startEntitiesDetectionJobRequest
-- Returns:
- Result of the StartEntitiesDetectionJob operation returned by the service.
- See Also:
-
startEntitiesDetectionJob
default 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 viaStartEntitiesDetectionJobRequest.builder()
- Parameters:
startEntitiesDetectionJobRequest
- AConsumer
that will call methods onStartEntitiesDetectionJobRequest.Builder
to create a request.- Returns:
- Result of the StartEntitiesDetectionJob operation returned by the service.
- See Also:
-
startEventsDetectionJob
default 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.
- Parameters:
startEventsDetectionJobRequest
-- Returns:
- Result of the StartEventsDetectionJob operation returned by the service.
- See Also:
-
startEventsDetectionJob
default 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 viaStartEventsDetectionJobRequest.builder()
- Parameters:
startEventsDetectionJobRequest
- AConsumer
that will call methods onStartEventsDetectionJobRequest.Builder
to create a request.- Returns:
- Result of the StartEventsDetectionJob operation returned by the service.
- See Also:
-
startFlywheelIteration
default 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.
- Parameters:
startFlywheelIterationRequest
-- Returns:
- Result of the StartFlywheelIteration operation returned by the service.
- See Also:
-
startFlywheelIteration
default 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 viaStartFlywheelIterationRequest.builder()
- Parameters:
startFlywheelIterationRequest
- AConsumer
that will call methods onStartFlywheelIterationRequest.Builder
to create a request.- Returns:
- Result of the StartFlywheelIteration operation returned by the service.
- See Also:
-
startKeyPhrasesDetectionJob
default 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.
- Parameters:
startKeyPhrasesDetectionJobRequest
-- Returns:
- Result of the StartKeyPhrasesDetectionJob operation returned by the service.
- See Also:
-
startKeyPhrasesDetectionJob
default 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 viaStartKeyPhrasesDetectionJobRequest.builder()
- Parameters:
startKeyPhrasesDetectionJobRequest
- AConsumer
that will call methods onStartKeyPhrasesDetectionJobRequest.Builder
to create a request.- Returns:
- Result of the StartKeyPhrasesDetectionJob operation returned by the service.
- See Also:
-
startPiiEntitiesDetectionJob
default 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.
- Parameters:
startPiiEntitiesDetectionJobRequest
-- Returns:
- Result of the StartPiiEntitiesDetectionJob operation returned by the service.
- See Also:
-
startPiiEntitiesDetectionJob
default 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 viaStartPiiEntitiesDetectionJobRequest.builder()
- Parameters:
startPiiEntitiesDetectionJobRequest
- AConsumer
that will call methods onStartPiiEntitiesDetectionJobRequest.Builder
to create a request.- Returns:
- Result of the StartPiiEntitiesDetectionJob operation returned by the service.
- See Also:
-
startSentimentDetectionJob
default 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.
- Parameters:
startSentimentDetectionJobRequest
-- Returns:
- Result of the StartSentimentDetectionJob operation returned by the service.
- See Also:
-
startSentimentDetectionJob
default 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 viaStartSentimentDetectionJobRequest.builder()
- Parameters:
startSentimentDetectionJobRequest
- AConsumer
that will call methods onStartSentimentDetectionJobRequest.Builder
to create a request.- Returns:
- Result of the StartSentimentDetectionJob operation returned by the service.
- See Also:
-
startTargetedSentimentDetectionJob
default 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.- Parameters:
startTargetedSentimentDetectionJobRequest
-- Returns:
- Result of the StartTargetedSentimentDetectionJob operation returned by the service.
- See Also:
-
startTargetedSentimentDetectionJob
default 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 viaStartTargetedSentimentDetectionJobRequest.builder()
- Parameters:
startTargetedSentimentDetectionJobRequest
- AConsumer
that will call methods onStartTargetedSentimentDetectionJobRequest.Builder
to create a request.- Returns:
- Result of the StartTargetedSentimentDetectionJob operation returned by the service.
- See Also:
-
startTopicsDetectionJob
default 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.- Parameters:
startTopicsDetectionJobRequest
-- Returns:
- Result of the StartTopicsDetectionJob operation returned by the service.
- See Also:
-
startTopicsDetectionJob
default 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 viaStartTopicsDetectionJobRequest.builder()
- Parameters:
startTopicsDetectionJobRequest
- AConsumer
that will call methods onStartTopicsDetectionJobRequest.Builder
to create a request.- Returns:
- Result of the StartTopicsDetectionJob operation returned by the service.
- See Also:
-
stopDominantLanguageDetectionJob
default StopDominantLanguageDetectionJobResponse stopDominantLanguageDetectionJob(StopDominantLanguageDetectionJobRequest stopDominantLanguageDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Stops a dominant language detection job in progress.
If the job state is
IN_PROGRESS
the job is marked for termination and put into theSTOP_REQUESTED
state. If the job completes before it can be stopped, it is put into theCOMPLETED
state; otherwise the job is stopped and put into theSTOPPED
state.If the job is in the
COMPLETED
orFAILED
state when you call theStopDominantLanguageDetectionJob
operation, the operation returns a 400 Internal Request Exception.When a job is stopped, any documents already processed are written to the output location.
- Parameters:
stopDominantLanguageDetectionJobRequest
-- Returns:
- Result of the StopDominantLanguageDetectionJob operation returned by the service.
- See Also:
-
stopDominantLanguageDetectionJob
default StopDominantLanguageDetectionJobResponse stopDominantLanguageDetectionJob(Consumer<StopDominantLanguageDetectionJobRequest.Builder> stopDominantLanguageDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Stops a dominant language detection job in progress.
If the job state is
IN_PROGRESS
the job is marked for termination and put into theSTOP_REQUESTED
state. If the job completes before it can be stopped, it is put into theCOMPLETED
state; otherwise the job is stopped and put into theSTOPPED
state.If the job is in the
COMPLETED
orFAILED
state when you call theStopDominantLanguageDetectionJob
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 viaStopDominantLanguageDetectionJobRequest.builder()
- Parameters:
stopDominantLanguageDetectionJobRequest
- AConsumer
that will call methods onStopDominantLanguageDetectionJobRequest.Builder
to create a request.- Returns:
- Result of the StopDominantLanguageDetectionJob operation returned by the service.
- See Also:
-
stopEntitiesDetectionJob
default StopEntitiesDetectionJobResponse stopEntitiesDetectionJob(StopEntitiesDetectionJobRequest stopEntitiesDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Stops an entities detection job in progress.
If the job state is
IN_PROGRESS
the job is marked for termination and put into theSTOP_REQUESTED
state. If the job completes before it can be stopped, it is put into theCOMPLETED
state; otherwise the job is stopped and put into theSTOPPED
state.If the job is in the
COMPLETED
orFAILED
state when you call theStopDominantLanguageDetectionJob
operation, the operation returns a 400 Internal Request Exception.When a job is stopped, any documents already processed are written to the output location.
- Parameters:
stopEntitiesDetectionJobRequest
-- Returns:
- Result of the StopEntitiesDetectionJob operation returned by the service.
- See Also:
-
stopEntitiesDetectionJob
default StopEntitiesDetectionJobResponse stopEntitiesDetectionJob(Consumer<StopEntitiesDetectionJobRequest.Builder> stopEntitiesDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Stops an entities detection job in progress.
If the job state is
IN_PROGRESS
the job is marked for termination and put into theSTOP_REQUESTED
state. If the job completes before it can be stopped, it is put into theCOMPLETED
state; otherwise the job is stopped and put into theSTOPPED
state.If the job is in the
COMPLETED
orFAILED
state when you call theStopDominantLanguageDetectionJob
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 viaStopEntitiesDetectionJobRequest.builder()
- Parameters:
stopEntitiesDetectionJobRequest
- AConsumer
that will call methods onStopEntitiesDetectionJobRequest.Builder
to create a request.- Returns:
- Result of the StopEntitiesDetectionJob operation returned by the service.
- See Also:
-
stopEventsDetectionJob
default StopEventsDetectionJobResponse stopEventsDetectionJob(StopEventsDetectionJobRequest stopEventsDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Stops an events detection job in progress.
- Parameters:
stopEventsDetectionJobRequest
-- Returns:
- Result of the StopEventsDetectionJob operation returned by the service.
- See Also:
-
stopEventsDetectionJob
default 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 viaStopEventsDetectionJobRequest.builder()
- Parameters:
stopEventsDetectionJobRequest
- AConsumer
that will call methods onStopEventsDetectionJobRequest.Builder
to create a request.- Returns:
- Result of the StopEventsDetectionJob operation returned by the service.
- See Also:
-
stopKeyPhrasesDetectionJob
default StopKeyPhrasesDetectionJobResponse stopKeyPhrasesDetectionJob(StopKeyPhrasesDetectionJobRequest stopKeyPhrasesDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Stops a key phrases detection job in progress.
If the job state is
IN_PROGRESS
the job is marked for termination and put into theSTOP_REQUESTED
state. If the job completes before it can be stopped, it is put into theCOMPLETED
state; otherwise the job is stopped and put into theSTOPPED
state.If the job is in the
COMPLETED
orFAILED
state when you call theStopDominantLanguageDetectionJob
operation, the operation returns a 400 Internal Request Exception.When a job is stopped, any documents already processed are written to the output location.
- Parameters:
stopKeyPhrasesDetectionJobRequest
-- Returns:
- Result of the StopKeyPhrasesDetectionJob operation returned by the service.
- See Also:
-
stopKeyPhrasesDetectionJob
default StopKeyPhrasesDetectionJobResponse stopKeyPhrasesDetectionJob(Consumer<StopKeyPhrasesDetectionJobRequest.Builder> stopKeyPhrasesDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Stops a key phrases detection job in progress.
If the job state is
IN_PROGRESS
the job is marked for termination and put into theSTOP_REQUESTED
state. If the job completes before it can be stopped, it is put into theCOMPLETED
state; otherwise the job is stopped and put into theSTOPPED
state.If the job is in the
COMPLETED
orFAILED
state when you call theStopDominantLanguageDetectionJob
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 viaStopKeyPhrasesDetectionJobRequest.builder()
- Parameters:
stopKeyPhrasesDetectionJobRequest
- AConsumer
that will call methods onStopKeyPhrasesDetectionJobRequest.Builder
to create a request.- Returns:
- Result of the StopKeyPhrasesDetectionJob operation returned by the service.
- See Also:
-
stopPiiEntitiesDetectionJob
default StopPiiEntitiesDetectionJobResponse stopPiiEntitiesDetectionJob(StopPiiEntitiesDetectionJobRequest stopPiiEntitiesDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Stops a PII entities detection job in progress.
- Parameters:
stopPiiEntitiesDetectionJobRequest
-- Returns:
- Result of the StopPiiEntitiesDetectionJob operation returned by the service.
- See Also:
-
stopPiiEntitiesDetectionJob
default 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 viaStopPiiEntitiesDetectionJobRequest.builder()
- Parameters:
stopPiiEntitiesDetectionJobRequest
- AConsumer
that will call methods onStopPiiEntitiesDetectionJobRequest.Builder
to create a request.- Returns:
- Result of the StopPiiEntitiesDetectionJob operation returned by the service.
- See Also:
-
stopSentimentDetectionJob
default StopSentimentDetectionJobResponse stopSentimentDetectionJob(StopSentimentDetectionJobRequest stopSentimentDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Stops a sentiment detection job in progress.
If the job state is
IN_PROGRESS
, the job is marked for termination and put into theSTOP_REQUESTED
state. If the job completes before it can be stopped, it is put into theCOMPLETED
state; otherwise the job is be stopped and put into theSTOPPED
state.If the job is in the
COMPLETED
orFAILED
state when you call theStopDominantLanguageDetectionJob
operation, the operation returns a 400 Internal Request Exception.When a job is stopped, any documents already processed are written to the output location.
- Parameters:
stopSentimentDetectionJobRequest
-- Returns:
- Result of the StopSentimentDetectionJob operation returned by the service.
- See Also:
-
stopSentimentDetectionJob
default StopSentimentDetectionJobResponse stopSentimentDetectionJob(Consumer<StopSentimentDetectionJobRequest.Builder> stopSentimentDetectionJobRequest) throws InvalidRequestException, JobNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Stops a sentiment detection job in progress.
If the job state is
IN_PROGRESS
, the job is marked for termination and put into theSTOP_REQUESTED
state. If the job completes before it can be stopped, it is put into theCOMPLETED
state; otherwise the job is be stopped and put into theSTOPPED
state.If the job is in the
COMPLETED
orFAILED
state when you call theStopDominantLanguageDetectionJob
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 viaStopSentimentDetectionJobRequest.builder()
- Parameters:
stopSentimentDetectionJobRequest
- AConsumer
that will call methods onStopSentimentDetectionJobRequest.Builder
to create a request.- Returns:
- Result of the StopSentimentDetectionJob operation returned by the service.
- See Also:
-
stopTargetedSentimentDetectionJob
default 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 theSTOP_REQUESTED
state. If the job completes before it can be stopped, it is put into theCOMPLETED
state; otherwise the job is be stopped and put into theSTOPPED
state.If the job is in the
COMPLETED
orFAILED
state when you call theStopDominantLanguageDetectionJob
operation, the operation returns a 400 Internal Request Exception.When a job is stopped, any documents already processed are written to the output location.
- Parameters:
stopTargetedSentimentDetectionJobRequest
-- Returns:
- Result of the StopTargetedSentimentDetectionJob operation returned by the service.
- See Also:
-
stopTargetedSentimentDetectionJob
default 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 theSTOP_REQUESTED
state. If the job completes before it can be stopped, it is put into theCOMPLETED
state; otherwise the job is be stopped and put into theSTOPPED
state.If the job is in the
COMPLETED
orFAILED
state when you call theStopDominantLanguageDetectionJob
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 viaStopTargetedSentimentDetectionJobRequest.builder()
- Parameters:
stopTargetedSentimentDetectionJobRequest
- AConsumer
that will call methods onStopTargetedSentimentDetectionJobRequest.Builder
to create a request.- Returns:
- Result of the StopTargetedSentimentDetectionJob operation returned by the service.
- See Also:
-
stopTrainingDocumentClassifier
default 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 theSTOP_REQUESTED
state. If the training job completes before it can be stopped, it is put into theTRAINED
; otherwise the training job is stopped and put into theSTOPPED
state and the service sends back an HTTP 200 response with an empty HTTP body.- Parameters:
stopTrainingDocumentClassifierRequest
-- Returns:
- Result of the StopTrainingDocumentClassifier operation returned by the service.
- See Also:
-
stopTrainingDocumentClassifier
default 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 theSTOP_REQUESTED
state. If the training job completes before it can be stopped, it is put into theTRAINED
; otherwise the training job is stopped and put into theSTOPPED
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 viaStopTrainingDocumentClassifierRequest.builder()
- Parameters:
stopTrainingDocumentClassifierRequest
- AConsumer
that will call methods onStopTrainingDocumentClassifierRequest.Builder
to create a request.- Returns:
- Result of the StopTrainingDocumentClassifier operation returned by the service.
- See Also:
-
stopTrainingEntityRecognizer
default 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 theSTOP_REQUESTED
state. If the training job completes before it can be stopped, it is put into theTRAINED
; otherwise the training job is stopped and putted into theSTOPPED
state and the service sends back an HTTP 200 response with an empty HTTP body.- Parameters:
stopTrainingEntityRecognizerRequest
-- Returns:
- Result of the StopTrainingEntityRecognizer operation returned by the service.
- See Also:
-
stopTrainingEntityRecognizer
default 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 theSTOP_REQUESTED
state. If the training job completes before it can be stopped, it is put into theTRAINED
; otherwise the training job is stopped and putted into theSTOPPED
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 viaStopTrainingEntityRecognizerRequest.builder()
- Parameters:
stopTrainingEntityRecognizerRequest
- AConsumer
that will call methods onStopTrainingEntityRecognizerRequest.Builder
to create a request.- Returns:
- Result of the StopTrainingEntityRecognizer operation returned by the service.
- See Also:
-
tagResource
default 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.
- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default 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 viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws TooManyTagKeysException, InvalidRequestException, ConcurrentModificationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Removes a specific tag associated with an Amazon Comprehend resource.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default 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 viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateEndpoint
default 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.
- Parameters:
updateEndpointRequest
-- Returns:
- Result of the UpdateEndpoint operation returned by the service.
- See Also:
-
updateEndpoint
default 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 viaUpdateEndpointRequest.builder()
- Parameters:
updateEndpointRequest
- AConsumer
that will call methods onUpdateEndpointRequest.Builder
to create a request.- Returns:
- Result of the UpdateEndpoint operation returned by the service.
- See Also:
-
updateFlywheel
default UpdateFlywheelResponse updateFlywheel(UpdateFlywheelRequest updateFlywheelRequest) throws InvalidRequestException, TooManyRequestsException, KmsKeyValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendException Update the configuration information for an existing flywheel.
- Parameters:
updateFlywheelRequest
-- Returns:
- Result of the UpdateFlywheel operation returned by the service.
- See Also:
-
updateFlywheel
default 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 viaUpdateFlywheelRequest.builder()
- Parameters:
updateFlywheelRequest
- AConsumer
that will call methods onUpdateFlywheelRequest.Builder
to create a request.- Returns:
- Result of the UpdateFlywheel operation returned by the service.
- See Also:
-
create
Create aComprehendClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aComprehendClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-