* 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. *
**/ public interface AmazonComprehend { /** * Overrides the default endpoint for this client * ("https://comprehend.us-east-1.amazonaws.com"). Callers can use this * method to control which AWS region they want to work with. ** Callers can pass in just the endpoint (ex: * "comprehend.us-east-1.amazonaws.com") or a full URL, including the * protocol (ex: "https://comprehend.us-east-1.amazonaws.com"). If the * protocol is not specified here, the default protocol from this client's * {@link ClientConfiguration} will be used, which by default is HTTPS. *
* For more information on using AWS regions with the AWS SDK for Java, and * a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= * 3912 *
* This method is not threadsafe. An endpoint should be configured when * the client is created and before any service requests are made. Changing * it afterwards creates inevitable race conditions for any service requests * in transit or retrying. * * @param endpoint The endpoint (ex: "comprehend.us-east-1.amazonaws.com") * or a full URL, including the protocol (ex: * "https://comprehend.us-east-1.amazonaws.com") of the region * specific AWS endpoint this client will communicate with. * @throws IllegalArgumentException If any problems are detected with the * specified endpoint. */ public void setEndpoint(String endpoint) throws java.lang.IllegalArgumentException; /** * An alternative to {@link AmazonComprehend#setEndpoint(String)}, sets the * regional endpoint for this client's service calls. Callers can use this * method to control which AWS region they want to work with. *
* By default, all service endpoints in all regions use the https protocol. * To use http instead, specify it in the {@link ClientConfiguration} * supplied at construction. *
* This method is not threadsafe. A region should be configured when the * client is created and before any service requests are made. Changing it * afterwards creates inevitable race conditions for any service requests in * transit or retrying. * * @param region The region this client will communicate with. See * {@link Region#getRegion(com.amazonaws.regions.Regions)} for * accessing a given region. * @throws java.lang.IllegalArgumentException If the given region is null, * or if this service isn't available in the given region. See * {@link Region#isServiceSupported(String)} * @see Region#getRegion(com.amazonaws.regions.Regions) * @see Region#createClient(Class, * com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration) */ public void setRegion(Region region) throws java.lang.IllegalArgumentException; /** *
* 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 batchDetectDominantLanguageResult The response from the * BatchDetectDominantLanguage service method, as returned by Amazon * Comprehend. * @throws InvalidRequestException * @throws TextSizeLimitExceededException * @throws BatchSizeLimitExceededException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ BatchDetectDominantLanguageResult batchDetectDominantLanguage( BatchDetectDominantLanguageRequest batchDetectDominantLanguageRequest) throws AmazonClientException, AmazonServiceException; /** ** 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 batchDetectEntitiesResult The response from the * BatchDetectEntities service method, as returned by Amazon * Comprehend. * @throws InvalidRequestException * @throws TextSizeLimitExceededException * @throws UnsupportedLanguageException * @throws BatchSizeLimitExceededException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ BatchDetectEntitiesResult batchDetectEntities( BatchDetectEntitiesRequest batchDetectEntitiesRequest) throws AmazonClientException, AmazonServiceException; /** ** Detects the key noun phrases found in a batch of documents. *
* * @param batchDetectKeyPhrasesRequest * @return batchDetectKeyPhrasesResult The response from the * BatchDetectKeyPhrases service method, as returned by Amazon * Comprehend. * @throws InvalidRequestException * @throws TextSizeLimitExceededException * @throws UnsupportedLanguageException * @throws BatchSizeLimitExceededException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ BatchDetectKeyPhrasesResult batchDetectKeyPhrases( BatchDetectKeyPhrasesRequest batchDetectKeyPhrasesRequest) throws AmazonClientException, AmazonServiceException; /** *
* Inspects a batch of documents and returns an inference of the prevailing
* sentiment, POSITIVE, NEUTRAL,
* MIXED, or NEGATIVE, in each one.
*
* 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 batchDetectSyntaxResult The response from the BatchDetectSyntax * service method, as returned by Amazon Comprehend. * @throws InvalidRequestException * @throws TextSizeLimitExceededException * @throws UnsupportedLanguageException * @throws BatchSizeLimitExceededException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ BatchDetectSyntaxResult batchDetectSyntax(BatchDetectSyntaxRequest batchDetectSyntaxRequest) throws AmazonClientException, AmazonServiceException; /** ** 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. *
* * @param batchDetectTargetedSentimentRequest * @return batchDetectTargetedSentimentResult The response from the * BatchDetectTargetedSentiment service method, as returned by * Amazon Comprehend. * @throws InvalidRequestException * @throws TextSizeLimitExceededException * @throws UnsupportedLanguageException * @throws BatchSizeLimitExceededException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ BatchDetectTargetedSentimentResult batchDetectTargetedSentiment( BatchDetectTargetedSentimentRequest batchDetectTargetedSentimentRequest) throws AmazonClientException, AmazonServiceException; /** ** Creates a new document classification request to analyze a single * document in real-time, using a previously created and trained custom * model and an endpoint. *
** You can input plain text or you can upload a single-page input document * (text, PDF, Word, or image). *
*
* If the system detects errors while processing a page in the input
* document, the API response includes an entry in Errors that
* describes the errors.
*
* If the system detects a document-level error in your input document, the
* API returns an InvalidRequestException error response. For
* details about this exception, see Errors in semi-structured documents in the Comprehend Developer
* Guide.
*
* 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 containsPiiEntitiesResult The response from the * ContainsPiiEntities service method, as returned by Amazon * Comprehend. * @throws InvalidRequestException * @throws TextSizeLimitExceededException * @throws UnsupportedLanguageException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ ContainsPiiEntitiesResult containsPiiEntities( ContainsPiiEntitiesRequest containsPiiEntitiesRequest) throws AmazonClientException, AmazonServiceException; /** ** 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 createDatasetResult The response from the CreateDataset service * method, as returned by Amazon Comprehend. * @throws InvalidRequestException * @throws ResourceInUseException * @throws TooManyTagsException * @throws TooManyRequestsException * @throws ResourceLimitExceededException * @throws ResourceNotFoundException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ CreateDatasetResult createDataset(CreateDatasetRequest createDatasetRequest) throws AmazonClientException, AmazonServiceException; /** ** 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 createDocumentClassifierResult The response from the * CreateDocumentClassifier service method, as returned by Amazon * Comprehend. * @throws InvalidRequestException * @throws ResourceInUseException * @throws TooManyTagsException * @throws TooManyRequestsException * @throws ResourceLimitExceededException * @throws UnsupportedLanguageException * @throws KmsKeyValidationException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ CreateDocumentClassifierResult createDocumentClassifier( CreateDocumentClassifierRequest createDocumentClassifierRequest) throws AmazonClientException, AmazonServiceException; /** ** Creates a model-specific endpoint for synchronous inference for a * previously trained custom model For information about endpoints, see Managing endpoints. *
* * @param createEndpointRequest * @return createEndpointResult The response from the CreateEndpoint service * method, as returned by Amazon Comprehend. * @throws InvalidRequestException * @throws ResourceInUseException * @throws ResourceLimitExceededException * @throws ResourceNotFoundException * @throws ResourceUnavailableException * @throws TooManyRequestsException * @throws TooManyTagsException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ CreateEndpointResult createEndpoint(CreateEndpointRequest createEndpointRequest) throws AmazonClientException, AmazonServiceException; /** *
* Creates an entity recognizer using submitted files. After your
* CreateEntityRecognizer request is submitted, you can check
* job status using the DescribeEntityRecognizer API.
*
* 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 createFlywheelResult The response from the CreateFlywheel service * method, as returned by Amazon Comprehend. * @throws InvalidRequestException * @throws ResourceInUseException * @throws TooManyTagsException * @throws TooManyRequestsException * @throws ResourceLimitExceededException * @throws UnsupportedLanguageException * @throws KmsKeyValidationException * @throws ResourceNotFoundException * @throws ResourceUnavailableException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ CreateFlywheelResult createFlywheel(CreateFlywheelRequest createFlywheelRequest) throws AmazonClientException, AmazonServiceException; /** ** 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 deleteDocumentClassifierResult The response from the * DeleteDocumentClassifier service method, as returned by Amazon * Comprehend. * @throws InvalidRequestException * @throws TooManyRequestsException * @throws ResourceNotFoundException * @throws ResourceUnavailableException * @throws ResourceInUseException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ DeleteDocumentClassifierResult deleteDocumentClassifier( DeleteDocumentClassifierRequest deleteDocumentClassifierRequest) throws AmazonClientException, AmazonServiceException; /** ** 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 deleteEndpointResult The response from the DeleteEndpoint service * method, as returned by Amazon Comprehend. * @throws InvalidRequestException * @throws ResourceInUseException * @throws ResourceNotFoundException * @throws TooManyRequestsException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ DeleteEndpointResult deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest) throws AmazonClientException, AmazonServiceException; /** ** 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 deleteEntityRecognizerResult The response from the * DeleteEntityRecognizer service method, as returned by Amazon * Comprehend. * @throws InvalidRequestException * @throws TooManyRequestsException * @throws ResourceNotFoundException * @throws ResourceUnavailableException * @throws ResourceInUseException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ DeleteEntityRecognizerResult deleteEntityRecognizer( DeleteEntityRecognizerRequest deleteEntityRecognizerRequest) throws AmazonClientException, AmazonServiceException; /** ** 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 deleteFlywheelResult The response from the DeleteFlywheel service * method, as returned by Amazon Comprehend. * @throws InvalidRequestException * @throws TooManyRequestsException * @throws ResourceNotFoundException * @throws ResourceUnavailableException * @throws ResourceInUseException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ DeleteFlywheelResult deleteFlywheel(DeleteFlywheelRequest deleteFlywheelRequest) throws AmazonClientException, AmazonServiceException; /** ** Deletes a resource-based policy that is attached to a custom model. *
* * @param deleteResourcePolicyRequest * @return deleteResourcePolicyResult The response from the * DeleteResourcePolicy service method, as returned by Amazon * Comprehend. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ DeleteResourcePolicyResult deleteResourcePolicy( DeleteResourcePolicyRequest deleteResourcePolicyRequest) throws AmazonClientException, AmazonServiceException; /** ** 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 describeDatasetResult The response from the DescribeDataset * service method, as returned by Amazon Comprehend. * @throws InvalidRequestException * @throws TooManyRequestsException * @throws ResourceNotFoundException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ DescribeDatasetResult describeDataset(DescribeDatasetRequest describeDatasetRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets the properties associated with a document classification job. Use * this operation to get the status of a classification job. *
* * @param describeDocumentClassificationJobRequest * @return describeDocumentClassificationJobResult The response from the * DescribeDocumentClassificationJob service method, as returned by * Amazon Comprehend. * @throws InvalidRequestException * @throws TooManyRequestsException * @throws JobNotFoundException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ DescribeDocumentClassificationJobResult describeDocumentClassificationJob( DescribeDocumentClassificationJobRequest describeDocumentClassificationJobRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets the properties associated with a document classifier. *
* * @param describeDocumentClassifierRequest * @return describeDocumentClassifierResult The response from the * DescribeDocumentClassifier service method, as returned by Amazon * Comprehend. * @throws InvalidRequestException * @throws TooManyRequestsException * @throws ResourceNotFoundException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ DescribeDocumentClassifierResult describeDocumentClassifier( DescribeDocumentClassifierRequest describeDocumentClassifierRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets the properties associated with a dominant language detection job. * Use this operation to get the status of a detection job. *
* * @param describeDominantLanguageDetectionJobRequest * @return describeDominantLanguageDetectionJobResult The response from the * DescribeDominantLanguageDetectionJob service method, as returned * by Amazon Comprehend. * @throws InvalidRequestException * @throws JobNotFoundException * @throws TooManyRequestsException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ DescribeDominantLanguageDetectionJobResult describeDominantLanguageDetectionJob( DescribeDominantLanguageDetectionJobRequest describeDominantLanguageDetectionJobRequest) throws AmazonClientException, AmazonServiceException; /** ** 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 describeEndpointResult The response from the DescribeEndpoint * service method, as returned by Amazon Comprehend. * @throws InvalidRequestException * @throws TooManyRequestsException * @throws ResourceNotFoundException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ DescribeEndpointResult describeEndpoint(DescribeEndpointRequest describeEndpointRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets the properties associated with an entities detection job. Use this * operation to get the status of a detection job. *
* * @param describeEntitiesDetectionJobRequest * @return describeEntitiesDetectionJobResult The response from the * DescribeEntitiesDetectionJob service method, as returned by * Amazon Comprehend. * @throws InvalidRequestException * @throws JobNotFoundException * @throws TooManyRequestsException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ DescribeEntitiesDetectionJobResult describeEntitiesDetectionJob( DescribeEntitiesDetectionJobRequest describeEntitiesDetectionJobRequest) throws AmazonClientException, AmazonServiceException; /** ** Provides details about an entity recognizer including status, S3 buckets * containing training data, recognizer metadata, metrics, and so on. *
* * @param describeEntityRecognizerRequest * @return describeEntityRecognizerResult The response from the * DescribeEntityRecognizer service method, as returned by Amazon * Comprehend. * @throws InvalidRequestException * @throws TooManyRequestsException * @throws ResourceNotFoundException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ DescribeEntityRecognizerResult describeEntityRecognizer( DescribeEntityRecognizerRequest describeEntityRecognizerRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets the status and details of an events detection job. *
* * @param describeEventsDetectionJobRequest * @return describeEventsDetectionJobResult The response from the * DescribeEventsDetectionJob service method, as returned by Amazon * Comprehend. * @throws InvalidRequestException * @throws JobNotFoundException * @throws TooManyRequestsException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ DescribeEventsDetectionJobResult describeEventsDetectionJob( DescribeEventsDetectionJobRequest describeEventsDetectionJobRequest) throws AmazonClientException, AmazonServiceException; /** ** Provides configuration information about the flywheel. For more * information about flywheels, see * Flywheel overview in the Amazon Comprehend Developer Guide. *
* * @param describeFlywheelRequest * @return describeFlywheelResult The response from the DescribeFlywheel * service method, as returned by Amazon Comprehend. * @throws InvalidRequestException * @throws TooManyRequestsException * @throws ResourceNotFoundException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ DescribeFlywheelResult describeFlywheel(DescribeFlywheelRequest describeFlywheelRequest) throws AmazonClientException, AmazonServiceException; /** ** 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 describeFlywheelIterationResult The response from the * DescribeFlywheelIteration service method, as returned by Amazon * Comprehend. * @throws InvalidRequestException * @throws TooManyRequestsException * @throws ResourceNotFoundException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ DescribeFlywheelIterationResult describeFlywheelIteration( DescribeFlywheelIterationRequest describeFlywheelIterationRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets the properties associated with a key phrases detection job. Use this * operation to get the status of a detection job. *
* * @param describeKeyPhrasesDetectionJobRequest * @return describeKeyPhrasesDetectionJobResult The response from the * DescribeKeyPhrasesDetectionJob service method, as returned by * Amazon Comprehend. * @throws InvalidRequestException * @throws JobNotFoundException * @throws TooManyRequestsException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ DescribeKeyPhrasesDetectionJobResult describeKeyPhrasesDetectionJob( DescribeKeyPhrasesDetectionJobRequest describeKeyPhrasesDetectionJobRequest) throws AmazonClientException, AmazonServiceException; /** ** 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 describePiiEntitiesDetectionJobResult The response from the * DescribePiiEntitiesDetectionJob service method, as returned by * Amazon Comprehend. * @throws InvalidRequestException * @throws JobNotFoundException * @throws TooManyRequestsException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ DescribePiiEntitiesDetectionJobResult describePiiEntitiesDetectionJob( DescribePiiEntitiesDetectionJobRequest describePiiEntitiesDetectionJobRequest) throws AmazonClientException, AmazonServiceException; /** ** 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 describeResourcePolicyResult The response from the * DescribeResourcePolicy service method, as returned by Amazon * Comprehend. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ DescribeResourcePolicyResult describeResourcePolicy( DescribeResourcePolicyRequest describeResourcePolicyRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets the properties associated with a sentiment detection job. Use this * operation to get the status of a detection job. *
* * @param describeSentimentDetectionJobRequest * @return describeSentimentDetectionJobResult The response from the * DescribeSentimentDetectionJob service method, as returned by * Amazon Comprehend. * @throws InvalidRequestException * @throws JobNotFoundException * @throws TooManyRequestsException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ DescribeSentimentDetectionJobResult describeSentimentDetectionJob( DescribeSentimentDetectionJobRequest describeSentimentDetectionJobRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets the properties associated with a targeted sentiment detection job. * Use this operation to get the status of the job. *
* * @param describeTargetedSentimentDetectionJobRequest * @return describeTargetedSentimentDetectionJobResult The response from the * DescribeTargetedSentimentDetectionJob service method, as returned * by Amazon Comprehend. * @throws InvalidRequestException * @throws JobNotFoundException * @throws TooManyRequestsException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ DescribeTargetedSentimentDetectionJobResult describeTargetedSentimentDetectionJob( DescribeTargetedSentimentDetectionJobRequest describeTargetedSentimentDetectionJobRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets the properties associated with a topic detection job. Use this * operation to get the status of a detection job. *
* * @param describeTopicsDetectionJobRequest * @return describeTopicsDetectionJobResult The response from the * DescribeTopicsDetectionJob service method, as returned by Amazon * Comprehend. * @throws InvalidRequestException * @throws JobNotFoundException * @throws TooManyRequestsException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ DescribeTopicsDetectionJobResult describeTopicsDetectionJob( DescribeTopicsDetectionJobRequest describeTopicsDetectionJobRequest) throws AmazonClientException, AmazonServiceException; /** ** 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 detectDominantLanguageResult The response from the * DetectDominantLanguage service method, as returned by Amazon * Comprehend. * @throws InvalidRequestException * @throws TextSizeLimitExceededException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ DetectDominantLanguageResult detectDominantLanguage( DetectDominantLanguageRequest detectDominantLanguageRequest) throws AmazonClientException, AmazonServiceException; /** ** 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.
*
* Detects the key noun phrases found in the text. *
* * @param detectKeyPhrasesRequest * @return detectKeyPhrasesResult The response from the DetectKeyPhrases * service method, as returned by Amazon Comprehend. * @throws InvalidRequestException * @throws TextSizeLimitExceededException * @throws UnsupportedLanguageException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ DetectKeyPhrasesResult detectKeyPhrases(DetectKeyPhrasesRequest detectKeyPhrasesRequest) throws AmazonClientException, AmazonServiceException; /** ** Inspects the input text for entities that contain personally identifiable * information (PII) and returns information about them. *
* * @param detectPiiEntitiesRequest * @return detectPiiEntitiesResult The response from the DetectPiiEntities * service method, as returned by Amazon Comprehend. * @throws InvalidRequestException * @throws TextSizeLimitExceededException * @throws UnsupportedLanguageException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ DetectPiiEntitiesResult detectPiiEntities(DetectPiiEntitiesRequest detectPiiEntitiesRequest) throws AmazonClientException, AmazonServiceException; /** *
* Inspects text and returns an inference of the prevailing sentiment (
* POSITIVE, NEUTRAL, MIXED, or
* NEGATIVE).
*
* 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 detectSyntaxResult The response from the DetectSyntax service * method, as returned by Amazon Comprehend. * @throws InvalidRequestException * @throws TextSizeLimitExceededException * @throws UnsupportedLanguageException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ DetectSyntaxResult detectSyntax(DetectSyntaxRequest detectSyntaxRequest) throws AmazonClientException, AmazonServiceException; /** ** 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. *
* * @param detectTargetedSentimentRequest * @return detectTargetedSentimentResult The response from the * DetectTargetedSentiment service method, as returned by Amazon * Comprehend. * @throws InvalidRequestException * @throws TextSizeLimitExceededException * @throws UnsupportedLanguageException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ DetectTargetedSentimentResult detectTargetedSentiment( DetectTargetedSentimentRequest detectTargetedSentimentRequest) throws AmazonClientException, AmazonServiceException; /** ** 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 importModelResult The response from the ImportModel service * method, as returned by Amazon Comprehend. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws ResourceInUseException * @throws ResourceUnavailableException * @throws TooManyTagsException * @throws TooManyRequestsException * @throws ResourceLimitExceededException * @throws KmsKeyValidationException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ ImportModelResult importModel(ImportModelRequest importModelRequest) throws AmazonClientException, AmazonServiceException; /** ** 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 listDatasetsResult The response from the ListDatasets service * method, as returned by Amazon Comprehend. * @throws InvalidRequestException * @throws TooManyRequestsException * @throws InvalidFilterException * @throws ResourceNotFoundException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ ListDatasetsResult listDatasets(ListDatasetsRequest listDatasetsRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets a list of the documentation classification jobs that you have * submitted. *
* * @param listDocumentClassificationJobsRequest * @return listDocumentClassificationJobsResult The response from the * ListDocumentClassificationJobs service method, as returned by * Amazon Comprehend. * @throws InvalidRequestException * @throws TooManyRequestsException * @throws InvalidFilterException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ ListDocumentClassificationJobsResult listDocumentClassificationJobs( ListDocumentClassificationJobsRequest listDocumentClassificationJobsRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets a list of summaries of the document classifiers that you have * created *
* * @param listDocumentClassifierSummariesRequest * @return listDocumentClassifierSummariesResult The response from the * ListDocumentClassifierSummaries service method, as returned by * Amazon Comprehend. * @throws InvalidRequestException * @throws TooManyRequestsException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ ListDocumentClassifierSummariesResult listDocumentClassifierSummaries( ListDocumentClassifierSummariesRequest listDocumentClassifierSummariesRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets a list of the document classifiers that you have created. *
* * @param listDocumentClassifiersRequest * @return listDocumentClassifiersResult The response from the * ListDocumentClassifiers service method, as returned by Amazon * Comprehend. * @throws InvalidRequestException * @throws TooManyRequestsException * @throws InvalidFilterException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ ListDocumentClassifiersResult listDocumentClassifiers( ListDocumentClassifiersRequest listDocumentClassifiersRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets a list of the dominant language detection jobs that you have * submitted. *
* * @param listDominantLanguageDetectionJobsRequest * @return listDominantLanguageDetectionJobsResult The response from the * ListDominantLanguageDetectionJobs service method, as returned by * Amazon Comprehend. * @throws InvalidRequestException * @throws TooManyRequestsException * @throws InvalidFilterException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ ListDominantLanguageDetectionJobsResult listDominantLanguageDetectionJobs( ListDominantLanguageDetectionJobsRequest listDominantLanguageDetectionJobsRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets a list of all existing endpoints that you've created. For * information about endpoints, see Managing endpoints. *
* * @param listEndpointsRequest * @return listEndpointsResult The response from the ListEndpoints service * method, as returned by Amazon Comprehend. * @throws InvalidRequestException * @throws TooManyRequestsException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ ListEndpointsResult listEndpoints(ListEndpointsRequest listEndpointsRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets a list of the entity detection jobs that you have submitted. *
* * @param listEntitiesDetectionJobsRequest * @return listEntitiesDetectionJobsResult The response from the * ListEntitiesDetectionJobs service method, as returned by Amazon * Comprehend. * @throws InvalidRequestException * @throws TooManyRequestsException * @throws InvalidFilterException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ ListEntitiesDetectionJobsResult listEntitiesDetectionJobs( ListEntitiesDetectionJobsRequest listEntitiesDetectionJobsRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets a list of summaries for the entity recognizers that you have * created. *
* * @param listEntityRecognizerSummariesRequest * @return listEntityRecognizerSummariesResult The response from the * ListEntityRecognizerSummaries service method, as returned by * Amazon Comprehend. * @throws InvalidRequestException * @throws TooManyRequestsException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ ListEntityRecognizerSummariesResult listEntityRecognizerSummaries( ListEntityRecognizerSummariesRequest listEntityRecognizerSummariesRequest) throws AmazonClientException, AmazonServiceException; /** ** 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 listEntityRecognizersResult The response from the * ListEntityRecognizers service method, as returned by Amazon * Comprehend. * @throws InvalidRequestException * @throws TooManyRequestsException * @throws InvalidFilterException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ ListEntityRecognizersResult listEntityRecognizers( ListEntityRecognizersRequest listEntityRecognizersRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets a list of the events detection jobs that you have submitted. *
* * @param listEventsDetectionJobsRequest * @return listEventsDetectionJobsResult The response from the * ListEventsDetectionJobs service method, as returned by Amazon * Comprehend. * @throws InvalidRequestException * @throws TooManyRequestsException * @throws InvalidFilterException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ ListEventsDetectionJobsResult listEventsDetectionJobs( ListEventsDetectionJobsRequest listEventsDetectionJobsRequest) throws AmazonClientException, AmazonServiceException; /** ** 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 listFlywheelIterationHistoryResult The response from the * ListFlywheelIterationHistory service method, as returned by * Amazon Comprehend. * @throws InvalidRequestException * @throws TooManyRequestsException * @throws InvalidFilterException * @throws ResourceNotFoundException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ ListFlywheelIterationHistoryResult listFlywheelIterationHistory( ListFlywheelIterationHistoryRequest listFlywheelIterationHistoryRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets a list of the flywheels that you have created. *
* * @param listFlywheelsRequest * @return listFlywheelsResult The response from the ListFlywheels service * method, as returned by Amazon Comprehend. * @throws InvalidRequestException * @throws TooManyRequestsException * @throws InvalidFilterException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ ListFlywheelsResult listFlywheels(ListFlywheelsRequest listFlywheelsRequest) throws AmazonClientException, AmazonServiceException; /** ** Get a list of key phrase detection jobs that you have submitted. *
* * @param listKeyPhrasesDetectionJobsRequest * @return listKeyPhrasesDetectionJobsResult The response from the * ListKeyPhrasesDetectionJobs service method, as returned by Amazon * Comprehend. * @throws InvalidRequestException * @throws TooManyRequestsException * @throws InvalidFilterException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ ListKeyPhrasesDetectionJobsResult listKeyPhrasesDetectionJobs( ListKeyPhrasesDetectionJobsRequest listKeyPhrasesDetectionJobsRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets a list of the PII entity detection jobs that you have submitted. *
* * @param listPiiEntitiesDetectionJobsRequest * @return listPiiEntitiesDetectionJobsResult The response from the * ListPiiEntitiesDetectionJobs service method, as returned by * Amazon Comprehend. * @throws InvalidRequestException * @throws TooManyRequestsException * @throws InvalidFilterException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ ListPiiEntitiesDetectionJobsResult listPiiEntitiesDetectionJobs( ListPiiEntitiesDetectionJobsRequest listPiiEntitiesDetectionJobsRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets a list of sentiment detection jobs that you have submitted. *
* * @param listSentimentDetectionJobsRequest * @return listSentimentDetectionJobsResult The response from the * ListSentimentDetectionJobs service method, as returned by Amazon * Comprehend. * @throws InvalidRequestException * @throws TooManyRequestsException * @throws InvalidFilterException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ ListSentimentDetectionJobsResult listSentimentDetectionJobs( ListSentimentDetectionJobsRequest listSentimentDetectionJobsRequest) throws AmazonClientException, AmazonServiceException; /** ** Lists all tags associated with a given Amazon Comprehend resource. *
* * @param listTagsForResourceRequest * @return listTagsForResourceResult The response from the * ListTagsForResource service method, as returned by Amazon * Comprehend. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ ListTagsForResourceResult listTagsForResource( ListTagsForResourceRequest listTagsForResourceRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets a list of targeted sentiment detection jobs that you have submitted. *
* * @param listTargetedSentimentDetectionJobsRequest * @return listTargetedSentimentDetectionJobsResult The response from the * ListTargetedSentimentDetectionJobs service method, as returned by * Amazon Comprehend. * @throws InvalidRequestException * @throws TooManyRequestsException * @throws InvalidFilterException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ ListTargetedSentimentDetectionJobsResult listTargetedSentimentDetectionJobs( ListTargetedSentimentDetectionJobsRequest listTargetedSentimentDetectionJobsRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets a list of the topic detection jobs that you have submitted. *
* * @param listTopicsDetectionJobsRequest * @return listTopicsDetectionJobsResult The response from the * ListTopicsDetectionJobs service method, as returned by Amazon * Comprehend. * @throws InvalidRequestException * @throws TooManyRequestsException * @throws InvalidFilterException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ ListTopicsDetectionJobsResult listTopicsDetectionJobs( ListTopicsDetectionJobsRequest listTopicsDetectionJobsRequest) throws AmazonClientException, AmazonServiceException; /** ** 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 putResourcePolicyResult The response from the PutResourcePolicy * service method, as returned by Amazon Comprehend. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ PutResourcePolicyResult putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest) throws AmazonClientException, AmazonServiceException; /** *
* Starts an asynchronous document classification job. Use the
* DescribeDocumentClassificationJob operation to track the
* progress of the job.
*
* 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 startDominantLanguageDetectionJobResult The response from the * StartDominantLanguageDetectionJob service method, as returned by * Amazon Comprehend. * @throws InvalidRequestException * @throws TooManyRequestsException * @throws KmsKeyValidationException * @throws TooManyTagsException * @throws ResourceInUseException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ StartDominantLanguageDetectionJobResult startDominantLanguageDetectionJob( StartDominantLanguageDetectionJobRequest startDominantLanguageDetectionJobRequest) throws AmazonClientException, AmazonServiceException; /** ** 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.
*
* Starts an asynchronous event detection job for a collection of documents. *
* * @param startEventsDetectionJobRequest * @return startEventsDetectionJobResult The response from the * StartEventsDetectionJob service method, as returned by Amazon * Comprehend. * @throws InvalidRequestException * @throws TooManyRequestsException * @throws KmsKeyValidationException * @throws TooManyTagsException * @throws ResourceInUseException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ StartEventsDetectionJobResult startEventsDetectionJob( StartEventsDetectionJobRequest startEventsDetectionJobRequest) throws AmazonClientException, AmazonServiceException; /** ** 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 startFlywheelIterationResult The response from the * StartFlywheelIteration service method, as returned by Amazon * Comprehend. * @throws InvalidRequestException * @throws TooManyRequestsException * @throws ResourceInUseException * @throws ResourceNotFoundException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ StartFlywheelIterationResult startFlywheelIteration( StartFlywheelIterationRequest startFlywheelIterationRequest) throws AmazonClientException, AmazonServiceException; /** ** 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 startKeyPhrasesDetectionJobResult The response from the * StartKeyPhrasesDetectionJob service method, as returned by Amazon * Comprehend. * @throws InvalidRequestException * @throws TooManyRequestsException * @throws KmsKeyValidationException * @throws TooManyTagsException * @throws ResourceInUseException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ StartKeyPhrasesDetectionJobResult startKeyPhrasesDetectionJob( StartKeyPhrasesDetectionJobRequest startKeyPhrasesDetectionJobRequest) throws AmazonClientException, AmazonServiceException; /** ** Starts an asynchronous PII entity detection job for a collection of * documents. *
* * @param startPiiEntitiesDetectionJobRequest * @return startPiiEntitiesDetectionJobResult The response from the * StartPiiEntitiesDetectionJob service method, as returned by * Amazon Comprehend. * @throws InvalidRequestException * @throws TooManyRequestsException * @throws KmsKeyValidationException * @throws TooManyTagsException * @throws ResourceInUseException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ StartPiiEntitiesDetectionJobResult startPiiEntitiesDetectionJob( StartPiiEntitiesDetectionJobRequest startPiiEntitiesDetectionJobRequest) throws AmazonClientException, AmazonServiceException; /** ** Starts an asynchronous sentiment detection job for a collection of * documents. Use the operation to track the status of a job. *
* * @param startSentimentDetectionJobRequest * @return startSentimentDetectionJobResult The response from the * StartSentimentDetectionJob service method, as returned by Amazon * Comprehend. * @throws InvalidRequestException * @throws TooManyRequestsException * @throws KmsKeyValidationException * @throws TooManyTagsException * @throws ResourceInUseException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ StartSentimentDetectionJobResult startSentimentDetectionJob( StartSentimentDetectionJobRequest startSentimentDetectionJobRequest) throws AmazonClientException, AmazonServiceException; /** *
* Starts an asynchronous targeted sentiment detection job for a collection
* of documents. Use the DescribeTargetedSentimentDetectionJob
* operation to track the status of a job.
*
* Starts an asynchronous topic detection job. Use the
* DescribeTopicDetectionJob operation to track the status of a
* job.
*
* 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 stopDominantLanguageDetectionJobResult The response from the * StopDominantLanguageDetectionJob service method, as returned by * Amazon Comprehend. * @throws InvalidRequestException * @throws JobNotFoundException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ StopDominantLanguageDetectionJobResult stopDominantLanguageDetectionJob( StopDominantLanguageDetectionJobRequest stopDominantLanguageDetectionJobRequest) throws AmazonClientException, AmazonServiceException; /** ** 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 stopEntitiesDetectionJobResult The response from the * StopEntitiesDetectionJob service method, as returned by Amazon * Comprehend. * @throws InvalidRequestException * @throws JobNotFoundException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ StopEntitiesDetectionJobResult stopEntitiesDetectionJob( StopEntitiesDetectionJobRequest stopEntitiesDetectionJobRequest) throws AmazonClientException, AmazonServiceException; /** ** Stops an events detection job in progress. *
* * @param stopEventsDetectionJobRequest * @return stopEventsDetectionJobResult The response from the * StopEventsDetectionJob service method, as returned by Amazon * Comprehend. * @throws InvalidRequestException * @throws JobNotFoundException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ StopEventsDetectionJobResult stopEventsDetectionJob( StopEventsDetectionJobRequest stopEventsDetectionJobRequest) throws AmazonClientException, AmazonServiceException; /** ** 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 stopKeyPhrasesDetectionJobResult The response from the * StopKeyPhrasesDetectionJob service method, as returned by Amazon * Comprehend. * @throws InvalidRequestException * @throws JobNotFoundException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ StopKeyPhrasesDetectionJobResult stopKeyPhrasesDetectionJob( StopKeyPhrasesDetectionJobRequest stopKeyPhrasesDetectionJobRequest) throws AmazonClientException, AmazonServiceException; /** ** Stops a PII entities detection job in progress. *
* * @param stopPiiEntitiesDetectionJobRequest * @return stopPiiEntitiesDetectionJobResult The response from the * StopPiiEntitiesDetectionJob service method, as returned by Amazon * Comprehend. * @throws InvalidRequestException * @throws JobNotFoundException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ StopPiiEntitiesDetectionJobResult stopPiiEntitiesDetectionJob( StopPiiEntitiesDetectionJobRequest stopPiiEntitiesDetectionJobRequest) throws AmazonClientException, AmazonServiceException; /** ** 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 stopSentimentDetectionJobResult The response from the * StopSentimentDetectionJob service method, as returned by Amazon * Comprehend. * @throws InvalidRequestException * @throws JobNotFoundException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ StopSentimentDetectionJobResult stopSentimentDetectionJob( StopSentimentDetectionJobRequest stopSentimentDetectionJobRequest) throws AmazonClientException, AmazonServiceException; /** ** 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 stopTargetedSentimentDetectionJobResult The response from the * StopTargetedSentimentDetectionJob service method, as returned by * Amazon Comprehend. * @throws InvalidRequestException * @throws JobNotFoundException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ StopTargetedSentimentDetectionJobResult stopTargetedSentimentDetectionJob( StopTargetedSentimentDetectionJobRequest stopTargetedSentimentDetectionJobRequest) throws AmazonClientException, AmazonServiceException; /** ** 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.
*
* 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.
*
* 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 tagResourceResult The response from the TagResource service * method, as returned by Amazon Comprehend. * @throws InvalidRequestException * @throws ConcurrentModificationException * @throws ResourceNotFoundException * @throws TooManyTagsException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ TagResourceResult tagResource(TagResourceRequest tagResourceRequest) throws AmazonClientException, AmazonServiceException; /** ** Removes a specific tag associated with an Amazon Comprehend resource. *
* * @param untagResourceRequest * @return untagResourceResult The response from the UntagResource service * method, as returned by Amazon Comprehend. * @throws TooManyTagKeysException * @throws InvalidRequestException * @throws ConcurrentModificationException * @throws ResourceNotFoundException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest) throws AmazonClientException, AmazonServiceException; /** ** Updates information about the specified endpoint. For information about * endpoints, see Managing endpoints. *
* * @param updateEndpointRequest * @return updateEndpointResult The response from the UpdateEndpoint service * method, as returned by Amazon Comprehend. * @throws InvalidRequestException * @throws TooManyRequestsException * @throws ResourceInUseException * @throws ResourceLimitExceededException * @throws ResourceNotFoundException * @throws ResourceUnavailableException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ UpdateEndpointResult updateEndpoint(UpdateEndpointRequest updateEndpointRequest) throws AmazonClientException, AmazonServiceException; /** ** Update the configuration information for an existing flywheel. *
* * @param updateFlywheelRequest * @return updateFlywheelResult The response from the UpdateFlywheel service * method, as returned by Amazon Comprehend. * @throws InvalidRequestException * @throws TooManyRequestsException * @throws KmsKeyValidationException * @throws ResourceNotFoundException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Comprehend indicating either a problem with the data in the * request, or a server side issue. */ UpdateFlywheelResult updateFlywheel(UpdateFlywheelRequest updateFlywheelRequest) throws AmazonClientException, AmazonServiceException; /** * Shuts down this client object, releasing any resources that might be held * open. This is an optional method, and callers are not expected to call * it, but can if they want to explicitly release any open resources. Once a * client has been shutdown, it should not be used to make any more * requests. */ public void shutdown(); /** * Returns additional metadata for a previously executed successful request, * typically used for debugging issues where a service isn't acting as * expected. This data isn't considered part of the result data returned by * an operation, so it's available through this separate, diagnostic * interface. ** Response metadata is only cached for a limited period of time, so if you * need to access this extra diagnostic information for an executed request, * you should use this method to retrieve it as soon as possible after * executing a request. * * @param request The originally executed request. * @return The response metadata for the specified request, or null if none * is available. */ public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request); }