@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonComprehendAsync extends AmazonComprehend
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonComprehendAsync instead.
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.
ENDPOINT_PREFIXbatchDetectDominantLanguage, batchDetectEntities, batchDetectKeyPhrases, batchDetectSentiment, batchDetectSyntax, batchDetectTargetedSentiment, classifyDocument, containsPiiEntities, createDataset, createDocumentClassifier, createEndpoint, createEntityRecognizer, createFlywheel, deleteDocumentClassifier, deleteEndpoint, deleteEntityRecognizer, deleteFlywheel, deleteResourcePolicy, describeDataset, describeDocumentClassificationJob, describeDocumentClassifier, describeDominantLanguageDetectionJob, describeEndpoint, describeEntitiesDetectionJob, describeEntityRecognizer, describeEventsDetectionJob, describeFlywheel, describeFlywheelIteration, describeKeyPhrasesDetectionJob, describePiiEntitiesDetectionJob, describeResourcePolicy, describeSentimentDetectionJob, describeTargetedSentimentDetectionJob, describeTopicsDetectionJob, detectDominantLanguage, detectEntities, detectKeyPhrases, detectPiiEntities, detectSentiment, detectSyntax, detectTargetedSentiment, getCachedResponseMetadata, importModel, listDatasets, listDocumentClassificationJobs, listDocumentClassifiers, listDocumentClassifierSummaries, listDominantLanguageDetectionJobs, listEndpoints, listEntitiesDetectionJobs, listEntityRecognizers, listEntityRecognizerSummaries, listEventsDetectionJobs, listFlywheelIterationHistory, listFlywheels, listKeyPhrasesDetectionJobs, listPiiEntitiesDetectionJobs, listSentimentDetectionJobs, listTagsForResource, listTargetedSentimentDetectionJobs, listTopicsDetectionJobs, putResourcePolicy, shutdown, startDocumentClassificationJob, startDominantLanguageDetectionJob, startEntitiesDetectionJob, startEventsDetectionJob, startFlywheelIteration, startKeyPhrasesDetectionJob, startPiiEntitiesDetectionJob, startSentimentDetectionJob, startTargetedSentimentDetectionJob, startTopicsDetectionJob, stopDominantLanguageDetectionJob, stopEntitiesDetectionJob, stopEventsDetectionJob, stopKeyPhrasesDetectionJob, stopPiiEntitiesDetectionJob, stopSentimentDetectionJob, stopTargetedSentimentDetectionJob, stopTrainingDocumentClassifier, stopTrainingEntityRecognizer, tagResource, untagResource, updateEndpoint, updateFlywheelFuture<BatchDetectDominantLanguageResult> batchDetectDominantLanguageAsync(BatchDetectDominantLanguageRequest batchDetectDominantLanguageRequest)
Determines the dominant language of the input text for a batch of documents. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.
batchDetectDominantLanguageRequest - Future<BatchDetectDominantLanguageResult> batchDetectDominantLanguageAsync(BatchDetectDominantLanguageRequest batchDetectDominantLanguageRequest, AsyncHandler<BatchDetectDominantLanguageRequest,BatchDetectDominantLanguageResult> asyncHandler)
Determines the dominant language of the input text for a batch of documents. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.
batchDetectDominantLanguageRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<BatchDetectEntitiesResult> batchDetectEntitiesAsync(BatchDetectEntitiesRequest batchDetectEntitiesRequest)
Inspects the text of a batch of documents for named entities and returns information about them. For more information about named entities, see Entities in the Comprehend Developer Guide.
batchDetectEntitiesRequest - Future<BatchDetectEntitiesResult> batchDetectEntitiesAsync(BatchDetectEntitiesRequest batchDetectEntitiesRequest, AsyncHandler<BatchDetectEntitiesRequest,BatchDetectEntitiesResult> asyncHandler)
Inspects the text of a batch of documents for named entities and returns information about them. For more information about named entities, see Entities in the Comprehend Developer Guide.
batchDetectEntitiesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<BatchDetectKeyPhrasesResult> batchDetectKeyPhrasesAsync(BatchDetectKeyPhrasesRequest batchDetectKeyPhrasesRequest)
Detects the key noun phrases found in a batch of documents.
batchDetectKeyPhrasesRequest - Future<BatchDetectKeyPhrasesResult> batchDetectKeyPhrasesAsync(BatchDetectKeyPhrasesRequest batchDetectKeyPhrasesRequest, AsyncHandler<BatchDetectKeyPhrasesRequest,BatchDetectKeyPhrasesResult> asyncHandler)
Detects the key noun phrases found in a batch of documents.
batchDetectKeyPhrasesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<BatchDetectSentimentResult> batchDetectSentimentAsync(BatchDetectSentimentRequest batchDetectSentimentRequest)
Inspects a batch of documents and returns an inference of the prevailing sentiment, POSITIVE,
NEUTRAL, MIXED, or NEGATIVE, in each one.
batchDetectSentimentRequest - Future<BatchDetectSentimentResult> batchDetectSentimentAsync(BatchDetectSentimentRequest batchDetectSentimentRequest, AsyncHandler<BatchDetectSentimentRequest,BatchDetectSentimentResult> asyncHandler)
Inspects a batch of documents and returns an inference of the prevailing sentiment, POSITIVE,
NEUTRAL, MIXED, or NEGATIVE, in each one.
batchDetectSentimentRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<BatchDetectSyntaxResult> batchDetectSyntaxAsync(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. For more information, see Syntax in the Comprehend Developer Guide.
batchDetectSyntaxRequest - Future<BatchDetectSyntaxResult> batchDetectSyntaxAsync(BatchDetectSyntaxRequest batchDetectSyntaxRequest, AsyncHandler<BatchDetectSyntaxRequest,BatchDetectSyntaxResult> asyncHandler)
Inspects the text of a batch of documents for the syntax and part of speech of the words in the document and returns information about them. For more information, see Syntax in the Comprehend Developer Guide.
batchDetectSyntaxRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<BatchDetectTargetedSentimentResult> batchDetectTargetedSentimentAsync(BatchDetectTargetedSentimentRequest batchDetectTargetedSentimentRequest)
Inspects a batch of documents and returns a sentiment analysis for each entity identified in the documents.
For more information about targeted sentiment, see Targeted sentiment.
batchDetectTargetedSentimentRequest - Future<BatchDetectTargetedSentimentResult> batchDetectTargetedSentimentAsync(BatchDetectTargetedSentimentRequest batchDetectTargetedSentimentRequest, AsyncHandler<BatchDetectTargetedSentimentRequest,BatchDetectTargetedSentimentResult> asyncHandler)
Inspects a batch of documents and returns a sentiment analysis for each entity identified in the documents.
For more information about targeted sentiment, see Targeted sentiment.
batchDetectTargetedSentimentRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ClassifyDocumentResult> classifyDocumentAsync(ClassifyDocumentRequest classifyDocumentRequest)
Creates a new document classification request to analyze a single document in real-time, using a previously created and trained custom model and an endpoint.
You can input plain text or you can upload a single-page input document (text, PDF, Word, or image).
If the system detects errors while processing a page in the input document, the API response includes an entry in
Errors that describes the errors.
If the system detects a document-level error in your input document, the API returns an
InvalidRequestException error response. For details about this exception, see Errors in semi-structured
documents in the Comprehend Developer Guide.
classifyDocumentRequest - Future<ClassifyDocumentResult> classifyDocumentAsync(ClassifyDocumentRequest classifyDocumentRequest, AsyncHandler<ClassifyDocumentRequest,ClassifyDocumentResult> asyncHandler)
Creates a new document classification request to analyze a single document in real-time, using a previously created and trained custom model and an endpoint.
You can input plain text or you can upload a single-page input document (text, PDF, Word, or image).
If the system detects errors while processing a page in the input document, the API response includes an entry in
Errors that describes the errors.
If the system detects a document-level error in your input document, the API returns an
InvalidRequestException error response. For details about this exception, see Errors in semi-structured
documents in the Comprehend Developer Guide.
classifyDocumentRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ContainsPiiEntitiesResult> containsPiiEntitiesAsync(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.
containsPiiEntitiesRequest - Future<ContainsPiiEntitiesResult> containsPiiEntitiesAsync(ContainsPiiEntitiesRequest containsPiiEntitiesRequest, AsyncHandler<ContainsPiiEntitiesRequest,ContainsPiiEntitiesResult> asyncHandler)
Analyzes input text for the presence of personally identifiable information (PII) and returns the labels of identified PII entity types such as name, address, bank account number, or phone number.
containsPiiEntitiesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateDatasetResult> createDatasetAsync(CreateDatasetRequest createDatasetRequest)
Creates a dataset to upload training or test data for a model associated with a flywheel. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.
createDatasetRequest - Future<CreateDatasetResult> createDatasetAsync(CreateDatasetRequest createDatasetRequest, AsyncHandler<CreateDatasetRequest,CreateDatasetResult> asyncHandler)
Creates a dataset to upload training or test data for a model associated with a flywheel. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.
createDatasetRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateDocumentClassifierResult> createDocumentClassifierAsync(CreateDocumentClassifierRequest createDocumentClassifierRequest)
Creates a new document classifier that you can use to categorize documents. To create a classifier, you provide a set of training documents that are labeled with the categories that you want to use. For more information, see Training classifier models in the Comprehend Developer Guide.
createDocumentClassifierRequest - Future<CreateDocumentClassifierResult> createDocumentClassifierAsync(CreateDocumentClassifierRequest createDocumentClassifierRequest, AsyncHandler<CreateDocumentClassifierRequest,CreateDocumentClassifierResult> asyncHandler)
Creates a new document classifier that you can use to categorize documents. To create a classifier, you provide a set of training documents that are labeled with the categories that you want to use. For more information, see Training classifier models in the Comprehend Developer Guide.
createDocumentClassifierRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateEndpointResult> createEndpointAsync(CreateEndpointRequest createEndpointRequest)
Creates a model-specific endpoint for synchronous inference for a previously trained custom model For information about endpoints, see Managing endpoints.
createEndpointRequest - Future<CreateEndpointResult> createEndpointAsync(CreateEndpointRequest createEndpointRequest, AsyncHandler<CreateEndpointRequest,CreateEndpointResult> asyncHandler)
Creates a model-specific endpoint for synchronous inference for a previously trained custom model For information about endpoints, see Managing endpoints.
createEndpointRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateEntityRecognizerResult> createEntityRecognizerAsync(CreateEntityRecognizerRequest createEntityRecognizerRequest)
Creates an entity recognizer using submitted files. After your CreateEntityRecognizer request is
submitted, you can check job status using the DescribeEntityRecognizer API.
createEntityRecognizerRequest - Future<CreateEntityRecognizerResult> createEntityRecognizerAsync(CreateEntityRecognizerRequest createEntityRecognizerRequest, AsyncHandler<CreateEntityRecognizerRequest,CreateEntityRecognizerResult> asyncHandler)
Creates an entity recognizer using submitted files. After your CreateEntityRecognizer request is
submitted, you can check job status using the DescribeEntityRecognizer API.
createEntityRecognizerRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateFlywheelResult> createFlywheelAsync(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. You can create a flywheel to start with an existing trained model, or Comprehend can create and train a new model.
When you create the flywheel, Comprehend creates a data lake in your account. The data lake holds the training data and test data for all versions of the model.
To use a flywheel with an existing trained model, you specify the active model version. Comprehend copies the model's training data and test data into the flywheel's data lake.
To use the flywheel with a new model, you need to provide a dataset for training data (and optional test data) when you create the flywheel.
For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
createFlywheelRequest - Future<CreateFlywheelResult> createFlywheelAsync(CreateFlywheelRequest createFlywheelRequest, AsyncHandler<CreateFlywheelRequest,CreateFlywheelResult> asyncHandler)
A flywheel is an Amazon Web Services resource that orchestrates the ongoing training of a model for custom classification or custom entity recognition. You can create a flywheel to start with an existing trained model, or Comprehend can create and train a new model.
When you create the flywheel, Comprehend creates a data lake in your account. The data lake holds the training data and test data for all versions of the model.
To use a flywheel with an existing trained model, you specify the active model version. Comprehend copies the model's training data and test data into the flywheel's data lake.
To use the flywheel with a new model, you need to provide a dataset for training data (and optional test data) when you create the flywheel.
For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
createFlywheelRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteDocumentClassifierResult> deleteDocumentClassifierAsync(DeleteDocumentClassifierRequest deleteDocumentClassifierRequest)
Deletes a previously created document classifier
Only those classifiers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference
job is using the model, a ResourceInUseException will be returned.
This is an asynchronous action that puts the classifier into a DELETING state, and it is then removed by a background job. Once removed, the classifier disappears from your account and is no longer available for use.
deleteDocumentClassifierRequest - Future<DeleteDocumentClassifierResult> deleteDocumentClassifierAsync(DeleteDocumentClassifierRequest deleteDocumentClassifierRequest, AsyncHandler<DeleteDocumentClassifierRequest,DeleteDocumentClassifierResult> asyncHandler)
Deletes a previously created document classifier
Only those classifiers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference
job is using the model, a ResourceInUseException will be returned.
This is an asynchronous action that puts the classifier into a DELETING state, and it is then removed by a background job. Once removed, the classifier disappears from your account and is no longer available for use.
deleteDocumentClassifierRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteEndpointResult> deleteEndpointAsync(DeleteEndpointRequest deleteEndpointRequest)
Deletes a model-specific endpoint for a previously-trained custom model. All endpoints must be deleted in order for the model to be deleted. For information about endpoints, see Managing endpoints.
deleteEndpointRequest - Future<DeleteEndpointResult> deleteEndpointAsync(DeleteEndpointRequest deleteEndpointRequest, AsyncHandler<DeleteEndpointRequest,DeleteEndpointResult> asyncHandler)
Deletes a model-specific endpoint for a previously-trained custom model. All endpoints must be deleted in order for the model to be deleted. For information about endpoints, see Managing endpoints.
deleteEndpointRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteEntityRecognizerResult> deleteEntityRecognizerAsync(DeleteEntityRecognizerRequest deleteEntityRecognizerRequest)
Deletes an entity recognizer.
Only those recognizers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference
job is using the model, a ResourceInUseException will be returned.
This is an asynchronous action that puts the recognizer into a DELETING state, and it is then removed by a background job. Once removed, the recognizer disappears from your account and is no longer available for use.
deleteEntityRecognizerRequest - Future<DeleteEntityRecognizerResult> deleteEntityRecognizerAsync(DeleteEntityRecognizerRequest deleteEntityRecognizerRequest, AsyncHandler<DeleteEntityRecognizerRequest,DeleteEntityRecognizerResult> asyncHandler)
Deletes an entity recognizer.
Only those recognizers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference
job is using the model, a ResourceInUseException will be returned.
This is an asynchronous action that puts the recognizer into a DELETING state, and it is then removed by a background job. Once removed, the recognizer disappears from your account and is no longer available for use.
deleteEntityRecognizerRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteFlywheelResult> deleteFlywheelAsync(DeleteFlywheelRequest deleteFlywheelRequest)
Deletes a flywheel. When you delete the flywheel, Amazon Comprehend does not delete the data lake or the model associated with the flywheel.
For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
deleteFlywheelRequest - Future<DeleteFlywheelResult> deleteFlywheelAsync(DeleteFlywheelRequest deleteFlywheelRequest, AsyncHandler<DeleteFlywheelRequest,DeleteFlywheelResult> asyncHandler)
Deletes a flywheel. When you delete the flywheel, Amazon Comprehend does not delete the data lake or the model associated with the flywheel.
For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
deleteFlywheelRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteResourcePolicyResult> deleteResourcePolicyAsync(DeleteResourcePolicyRequest deleteResourcePolicyRequest)
Deletes a resource-based policy that is attached to a custom model.
deleteResourcePolicyRequest - Future<DeleteResourcePolicyResult> deleteResourcePolicyAsync(DeleteResourcePolicyRequest deleteResourcePolicyRequest, AsyncHandler<DeleteResourcePolicyRequest,DeleteResourcePolicyResult> asyncHandler)
Deletes a resource-based policy that is attached to a custom model.
deleteResourcePolicyRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeDatasetResult> describeDatasetAsync(DescribeDatasetRequest describeDatasetRequest)
Returns information about the dataset that you specify. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.
describeDatasetRequest - Future<DescribeDatasetResult> describeDatasetAsync(DescribeDatasetRequest describeDatasetRequest, AsyncHandler<DescribeDatasetRequest,DescribeDatasetResult> asyncHandler)
Returns information about the dataset that you specify. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.
describeDatasetRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeDocumentClassificationJobResult> describeDocumentClassificationJobAsync(DescribeDocumentClassificationJobRequest describeDocumentClassificationJobRequest)
Gets the properties associated with a document classification job. Use this operation to get the status of a classification job.
describeDocumentClassificationJobRequest - Future<DescribeDocumentClassificationJobResult> describeDocumentClassificationJobAsync(DescribeDocumentClassificationJobRequest describeDocumentClassificationJobRequest, AsyncHandler<DescribeDocumentClassificationJobRequest,DescribeDocumentClassificationJobResult> asyncHandler)
Gets the properties associated with a document classification job. Use this operation to get the status of a classification job.
describeDocumentClassificationJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeDocumentClassifierResult> describeDocumentClassifierAsync(DescribeDocumentClassifierRequest describeDocumentClassifierRequest)
Gets the properties associated with a document classifier.
describeDocumentClassifierRequest - Future<DescribeDocumentClassifierResult> describeDocumentClassifierAsync(DescribeDocumentClassifierRequest describeDocumentClassifierRequest, AsyncHandler<DescribeDocumentClassifierRequest,DescribeDocumentClassifierResult> asyncHandler)
Gets the properties associated with a document classifier.
describeDocumentClassifierRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeDominantLanguageDetectionJobResult> describeDominantLanguageDetectionJobAsync(DescribeDominantLanguageDetectionJobRequest describeDominantLanguageDetectionJobRequest)
Gets the properties associated with a dominant language detection job. Use this operation to get the status of a detection job.
describeDominantLanguageDetectionJobRequest - Future<DescribeDominantLanguageDetectionJobResult> describeDominantLanguageDetectionJobAsync(DescribeDominantLanguageDetectionJobRequest describeDominantLanguageDetectionJobRequest, AsyncHandler<DescribeDominantLanguageDetectionJobRequest,DescribeDominantLanguageDetectionJobResult> asyncHandler)
Gets the properties associated with a dominant language detection job. Use this operation to get the status of a detection job.
describeDominantLanguageDetectionJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeEndpointResult> describeEndpointAsync(DescribeEndpointRequest describeEndpointRequest)
Gets the properties associated with a specific endpoint. Use this operation to get the status of an endpoint. For information about endpoints, see Managing endpoints.
describeEndpointRequest - Future<DescribeEndpointResult> describeEndpointAsync(DescribeEndpointRequest describeEndpointRequest, AsyncHandler<DescribeEndpointRequest,DescribeEndpointResult> asyncHandler)
Gets the properties associated with a specific endpoint. Use this operation to get the status of an endpoint. For information about endpoints, see Managing endpoints.
describeEndpointRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeEntitiesDetectionJobResult> describeEntitiesDetectionJobAsync(DescribeEntitiesDetectionJobRequest describeEntitiesDetectionJobRequest)
Gets the properties associated with an entities detection job. Use this operation to get the status of a detection job.
describeEntitiesDetectionJobRequest - Future<DescribeEntitiesDetectionJobResult> describeEntitiesDetectionJobAsync(DescribeEntitiesDetectionJobRequest describeEntitiesDetectionJobRequest, AsyncHandler<DescribeEntitiesDetectionJobRequest,DescribeEntitiesDetectionJobResult> asyncHandler)
Gets the properties associated with an entities detection job. Use this operation to get the status of a detection job.
describeEntitiesDetectionJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeEntityRecognizerResult> describeEntityRecognizerAsync(DescribeEntityRecognizerRequest describeEntityRecognizerRequest)
Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on.
describeEntityRecognizerRequest - Future<DescribeEntityRecognizerResult> describeEntityRecognizerAsync(DescribeEntityRecognizerRequest describeEntityRecognizerRequest, AsyncHandler<DescribeEntityRecognizerRequest,DescribeEntityRecognizerResult> asyncHandler)
Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on.
describeEntityRecognizerRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeEventsDetectionJobResult> describeEventsDetectionJobAsync(DescribeEventsDetectionJobRequest describeEventsDetectionJobRequest)
Gets the status and details of an events detection job.
describeEventsDetectionJobRequest - Future<DescribeEventsDetectionJobResult> describeEventsDetectionJobAsync(DescribeEventsDetectionJobRequest describeEventsDetectionJobRequest, AsyncHandler<DescribeEventsDetectionJobRequest,DescribeEventsDetectionJobResult> asyncHandler)
Gets the status and details of an events detection job.
describeEventsDetectionJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeFlywheelResult> describeFlywheelAsync(DescribeFlywheelRequest describeFlywheelRequest)
Provides configuration information about the flywheel. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
describeFlywheelRequest - Future<DescribeFlywheelResult> describeFlywheelAsync(DescribeFlywheelRequest describeFlywheelRequest, AsyncHandler<DescribeFlywheelRequest,DescribeFlywheelResult> asyncHandler)
Provides configuration information about the flywheel. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
describeFlywheelRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeFlywheelIterationResult> describeFlywheelIterationAsync(DescribeFlywheelIterationRequest describeFlywheelIterationRequest)
Retrieve the configuration properties of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
describeFlywheelIterationRequest - Future<DescribeFlywheelIterationResult> describeFlywheelIterationAsync(DescribeFlywheelIterationRequest describeFlywheelIterationRequest, AsyncHandler<DescribeFlywheelIterationRequest,DescribeFlywheelIterationResult> asyncHandler)
Retrieve the configuration properties of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
describeFlywheelIterationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeKeyPhrasesDetectionJobResult> describeKeyPhrasesDetectionJobAsync(DescribeKeyPhrasesDetectionJobRequest describeKeyPhrasesDetectionJobRequest)
Gets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job.
describeKeyPhrasesDetectionJobRequest - Future<DescribeKeyPhrasesDetectionJobResult> describeKeyPhrasesDetectionJobAsync(DescribeKeyPhrasesDetectionJobRequest describeKeyPhrasesDetectionJobRequest, AsyncHandler<DescribeKeyPhrasesDetectionJobRequest,DescribeKeyPhrasesDetectionJobResult> asyncHandler)
Gets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job.
describeKeyPhrasesDetectionJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribePiiEntitiesDetectionJobResult> describePiiEntitiesDetectionJobAsync(DescribePiiEntitiesDetectionJobRequest describePiiEntitiesDetectionJobRequest)
Gets the properties associated with a PII entities detection job. For example, you can use this operation to get the job status.
describePiiEntitiesDetectionJobRequest - Future<DescribePiiEntitiesDetectionJobResult> describePiiEntitiesDetectionJobAsync(DescribePiiEntitiesDetectionJobRequest describePiiEntitiesDetectionJobRequest, AsyncHandler<DescribePiiEntitiesDetectionJobRequest,DescribePiiEntitiesDetectionJobResult> asyncHandler)
Gets the properties associated with a PII entities detection job. For example, you can use this operation to get the job status.
describePiiEntitiesDetectionJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeResourcePolicyResult> describeResourcePolicyAsync(DescribeResourcePolicyRequest describeResourcePolicyRequest)
Gets the details of a resource-based policy that is attached to a custom model, including the JSON body of the policy.
describeResourcePolicyRequest - Future<DescribeResourcePolicyResult> describeResourcePolicyAsync(DescribeResourcePolicyRequest describeResourcePolicyRequest, AsyncHandler<DescribeResourcePolicyRequest,DescribeResourcePolicyResult> asyncHandler)
Gets the details of a resource-based policy that is attached to a custom model, including the JSON body of the policy.
describeResourcePolicyRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeSentimentDetectionJobResult> describeSentimentDetectionJobAsync(DescribeSentimentDetectionJobRequest describeSentimentDetectionJobRequest)
Gets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job.
describeSentimentDetectionJobRequest - Future<DescribeSentimentDetectionJobResult> describeSentimentDetectionJobAsync(DescribeSentimentDetectionJobRequest describeSentimentDetectionJobRequest, AsyncHandler<DescribeSentimentDetectionJobRequest,DescribeSentimentDetectionJobResult> asyncHandler)
Gets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job.
describeSentimentDetectionJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeTargetedSentimentDetectionJobResult> describeTargetedSentimentDetectionJobAsync(DescribeTargetedSentimentDetectionJobRequest describeTargetedSentimentDetectionJobRequest)
Gets the properties associated with a targeted sentiment detection job. Use this operation to get the status of the job.
describeTargetedSentimentDetectionJobRequest - Future<DescribeTargetedSentimentDetectionJobResult> describeTargetedSentimentDetectionJobAsync(DescribeTargetedSentimentDetectionJobRequest describeTargetedSentimentDetectionJobRequest, AsyncHandler<DescribeTargetedSentimentDetectionJobRequest,DescribeTargetedSentimentDetectionJobResult> asyncHandler)
Gets the properties associated with a targeted sentiment detection job. Use this operation to get the status of the job.
describeTargetedSentimentDetectionJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeTopicsDetectionJobResult> describeTopicsDetectionJobAsync(DescribeTopicsDetectionJobRequest describeTopicsDetectionJobRequest)
Gets the properties associated with a topic detection job. Use this operation to get the status of a detection job.
describeTopicsDetectionJobRequest - Future<DescribeTopicsDetectionJobResult> describeTopicsDetectionJobAsync(DescribeTopicsDetectionJobRequest describeTopicsDetectionJobRequest, AsyncHandler<DescribeTopicsDetectionJobRequest,DescribeTopicsDetectionJobResult> asyncHandler)
Gets the properties associated with a topic detection job. Use this operation to get the status of a detection job.
describeTopicsDetectionJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DetectDominantLanguageResult> detectDominantLanguageAsync(DetectDominantLanguageRequest detectDominantLanguageRequest)
Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.
detectDominantLanguageRequest - Future<DetectDominantLanguageResult> detectDominantLanguageAsync(DetectDominantLanguageRequest detectDominantLanguageRequest, AsyncHandler<DetectDominantLanguageRequest,DetectDominantLanguageResult> asyncHandler)
Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.
detectDominantLanguageRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DetectEntitiesResult> detectEntitiesAsync(DetectEntitiesRequest detectEntitiesRequest)
Detects named entities in input text when you use the pre-trained model. Detects custom entities if you have a custom entity recognition model.
When detecting named entities using the pre-trained model, use plain text as the input. For more information about named entities, see Entities in the Comprehend Developer Guide.
When you use a custom entity recognition model, you can input plain text or you can upload a single-page input document (text, PDF, Word, or image).
If the system detects errors while processing a page in the input document, the API response includes an entry in
Errors for each error.
If the system detects a document-level error in your input document, the API returns an
InvalidRequestException error response. For details about this exception, see Errors in semi-structured
documents in the Comprehend Developer Guide.
detectEntitiesRequest - Future<DetectEntitiesResult> detectEntitiesAsync(DetectEntitiesRequest detectEntitiesRequest, AsyncHandler<DetectEntitiesRequest,DetectEntitiesResult> asyncHandler)
Detects named entities in input text when you use the pre-trained model. Detects custom entities if you have a custom entity recognition model.
When detecting named entities using the pre-trained model, use plain text as the input. For more information about named entities, see Entities in the Comprehend Developer Guide.
When you use a custom entity recognition model, you can input plain text or you can upload a single-page input document (text, PDF, Word, or image).
If the system detects errors while processing a page in the input document, the API response includes an entry in
Errors for each error.
If the system detects a document-level error in your input document, the API returns an
InvalidRequestException error response. For details about this exception, see Errors in semi-structured
documents in the Comprehend Developer Guide.
detectEntitiesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DetectKeyPhrasesResult> detectKeyPhrasesAsync(DetectKeyPhrasesRequest detectKeyPhrasesRequest)
Detects the key noun phrases found in the text.
detectKeyPhrasesRequest - Future<DetectKeyPhrasesResult> detectKeyPhrasesAsync(DetectKeyPhrasesRequest detectKeyPhrasesRequest, AsyncHandler<DetectKeyPhrasesRequest,DetectKeyPhrasesResult> asyncHandler)
Detects the key noun phrases found in the text.
detectKeyPhrasesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DetectPiiEntitiesResult> detectPiiEntitiesAsync(DetectPiiEntitiesRequest detectPiiEntitiesRequest)
Inspects the input text for entities that contain personally identifiable information (PII) and returns information about them.
detectPiiEntitiesRequest - Future<DetectPiiEntitiesResult> detectPiiEntitiesAsync(DetectPiiEntitiesRequest detectPiiEntitiesRequest, AsyncHandler<DetectPiiEntitiesRequest,DetectPiiEntitiesResult> asyncHandler)
Inspects the input text for entities that contain personally identifiable information (PII) and returns information about them.
detectPiiEntitiesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DetectSentimentResult> detectSentimentAsync(DetectSentimentRequest detectSentimentRequest)
Inspects text and returns an inference of the prevailing sentiment (POSITIVE, NEUTRAL,
MIXED, or NEGATIVE).
detectSentimentRequest - Future<DetectSentimentResult> detectSentimentAsync(DetectSentimentRequest detectSentimentRequest, AsyncHandler<DetectSentimentRequest,DetectSentimentResult> asyncHandler)
Inspects text and returns an inference of the prevailing sentiment (POSITIVE, NEUTRAL,
MIXED, or NEGATIVE).
detectSentimentRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DetectSyntaxResult> detectSyntaxAsync(DetectSyntaxRequest detectSyntaxRequest)
Inspects text for syntax and the part of speech of words in the document. For more information, see Syntax in the Comprehend Developer Guide.
detectSyntaxRequest - Future<DetectSyntaxResult> detectSyntaxAsync(DetectSyntaxRequest detectSyntaxRequest, AsyncHandler<DetectSyntaxRequest,DetectSyntaxResult> asyncHandler)
Inspects text for syntax and the part of speech of words in the document. For more information, see Syntax in the Comprehend Developer Guide.
detectSyntaxRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DetectTargetedSentimentResult> detectTargetedSentimentAsync(DetectTargetedSentimentRequest detectTargetedSentimentRequest)
Inspects the input text and returns a sentiment analysis for each entity identified in the text.
For more information about targeted sentiment, see Targeted sentiment.
detectTargetedSentimentRequest - Future<DetectTargetedSentimentResult> detectTargetedSentimentAsync(DetectTargetedSentimentRequest detectTargetedSentimentRequest, AsyncHandler<DetectTargetedSentimentRequest,DetectTargetedSentimentResult> asyncHandler)
Inspects the input text and returns a sentiment analysis for each entity identified in the text.
For more information about targeted sentiment, see Targeted sentiment.
detectTargetedSentimentRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ImportModelResult> importModelAsync(ImportModelRequest importModelRequest)
Creates a new custom model that replicates a source custom model that you import. The source model can be in your Amazon Web Services account or another one.
If the source model is in another Amazon Web Services account, then it must have a resource-based policy that authorizes you to import it.
The source model must be in the same Amazon Web Services Region that you're using when you import. You can't import a model that's in a different Region.
importModelRequest - Future<ImportModelResult> importModelAsync(ImportModelRequest importModelRequest, AsyncHandler<ImportModelRequest,ImportModelResult> asyncHandler)
Creates a new custom model that replicates a source custom model that you import. The source model can be in your Amazon Web Services account or another one.
If the source model is in another Amazon Web Services account, then it must have a resource-based policy that authorizes you to import it.
The source model must be in the same Amazon Web Services Region that you're using when you import. You can't import a model that's in a different Region.
importModelRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListDatasetsResult> listDatasetsAsync(ListDatasetsRequest listDatasetsRequest)
List the datasets that you have configured in this Region. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.
listDatasetsRequest - Future<ListDatasetsResult> listDatasetsAsync(ListDatasetsRequest listDatasetsRequest, AsyncHandler<ListDatasetsRequest,ListDatasetsResult> asyncHandler)
List the datasets that you have configured in this Region. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.
listDatasetsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListDocumentClassificationJobsResult> listDocumentClassificationJobsAsync(ListDocumentClassificationJobsRequest listDocumentClassificationJobsRequest)
Gets a list of the documentation classification jobs that you have submitted.
listDocumentClassificationJobsRequest - Future<ListDocumentClassificationJobsResult> listDocumentClassificationJobsAsync(ListDocumentClassificationJobsRequest listDocumentClassificationJobsRequest, AsyncHandler<ListDocumentClassificationJobsRequest,ListDocumentClassificationJobsResult> asyncHandler)
Gets a list of the documentation classification jobs that you have submitted.
listDocumentClassificationJobsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListDocumentClassifierSummariesResult> listDocumentClassifierSummariesAsync(ListDocumentClassifierSummariesRequest listDocumentClassifierSummariesRequest)
Gets a list of summaries of the document classifiers that you have created
listDocumentClassifierSummariesRequest - Future<ListDocumentClassifierSummariesResult> listDocumentClassifierSummariesAsync(ListDocumentClassifierSummariesRequest listDocumentClassifierSummariesRequest, AsyncHandler<ListDocumentClassifierSummariesRequest,ListDocumentClassifierSummariesResult> asyncHandler)
Gets a list of summaries of the document classifiers that you have created
listDocumentClassifierSummariesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListDocumentClassifiersResult> listDocumentClassifiersAsync(ListDocumentClassifiersRequest listDocumentClassifiersRequest)
Gets a list of the document classifiers that you have created.
listDocumentClassifiersRequest - Future<ListDocumentClassifiersResult> listDocumentClassifiersAsync(ListDocumentClassifiersRequest listDocumentClassifiersRequest, AsyncHandler<ListDocumentClassifiersRequest,ListDocumentClassifiersResult> asyncHandler)
Gets a list of the document classifiers that you have created.
listDocumentClassifiersRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListDominantLanguageDetectionJobsResult> listDominantLanguageDetectionJobsAsync(ListDominantLanguageDetectionJobsRequest listDominantLanguageDetectionJobsRequest)
Gets a list of the dominant language detection jobs that you have submitted.
listDominantLanguageDetectionJobsRequest - Future<ListDominantLanguageDetectionJobsResult> listDominantLanguageDetectionJobsAsync(ListDominantLanguageDetectionJobsRequest listDominantLanguageDetectionJobsRequest, AsyncHandler<ListDominantLanguageDetectionJobsRequest,ListDominantLanguageDetectionJobsResult> asyncHandler)
Gets a list of the dominant language detection jobs that you have submitted.
listDominantLanguageDetectionJobsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListEndpointsResult> listEndpointsAsync(ListEndpointsRequest listEndpointsRequest)
Gets a list of all existing endpoints that you've created. For information about endpoints, see Managing endpoints.
listEndpointsRequest - Future<ListEndpointsResult> listEndpointsAsync(ListEndpointsRequest listEndpointsRequest, AsyncHandler<ListEndpointsRequest,ListEndpointsResult> asyncHandler)
Gets a list of all existing endpoints that you've created. For information about endpoints, see Managing endpoints.
listEndpointsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListEntitiesDetectionJobsResult> listEntitiesDetectionJobsAsync(ListEntitiesDetectionJobsRequest listEntitiesDetectionJobsRequest)
Gets a list of the entity detection jobs that you have submitted.
listEntitiesDetectionJobsRequest - Future<ListEntitiesDetectionJobsResult> listEntitiesDetectionJobsAsync(ListEntitiesDetectionJobsRequest listEntitiesDetectionJobsRequest, AsyncHandler<ListEntitiesDetectionJobsRequest,ListEntitiesDetectionJobsResult> asyncHandler)
Gets a list of the entity detection jobs that you have submitted.
listEntitiesDetectionJobsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListEntityRecognizerSummariesResult> listEntityRecognizerSummariesAsync(ListEntityRecognizerSummariesRequest listEntityRecognizerSummariesRequest)
Gets a list of summaries for the entity recognizers that you have created.
listEntityRecognizerSummariesRequest - Future<ListEntityRecognizerSummariesResult> listEntityRecognizerSummariesAsync(ListEntityRecognizerSummariesRequest listEntityRecognizerSummariesRequest, AsyncHandler<ListEntityRecognizerSummariesRequest,ListEntityRecognizerSummariesResult> asyncHandler)
Gets a list of summaries for the entity recognizers that you have created.
listEntityRecognizerSummariesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListEntityRecognizersResult> listEntityRecognizersAsync(ListEntityRecognizersRequest listEntityRecognizersRequest)
Gets a list of the properties of all entity recognizers that you created, including recognizers currently in training. Allows you to filter the list of recognizers based on criteria such as status and submission time. This call returns up to 500 entity recognizers in the list, with a default number of 100 recognizers in the list.
The results of this list are not in any particular order. Please get the list and sort locally if needed.
listEntityRecognizersRequest - Future<ListEntityRecognizersResult> listEntityRecognizersAsync(ListEntityRecognizersRequest listEntityRecognizersRequest, AsyncHandler<ListEntityRecognizersRequest,ListEntityRecognizersResult> asyncHandler)
Gets a list of the properties of all entity recognizers that you created, including recognizers currently in training. Allows you to filter the list of recognizers based on criteria such as status and submission time. This call returns up to 500 entity recognizers in the list, with a default number of 100 recognizers in the list.
The results of this list are not in any particular order. Please get the list and sort locally if needed.
listEntityRecognizersRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListEventsDetectionJobsResult> listEventsDetectionJobsAsync(ListEventsDetectionJobsRequest listEventsDetectionJobsRequest)
Gets a list of the events detection jobs that you have submitted.
listEventsDetectionJobsRequest - Future<ListEventsDetectionJobsResult> listEventsDetectionJobsAsync(ListEventsDetectionJobsRequest listEventsDetectionJobsRequest, AsyncHandler<ListEventsDetectionJobsRequest,ListEventsDetectionJobsResult> asyncHandler)
Gets a list of the events detection jobs that you have submitted.
listEventsDetectionJobsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListFlywheelIterationHistoryResult> listFlywheelIterationHistoryAsync(ListFlywheelIterationHistoryRequest listFlywheelIterationHistoryRequest)
Information about the history of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
listFlywheelIterationHistoryRequest - Future<ListFlywheelIterationHistoryResult> listFlywheelIterationHistoryAsync(ListFlywheelIterationHistoryRequest listFlywheelIterationHistoryRequest, AsyncHandler<ListFlywheelIterationHistoryRequest,ListFlywheelIterationHistoryResult> asyncHandler)
Information about the history of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
listFlywheelIterationHistoryRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListFlywheelsResult> listFlywheelsAsync(ListFlywheelsRequest listFlywheelsRequest)
Gets a list of the flywheels that you have created.
listFlywheelsRequest - Future<ListFlywheelsResult> listFlywheelsAsync(ListFlywheelsRequest listFlywheelsRequest, AsyncHandler<ListFlywheelsRequest,ListFlywheelsResult> asyncHandler)
Gets a list of the flywheels that you have created.
listFlywheelsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListKeyPhrasesDetectionJobsResult> listKeyPhrasesDetectionJobsAsync(ListKeyPhrasesDetectionJobsRequest listKeyPhrasesDetectionJobsRequest)
Get a list of key phrase detection jobs that you have submitted.
listKeyPhrasesDetectionJobsRequest - Future<ListKeyPhrasesDetectionJobsResult> listKeyPhrasesDetectionJobsAsync(ListKeyPhrasesDetectionJobsRequest listKeyPhrasesDetectionJobsRequest, AsyncHandler<ListKeyPhrasesDetectionJobsRequest,ListKeyPhrasesDetectionJobsResult> asyncHandler)
Get a list of key phrase detection jobs that you have submitted.
listKeyPhrasesDetectionJobsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListPiiEntitiesDetectionJobsResult> listPiiEntitiesDetectionJobsAsync(ListPiiEntitiesDetectionJobsRequest listPiiEntitiesDetectionJobsRequest)
Gets a list of the PII entity detection jobs that you have submitted.
listPiiEntitiesDetectionJobsRequest - Future<ListPiiEntitiesDetectionJobsResult> listPiiEntitiesDetectionJobsAsync(ListPiiEntitiesDetectionJobsRequest listPiiEntitiesDetectionJobsRequest, AsyncHandler<ListPiiEntitiesDetectionJobsRequest,ListPiiEntitiesDetectionJobsResult> asyncHandler)
Gets a list of the PII entity detection jobs that you have submitted.
listPiiEntitiesDetectionJobsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListSentimentDetectionJobsResult> listSentimentDetectionJobsAsync(ListSentimentDetectionJobsRequest listSentimentDetectionJobsRequest)
Gets a list of sentiment detection jobs that you have submitted.
listSentimentDetectionJobsRequest - Future<ListSentimentDetectionJobsResult> listSentimentDetectionJobsAsync(ListSentimentDetectionJobsRequest listSentimentDetectionJobsRequest, AsyncHandler<ListSentimentDetectionJobsRequest,ListSentimentDetectionJobsResult> asyncHandler)
Gets a list of sentiment detection jobs that you have submitted.
listSentimentDetectionJobsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags associated with a given Amazon Comprehend resource.
listTagsForResourceRequest - Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Lists all tags associated with a given Amazon Comprehend resource.
listTagsForResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListTargetedSentimentDetectionJobsResult> listTargetedSentimentDetectionJobsAsync(ListTargetedSentimentDetectionJobsRequest listTargetedSentimentDetectionJobsRequest)
Gets a list of targeted sentiment detection jobs that you have submitted.
listTargetedSentimentDetectionJobsRequest - Future<ListTargetedSentimentDetectionJobsResult> listTargetedSentimentDetectionJobsAsync(ListTargetedSentimentDetectionJobsRequest listTargetedSentimentDetectionJobsRequest, AsyncHandler<ListTargetedSentimentDetectionJobsRequest,ListTargetedSentimentDetectionJobsResult> asyncHandler)
Gets a list of targeted sentiment detection jobs that you have submitted.
listTargetedSentimentDetectionJobsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListTopicsDetectionJobsResult> listTopicsDetectionJobsAsync(ListTopicsDetectionJobsRequest listTopicsDetectionJobsRequest)
Gets a list of the topic detection jobs that you have submitted.
listTopicsDetectionJobsRequest - Future<ListTopicsDetectionJobsResult> listTopicsDetectionJobsAsync(ListTopicsDetectionJobsRequest listTopicsDetectionJobsRequest, AsyncHandler<ListTopicsDetectionJobsRequest,ListTopicsDetectionJobsResult> asyncHandler)
Gets a list of the topic detection jobs that you have submitted.
listTopicsDetectionJobsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutResourcePolicyResult> putResourcePolicyAsync(PutResourcePolicyRequest putResourcePolicyRequest)
Attaches a resource-based policy to a custom model. You can use this policy to authorize an entity in another Amazon Web Services account to import the custom model, which replicates it in Amazon Comprehend in their account.
putResourcePolicyRequest - Future<PutResourcePolicyResult> putResourcePolicyAsync(PutResourcePolicyRequest putResourcePolicyRequest, AsyncHandler<PutResourcePolicyRequest,PutResourcePolicyResult> asyncHandler)
Attaches a resource-based policy to a custom model. You can use this policy to authorize an entity in another Amazon Web Services account to import the custom model, which replicates it in Amazon Comprehend in their account.
putResourcePolicyRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartDocumentClassificationJobResult> startDocumentClassificationJobAsync(StartDocumentClassificationJobRequest startDocumentClassificationJobRequest)
Starts an asynchronous document classification job. Use the DescribeDocumentClassificationJob
operation to track the progress of the job.
startDocumentClassificationJobRequest - Future<StartDocumentClassificationJobResult> startDocumentClassificationJobAsync(StartDocumentClassificationJobRequest startDocumentClassificationJobRequest, AsyncHandler<StartDocumentClassificationJobRequest,StartDocumentClassificationJobResult> asyncHandler)
Starts an asynchronous document classification job. Use the DescribeDocumentClassificationJob
operation to track the progress of the job.
startDocumentClassificationJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartDominantLanguageDetectionJobResult> startDominantLanguageDetectionJobAsync(StartDominantLanguageDetectionJobRequest startDominantLanguageDetectionJobRequest)
Starts an asynchronous dominant language detection job for a collection of documents. Use the operation to track the status of a job.
startDominantLanguageDetectionJobRequest - Future<StartDominantLanguageDetectionJobResult> startDominantLanguageDetectionJobAsync(StartDominantLanguageDetectionJobRequest startDominantLanguageDetectionJobRequest, AsyncHandler<StartDominantLanguageDetectionJobRequest,StartDominantLanguageDetectionJobResult> asyncHandler)
Starts an asynchronous dominant language detection job for a collection of documents. Use the operation to track the status of a job.
startDominantLanguageDetectionJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartEntitiesDetectionJobResult> startEntitiesDetectionJobAsync(StartEntitiesDetectionJobRequest startEntitiesDetectionJobRequest)
Starts an asynchronous entity detection job for a collection of documents. Use the operation to track the status of a job.
This API can be used for either standard entity detection or custom entity recognition. In order to be used for
custom entity recognition, the optional EntityRecognizerArn must be used in order to provide access
to the recognizer being used to detect the custom entity.
startEntitiesDetectionJobRequest - Future<StartEntitiesDetectionJobResult> startEntitiesDetectionJobAsync(StartEntitiesDetectionJobRequest startEntitiesDetectionJobRequest, AsyncHandler<StartEntitiesDetectionJobRequest,StartEntitiesDetectionJobResult> asyncHandler)
Starts an asynchronous entity detection job for a collection of documents. Use the operation to track the status of a job.
This API can be used for either standard entity detection or custom entity recognition. In order to be used for
custom entity recognition, the optional EntityRecognizerArn must be used in order to provide access
to the recognizer being used to detect the custom entity.
startEntitiesDetectionJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartEventsDetectionJobResult> startEventsDetectionJobAsync(StartEventsDetectionJobRequest startEventsDetectionJobRequest)
Starts an asynchronous event detection job for a collection of documents.
startEventsDetectionJobRequest - Future<StartEventsDetectionJobResult> startEventsDetectionJobAsync(StartEventsDetectionJobRequest startEventsDetectionJobRequest, AsyncHandler<StartEventsDetectionJobRequest,StartEventsDetectionJobResult> asyncHandler)
Starts an asynchronous event detection job for a collection of documents.
startEventsDetectionJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartFlywheelIterationResult> startFlywheelIterationAsync(StartFlywheelIterationRequest startFlywheelIterationRequest)
Start the flywheel iteration.This operation uses any new datasets to train a new model version. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
startFlywheelIterationRequest - Future<StartFlywheelIterationResult> startFlywheelIterationAsync(StartFlywheelIterationRequest startFlywheelIterationRequest, AsyncHandler<StartFlywheelIterationRequest,StartFlywheelIterationResult> asyncHandler)
Start the flywheel iteration.This operation uses any new datasets to train a new model version. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
startFlywheelIterationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartKeyPhrasesDetectionJobResult> startKeyPhrasesDetectionJobAsync(StartKeyPhrasesDetectionJobRequest startKeyPhrasesDetectionJobRequest)
Starts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the status of a job.
startKeyPhrasesDetectionJobRequest - Future<StartKeyPhrasesDetectionJobResult> startKeyPhrasesDetectionJobAsync(StartKeyPhrasesDetectionJobRequest startKeyPhrasesDetectionJobRequest, AsyncHandler<StartKeyPhrasesDetectionJobRequest,StartKeyPhrasesDetectionJobResult> asyncHandler)
Starts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the status of a job.
startKeyPhrasesDetectionJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartPiiEntitiesDetectionJobResult> startPiiEntitiesDetectionJobAsync(StartPiiEntitiesDetectionJobRequest startPiiEntitiesDetectionJobRequest)
Starts an asynchronous PII entity detection job for a collection of documents.
startPiiEntitiesDetectionJobRequest - Future<StartPiiEntitiesDetectionJobResult> startPiiEntitiesDetectionJobAsync(StartPiiEntitiesDetectionJobRequest startPiiEntitiesDetectionJobRequest, AsyncHandler<StartPiiEntitiesDetectionJobRequest,StartPiiEntitiesDetectionJobResult> asyncHandler)
Starts an asynchronous PII entity detection job for a collection of documents.
startPiiEntitiesDetectionJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartSentimentDetectionJobResult> startSentimentDetectionJobAsync(StartSentimentDetectionJobRequest startSentimentDetectionJobRequest)
Starts an asynchronous sentiment detection job for a collection of documents. Use the operation to track the status of a job.
startSentimentDetectionJobRequest - Future<StartSentimentDetectionJobResult> startSentimentDetectionJobAsync(StartSentimentDetectionJobRequest startSentimentDetectionJobRequest, AsyncHandler<StartSentimentDetectionJobRequest,StartSentimentDetectionJobResult> asyncHandler)
Starts an asynchronous sentiment detection job for a collection of documents. Use the operation to track the status of a job.
startSentimentDetectionJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartTargetedSentimentDetectionJobResult> startTargetedSentimentDetectionJobAsync(StartTargetedSentimentDetectionJobRequest startTargetedSentimentDetectionJobRequest)
Starts an asynchronous targeted sentiment detection job for a collection of documents. Use the
DescribeTargetedSentimentDetectionJob operation to track the status of a job.
startTargetedSentimentDetectionJobRequest - Future<StartTargetedSentimentDetectionJobResult> startTargetedSentimentDetectionJobAsync(StartTargetedSentimentDetectionJobRequest startTargetedSentimentDetectionJobRequest, AsyncHandler<StartTargetedSentimentDetectionJobRequest,StartTargetedSentimentDetectionJobResult> asyncHandler)
Starts an asynchronous targeted sentiment detection job for a collection of documents. Use the
DescribeTargetedSentimentDetectionJob operation to track the status of a job.
startTargetedSentimentDetectionJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartTopicsDetectionJobResult> startTopicsDetectionJobAsync(StartTopicsDetectionJobRequest startTopicsDetectionJobRequest)
Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob operation to track the
status of a job.
startTopicsDetectionJobRequest - Future<StartTopicsDetectionJobResult> startTopicsDetectionJobAsync(StartTopicsDetectionJobRequest startTopicsDetectionJobRequest, AsyncHandler<StartTopicsDetectionJobRequest,StartTopicsDetectionJobResult> asyncHandler)
Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob operation to track the
status of a job.
startTopicsDetectionJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StopDominantLanguageDetectionJobResult> stopDominantLanguageDetectionJobAsync(StopDominantLanguageDetectionJobRequest stopDominantLanguageDetectionJobRequest)
Stops a dominant language detection job in progress.
If the job state is IN_PROGRESS the job is marked for termination and put into the
STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the
COMPLETED state; otherwise the job is stopped and put into the STOPPED state.
If the job is in the COMPLETED or FAILED state when you call the
StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.
When a job is stopped, any documents already processed are written to the output location.
stopDominantLanguageDetectionJobRequest - Future<StopDominantLanguageDetectionJobResult> stopDominantLanguageDetectionJobAsync(StopDominantLanguageDetectionJobRequest stopDominantLanguageDetectionJobRequest, AsyncHandler<StopDominantLanguageDetectionJobRequest,StopDominantLanguageDetectionJobResult> asyncHandler)
Stops a dominant language detection job in progress.
If the job state is IN_PROGRESS the job is marked for termination and put into the
STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the
COMPLETED state; otherwise the job is stopped and put into the STOPPED state.
If the job is in the COMPLETED or FAILED state when you call the
StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.
When a job is stopped, any documents already processed are written to the output location.
stopDominantLanguageDetectionJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StopEntitiesDetectionJobResult> stopEntitiesDetectionJobAsync(StopEntitiesDetectionJobRequest stopEntitiesDetectionJobRequest)
Stops an entities detection job in progress.
If the job state is IN_PROGRESS the job is marked for termination and put into the
STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the
COMPLETED state; otherwise the job is stopped and put into the STOPPED state.
If the job is in the COMPLETED or FAILED state when you call the
StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.
When a job is stopped, any documents already processed are written to the output location.
stopEntitiesDetectionJobRequest - Future<StopEntitiesDetectionJobResult> stopEntitiesDetectionJobAsync(StopEntitiesDetectionJobRequest stopEntitiesDetectionJobRequest, AsyncHandler<StopEntitiesDetectionJobRequest,StopEntitiesDetectionJobResult> asyncHandler)
Stops an entities detection job in progress.
If the job state is IN_PROGRESS the job is marked for termination and put into the
STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the
COMPLETED state; otherwise the job is stopped and put into the STOPPED state.
If the job is in the COMPLETED or FAILED state when you call the
StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.
When a job is stopped, any documents already processed are written to the output location.
stopEntitiesDetectionJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StopEventsDetectionJobResult> stopEventsDetectionJobAsync(StopEventsDetectionJobRequest stopEventsDetectionJobRequest)
Stops an events detection job in progress.
stopEventsDetectionJobRequest - Future<StopEventsDetectionJobResult> stopEventsDetectionJobAsync(StopEventsDetectionJobRequest stopEventsDetectionJobRequest, AsyncHandler<StopEventsDetectionJobRequest,StopEventsDetectionJobResult> asyncHandler)
Stops an events detection job in progress.
stopEventsDetectionJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StopKeyPhrasesDetectionJobResult> stopKeyPhrasesDetectionJobAsync(StopKeyPhrasesDetectionJobRequest stopKeyPhrasesDetectionJobRequest)
Stops a key phrases detection job in progress.
If the job state is IN_PROGRESS the job is marked for termination and put into the
STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the
COMPLETED state; otherwise the job is stopped and put into the STOPPED state.
If the job is in the COMPLETED or FAILED state when you call the
StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.
When a job is stopped, any documents already processed are written to the output location.
stopKeyPhrasesDetectionJobRequest - Future<StopKeyPhrasesDetectionJobResult> stopKeyPhrasesDetectionJobAsync(StopKeyPhrasesDetectionJobRequest stopKeyPhrasesDetectionJobRequest, AsyncHandler<StopKeyPhrasesDetectionJobRequest,StopKeyPhrasesDetectionJobResult> asyncHandler)
Stops a key phrases detection job in progress.
If the job state is IN_PROGRESS the job is marked for termination and put into the
STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the
COMPLETED state; otherwise the job is stopped and put into the STOPPED state.
If the job is in the COMPLETED or FAILED state when you call the
StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.
When a job is stopped, any documents already processed are written to the output location.
stopKeyPhrasesDetectionJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StopPiiEntitiesDetectionJobResult> stopPiiEntitiesDetectionJobAsync(StopPiiEntitiesDetectionJobRequest stopPiiEntitiesDetectionJobRequest)
Stops a PII entities detection job in progress.
stopPiiEntitiesDetectionJobRequest - Future<StopPiiEntitiesDetectionJobResult> stopPiiEntitiesDetectionJobAsync(StopPiiEntitiesDetectionJobRequest stopPiiEntitiesDetectionJobRequest, AsyncHandler<StopPiiEntitiesDetectionJobRequest,StopPiiEntitiesDetectionJobResult> asyncHandler)
Stops a PII entities detection job in progress.
stopPiiEntitiesDetectionJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StopSentimentDetectionJobResult> stopSentimentDetectionJobAsync(StopSentimentDetectionJobRequest stopSentimentDetectionJobRequest)
Stops a sentiment detection job in progress.
If the job state is IN_PROGRESS, the job is marked for termination and put into the
STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the
COMPLETED state; otherwise the job is be stopped and put into the STOPPED state.
If the job is in the COMPLETED or FAILED state when you call the
StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.
When a job is stopped, any documents already processed are written to the output location.
stopSentimentDetectionJobRequest - Future<StopSentimentDetectionJobResult> stopSentimentDetectionJobAsync(StopSentimentDetectionJobRequest stopSentimentDetectionJobRequest, AsyncHandler<StopSentimentDetectionJobRequest,StopSentimentDetectionJobResult> asyncHandler)
Stops a sentiment detection job in progress.
If the job state is IN_PROGRESS, the job is marked for termination and put into the
STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the
COMPLETED state; otherwise the job is be stopped and put into the STOPPED state.
If the job is in the COMPLETED or FAILED state when you call the
StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.
When a job is stopped, any documents already processed are written to the output location.
stopSentimentDetectionJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StopTargetedSentimentDetectionJobResult> stopTargetedSentimentDetectionJobAsync(StopTargetedSentimentDetectionJobRequest stopTargetedSentimentDetectionJobRequest)
Stops a targeted sentiment detection job in progress.
If the job state is IN_PROGRESS, the job is marked for termination and put into the
STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the
COMPLETED state; otherwise the job is be stopped and put into the STOPPED state.
If the job is in the COMPLETED or FAILED state when you call the
StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.
When a job is stopped, any documents already processed are written to the output location.
stopTargetedSentimentDetectionJobRequest - Future<StopTargetedSentimentDetectionJobResult> stopTargetedSentimentDetectionJobAsync(StopTargetedSentimentDetectionJobRequest stopTargetedSentimentDetectionJobRequest, AsyncHandler<StopTargetedSentimentDetectionJobRequest,StopTargetedSentimentDetectionJobResult> asyncHandler)
Stops a targeted sentiment detection job in progress.
If the job state is IN_PROGRESS, the job is marked for termination and put into the
STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the
COMPLETED state; otherwise the job is be stopped and put into the STOPPED state.
If the job is in the COMPLETED or FAILED state when you call the
StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.
When a job is stopped, any documents already processed are written to the output location.
stopTargetedSentimentDetectionJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StopTrainingDocumentClassifierResult> stopTrainingDocumentClassifierAsync(StopTrainingDocumentClassifierRequest stopTrainingDocumentClassifierRequest)
Stops a document classifier training job while in progress.
If the training job state is TRAINING, the job is marked for termination and put into the
STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the
TRAINED; otherwise the training job is stopped and put into the STOPPED state and the
service sends back an HTTP 200 response with an empty HTTP body.
stopTrainingDocumentClassifierRequest - Future<StopTrainingDocumentClassifierResult> stopTrainingDocumentClassifierAsync(StopTrainingDocumentClassifierRequest stopTrainingDocumentClassifierRequest, AsyncHandler<StopTrainingDocumentClassifierRequest,StopTrainingDocumentClassifierResult> asyncHandler)
Stops a document classifier training job while in progress.
If the training job state is TRAINING, the job is marked for termination and put into the
STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the
TRAINED; otherwise the training job is stopped and put into the STOPPED state and the
service sends back an HTTP 200 response with an empty HTTP body.
stopTrainingDocumentClassifierRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StopTrainingEntityRecognizerResult> stopTrainingEntityRecognizerAsync(StopTrainingEntityRecognizerRequest stopTrainingEntityRecognizerRequest)
Stops an entity recognizer training job while in progress.
If the training job state is TRAINING, the job is marked for termination and put into the
STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the
TRAINED; otherwise the training job is stopped and putted into the STOPPED state and
the service sends back an HTTP 200 response with an empty HTTP body.
stopTrainingEntityRecognizerRequest - Future<StopTrainingEntityRecognizerResult> stopTrainingEntityRecognizerAsync(StopTrainingEntityRecognizerRequest stopTrainingEntityRecognizerRequest, AsyncHandler<StopTrainingEntityRecognizerRequest,StopTrainingEntityRecognizerResult> asyncHandler)
Stops an entity recognizer training job while in progress.
If the training job state is TRAINING, the job is marked for termination and put into the
STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the
TRAINED; otherwise the training job is stopped and putted into the STOPPED state and
the service sends back an HTTP 200 response with an empty HTTP body.
stopTrainingEntityRecognizerRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)
Associates a specific tag with an Amazon Comprehend resource. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
tagResourceRequest - Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Associates a specific tag with an Amazon Comprehend resource. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
tagResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes a specific tag associated with an Amazon Comprehend resource.
untagResourceRequest - Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes a specific tag associated with an Amazon Comprehend resource.
untagResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateEndpointResult> updateEndpointAsync(UpdateEndpointRequest updateEndpointRequest)
Updates information about the specified endpoint. For information about endpoints, see Managing endpoints.
updateEndpointRequest - Future<UpdateEndpointResult> updateEndpointAsync(UpdateEndpointRequest updateEndpointRequest, AsyncHandler<UpdateEndpointRequest,UpdateEndpointResult> asyncHandler)
Updates information about the specified endpoint. For information about endpoints, see Managing endpoints.
updateEndpointRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateFlywheelResult> updateFlywheelAsync(UpdateFlywheelRequest updateFlywheelRequest)
Update the configuration information for an existing flywheel.
updateFlywheelRequest - Future<UpdateFlywheelResult> updateFlywheelAsync(UpdateFlywheelRequest updateFlywheelRequest, AsyncHandler<UpdateFlywheelRequest,UpdateFlywheelResult> asyncHandler)
Update the configuration information for an existing flywheel.
updateFlywheelRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.