com.amazonaws.services.comprehend.AmazonComprehendAsync Maven / Gradle / Ivy
Show all versions of aws-java-sdk-comprehend Show documentation
/*
* Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.comprehend;
import javax.annotation.Generated;
import com.amazonaws.services.comprehend.model.*;
/**
* Interface for accessing Amazon Comprehend asynchronously. Each asynchronous method will return a Java Future object
* representing the asynchronous operation; overloads which accept an {@code 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
* {@link com.amazonaws.services.comprehend.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.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonComprehendAsync extends AmazonComprehend {
/**
*
* 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.
*
*
* @param batchDetectDominantLanguageRequest
* @return A Java Future containing the result of the BatchDetectDominantLanguage operation returned by the service.
* @sample AmazonComprehendAsync.BatchDetectDominantLanguage
* @see AWS API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param batchDetectDominantLanguageRequest
* @param 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.
* @return A Java Future containing the result of the BatchDetectDominantLanguage operation returned by the service.
* @sample AmazonComprehendAsyncHandler.BatchDetectDominantLanguage
* @see AWS API Documentation
*/
java.util.concurrent.Future batchDetectDominantLanguageAsync(
BatchDetectDominantLanguageRequest batchDetectDominantLanguageRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param batchDetectEntitiesRequest
* @return A Java Future containing the result of the BatchDetectEntities operation returned by the service.
* @sample AmazonComprehendAsync.BatchDetectEntities
* @see AWS
* API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param batchDetectEntitiesRequest
* @param 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.
* @return A Java Future containing the result of the BatchDetectEntities operation returned by the service.
* @sample AmazonComprehendAsyncHandler.BatchDetectEntities
* @see AWS
* API Documentation
*/
java.util.concurrent.Future batchDetectEntitiesAsync(BatchDetectEntitiesRequest batchDetectEntitiesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Detects the key noun phrases found in a batch of documents.
*
*
* @param batchDetectKeyPhrasesRequest
* @return A Java Future containing the result of the BatchDetectKeyPhrases operation returned by the service.
* @sample AmazonComprehendAsync.BatchDetectKeyPhrases
* @see AWS API Documentation
*/
java.util.concurrent.Future batchDetectKeyPhrasesAsync(BatchDetectKeyPhrasesRequest batchDetectKeyPhrasesRequest);
/**
*
* Detects the key noun phrases found in a batch of documents.
*
*
* @param batchDetectKeyPhrasesRequest
* @param 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.
* @return A Java Future containing the result of the BatchDetectKeyPhrases operation returned by the service.
* @sample AmazonComprehendAsyncHandler.BatchDetectKeyPhrases
* @see AWS API Documentation
*/
java.util.concurrent.Future batchDetectKeyPhrasesAsync(BatchDetectKeyPhrasesRequest batchDetectKeyPhrasesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Inspects a batch of documents and returns an inference of the prevailing sentiment, POSITIVE,
* NEUTRAL, MIXED, or NEGATIVE, in each one.
*
*
* @param batchDetectSentimentRequest
* @return A Java Future containing the result of the BatchDetectSentiment operation returned by the service.
* @sample AmazonComprehendAsync.BatchDetectSentiment
* @see AWS API Documentation
*/
java.util.concurrent.Future batchDetectSentimentAsync(BatchDetectSentimentRequest batchDetectSentimentRequest);
/**
*
* Inspects a batch of documents and returns an inference of the prevailing sentiment, POSITIVE,
* NEUTRAL, MIXED, or NEGATIVE, in each one.
*
*
* @param batchDetectSentimentRequest
* @param 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.
* @return A Java Future containing the result of the BatchDetectSentiment operation returned by the service.
* @sample AmazonComprehendAsyncHandler.BatchDetectSentiment
* @see AWS API Documentation
*/
java.util.concurrent.Future batchDetectSentimentAsync(BatchDetectSentimentRequest batchDetectSentimentRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param batchDetectSyntaxRequest
* @return A Java Future containing the result of the BatchDetectSyntax operation returned by the service.
* @sample AmazonComprehendAsync.BatchDetectSyntax
* @see AWS
* API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param batchDetectSyntaxRequest
* @param 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.
* @return A Java Future containing the result of the BatchDetectSyntax operation returned by the service.
* @sample AmazonComprehendAsyncHandler.BatchDetectSyntax
* @see AWS
* API Documentation
*/
java.util.concurrent.Future batchDetectSyntaxAsync(BatchDetectSyntaxRequest batchDetectSyntaxRequest,
com.amazonaws.handlers.AsyncHandler 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 in the
* Amazon Comprehend Developer Guide.
*
*
* @param batchDetectTargetedSentimentRequest
* @return A Java Future containing the result of the BatchDetectTargetedSentiment operation returned by the
* service.
* @sample AmazonComprehendAsync.BatchDetectTargetedSentiment
* @see AWS API Documentation
*/
java.util.concurrent.Future 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 in the
* Amazon Comprehend Developer Guide.
*
*
* @param batchDetectTargetedSentimentRequest
* @param 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.
* @return A Java Future containing the result of the BatchDetectTargetedSentiment operation returned by the
* service.
* @sample AmazonComprehendAsyncHandler.BatchDetectTargetedSentiment
* @see AWS API Documentation
*/
java.util.concurrent.Future batchDetectTargetedSentimentAsync(
BatchDetectTargetedSentimentRequest batchDetectTargetedSentimentRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param classifyDocumentRequest
* @return A Java Future containing the result of the ClassifyDocument operation returned by the service.
* @sample AmazonComprehendAsync.ClassifyDocument
* @see AWS
* API Documentation
*/
java.util.concurrent.Future classifyDocumentAsync(ClassifyDocumentRequest classifyDocumentRequest);
/**
*
* 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.
*
*
* @param classifyDocumentRequest
* @param 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.
* @return A Java Future containing the result of the ClassifyDocument operation returned by the service.
* @sample AmazonComprehendAsyncHandler.ClassifyDocument
* @see AWS
* API Documentation
*/
java.util.concurrent.Future classifyDocumentAsync(ClassifyDocumentRequest classifyDocumentRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param containsPiiEntitiesRequest
* @return A Java Future containing the result of the ContainsPiiEntities operation returned by the service.
* @sample AmazonComprehendAsync.ContainsPiiEntities
* @see AWS
* API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param containsPiiEntitiesRequest
* @param 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.
* @return A Java Future containing the result of the ContainsPiiEntities operation returned by the service.
* @sample AmazonComprehendAsyncHandler.ContainsPiiEntities
* @see AWS
* API Documentation
*/
java.util.concurrent.Future containsPiiEntitiesAsync(ContainsPiiEntitiesRequest containsPiiEntitiesRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param createDatasetRequest
* @return A Java Future containing the result of the CreateDataset operation returned by the service.
* @sample AmazonComprehendAsync.CreateDataset
* @see AWS API
* Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param createDatasetRequest
* @param 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.
* @return A Java Future containing the result of the CreateDataset operation returned by the service.
* @sample AmazonComprehendAsyncHandler.CreateDataset
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createDatasetAsync(CreateDatasetRequest createDatasetRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param createDocumentClassifierRequest
* @return A Java Future containing the result of the CreateDocumentClassifier operation returned by the service.
* @sample AmazonComprehendAsync.CreateDocumentClassifier
* @see AWS API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param createDocumentClassifierRequest
* @param 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.
* @return A Java Future containing the result of the CreateDocumentClassifier operation returned by the service.
* @sample AmazonComprehendAsyncHandler.CreateDocumentClassifier
* @see AWS API Documentation
*/
java.util.concurrent.Future createDocumentClassifierAsync(CreateDocumentClassifierRequest createDocumentClassifierRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Creates a model-specific endpoint for synchronous inference for a previously trained custom model For information
* about endpoints, see Managing
* endpoints.
*
*
* @param createEndpointRequest
* @return A Java Future containing the result of the CreateEndpoint operation returned by the service.
* @sample AmazonComprehendAsync.CreateEndpoint
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createEndpointAsync(CreateEndpointRequest createEndpointRequest);
/**
*
* Creates a model-specific endpoint for synchronous inference for a previously trained custom model For information
* about endpoints, see Managing
* endpoints.
*
*
* @param createEndpointRequest
* @param 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.
* @return A Java Future containing the result of the CreateEndpoint operation returned by the service.
* @sample AmazonComprehendAsyncHandler.CreateEndpoint
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createEndpointAsync(CreateEndpointRequest createEndpointRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Creates an entity recognizer using submitted files. After your CreateEntityRecognizer request is
* submitted, you can check job status using the DescribeEntityRecognizer API.
*
*
* @param createEntityRecognizerRequest
* @return A Java Future containing the result of the CreateEntityRecognizer operation returned by the service.
* @sample AmazonComprehendAsync.CreateEntityRecognizer
* @see AWS API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param createEntityRecognizerRequest
* @param 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.
* @return A Java Future containing the result of the CreateEntityRecognizer operation returned by the service.
* @sample AmazonComprehendAsyncHandler.CreateEntityRecognizer
* @see AWS API Documentation
*/
java.util.concurrent.Future createEntityRecognizerAsync(CreateEntityRecognizerRequest createEntityRecognizerRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param createFlywheelRequest
* @return A Java Future containing the result of the CreateFlywheel operation returned by the service.
* @sample AmazonComprehendAsync.CreateFlywheel
* @see AWS API
* Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param createFlywheelRequest
* @param 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.
* @return A Java Future containing the result of the CreateFlywheel operation returned by the service.
* @sample AmazonComprehendAsyncHandler.CreateFlywheel
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createFlywheelAsync(CreateFlywheelRequest createFlywheelRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param deleteDocumentClassifierRequest
* @return A Java Future containing the result of the DeleteDocumentClassifier operation returned by the service.
* @sample AmazonComprehendAsync.DeleteDocumentClassifier
* @see AWS API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param deleteDocumentClassifierRequest
* @param 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.
* @return A Java Future containing the result of the DeleteDocumentClassifier operation returned by the service.
* @sample AmazonComprehendAsyncHandler.DeleteDocumentClassifier
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteDocumentClassifierAsync(DeleteDocumentClassifierRequest deleteDocumentClassifierRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param deleteEndpointRequest
* @return A Java Future containing the result of the DeleteEndpoint operation returned by the service.
* @sample AmazonComprehendAsync.DeleteEndpoint
* @see AWS API
* Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param deleteEndpointRequest
* @param 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.
* @return A Java Future containing the result of the DeleteEndpoint operation returned by the service.
* @sample AmazonComprehendAsyncHandler.DeleteEndpoint
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deleteEndpointAsync(DeleteEndpointRequest deleteEndpointRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param deleteEntityRecognizerRequest
* @return A Java Future containing the result of the DeleteEntityRecognizer operation returned by the service.
* @sample AmazonComprehendAsync.DeleteEntityRecognizer
* @see AWS API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param deleteEntityRecognizerRequest
* @param 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.
* @return A Java Future containing the result of the DeleteEntityRecognizer operation returned by the service.
* @sample AmazonComprehendAsyncHandler.DeleteEntityRecognizer
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteEntityRecognizerAsync(DeleteEntityRecognizerRequest deleteEntityRecognizerRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param deleteFlywheelRequest
* @return A Java Future containing the result of the DeleteFlywheel operation returned by the service.
* @sample AmazonComprehendAsync.DeleteFlywheel
* @see AWS API
* Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param deleteFlywheelRequest
* @param 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.
* @return A Java Future containing the result of the DeleteFlywheel operation returned by the service.
* @sample AmazonComprehendAsyncHandler.DeleteFlywheel
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deleteFlywheelAsync(DeleteFlywheelRequest deleteFlywheelRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes a resource-based policy that is attached to a custom model.
*
*
* @param deleteResourcePolicyRequest
* @return A Java Future containing the result of the DeleteResourcePolicy operation returned by the service.
* @sample AmazonComprehendAsync.DeleteResourcePolicy
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteResourcePolicyAsync(DeleteResourcePolicyRequest deleteResourcePolicyRequest);
/**
*
* Deletes a resource-based policy that is attached to a custom model.
*
*
* @param deleteResourcePolicyRequest
* @param 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.
* @return A Java Future containing the result of the DeleteResourcePolicy operation returned by the service.
* @sample AmazonComprehendAsyncHandler.DeleteResourcePolicy
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteResourcePolicyAsync(DeleteResourcePolicyRequest deleteResourcePolicyRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns information about the dataset that you specify. For more information about datasets, see Flywheel overview in the
* Amazon Comprehend Developer Guide.
*
*
* @param describeDatasetRequest
* @return A Java Future containing the result of the DescribeDataset operation returned by the service.
* @sample AmazonComprehendAsync.DescribeDataset
* @see AWS API
* Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param describeDatasetRequest
* @param 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.
* @return A Java Future containing the result of the DescribeDataset operation returned by the service.
* @sample AmazonComprehendAsyncHandler.DescribeDataset
* @see AWS API
* Documentation
*/
java.util.concurrent.Future describeDatasetAsync(DescribeDatasetRequest describeDatasetRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Gets the properties associated with a document classification job. Use this operation to get the status of a
* classification job.
*
*
* @param describeDocumentClassificationJobRequest
* @return A Java Future containing the result of the DescribeDocumentClassificationJob operation returned by the
* service.
* @sample AmazonComprehendAsync.DescribeDocumentClassificationJob
* @see AWS API Documentation
*/
java.util.concurrent.Future describeDocumentClassificationJobAsync(
DescribeDocumentClassificationJobRequest describeDocumentClassificationJobRequest);
/**
*
* Gets the properties associated with a document classification job. Use this operation to get the status of a
* classification job.
*
*
* @param describeDocumentClassificationJobRequest
* @param 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.
* @return A Java Future containing the result of the DescribeDocumentClassificationJob operation returned by the
* service.
* @sample AmazonComprehendAsyncHandler.DescribeDocumentClassificationJob
* @see AWS API Documentation
*/
java.util.concurrent.Future describeDocumentClassificationJobAsync(
DescribeDocumentClassificationJobRequest describeDocumentClassificationJobRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Gets the properties associated with a document classifier.
*
*
* @param describeDocumentClassifierRequest
* @return A Java Future containing the result of the DescribeDocumentClassifier operation returned by the service.
* @sample AmazonComprehendAsync.DescribeDocumentClassifier
* @see AWS API Documentation
*/
java.util.concurrent.Future describeDocumentClassifierAsync(
DescribeDocumentClassifierRequest describeDocumentClassifierRequest);
/**
*
* Gets the properties associated with a document classifier.
*
*
* @param describeDocumentClassifierRequest
* @param 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.
* @return A Java Future containing the result of the DescribeDocumentClassifier operation returned by the service.
* @sample AmazonComprehendAsyncHandler.DescribeDocumentClassifier
* @see AWS API Documentation
*/
java.util.concurrent.Future describeDocumentClassifierAsync(
DescribeDocumentClassifierRequest describeDocumentClassifierRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Gets the properties associated with a dominant language detection job. Use this operation to get the status of a
* detection job.
*
*
* @param describeDominantLanguageDetectionJobRequest
* @return A Java Future containing the result of the DescribeDominantLanguageDetectionJob operation returned by the
* service.
* @sample AmazonComprehendAsync.DescribeDominantLanguageDetectionJob
* @see AWS API Documentation
*/
java.util.concurrent.Future describeDominantLanguageDetectionJobAsync(
DescribeDominantLanguageDetectionJobRequest describeDominantLanguageDetectionJobRequest);
/**
*
* Gets the properties associated with a dominant language detection job. Use this operation to get the status of a
* detection job.
*
*
* @param describeDominantLanguageDetectionJobRequest
* @param 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.
* @return A Java Future containing the result of the DescribeDominantLanguageDetectionJob operation returned by the
* service.
* @sample AmazonComprehendAsyncHandler.DescribeDominantLanguageDetectionJob
* @see AWS API Documentation
*/
java.util.concurrent.Future describeDominantLanguageDetectionJobAsync(
DescribeDominantLanguageDetectionJobRequest describeDominantLanguageDetectionJobRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param describeEndpointRequest
* @return A Java Future containing the result of the DescribeEndpoint operation returned by the service.
* @sample AmazonComprehendAsync.DescribeEndpoint
* @see AWS
* API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param describeEndpointRequest
* @param 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.
* @return A Java Future containing the result of the DescribeEndpoint operation returned by the service.
* @sample AmazonComprehendAsyncHandler.DescribeEndpoint
* @see AWS
* API Documentation
*/
java.util.concurrent.Future describeEndpointAsync(DescribeEndpointRequest describeEndpointRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Gets the properties associated with an entities detection job. Use this operation to get the status of a
* detection job.
*
*
* @param describeEntitiesDetectionJobRequest
* @return A Java Future containing the result of the DescribeEntitiesDetectionJob operation returned by the
* service.
* @sample AmazonComprehendAsync.DescribeEntitiesDetectionJob
* @see AWS API Documentation
*/
java.util.concurrent.Future describeEntitiesDetectionJobAsync(
DescribeEntitiesDetectionJobRequest describeEntitiesDetectionJobRequest);
/**
*
* Gets the properties associated with an entities detection job. Use this operation to get the status of a
* detection job.
*
*
* @param describeEntitiesDetectionJobRequest
* @param 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.
* @return A Java Future containing the result of the DescribeEntitiesDetectionJob operation returned by the
* service.
* @sample AmazonComprehendAsyncHandler.DescribeEntitiesDetectionJob
* @see AWS API Documentation
*/
java.util.concurrent.Future describeEntitiesDetectionJobAsync(
DescribeEntitiesDetectionJobRequest describeEntitiesDetectionJobRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer
* metadata, metrics, and so on.
*
*
* @param describeEntityRecognizerRequest
* @return A Java Future containing the result of the DescribeEntityRecognizer operation returned by the service.
* @sample AmazonComprehendAsync.DescribeEntityRecognizer
* @see AWS API Documentation
*/
java.util.concurrent.Future describeEntityRecognizerAsync(DescribeEntityRecognizerRequest describeEntityRecognizerRequest);
/**
*
* Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer
* metadata, metrics, and so on.
*
*
* @param describeEntityRecognizerRequest
* @param 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.
* @return A Java Future containing the result of the DescribeEntityRecognizer operation returned by the service.
* @sample AmazonComprehendAsyncHandler.DescribeEntityRecognizer
* @see AWS API Documentation
*/
java.util.concurrent.Future describeEntityRecognizerAsync(DescribeEntityRecognizerRequest describeEntityRecognizerRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Gets the status and details of an events detection job.
*
*
* @param describeEventsDetectionJobRequest
* @return A Java Future containing the result of the DescribeEventsDetectionJob operation returned by the service.
* @sample AmazonComprehendAsync.DescribeEventsDetectionJob
* @see AWS API Documentation
*/
java.util.concurrent.Future describeEventsDetectionJobAsync(
DescribeEventsDetectionJobRequest describeEventsDetectionJobRequest);
/**
*
* Gets the status and details of an events detection job.
*
*
* @param describeEventsDetectionJobRequest
* @param 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.
* @return A Java Future containing the result of the DescribeEventsDetectionJob operation returned by the service.
* @sample AmazonComprehendAsyncHandler.DescribeEventsDetectionJob
* @see AWS API Documentation
*/
java.util.concurrent.Future describeEventsDetectionJobAsync(
DescribeEventsDetectionJobRequest describeEventsDetectionJobRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Provides configuration information about the flywheel. For more information about flywheels, see Flywheel overview in the
* Amazon Comprehend Developer Guide.
*
*
* @param describeFlywheelRequest
* @return A Java Future containing the result of the DescribeFlywheel operation returned by the service.
* @sample AmazonComprehendAsync.DescribeFlywheel
* @see AWS
* API Documentation
*/
java.util.concurrent.Future describeFlywheelAsync(DescribeFlywheelRequest describeFlywheelRequest);
/**
*
* Provides configuration information about the flywheel. For more information about flywheels, see Flywheel overview in the
* Amazon Comprehend Developer Guide.
*
*
* @param describeFlywheelRequest
* @param 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.
* @return A Java Future containing the result of the DescribeFlywheel operation returned by the service.
* @sample AmazonComprehendAsyncHandler.DescribeFlywheel
* @see AWS
* API Documentation
*/
java.util.concurrent.Future describeFlywheelAsync(DescribeFlywheelRequest describeFlywheelRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieve the configuration properties of a flywheel iteration. For more information about flywheels, see Flywheel overview in the
* Amazon Comprehend Developer Guide.
*
*
* @param describeFlywheelIterationRequest
* @return A Java Future containing the result of the DescribeFlywheelIteration operation returned by the service.
* @sample AmazonComprehendAsync.DescribeFlywheelIteration
* @see AWS API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param describeFlywheelIterationRequest
* @param 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.
* @return A Java Future containing the result of the DescribeFlywheelIteration operation returned by the service.
* @sample AmazonComprehendAsyncHandler.DescribeFlywheelIteration
* @see AWS API Documentation
*/
java.util.concurrent.Future describeFlywheelIterationAsync(
DescribeFlywheelIterationRequest describeFlywheelIterationRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Gets the properties associated with a key phrases detection job. Use this operation to get the status of a
* detection job.
*
*
* @param describeKeyPhrasesDetectionJobRequest
* @return A Java Future containing the result of the DescribeKeyPhrasesDetectionJob operation returned by the
* service.
* @sample AmazonComprehendAsync.DescribeKeyPhrasesDetectionJob
* @see AWS API Documentation
*/
java.util.concurrent.Future describeKeyPhrasesDetectionJobAsync(
DescribeKeyPhrasesDetectionJobRequest describeKeyPhrasesDetectionJobRequest);
/**
*
* Gets the properties associated with a key phrases detection job. Use this operation to get the status of a
* detection job.
*
*
* @param describeKeyPhrasesDetectionJobRequest
* @param 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.
* @return A Java Future containing the result of the DescribeKeyPhrasesDetectionJob operation returned by the
* service.
* @sample AmazonComprehendAsyncHandler.DescribeKeyPhrasesDetectionJob
* @see AWS API Documentation
*/
java.util.concurrent.Future describeKeyPhrasesDetectionJobAsync(
DescribeKeyPhrasesDetectionJobRequest describeKeyPhrasesDetectionJobRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Gets the properties associated with a PII entities detection job. For example, you can use this operation to get
* the job status.
*
*
* @param describePiiEntitiesDetectionJobRequest
* @return A Java Future containing the result of the DescribePiiEntitiesDetectionJob operation returned by the
* service.
* @sample AmazonComprehendAsync.DescribePiiEntitiesDetectionJob
* @see AWS API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param describePiiEntitiesDetectionJobRequest
* @param 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.
* @return A Java Future containing the result of the DescribePiiEntitiesDetectionJob operation returned by the
* service.
* @sample AmazonComprehendAsyncHandler.DescribePiiEntitiesDetectionJob
* @see AWS API Documentation
*/
java.util.concurrent.Future describePiiEntitiesDetectionJobAsync(
DescribePiiEntitiesDetectionJobRequest describePiiEntitiesDetectionJobRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Gets the details of a resource-based policy that is attached to a custom model, including the JSON body of the
* policy.
*
*
* @param describeResourcePolicyRequest
* @return A Java Future containing the result of the DescribeResourcePolicy operation returned by the service.
* @sample AmazonComprehendAsync.DescribeResourcePolicy
* @see AWS API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param describeResourcePolicyRequest
* @param 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.
* @return A Java Future containing the result of the DescribeResourcePolicy operation returned by the service.
* @sample AmazonComprehendAsyncHandler.DescribeResourcePolicy
* @see AWS API Documentation
*/
java.util.concurrent.Future describeResourcePolicyAsync(DescribeResourcePolicyRequest describeResourcePolicyRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Gets the properties associated with a sentiment detection job. Use this operation to get the status of a
* detection job.
*
*
* @param describeSentimentDetectionJobRequest
* @return A Java Future containing the result of the DescribeSentimentDetectionJob operation returned by the
* service.
* @sample AmazonComprehendAsync.DescribeSentimentDetectionJob
* @see AWS API Documentation
*/
java.util.concurrent.Future describeSentimentDetectionJobAsync(
DescribeSentimentDetectionJobRequest describeSentimentDetectionJobRequest);
/**
*
* Gets the properties associated with a sentiment detection job. Use this operation to get the status of a
* detection job.
*
*
* @param describeSentimentDetectionJobRequest
* @param 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.
* @return A Java Future containing the result of the DescribeSentimentDetectionJob operation returned by the
* service.
* @sample AmazonComprehendAsyncHandler.DescribeSentimentDetectionJob
* @see AWS API Documentation
*/
java.util.concurrent.Future describeSentimentDetectionJobAsync(
DescribeSentimentDetectionJobRequest describeSentimentDetectionJobRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Gets the properties associated with a targeted sentiment detection job. Use this operation to get the status of
* the job.
*
*
* @param describeTargetedSentimentDetectionJobRequest
* @return A Java Future containing the result of the DescribeTargetedSentimentDetectionJob operation returned by
* the service.
* @sample AmazonComprehendAsync.DescribeTargetedSentimentDetectionJob
* @see AWS API Documentation
*/
java.util.concurrent.Future describeTargetedSentimentDetectionJobAsync(
DescribeTargetedSentimentDetectionJobRequest describeTargetedSentimentDetectionJobRequest);
/**
*
* Gets the properties associated with a targeted sentiment detection job. Use this operation to get the status of
* the job.
*
*
* @param describeTargetedSentimentDetectionJobRequest
* @param 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.
* @return A Java Future containing the result of the DescribeTargetedSentimentDetectionJob operation returned by
* the service.
* @sample AmazonComprehendAsyncHandler.DescribeTargetedSentimentDetectionJob
* @see AWS API Documentation
*/
java.util.concurrent.Future describeTargetedSentimentDetectionJobAsync(
DescribeTargetedSentimentDetectionJobRequest describeTargetedSentimentDetectionJobRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Gets the properties associated with a topic detection job. Use this operation to get the status of a detection
* job.
*
*
* @param describeTopicsDetectionJobRequest
* @return A Java Future containing the result of the DescribeTopicsDetectionJob operation returned by the service.
* @sample AmazonComprehendAsync.DescribeTopicsDetectionJob
* @see AWS API Documentation
*/
java.util.concurrent.Future describeTopicsDetectionJobAsync(
DescribeTopicsDetectionJobRequest describeTopicsDetectionJobRequest);
/**
*
* Gets the properties associated with a topic detection job. Use this operation to get the status of a detection
* job.
*
*
* @param describeTopicsDetectionJobRequest
* @param 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.
* @return A Java Future containing the result of the DescribeTopicsDetectionJob operation returned by the service.
* @sample AmazonComprehendAsyncHandler.DescribeTopicsDetectionJob
* @see AWS API Documentation
*/
java.util.concurrent.Future describeTopicsDetectionJobAsync(
DescribeTopicsDetectionJobRequest describeTopicsDetectionJobRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect,
* see Amazon Comprehend Supported
* Languages.
*
*
* @param detectDominantLanguageRequest
* @return A Java Future containing the result of the DetectDominantLanguage operation returned by the service.
* @sample AmazonComprehendAsync.DetectDominantLanguage
* @see AWS API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param detectDominantLanguageRequest
* @param 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.
* @return A Java Future containing the result of the DetectDominantLanguage operation returned by the service.
* @sample AmazonComprehendAsyncHandler.DetectDominantLanguage
* @see AWS API Documentation
*/
java.util.concurrent.Future detectDominantLanguageAsync(DetectDominantLanguageRequest detectDominantLanguageRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param detectEntitiesRequest
* @return A Java Future containing the result of the DetectEntities operation returned by the service.
* @sample AmazonComprehendAsync.DetectEntities
* @see AWS API
* Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param detectEntitiesRequest
* @param 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.
* @return A Java Future containing the result of the DetectEntities operation returned by the service.
* @sample AmazonComprehendAsyncHandler.DetectEntities
* @see AWS API
* Documentation
*/
java.util.concurrent.Future detectEntitiesAsync(DetectEntitiesRequest detectEntitiesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Detects the key noun phrases found in the text.
*
*
* @param detectKeyPhrasesRequest
* @return A Java Future containing the result of the DetectKeyPhrases operation returned by the service.
* @sample AmazonComprehendAsync.DetectKeyPhrases
* @see AWS
* API Documentation
*/
java.util.concurrent.Future detectKeyPhrasesAsync(DetectKeyPhrasesRequest detectKeyPhrasesRequest);
/**
*
* Detects the key noun phrases found in the text.
*
*
* @param detectKeyPhrasesRequest
* @param 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.
* @return A Java Future containing the result of the DetectKeyPhrases operation returned by the service.
* @sample AmazonComprehendAsyncHandler.DetectKeyPhrases
* @see AWS
* API Documentation
*/
java.util.concurrent.Future detectKeyPhrasesAsync(DetectKeyPhrasesRequest detectKeyPhrasesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Inspects the input text for entities that contain personally identifiable information (PII) and returns
* information about them.
*
*
* @param detectPiiEntitiesRequest
* @return A Java Future containing the result of the DetectPiiEntities operation returned by the service.
* @sample AmazonComprehendAsync.DetectPiiEntities
* @see AWS
* API Documentation
*/
java.util.concurrent.Future detectPiiEntitiesAsync(DetectPiiEntitiesRequest detectPiiEntitiesRequest);
/**
*
* Inspects the input text for entities that contain personally identifiable information (PII) and returns
* information about them.
*
*
* @param detectPiiEntitiesRequest
* @param 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.
* @return A Java Future containing the result of the DetectPiiEntities operation returned by the service.
* @sample AmazonComprehendAsyncHandler.DetectPiiEntities
* @see AWS
* API Documentation
*/
java.util.concurrent.Future detectPiiEntitiesAsync(DetectPiiEntitiesRequest detectPiiEntitiesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Inspects text and returns an inference of the prevailing sentiment (POSITIVE, NEUTRAL,
* MIXED, or NEGATIVE).
*
*
* @param detectSentimentRequest
* @return A Java Future containing the result of the DetectSentiment operation returned by the service.
* @sample AmazonComprehendAsync.DetectSentiment
* @see AWS API
* Documentation
*/
java.util.concurrent.Future detectSentimentAsync(DetectSentimentRequest detectSentimentRequest);
/**
*
* Inspects text and returns an inference of the prevailing sentiment (POSITIVE, NEUTRAL,
* MIXED, or NEGATIVE).
*
*
* @param detectSentimentRequest
* @param 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.
* @return A Java Future containing the result of the DetectSentiment operation returned by the service.
* @sample AmazonComprehendAsyncHandler.DetectSentiment
* @see AWS API
* Documentation
*/
java.util.concurrent.Future detectSentimentAsync(DetectSentimentRequest detectSentimentRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param detectSyntaxRequest
* @return A Java Future containing the result of the DetectSyntax operation returned by the service.
* @sample AmazonComprehendAsync.DetectSyntax
* @see AWS API
* Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param detectSyntaxRequest
* @param 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.
* @return A Java Future containing the result of the DetectSyntax operation returned by the service.
* @sample AmazonComprehendAsyncHandler.DetectSyntax
* @see AWS API
* Documentation
*/
java.util.concurrent.Future detectSyntaxAsync(DetectSyntaxRequest detectSyntaxRequest,
com.amazonaws.handlers.AsyncHandler 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 in the
* Amazon Comprehend Developer Guide.
*
*
* @param detectTargetedSentimentRequest
* @return A Java Future containing the result of the DetectTargetedSentiment operation returned by the service.
* @sample AmazonComprehendAsync.DetectTargetedSentiment
* @see AWS API Documentation
*/
java.util.concurrent.Future 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 in the
* Amazon Comprehend Developer Guide.
*
*
* @param detectTargetedSentimentRequest
* @param 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.
* @return A Java Future containing the result of the DetectTargetedSentiment operation returned by the service.
* @sample AmazonComprehendAsyncHandler.DetectTargetedSentiment
* @see AWS API Documentation
*/
java.util.concurrent.Future detectTargetedSentimentAsync(DetectTargetedSentimentRequest detectTargetedSentimentRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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
*
*
* @param detectToxicContentRequest
* @return A Java Future containing the result of the DetectToxicContent operation returned by the service.
* @sample AmazonComprehendAsync.DetectToxicContent
* @see AWS
* API Documentation
*/
java.util.concurrent.Future detectToxicContentAsync(DetectToxicContentRequest detectToxicContentRequest);
/**
*
* 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
*
*
* @param detectToxicContentRequest
* @param 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.
* @return A Java Future containing the result of the DetectToxicContent operation returned by the service.
* @sample AmazonComprehendAsyncHandler.DetectToxicContent
* @see AWS
* API Documentation
*/
java.util.concurrent.Future detectToxicContentAsync(DetectToxicContentRequest detectToxicContentRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param importModelRequest
* @return A Java Future containing the result of the ImportModel operation returned by the service.
* @sample AmazonComprehendAsync.ImportModel
* @see AWS API
* Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param importModelRequest
* @param 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.
* @return A Java Future containing the result of the ImportModel operation returned by the service.
* @sample AmazonComprehendAsyncHandler.ImportModel
* @see AWS API
* Documentation
*/
java.util.concurrent.Future importModelAsync(ImportModelRequest importModelRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param listDatasetsRequest
* @return A Java Future containing the result of the ListDatasets operation returned by the service.
* @sample AmazonComprehendAsync.ListDatasets
* @see AWS API
* Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param listDatasetsRequest
* @param 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.
* @return A Java Future containing the result of the ListDatasets operation returned by the service.
* @sample AmazonComprehendAsyncHandler.ListDatasets
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listDatasetsAsync(ListDatasetsRequest listDatasetsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Gets a list of the documentation classification jobs that you have submitted.
*
*
* @param listDocumentClassificationJobsRequest
* @return A Java Future containing the result of the ListDocumentClassificationJobs operation returned by the
* service.
* @sample AmazonComprehendAsync.ListDocumentClassificationJobs
* @see AWS API Documentation
*/
java.util.concurrent.Future listDocumentClassificationJobsAsync(
ListDocumentClassificationJobsRequest listDocumentClassificationJobsRequest);
/**
*
* Gets a list of the documentation classification jobs that you have submitted.
*
*
* @param listDocumentClassificationJobsRequest
* @param 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.
* @return A Java Future containing the result of the ListDocumentClassificationJobs operation returned by the
* service.
* @sample AmazonComprehendAsyncHandler.ListDocumentClassificationJobs
* @see AWS API Documentation
*/
java.util.concurrent.Future listDocumentClassificationJobsAsync(
ListDocumentClassificationJobsRequest listDocumentClassificationJobsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Gets a list of summaries of the document classifiers that you have created
*
*
* @param listDocumentClassifierSummariesRequest
* @return A Java Future containing the result of the ListDocumentClassifierSummaries operation returned by the
* service.
* @sample AmazonComprehendAsync.ListDocumentClassifierSummaries
* @see AWS API Documentation
*/
java.util.concurrent.Future listDocumentClassifierSummariesAsync(
ListDocumentClassifierSummariesRequest listDocumentClassifierSummariesRequest);
/**
*
* Gets a list of summaries of the document classifiers that you have created
*
*
* @param listDocumentClassifierSummariesRequest
* @param 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.
* @return A Java Future containing the result of the ListDocumentClassifierSummaries operation returned by the
* service.
* @sample AmazonComprehendAsyncHandler.ListDocumentClassifierSummaries
* @see AWS API Documentation
*/
java.util.concurrent.Future listDocumentClassifierSummariesAsync(
ListDocumentClassifierSummariesRequest listDocumentClassifierSummariesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Gets a list of the document classifiers that you have created.
*
*
* @param listDocumentClassifiersRequest
* @return A Java Future containing the result of the ListDocumentClassifiers operation returned by the service.
* @sample AmazonComprehendAsync.ListDocumentClassifiers
* @see AWS API Documentation
*/
java.util.concurrent.Future listDocumentClassifiersAsync(ListDocumentClassifiersRequest listDocumentClassifiersRequest);
/**
*
* Gets a list of the document classifiers that you have created.
*
*
* @param listDocumentClassifiersRequest
* @param 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.
* @return A Java Future containing the result of the ListDocumentClassifiers operation returned by the service.
* @sample AmazonComprehendAsyncHandler.ListDocumentClassifiers
* @see AWS API Documentation
*/
java.util.concurrent.Future listDocumentClassifiersAsync(ListDocumentClassifiersRequest listDocumentClassifiersRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Gets a list of the dominant language detection jobs that you have submitted.
*
*
* @param listDominantLanguageDetectionJobsRequest
* @return A Java Future containing the result of the ListDominantLanguageDetectionJobs operation returned by the
* service.
* @sample AmazonComprehendAsync.ListDominantLanguageDetectionJobs
* @see AWS API Documentation
*/
java.util.concurrent.Future listDominantLanguageDetectionJobsAsync(
ListDominantLanguageDetectionJobsRequest listDominantLanguageDetectionJobsRequest);
/**
*
* Gets a list of the dominant language detection jobs that you have submitted.
*
*
* @param listDominantLanguageDetectionJobsRequest
* @param 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.
* @return A Java Future containing the result of the ListDominantLanguageDetectionJobs operation returned by the
* service.
* @sample AmazonComprehendAsyncHandler.ListDominantLanguageDetectionJobs
* @see AWS API Documentation
*/
java.util.concurrent.Future listDominantLanguageDetectionJobsAsync(
ListDominantLanguageDetectionJobsRequest listDominantLanguageDetectionJobsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Gets a list of all existing endpoints that you've created. For information about endpoints, see Managing endpoints.
*
*
* @param listEndpointsRequest
* @return A Java Future containing the result of the ListEndpoints operation returned by the service.
* @sample AmazonComprehendAsync.ListEndpoints
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listEndpointsAsync(ListEndpointsRequest listEndpointsRequest);
/**
*
* Gets a list of all existing endpoints that you've created. For information about endpoints, see Managing endpoints.
*
*
* @param listEndpointsRequest
* @param 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.
* @return A Java Future containing the result of the ListEndpoints operation returned by the service.
* @sample AmazonComprehendAsyncHandler.ListEndpoints
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listEndpointsAsync(ListEndpointsRequest listEndpointsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Gets a list of the entity detection jobs that you have submitted.
*
*
* @param listEntitiesDetectionJobsRequest
* @return A Java Future containing the result of the ListEntitiesDetectionJobs operation returned by the service.
* @sample AmazonComprehendAsync.ListEntitiesDetectionJobs
* @see AWS API Documentation
*/
java.util.concurrent.Future listEntitiesDetectionJobsAsync(
ListEntitiesDetectionJobsRequest listEntitiesDetectionJobsRequest);
/**
*
* Gets a list of the entity detection jobs that you have submitted.
*
*
* @param listEntitiesDetectionJobsRequest
* @param 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.
* @return A Java Future containing the result of the ListEntitiesDetectionJobs operation returned by the service.
* @sample AmazonComprehendAsyncHandler.ListEntitiesDetectionJobs
* @see AWS API Documentation
*/
java.util.concurrent.Future listEntitiesDetectionJobsAsync(
ListEntitiesDetectionJobsRequest listEntitiesDetectionJobsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Gets a list of summaries for the entity recognizers that you have created.
*
*
* @param listEntityRecognizerSummariesRequest
* @return A Java Future containing the result of the ListEntityRecognizerSummaries operation returned by the
* service.
* @sample AmazonComprehendAsync.ListEntityRecognizerSummaries
* @see AWS API Documentation
*/
java.util.concurrent.Future listEntityRecognizerSummariesAsync(
ListEntityRecognizerSummariesRequest listEntityRecognizerSummariesRequest);
/**
*
* Gets a list of summaries for the entity recognizers that you have created.
*
*
* @param listEntityRecognizerSummariesRequest
* @param 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.
* @return A Java Future containing the result of the ListEntityRecognizerSummaries operation returned by the
* service.
* @sample AmazonComprehendAsyncHandler.ListEntityRecognizerSummaries
* @see AWS API Documentation
*/
java.util.concurrent.Future listEntityRecognizerSummariesAsync(
ListEntityRecognizerSummariesRequest listEntityRecognizerSummariesRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param listEntityRecognizersRequest
* @return A Java Future containing the result of the ListEntityRecognizers operation returned by the service.
* @sample AmazonComprehendAsync.ListEntityRecognizers
* @see AWS API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param listEntityRecognizersRequest
* @param 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.
* @return A Java Future containing the result of the ListEntityRecognizers operation returned by the service.
* @sample AmazonComprehendAsyncHandler.ListEntityRecognizers
* @see AWS API Documentation
*/
java.util.concurrent.Future listEntityRecognizersAsync(ListEntityRecognizersRequest listEntityRecognizersRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Gets a list of the events detection jobs that you have submitted.
*
*
* @param listEventsDetectionJobsRequest
* @return A Java Future containing the result of the ListEventsDetectionJobs operation returned by the service.
* @sample AmazonComprehendAsync.ListEventsDetectionJobs
* @see AWS API Documentation
*/
java.util.concurrent.Future listEventsDetectionJobsAsync(ListEventsDetectionJobsRequest listEventsDetectionJobsRequest);
/**
*
* Gets a list of the events detection jobs that you have submitted.
*
*
* @param listEventsDetectionJobsRequest
* @param 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.
* @return A Java Future containing the result of the ListEventsDetectionJobs operation returned by the service.
* @sample AmazonComprehendAsyncHandler.ListEventsDetectionJobs
* @see AWS API Documentation
*/
java.util.concurrent.Future listEventsDetectionJobsAsync(ListEventsDetectionJobsRequest listEventsDetectionJobsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Information about the history of a flywheel iteration. For more information about flywheels, see Flywheel overview in the
* Amazon Comprehend Developer Guide.
*
*
* @param listFlywheelIterationHistoryRequest
* @return A Java Future containing the result of the ListFlywheelIterationHistory operation returned by the
* service.
* @sample AmazonComprehendAsync.ListFlywheelIterationHistory
* @see AWS API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param listFlywheelIterationHistoryRequest
* @param 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.
* @return A Java Future containing the result of the ListFlywheelIterationHistory operation returned by the
* service.
* @sample AmazonComprehendAsyncHandler.ListFlywheelIterationHistory
* @see AWS API Documentation
*/
java.util.concurrent.Future listFlywheelIterationHistoryAsync(
ListFlywheelIterationHistoryRequest listFlywheelIterationHistoryRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Gets a list of the flywheels that you have created.
*
*
* @param listFlywheelsRequest
* @return A Java Future containing the result of the ListFlywheels operation returned by the service.
* @sample AmazonComprehendAsync.ListFlywheels
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listFlywheelsAsync(ListFlywheelsRequest listFlywheelsRequest);
/**
*
* Gets a list of the flywheels that you have created.
*
*
* @param listFlywheelsRequest
* @param 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.
* @return A Java Future containing the result of the ListFlywheels operation returned by the service.
* @sample AmazonComprehendAsyncHandler.ListFlywheels
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listFlywheelsAsync(ListFlywheelsRequest listFlywheelsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Get a list of key phrase detection jobs that you have submitted.
*
*
* @param listKeyPhrasesDetectionJobsRequest
* @return A Java Future containing the result of the ListKeyPhrasesDetectionJobs operation returned by the service.
* @sample AmazonComprehendAsync.ListKeyPhrasesDetectionJobs
* @see AWS API Documentation
*/
java.util.concurrent.Future listKeyPhrasesDetectionJobsAsync(
ListKeyPhrasesDetectionJobsRequest listKeyPhrasesDetectionJobsRequest);
/**
*
* Get a list of key phrase detection jobs that you have submitted.
*
*
* @param listKeyPhrasesDetectionJobsRequest
* @param 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.
* @return A Java Future containing the result of the ListKeyPhrasesDetectionJobs operation returned by the service.
* @sample AmazonComprehendAsyncHandler.ListKeyPhrasesDetectionJobs
* @see AWS API Documentation
*/
java.util.concurrent.Future listKeyPhrasesDetectionJobsAsync(
ListKeyPhrasesDetectionJobsRequest listKeyPhrasesDetectionJobsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Gets a list of the PII entity detection jobs that you have submitted.
*
*
* @param listPiiEntitiesDetectionJobsRequest
* @return A Java Future containing the result of the ListPiiEntitiesDetectionJobs operation returned by the
* service.
* @sample AmazonComprehendAsync.ListPiiEntitiesDetectionJobs
* @see AWS API Documentation
*/
java.util.concurrent.Future listPiiEntitiesDetectionJobsAsync(
ListPiiEntitiesDetectionJobsRequest listPiiEntitiesDetectionJobsRequest);
/**
*
* Gets a list of the PII entity detection jobs that you have submitted.
*
*
* @param listPiiEntitiesDetectionJobsRequest
* @param 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.
* @return A Java Future containing the result of the ListPiiEntitiesDetectionJobs operation returned by the
* service.
* @sample AmazonComprehendAsyncHandler.ListPiiEntitiesDetectionJobs
* @see AWS API Documentation
*/
java.util.concurrent.Future listPiiEntitiesDetectionJobsAsync(
ListPiiEntitiesDetectionJobsRequest listPiiEntitiesDetectionJobsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Gets a list of sentiment detection jobs that you have submitted.
*
*
* @param listSentimentDetectionJobsRequest
* @return A Java Future containing the result of the ListSentimentDetectionJobs operation returned by the service.
* @sample AmazonComprehendAsync.ListSentimentDetectionJobs
* @see AWS API Documentation
*/
java.util.concurrent.Future listSentimentDetectionJobsAsync(
ListSentimentDetectionJobsRequest listSentimentDetectionJobsRequest);
/**
*
* Gets a list of sentiment detection jobs that you have submitted.
*
*
* @param listSentimentDetectionJobsRequest
* @param 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.
* @return A Java Future containing the result of the ListSentimentDetectionJobs operation returned by the service.
* @sample AmazonComprehendAsyncHandler.ListSentimentDetectionJobs
* @see AWS API Documentation
*/
java.util.concurrent.Future listSentimentDetectionJobsAsync(
ListSentimentDetectionJobsRequest listSentimentDetectionJobsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists all tags associated with a given Amazon Comprehend resource.
*
*
* @param listTagsForResourceRequest
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* @sample AmazonComprehendAsync.ListTagsForResource
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Lists all tags associated with a given Amazon Comprehend resource.
*
*
* @param listTagsForResourceRequest
* @param 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.
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* @sample AmazonComprehendAsyncHandler.ListTagsForResource
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Gets a list of targeted sentiment detection jobs that you have submitted.
*
*
* @param listTargetedSentimentDetectionJobsRequest
* @return A Java Future containing the result of the ListTargetedSentimentDetectionJobs operation returned by the
* service.
* @sample AmazonComprehendAsync.ListTargetedSentimentDetectionJobs
* @see AWS API Documentation
*/
java.util.concurrent.Future listTargetedSentimentDetectionJobsAsync(
ListTargetedSentimentDetectionJobsRequest listTargetedSentimentDetectionJobsRequest);
/**
*
* Gets a list of targeted sentiment detection jobs that you have submitted.
*
*
* @param listTargetedSentimentDetectionJobsRequest
* @param 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.
* @return A Java Future containing the result of the ListTargetedSentimentDetectionJobs operation returned by the
* service.
* @sample AmazonComprehendAsyncHandler.ListTargetedSentimentDetectionJobs
* @see AWS API Documentation
*/
java.util.concurrent.Future listTargetedSentimentDetectionJobsAsync(
ListTargetedSentimentDetectionJobsRequest listTargetedSentimentDetectionJobsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Gets a list of the topic detection jobs that you have submitted.
*
*
* @param listTopicsDetectionJobsRequest
* @return A Java Future containing the result of the ListTopicsDetectionJobs operation returned by the service.
* @sample AmazonComprehendAsync.ListTopicsDetectionJobs
* @see AWS API Documentation
*/
java.util.concurrent.Future listTopicsDetectionJobsAsync(ListTopicsDetectionJobsRequest listTopicsDetectionJobsRequest);
/**
*
* Gets a list of the topic detection jobs that you have submitted.
*
*
* @param listTopicsDetectionJobsRequest
* @param 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.
* @return A Java Future containing the result of the ListTopicsDetectionJobs operation returned by the service.
* @sample AmazonComprehendAsyncHandler.ListTopicsDetectionJobs
* @see AWS API Documentation
*/
java.util.concurrent.Future listTopicsDetectionJobsAsync(ListTopicsDetectionJobsRequest listTopicsDetectionJobsRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param putResourcePolicyRequest
* @return A Java Future containing the result of the PutResourcePolicy operation returned by the service.
* @sample AmazonComprehendAsync.PutResourcePolicy
* @see AWS
* API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param putResourcePolicyRequest
* @param 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.
* @return A Java Future containing the result of the PutResourcePolicy operation returned by the service.
* @sample AmazonComprehendAsyncHandler.PutResourcePolicy
* @see AWS
* API Documentation
*/
java.util.concurrent.Future putResourcePolicyAsync(PutResourcePolicyRequest putResourcePolicyRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Starts an asynchronous document classification job. Use the DescribeDocumentClassificationJob
* operation to track the progress of the job.
*
*
* @param startDocumentClassificationJobRequest
* @return A Java Future containing the result of the StartDocumentClassificationJob operation returned by the
* service.
* @sample AmazonComprehendAsync.StartDocumentClassificationJob
* @see AWS API Documentation
*/
java.util.concurrent.Future startDocumentClassificationJobAsync(
StartDocumentClassificationJobRequest startDocumentClassificationJobRequest);
/**
*
* Starts an asynchronous document classification job. Use the DescribeDocumentClassificationJob
* operation to track the progress of the job.
*
*
* @param startDocumentClassificationJobRequest
* @param 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.
* @return A Java Future containing the result of the StartDocumentClassificationJob operation returned by the
* service.
* @sample AmazonComprehendAsyncHandler.StartDocumentClassificationJob
* @see AWS API Documentation
*/
java.util.concurrent.Future startDocumentClassificationJobAsync(
StartDocumentClassificationJobRequest startDocumentClassificationJobRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Starts an asynchronous dominant language detection job for a collection of documents. Use the operation to track
* the status of a job.
*
*
* @param startDominantLanguageDetectionJobRequest
* @return A Java Future containing the result of the StartDominantLanguageDetectionJob operation returned by the
* service.
* @sample AmazonComprehendAsync.StartDominantLanguageDetectionJob
* @see AWS API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param startDominantLanguageDetectionJobRequest
* @param 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.
* @return A Java Future containing the result of the StartDominantLanguageDetectionJob operation returned by the
* service.
* @sample AmazonComprehendAsyncHandler.StartDominantLanguageDetectionJob
* @see AWS API Documentation
*/
java.util.concurrent.Future startDominantLanguageDetectionJobAsync(
StartDominantLanguageDetectionJobRequest startDominantLanguageDetectionJobRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param startEntitiesDetectionJobRequest
* @return A Java Future containing the result of the StartEntitiesDetectionJob operation returned by the service.
* @sample AmazonComprehendAsync.StartEntitiesDetectionJob
* @see AWS API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param startEntitiesDetectionJobRequest
* @param 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.
* @return A Java Future containing the result of the StartEntitiesDetectionJob operation returned by the service.
* @sample AmazonComprehendAsyncHandler.StartEntitiesDetectionJob
* @see AWS API Documentation
*/
java.util.concurrent.Future startEntitiesDetectionJobAsync(
StartEntitiesDetectionJobRequest startEntitiesDetectionJobRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Starts an asynchronous event detection job for a collection of documents.
*
*
* @param startEventsDetectionJobRequest
* @return A Java Future containing the result of the StartEventsDetectionJob operation returned by the service.
* @sample AmazonComprehendAsync.StartEventsDetectionJob
* @see AWS API Documentation
*/
java.util.concurrent.Future startEventsDetectionJobAsync(StartEventsDetectionJobRequest startEventsDetectionJobRequest);
/**
*
* Starts an asynchronous event detection job for a collection of documents.
*
*
* @param startEventsDetectionJobRequest
* @param 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.
* @return A Java Future containing the result of the StartEventsDetectionJob operation returned by the service.
* @sample AmazonComprehendAsyncHandler.StartEventsDetectionJob
* @see AWS API Documentation
*/
java.util.concurrent.Future startEventsDetectionJobAsync(StartEventsDetectionJobRequest startEventsDetectionJobRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param startFlywheelIterationRequest
* @return A Java Future containing the result of the StartFlywheelIteration operation returned by the service.
* @sample AmazonComprehendAsync.StartFlywheelIteration
* @see AWS API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param startFlywheelIterationRequest
* @param 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.
* @return A Java Future containing the result of the StartFlywheelIteration operation returned by the service.
* @sample AmazonComprehendAsyncHandler.StartFlywheelIteration
* @see AWS API Documentation
*/
java.util.concurrent.Future startFlywheelIterationAsync(StartFlywheelIterationRequest startFlywheelIterationRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Starts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the
* status of a job.
*
*
* @param startKeyPhrasesDetectionJobRequest
* @return A Java Future containing the result of the StartKeyPhrasesDetectionJob operation returned by the service.
* @sample AmazonComprehendAsync.StartKeyPhrasesDetectionJob
* @see AWS API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param startKeyPhrasesDetectionJobRequest
* @param 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.
* @return A Java Future containing the result of the StartKeyPhrasesDetectionJob operation returned by the service.
* @sample AmazonComprehendAsyncHandler.StartKeyPhrasesDetectionJob
* @see AWS API Documentation
*/
java.util.concurrent.Future startKeyPhrasesDetectionJobAsync(
StartKeyPhrasesDetectionJobRequest startKeyPhrasesDetectionJobRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Starts an asynchronous PII entity detection job for a collection of documents.
*
*
* @param startPiiEntitiesDetectionJobRequest
* @return A Java Future containing the result of the StartPiiEntitiesDetectionJob operation returned by the
* service.
* @sample AmazonComprehendAsync.StartPiiEntitiesDetectionJob
* @see AWS API Documentation
*/
java.util.concurrent.Future startPiiEntitiesDetectionJobAsync(
StartPiiEntitiesDetectionJobRequest startPiiEntitiesDetectionJobRequest);
/**
*
* Starts an asynchronous PII entity detection job for a collection of documents.
*
*
* @param startPiiEntitiesDetectionJobRequest
* @param 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.
* @return A Java Future containing the result of the StartPiiEntitiesDetectionJob operation returned by the
* service.
* @sample AmazonComprehendAsyncHandler.StartPiiEntitiesDetectionJob
* @see AWS API Documentation
*/
java.util.concurrent.Future startPiiEntitiesDetectionJobAsync(
StartPiiEntitiesDetectionJobRequest startPiiEntitiesDetectionJobRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Starts an asynchronous sentiment detection job for a collection of documents. Use the operation to track the
* status of a job.
*
*
* @param startSentimentDetectionJobRequest
* @return A Java Future containing the result of the StartSentimentDetectionJob operation returned by the service.
* @sample AmazonComprehendAsync.StartSentimentDetectionJob
* @see AWS API Documentation
*/
java.util.concurrent.Future startSentimentDetectionJobAsync(
StartSentimentDetectionJobRequest startSentimentDetectionJobRequest);
/**
*
* Starts an asynchronous sentiment detection job for a collection of documents. Use the operation to track the
* status of a job.
*
*
* @param startSentimentDetectionJobRequest
* @param 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.
* @return A Java Future containing the result of the StartSentimentDetectionJob operation returned by the service.
* @sample AmazonComprehendAsyncHandler.StartSentimentDetectionJob
* @see AWS API Documentation
*/
java.util.concurrent.Future startSentimentDetectionJobAsync(
StartSentimentDetectionJobRequest startSentimentDetectionJobRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Starts an asynchronous targeted sentiment detection job for a collection of documents. Use the
* DescribeTargetedSentimentDetectionJob operation to track the status of a job.
*
*
* @param startTargetedSentimentDetectionJobRequest
* @return A Java Future containing the result of the StartTargetedSentimentDetectionJob operation returned by the
* service.
* @sample AmazonComprehendAsync.StartTargetedSentimentDetectionJob
* @see AWS API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param startTargetedSentimentDetectionJobRequest
* @param 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.
* @return A Java Future containing the result of the StartTargetedSentimentDetectionJob operation returned by the
* service.
* @sample AmazonComprehendAsyncHandler.StartTargetedSentimentDetectionJob
* @see AWS API Documentation
*/
java.util.concurrent.Future startTargetedSentimentDetectionJobAsync(
StartTargetedSentimentDetectionJobRequest startTargetedSentimentDetectionJobRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob operation to track the
* status of a job.
*
*
* @param startTopicsDetectionJobRequest
* @return A Java Future containing the result of the StartTopicsDetectionJob operation returned by the service.
* @sample AmazonComprehendAsync.StartTopicsDetectionJob
* @see AWS API Documentation
*/
java.util.concurrent.Future startTopicsDetectionJobAsync(StartTopicsDetectionJobRequest startTopicsDetectionJobRequest);
/**
*
* Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob operation to track the
* status of a job.
*
*
* @param startTopicsDetectionJobRequest
* @param 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.
* @return A Java Future containing the result of the StartTopicsDetectionJob operation returned by the service.
* @sample AmazonComprehendAsyncHandler.StartTopicsDetectionJob
* @see AWS API Documentation
*/
java.util.concurrent.Future startTopicsDetectionJobAsync(StartTopicsDetectionJobRequest startTopicsDetectionJobRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param stopDominantLanguageDetectionJobRequest
* @return A Java Future containing the result of the StopDominantLanguageDetectionJob operation returned by the
* service.
* @sample AmazonComprehendAsync.StopDominantLanguageDetectionJob
* @see AWS API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param stopDominantLanguageDetectionJobRequest
* @param 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.
* @return A Java Future containing the result of the StopDominantLanguageDetectionJob operation returned by the
* service.
* @sample AmazonComprehendAsyncHandler.StopDominantLanguageDetectionJob
* @see AWS API Documentation
*/
java.util.concurrent.Future stopDominantLanguageDetectionJobAsync(
StopDominantLanguageDetectionJobRequest stopDominantLanguageDetectionJobRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param stopEntitiesDetectionJobRequest
* @return A Java Future containing the result of the StopEntitiesDetectionJob operation returned by the service.
* @sample AmazonComprehendAsync.StopEntitiesDetectionJob
* @see AWS API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param stopEntitiesDetectionJobRequest
* @param 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.
* @return A Java Future containing the result of the StopEntitiesDetectionJob operation returned by the service.
* @sample AmazonComprehendAsyncHandler.StopEntitiesDetectionJob
* @see AWS API Documentation
*/
java.util.concurrent.Future stopEntitiesDetectionJobAsync(StopEntitiesDetectionJobRequest stopEntitiesDetectionJobRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Stops an events detection job in progress.
*
*
* @param stopEventsDetectionJobRequest
* @return A Java Future containing the result of the StopEventsDetectionJob operation returned by the service.
* @sample AmazonComprehendAsync.StopEventsDetectionJob
* @see AWS API Documentation
*/
java.util.concurrent.Future stopEventsDetectionJobAsync(StopEventsDetectionJobRequest stopEventsDetectionJobRequest);
/**
*
* Stops an events detection job in progress.
*
*
* @param stopEventsDetectionJobRequest
* @param 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.
* @return A Java Future containing the result of the StopEventsDetectionJob operation returned by the service.
* @sample AmazonComprehendAsyncHandler.StopEventsDetectionJob
* @see AWS API Documentation
*/
java.util.concurrent.Future stopEventsDetectionJobAsync(StopEventsDetectionJobRequest stopEventsDetectionJobRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param stopKeyPhrasesDetectionJobRequest
* @return A Java Future containing the result of the StopKeyPhrasesDetectionJob operation returned by the service.
* @sample AmazonComprehendAsync.StopKeyPhrasesDetectionJob
* @see AWS API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param stopKeyPhrasesDetectionJobRequest
* @param 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.
* @return A Java Future containing the result of the StopKeyPhrasesDetectionJob operation returned by the service.
* @sample AmazonComprehendAsyncHandler.StopKeyPhrasesDetectionJob
* @see AWS API Documentation
*/
java.util.concurrent.Future stopKeyPhrasesDetectionJobAsync(
StopKeyPhrasesDetectionJobRequest stopKeyPhrasesDetectionJobRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Stops a PII entities detection job in progress.
*
*
* @param stopPiiEntitiesDetectionJobRequest
* @return A Java Future containing the result of the StopPiiEntitiesDetectionJob operation returned by the service.
* @sample AmazonComprehendAsync.StopPiiEntitiesDetectionJob
* @see AWS API Documentation
*/
java.util.concurrent.Future stopPiiEntitiesDetectionJobAsync(
StopPiiEntitiesDetectionJobRequest stopPiiEntitiesDetectionJobRequest);
/**
*
* Stops a PII entities detection job in progress.
*
*
* @param stopPiiEntitiesDetectionJobRequest
* @param 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.
* @return A Java Future containing the result of the StopPiiEntitiesDetectionJob operation returned by the service.
* @sample AmazonComprehendAsyncHandler.StopPiiEntitiesDetectionJob
* @see AWS API Documentation
*/
java.util.concurrent.Future stopPiiEntitiesDetectionJobAsync(
StopPiiEntitiesDetectionJobRequest stopPiiEntitiesDetectionJobRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param stopSentimentDetectionJobRequest
* @return A Java Future containing the result of the StopSentimentDetectionJob operation returned by the service.
* @sample AmazonComprehendAsync.StopSentimentDetectionJob
* @see AWS API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param stopSentimentDetectionJobRequest
* @param 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.
* @return A Java Future containing the result of the StopSentimentDetectionJob operation returned by the service.
* @sample AmazonComprehendAsyncHandler.StopSentimentDetectionJob
* @see AWS API Documentation
*/
java.util.concurrent.Future stopSentimentDetectionJobAsync(
StopSentimentDetectionJobRequest stopSentimentDetectionJobRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param stopTargetedSentimentDetectionJobRequest
* @return A Java Future containing the result of the StopTargetedSentimentDetectionJob operation returned by the
* service.
* @sample AmazonComprehendAsync.StopTargetedSentimentDetectionJob
* @see AWS API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param stopTargetedSentimentDetectionJobRequest
* @param 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.
* @return A Java Future containing the result of the StopTargetedSentimentDetectionJob operation returned by the
* service.
* @sample AmazonComprehendAsyncHandler.StopTargetedSentimentDetectionJob
* @see AWS API Documentation
*/
java.util.concurrent.Future stopTargetedSentimentDetectionJobAsync(
StopTargetedSentimentDetectionJobRequest stopTargetedSentimentDetectionJobRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param stopTrainingDocumentClassifierRequest
* @return A Java Future containing the result of the StopTrainingDocumentClassifier operation returned by the
* service.
* @sample AmazonComprehendAsync.StopTrainingDocumentClassifier
* @see AWS API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param stopTrainingDocumentClassifierRequest
* @param 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.
* @return A Java Future containing the result of the StopTrainingDocumentClassifier operation returned by the
* service.
* @sample AmazonComprehendAsyncHandler.StopTrainingDocumentClassifier
* @see AWS API Documentation
*/
java.util.concurrent.Future stopTrainingDocumentClassifierAsync(
StopTrainingDocumentClassifierRequest stopTrainingDocumentClassifierRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param stopTrainingEntityRecognizerRequest
* @return A Java Future containing the result of the StopTrainingEntityRecognizer operation returned by the
* service.
* @sample AmazonComprehendAsync.StopTrainingEntityRecognizer
* @see AWS API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param stopTrainingEntityRecognizerRequest
* @param 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.
* @return A Java Future containing the result of the StopTrainingEntityRecognizer operation returned by the
* service.
* @sample AmazonComprehendAsyncHandler.StopTrainingEntityRecognizer
* @see AWS API Documentation
*/
java.util.concurrent.Future stopTrainingEntityRecognizerAsync(
StopTrainingEntityRecognizerRequest stopTrainingEntityRecognizerRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param tagResourceRequest
* @return A Java Future containing the result of the TagResource operation returned by the service.
* @sample AmazonComprehendAsync.TagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param tagResourceRequest
* @param 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.
* @return A Java Future containing the result of the TagResource operation returned by the service.
* @sample AmazonComprehendAsyncHandler.TagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Removes a specific tag associated with an Amazon Comprehend resource.
*
*
* @param untagResourceRequest
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* @sample AmazonComprehendAsync.UntagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest);
/**
*
* Removes a specific tag associated with an Amazon Comprehend resource.
*
*
* @param untagResourceRequest
* @param 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.
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* @sample AmazonComprehendAsyncHandler.UntagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Updates information about the specified endpoint. For information about endpoints, see