com.amazonaws.services.comprehend.AmazonComprehend Maven / Gradle / Ivy
/*
* Copyright 2017-2022 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.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.comprehend.model.*;
/**
* Interface for accessing Amazon Comprehend.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.comprehend.AbstractAmazonComprehend} instead.
*
*
*
* Amazon Comprehend is an AWS 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 AmazonComprehend {
/**
* The region metadata service name for computing region endpoints. You can use this value to retrieve metadata
* (such as supported regions) of the service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "comprehend";
/**
*
* 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 Result of the BatchDetectDominantLanguage operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TextSizeLimitExceededException
* The size of the input text exceeds the limit. Use a smaller document.
* @throws BatchSizeLimitExceededException
* The number of documents in the request exceeds the limit of 25. Try your request again with fewer
* documents.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.BatchDetectDominantLanguage
* @see AWS API Documentation
*/
BatchDetectDominantLanguageResult batchDetectDominantLanguage(BatchDetectDominantLanguageRequest batchDetectDominantLanguageRequest);
/**
*
* Inspects the text of a batch of documents for named entities and returns information about them. For more
* information about named entities, see how-entities
*
*
* @param batchDetectEntitiesRequest
* @return Result of the BatchDetectEntities operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TextSizeLimitExceededException
* The size of the input text exceeds the limit. Use a smaller document.
* @throws UnsupportedLanguageException
* Amazon Comprehend can't process the language of the input text. For custom entity recognition APIs, only
* English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages,
* see supported-languages.
* @throws BatchSizeLimitExceededException
* The number of documents in the request exceeds the limit of 25. Try your request again with fewer
* documents.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.BatchDetectEntities
* @see AWS
* API Documentation
*/
BatchDetectEntitiesResult batchDetectEntities(BatchDetectEntitiesRequest batchDetectEntitiesRequest);
/**
*
* Detects the key noun phrases found in a batch of documents.
*
*
* @param batchDetectKeyPhrasesRequest
* @return Result of the BatchDetectKeyPhrases operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TextSizeLimitExceededException
* The size of the input text exceeds the limit. Use a smaller document.
* @throws UnsupportedLanguageException
* Amazon Comprehend can't process the language of the input text. For custom entity recognition APIs, only
* English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages,
* see supported-languages.
* @throws BatchSizeLimitExceededException
* The number of documents in the request exceeds the limit of 25. Try your request again with fewer
* documents.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.BatchDetectKeyPhrases
* @see AWS API Documentation
*/
BatchDetectKeyPhrasesResult batchDetectKeyPhrases(BatchDetectKeyPhrasesRequest batchDetectKeyPhrasesRequest);
/**
*
* Inspects a batch of documents and returns an inference of the prevailing sentiment, POSITIVE,
* NEUTRAL, MIXED, or NEGATIVE, in each one.
*
*
* @param batchDetectSentimentRequest
* @return Result of the BatchDetectSentiment operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TextSizeLimitExceededException
* The size of the input text exceeds the limit. Use a smaller document.
* @throws UnsupportedLanguageException
* Amazon Comprehend can't process the language of the input text. For custom entity recognition APIs, only
* English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages,
* see supported-languages.
* @throws BatchSizeLimitExceededException
* The number of documents in the request exceeds the limit of 25. Try your request again with fewer
* documents.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.BatchDetectSentiment
* @see AWS API Documentation
*/
BatchDetectSentimentResult batchDetectSentiment(BatchDetectSentimentRequest batchDetectSentimentRequest);
/**
*
* 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 how-syntax.
*
*
* @param batchDetectSyntaxRequest
* @return Result of the BatchDetectSyntax operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TextSizeLimitExceededException
* The size of the input text exceeds the limit. Use a smaller document.
* @throws UnsupportedLanguageException
* Amazon Comprehend can't process the language of the input text. For custom entity recognition APIs, only
* English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages,
* see supported-languages.
* @throws BatchSizeLimitExceededException
* The number of documents in the request exceeds the limit of 25. Try your request again with fewer
* documents.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.BatchDetectSyntax
* @see AWS
* API Documentation
*/
BatchDetectSyntaxResult batchDetectSyntax(BatchDetectSyntaxRequest batchDetectSyntaxRequest);
/**
*
* 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.
*
*
* @param classifyDocumentRequest
* @return Result of the ClassifyDocument operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws ResourceUnavailableException
* The specified resource is not available. Check the resource and try your request again.
* @throws TextSizeLimitExceededException
* The size of the input text exceeds the limit. Use a smaller document.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.ClassifyDocument
* @see AWS
* API Documentation
*/
ClassifyDocumentResult classifyDocument(ClassifyDocumentRequest classifyDocumentRequest);
/**
*
* 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 Result of the ContainsPiiEntities operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TextSizeLimitExceededException
* The size of the input text exceeds the limit. Use a smaller document.
* @throws UnsupportedLanguageException
* Amazon Comprehend can't process the language of the input text. For custom entity recognition APIs, only
* English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages,
* see supported-languages.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.ContainsPiiEntities
* @see AWS
* API Documentation
*/
ContainsPiiEntitiesResult containsPiiEntities(ContainsPiiEntitiesRequest containsPiiEntitiesRequest);
/**
*
* Creates a new document classifier that you can use to categorize documents. To create a classifier, you provide a
* set of training documents that labeled with the categories that you want to use. After the classifier is trained
* you can use it to categorize a set of labeled documents into the categories. For more information, see
* how-document-classification.
*
*
* @param createDocumentClassifierRequest
* @return Result of the CreateDocumentClassifier operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws ResourceInUseException
* The specified resource name is already in use. Use a different name and try your request again.
* @throws TooManyTagsException
* The request contains more tags than can be associated with a resource (50 tags per resource). The maximum
* number of tags includes both existing tags and those included in your current request.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws ResourceLimitExceededException
* The maximum number of resources per account has been exceeded. Review the resources, and then try your
* request again.
* @throws UnsupportedLanguageException
* Amazon Comprehend can't process the language of the input text. For custom entity recognition APIs, only
* English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages,
* see supported-languages.
* @throws KmsKeyValidationException
* The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.CreateDocumentClassifier
* @see AWS API Documentation
*/
CreateDocumentClassifierResult createDocumentClassifier(CreateDocumentClassifierRequest createDocumentClassifierRequest);
/**
*
* Creates a model-specific endpoint for synchronous inference for a previously trained custom model
*
*
* @param createEndpointRequest
* @return Result of the CreateEndpoint operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws ResourceInUseException
* The specified resource name is already in use. Use a different name and try your request again.
* @throws ResourceLimitExceededException
* The maximum number of resources per account has been exceeded. Review the resources, and then try your
* request again.
* @throws ResourceNotFoundException
* The specified resource ARN was not found. Check the ARN and try your request again.
* @throws ResourceUnavailableException
* The specified resource is not available. Check the resource and try your request again.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws TooManyTagsException
* The request contains more tags than can be associated with a resource (50 tags per resource). The maximum
* number of tags includes both existing tags and those included in your current request.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.CreateEndpoint
* @see AWS API
* Documentation
*/
CreateEndpointResult createEndpoint(CreateEndpointRequest createEndpointRequest);
/**
*
* Creates an entity recognizer using submitted files. After your CreateEntityRecognizer request is
* submitted, you can check job status using the API.
*
*
* @param createEntityRecognizerRequest
* @return Result of the CreateEntityRecognizer operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws ResourceInUseException
* The specified resource name is already in use. Use a different name and try your request again.
* @throws TooManyTagsException
* The request contains more tags than can be associated with a resource (50 tags per resource). The maximum
* number of tags includes both existing tags and those included in your current request.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws ResourceLimitExceededException
* The maximum number of resources per account has been exceeded. Review the resources, and then try your
* request again.
* @throws UnsupportedLanguageException
* Amazon Comprehend can't process the language of the input text. For custom entity recognition APIs, only
* English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages,
* see supported-languages.
* @throws KmsKeyValidationException
* The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.CreateEntityRecognizer
* @see AWS API Documentation
*/
CreateEntityRecognizerResult createEntityRecognizer(CreateEntityRecognizerRequest createEntityRecognizerRequest);
/**
*
* 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 Result of the DeleteDocumentClassifier operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws ResourceNotFoundException
* The specified resource ARN was not found. Check the ARN and try your request again.
* @throws ResourceUnavailableException
* The specified resource is not available. Check the resource and try your request again.
* @throws ResourceInUseException
* The specified resource name is already in use. Use a different name and try your request again.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.DeleteDocumentClassifier
* @see AWS API Documentation
*/
DeleteDocumentClassifierResult deleteDocumentClassifier(DeleteDocumentClassifierRequest deleteDocumentClassifierRequest);
/**
*
* Deletes a model-specific endpoint for a previously-trained custom model. All endpoints must be deleted in order
* for the model to be deleted.
*
*
* @param deleteEndpointRequest
* @return Result of the DeleteEndpoint operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws ResourceInUseException
* The specified resource name is already in use. Use a different name and try your request again.
* @throws ResourceNotFoundException
* The specified resource ARN was not found. Check the ARN and try your request again.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.DeleteEndpoint
* @see AWS API
* Documentation
*/
DeleteEndpointResult deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest);
/**
*
* 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 Result of the DeleteEntityRecognizer operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws ResourceNotFoundException
* The specified resource ARN was not found. Check the ARN and try your request again.
* @throws ResourceUnavailableException
* The specified resource is not available. Check the resource and try your request again.
* @throws ResourceInUseException
* The specified resource name is already in use. Use a different name and try your request again.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.DeleteEntityRecognizer
* @see AWS API Documentation
*/
DeleteEntityRecognizerResult deleteEntityRecognizer(DeleteEntityRecognizerRequest deleteEntityRecognizerRequest);
/**
*
* Deletes a resource-based policy that is attached to a custom model.
*
*
* @param deleteResourcePolicyRequest
* @return Result of the DeleteResourcePolicy operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws ResourceNotFoundException
* The specified resource ARN was not found. Check the ARN and try your request again.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.DeleteResourcePolicy
* @see AWS API Documentation
*/
DeleteResourcePolicyResult deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest);
/**
*
* Gets the properties associated with a document classification job. Use this operation to get the status of a
* classification job.
*
*
* @param describeDocumentClassificationJobRequest
* @return Result of the DescribeDocumentClassificationJob operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws JobNotFoundException
* The specified job was not found. Check the job ID and try again.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.DescribeDocumentClassificationJob
* @see AWS API Documentation
*/
DescribeDocumentClassificationJobResult describeDocumentClassificationJob(DescribeDocumentClassificationJobRequest describeDocumentClassificationJobRequest);
/**
*
* Gets the properties associated with a document classifier.
*
*
* @param describeDocumentClassifierRequest
* @return Result of the DescribeDocumentClassifier operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws ResourceNotFoundException
* The specified resource ARN was not found. Check the ARN and try your request again.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.DescribeDocumentClassifier
* @see AWS API Documentation
*/
DescribeDocumentClassifierResult describeDocumentClassifier(DescribeDocumentClassifierRequest describeDocumentClassifierRequest);
/**
*
* Gets the properties associated with a dominant language detection job. Use this operation to get the status of a
* detection job.
*
*
* @param describeDominantLanguageDetectionJobRequest
* @return Result of the DescribeDominantLanguageDetectionJob operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws JobNotFoundException
* The specified job was not found. Check the job ID and try again.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.DescribeDominantLanguageDetectionJob
* @see AWS API Documentation
*/
DescribeDominantLanguageDetectionJobResult describeDominantLanguageDetectionJob(
DescribeDominantLanguageDetectionJobRequest describeDominantLanguageDetectionJobRequest);
/**
*
* Gets the properties associated with a specific endpoint. Use this operation to get the status of an endpoint.
*
*
* @param describeEndpointRequest
* @return Result of the DescribeEndpoint operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws ResourceNotFoundException
* The specified resource ARN was not found. Check the ARN and try your request again.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.DescribeEndpoint
* @see AWS
* API Documentation
*/
DescribeEndpointResult describeEndpoint(DescribeEndpointRequest describeEndpointRequest);
/**
*
* Gets the properties associated with an entities detection job. Use this operation to get the status of a
* detection job.
*
*
* @param describeEntitiesDetectionJobRequest
* @return Result of the DescribeEntitiesDetectionJob operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws JobNotFoundException
* The specified job was not found. Check the job ID and try again.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.DescribeEntitiesDetectionJob
* @see AWS API Documentation
*/
DescribeEntitiesDetectionJobResult describeEntitiesDetectionJob(DescribeEntitiesDetectionJobRequest describeEntitiesDetectionJobRequest);
/**
*
* Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer
* metadata, metrics, and so on.
*
*
* @param describeEntityRecognizerRequest
* @return Result of the DescribeEntityRecognizer operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws ResourceNotFoundException
* The specified resource ARN was not found. Check the ARN and try your request again.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.DescribeEntityRecognizer
* @see AWS API Documentation
*/
DescribeEntityRecognizerResult describeEntityRecognizer(DescribeEntityRecognizerRequest describeEntityRecognizerRequest);
/**
*
* Gets the status and details of an events detection job.
*
*
* @param describeEventsDetectionJobRequest
* @return Result of the DescribeEventsDetectionJob operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws JobNotFoundException
* The specified job was not found. Check the job ID and try again.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.DescribeEventsDetectionJob
* @see AWS API Documentation
*/
DescribeEventsDetectionJobResult describeEventsDetectionJob(DescribeEventsDetectionJobRequest describeEventsDetectionJobRequest);
/**
*
* Gets the properties associated with a key phrases detection job. Use this operation to get the status of a
* detection job.
*
*
* @param describeKeyPhrasesDetectionJobRequest
* @return Result of the DescribeKeyPhrasesDetectionJob operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws JobNotFoundException
* The specified job was not found. Check the job ID and try again.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.DescribeKeyPhrasesDetectionJob
* @see AWS API Documentation
*/
DescribeKeyPhrasesDetectionJobResult describeKeyPhrasesDetectionJob(DescribeKeyPhrasesDetectionJobRequest describeKeyPhrasesDetectionJobRequest);
/**
*
* 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 Result of the DescribePiiEntitiesDetectionJob operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws JobNotFoundException
* The specified job was not found. Check the job ID and try again.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.DescribePiiEntitiesDetectionJob
* @see AWS API Documentation
*/
DescribePiiEntitiesDetectionJobResult describePiiEntitiesDetectionJob(DescribePiiEntitiesDetectionJobRequest describePiiEntitiesDetectionJobRequest);
/**
*
* 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 Result of the DescribeResourcePolicy operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws ResourceNotFoundException
* The specified resource ARN was not found. Check the ARN and try your request again.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.DescribeResourcePolicy
* @see AWS API Documentation
*/
DescribeResourcePolicyResult describeResourcePolicy(DescribeResourcePolicyRequest describeResourcePolicyRequest);
/**
*
* Gets the properties associated with a sentiment detection job. Use this operation to get the status of a
* detection job.
*
*
* @param describeSentimentDetectionJobRequest
* @return Result of the DescribeSentimentDetectionJob operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws JobNotFoundException
* The specified job was not found. Check the job ID and try again.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.DescribeSentimentDetectionJob
* @see AWS API Documentation
*/
DescribeSentimentDetectionJobResult describeSentimentDetectionJob(DescribeSentimentDetectionJobRequest describeSentimentDetectionJobRequest);
/**
*
* Gets the properties associated with a topic detection job. Use this operation to get the status of a detection
* job.
*
*
* @param describeTopicsDetectionJobRequest
* @return Result of the DescribeTopicsDetectionJob operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws JobNotFoundException
* The specified job was not found. Check the job ID and try again.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.DescribeTopicsDetectionJob
* @see AWS API Documentation
*/
DescribeTopicsDetectionJobResult describeTopicsDetectionJob(DescribeTopicsDetectionJobRequest describeTopicsDetectionJobRequest);
/**
*
* 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 Result of the DetectDominantLanguage operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TextSizeLimitExceededException
* The size of the input text exceeds the limit. Use a smaller document.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.DetectDominantLanguage
* @see AWS API Documentation
*/
DetectDominantLanguageResult detectDominantLanguage(DetectDominantLanguageRequest detectDominantLanguageRequest);
/**
*
* Inspects text for named entities, and returns information about them. For more information, about named entities,
* see how-entities.
*
*
* @param detectEntitiesRequest
* @return Result of the DetectEntities operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws ResourceUnavailableException
* The specified resource is not available. Check the resource and try your request again.
* @throws TextSizeLimitExceededException
* The size of the input text exceeds the limit. Use a smaller document.
* @throws UnsupportedLanguageException
* Amazon Comprehend can't process the language of the input text. For custom entity recognition APIs, only
* English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages,
* see supported-languages.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.DetectEntities
* @see AWS API
* Documentation
*/
DetectEntitiesResult detectEntities(DetectEntitiesRequest detectEntitiesRequest);
/**
*
* Detects the key noun phrases found in the text.
*
*
* @param detectKeyPhrasesRequest
* @return Result of the DetectKeyPhrases operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TextSizeLimitExceededException
* The size of the input text exceeds the limit. Use a smaller document.
* @throws UnsupportedLanguageException
* Amazon Comprehend can't process the language of the input text. For custom entity recognition APIs, only
* English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages,
* see supported-languages.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.DetectKeyPhrases
* @see AWS
* API Documentation
*/
DetectKeyPhrasesResult detectKeyPhrases(DetectKeyPhrasesRequest detectKeyPhrasesRequest);
/**
*
* Inspects the input text for entities that contain personally identifiable information (PII) and returns
* information about them.
*
*
* @param detectPiiEntitiesRequest
* @return Result of the DetectPiiEntities operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TextSizeLimitExceededException
* The size of the input text exceeds the limit. Use a smaller document.
* @throws UnsupportedLanguageException
* Amazon Comprehend can't process the language of the input text. For custom entity recognition APIs, only
* English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages,
* see supported-languages.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.DetectPiiEntities
* @see AWS
* API Documentation
*/
DetectPiiEntitiesResult detectPiiEntities(DetectPiiEntitiesRequest detectPiiEntitiesRequest);
/**
*
* Inspects text and returns an inference of the prevailing sentiment (POSITIVE, NEUTRAL,
* MIXED, or NEGATIVE).
*
*
* @param detectSentimentRequest
* @return Result of the DetectSentiment operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TextSizeLimitExceededException
* The size of the input text exceeds the limit. Use a smaller document.
* @throws UnsupportedLanguageException
* Amazon Comprehend can't process the language of the input text. For custom entity recognition APIs, only
* English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages,
* see supported-languages.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.DetectSentiment
* @see AWS API
* Documentation
*/
DetectSentimentResult detectSentiment(DetectSentimentRequest detectSentimentRequest);
/**
*
* Inspects text for syntax and the part of speech of words in the document. For more information,
* how-syntax.
*
*
* @param detectSyntaxRequest
* @return Result of the DetectSyntax operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TextSizeLimitExceededException
* The size of the input text exceeds the limit. Use a smaller document.
* @throws UnsupportedLanguageException
* Amazon Comprehend can't process the language of the input text. For custom entity recognition APIs, only
* English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages,
* see supported-languages.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.DetectSyntax
* @see AWS API
* Documentation
*/
DetectSyntaxResult detectSyntax(DetectSyntaxRequest detectSyntaxRequest);
/**
*
* Creates a new custom model that replicates a source custom model that you import. The source model can be in your
* AWS account or another one.
*
*
* If the source model is in another AWS account, then it must have a resource-based policy that authorizes you to
* import it.
*
*
* The source model must be in the same AWS region that you're using when you import. You can't import a model
* that's in a different region.
*
*
* @param importModelRequest
* @return Result of the ImportModel operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws ResourceNotFoundException
* The specified resource ARN was not found. Check the ARN and try your request again.
* @throws ResourceInUseException
* The specified resource name is already in use. Use a different name and try your request again.
* @throws ResourceUnavailableException
* The specified resource is not available. Check the resource and try your request again.
* @throws TooManyTagsException
* The request contains more tags than can be associated with a resource (50 tags per resource). The maximum
* number of tags includes both existing tags and those included in your current request.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws ResourceLimitExceededException
* The maximum number of resources per account has been exceeded. Review the resources, and then try your
* request again.
* @throws KmsKeyValidationException
* The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.ImportModel
* @see AWS API
* Documentation
*/
ImportModelResult importModel(ImportModelRequest importModelRequest);
/**
*
* Gets a list of the documentation classification jobs that you have submitted.
*
*
* @param listDocumentClassificationJobsRequest
* @return Result of the ListDocumentClassificationJobs operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws InvalidFilterException
* The filter specified for the operation is invalid. Specify a different filter.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.ListDocumentClassificationJobs
* @see AWS API Documentation
*/
ListDocumentClassificationJobsResult listDocumentClassificationJobs(ListDocumentClassificationJobsRequest listDocumentClassificationJobsRequest);
/**
*
* Gets a list of summaries of the document classifiers that you have created
*
*
* @param listDocumentClassifierSummariesRequest
* @return Result of the ListDocumentClassifierSummaries operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.ListDocumentClassifierSummaries
* @see AWS API Documentation
*/
ListDocumentClassifierSummariesResult listDocumentClassifierSummaries(ListDocumentClassifierSummariesRequest listDocumentClassifierSummariesRequest);
/**
*
* Gets a list of the document classifiers that you have created.
*
*
* @param listDocumentClassifiersRequest
* @return Result of the ListDocumentClassifiers operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws InvalidFilterException
* The filter specified for the operation is invalid. Specify a different filter.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.ListDocumentClassifiers
* @see AWS API Documentation
*/
ListDocumentClassifiersResult listDocumentClassifiers(ListDocumentClassifiersRequest listDocumentClassifiersRequest);
/**
*
* Gets a list of the dominant language detection jobs that you have submitted.
*
*
* @param listDominantLanguageDetectionJobsRequest
* @return Result of the ListDominantLanguageDetectionJobs operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws InvalidFilterException
* The filter specified for the operation is invalid. Specify a different filter.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.ListDominantLanguageDetectionJobs
* @see AWS API Documentation
*/
ListDominantLanguageDetectionJobsResult listDominantLanguageDetectionJobs(ListDominantLanguageDetectionJobsRequest listDominantLanguageDetectionJobsRequest);
/**
*
* Gets a list of all existing endpoints that you've created.
*
*
* @param listEndpointsRequest
* @return Result of the ListEndpoints operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.ListEndpoints
* @see AWS API
* Documentation
*/
ListEndpointsResult listEndpoints(ListEndpointsRequest listEndpointsRequest);
/**
*
* Gets a list of the entity detection jobs that you have submitted.
*
*
* @param listEntitiesDetectionJobsRequest
* @return Result of the ListEntitiesDetectionJobs operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws InvalidFilterException
* The filter specified for the operation is invalid. Specify a different filter.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.ListEntitiesDetectionJobs
* @see AWS API Documentation
*/
ListEntitiesDetectionJobsResult listEntitiesDetectionJobs(ListEntitiesDetectionJobsRequest listEntitiesDetectionJobsRequest);
/**
*
* Gets a list of summaries for the entity recognizers that you have created.
*
*
* @param listEntityRecognizerSummariesRequest
* @return Result of the ListEntityRecognizerSummaries operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.ListEntityRecognizerSummaries
* @see AWS API Documentation
*/
ListEntityRecognizerSummariesResult listEntityRecognizerSummaries(ListEntityRecognizerSummariesRequest listEntityRecognizerSummariesRequest);
/**
*
* 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 Result of the ListEntityRecognizers operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws InvalidFilterException
* The filter specified for the operation is invalid. Specify a different filter.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.ListEntityRecognizers
* @see AWS API Documentation
*/
ListEntityRecognizersResult listEntityRecognizers(ListEntityRecognizersRequest listEntityRecognizersRequest);
/**
*
* Gets a list of the events detection jobs that you have submitted.
*
*
* @param listEventsDetectionJobsRequest
* @return Result of the ListEventsDetectionJobs operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws InvalidFilterException
* The filter specified for the operation is invalid. Specify a different filter.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.ListEventsDetectionJobs
* @see AWS API Documentation
*/
ListEventsDetectionJobsResult listEventsDetectionJobs(ListEventsDetectionJobsRequest listEventsDetectionJobsRequest);
/**
*
* Get a list of key phrase detection jobs that you have submitted.
*
*
* @param listKeyPhrasesDetectionJobsRequest
* @return Result of the ListKeyPhrasesDetectionJobs operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws InvalidFilterException
* The filter specified for the operation is invalid. Specify a different filter.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.ListKeyPhrasesDetectionJobs
* @see AWS API Documentation
*/
ListKeyPhrasesDetectionJobsResult listKeyPhrasesDetectionJobs(ListKeyPhrasesDetectionJobsRequest listKeyPhrasesDetectionJobsRequest);
/**
*
* Gets a list of the PII entity detection jobs that you have submitted.
*
*
* @param listPiiEntitiesDetectionJobsRequest
* @return Result of the ListPiiEntitiesDetectionJobs operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws InvalidFilterException
* The filter specified for the operation is invalid. Specify a different filter.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.ListPiiEntitiesDetectionJobs
* @see AWS API Documentation
*/
ListPiiEntitiesDetectionJobsResult listPiiEntitiesDetectionJobs(ListPiiEntitiesDetectionJobsRequest listPiiEntitiesDetectionJobsRequest);
/**
*
* Gets a list of sentiment detection jobs that you have submitted.
*
*
* @param listSentimentDetectionJobsRequest
* @return Result of the ListSentimentDetectionJobs operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws InvalidFilterException
* The filter specified for the operation is invalid. Specify a different filter.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.ListSentimentDetectionJobs
* @see AWS API Documentation
*/
ListSentimentDetectionJobsResult listSentimentDetectionJobs(ListSentimentDetectionJobsRequest listSentimentDetectionJobsRequest);
/**
*
* Lists all tags associated with a given Amazon Comprehend resource.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws ResourceNotFoundException
* The specified resource ARN was not found. Check the ARN and try your request again.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.ListTagsForResource
* @see AWS
* API Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Gets a list of the topic detection jobs that you have submitted.
*
*
* @param listTopicsDetectionJobsRequest
* @return Result of the ListTopicsDetectionJobs operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws InvalidFilterException
* The filter specified for the operation is invalid. Specify a different filter.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.ListTopicsDetectionJobs
* @see AWS API Documentation
*/
ListTopicsDetectionJobsResult listTopicsDetectionJobs(ListTopicsDetectionJobsRequest listTopicsDetectionJobsRequest);
/**
*
* Attaches a resource-based policy to a custom model. You can use this policy to authorize an entity in another AWS
* account to import the custom model, which replicates it in Amazon Comprehend in their account.
*
*
* @param putResourcePolicyRequest
* @return Result of the PutResourcePolicy operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws ResourceNotFoundException
* The specified resource ARN was not found. Check the ARN and try your request again.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.PutResourcePolicy
* @see AWS
* API Documentation
*/
PutResourcePolicyResult putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest);
/**
*
* Starts an asynchronous document classification job. Use the operation to track the progress of the job.
*
*
* @param startDocumentClassificationJobRequest
* @return Result of the StartDocumentClassificationJob operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws ResourceNotFoundException
* The specified resource ARN was not found. Check the ARN and try your request again.
* @throws ResourceUnavailableException
* The specified resource is not available. Check the resource and try your request again.
* @throws KmsKeyValidationException
* The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
* @throws TooManyTagsException
* The request contains more tags than can be associated with a resource (50 tags per resource). The maximum
* number of tags includes both existing tags and those included in your current request.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.StartDocumentClassificationJob
* @see AWS API Documentation
*/
StartDocumentClassificationJobResult startDocumentClassificationJob(StartDocumentClassificationJobRequest startDocumentClassificationJobRequest);
/**
*
* 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 Result of the StartDominantLanguageDetectionJob operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws KmsKeyValidationException
* The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
* @throws TooManyTagsException
* The request contains more tags than can be associated with a resource (50 tags per resource). The maximum
* number of tags includes both existing tags and those included in your current request.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.StartDominantLanguageDetectionJob
* @see AWS API Documentation
*/
StartDominantLanguageDetectionJobResult startDominantLanguageDetectionJob(StartDominantLanguageDetectionJobRequest startDominantLanguageDetectionJobRequest);
/**
*
* 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 Result of the StartEntitiesDetectionJob operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws ResourceNotFoundException
* The specified resource ARN was not found. Check the ARN and try your request again.
* @throws ResourceUnavailableException
* The specified resource is not available. Check the resource and try your request again.
* @throws KmsKeyValidationException
* The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
* @throws TooManyTagsException
* The request contains more tags than can be associated with a resource (50 tags per resource). The maximum
* number of tags includes both existing tags and those included in your current request.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.StartEntitiesDetectionJob
* @see AWS API Documentation
*/
StartEntitiesDetectionJobResult startEntitiesDetectionJob(StartEntitiesDetectionJobRequest startEntitiesDetectionJobRequest);
/**
*
* Starts an asynchronous event detection job for a collection of documents.
*
*
* @param startEventsDetectionJobRequest
* @return Result of the StartEventsDetectionJob operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws KmsKeyValidationException
* The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
* @throws TooManyTagsException
* The request contains more tags than can be associated with a resource (50 tags per resource). The maximum
* number of tags includes both existing tags and those included in your current request.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.StartEventsDetectionJob
* @see AWS API Documentation
*/
StartEventsDetectionJobResult startEventsDetectionJob(StartEventsDetectionJobRequest startEventsDetectionJobRequest);
/**
*
* 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 Result of the StartKeyPhrasesDetectionJob operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws KmsKeyValidationException
* The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
* @throws TooManyTagsException
* The request contains more tags than can be associated with a resource (50 tags per resource). The maximum
* number of tags includes both existing tags and those included in your current request.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.StartKeyPhrasesDetectionJob
* @see AWS API Documentation
*/
StartKeyPhrasesDetectionJobResult startKeyPhrasesDetectionJob(StartKeyPhrasesDetectionJobRequest startKeyPhrasesDetectionJobRequest);
/**
*
* Starts an asynchronous PII entity detection job for a collection of documents.
*
*
* @param startPiiEntitiesDetectionJobRequest
* @return Result of the StartPiiEntitiesDetectionJob operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws KmsKeyValidationException
* The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
* @throws TooManyTagsException
* The request contains more tags than can be associated with a resource (50 tags per resource). The maximum
* number of tags includes both existing tags and those included in your current request.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.StartPiiEntitiesDetectionJob
* @see AWS API Documentation
*/
StartPiiEntitiesDetectionJobResult startPiiEntitiesDetectionJob(StartPiiEntitiesDetectionJobRequest startPiiEntitiesDetectionJobRequest);
/**
*
* Starts an asynchronous sentiment detection job for a collection of documents. use the operation to track the
* status of a job.
*
*
* @param startSentimentDetectionJobRequest
* @return Result of the StartSentimentDetectionJob operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws KmsKeyValidationException
* The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
* @throws TooManyTagsException
* The request contains more tags than can be associated with a resource (50 tags per resource). The maximum
* number of tags includes both existing tags and those included in your current request.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.StartSentimentDetectionJob
* @see AWS API Documentation
*/
StartSentimentDetectionJobResult startSentimentDetectionJob(StartSentimentDetectionJobRequest startSentimentDetectionJobRequest);
/**
*
* Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob operation to track the
* status of a job.
*
*
* @param startTopicsDetectionJobRequest
* @return Result of the StartTopicsDetectionJob operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws KmsKeyValidationException
* The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
* @throws TooManyTagsException
* The request contains more tags than can be associated with a resource (50 tags per resource). The maximum
* number of tags includes both existing tags and those included in your current request.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.StartTopicsDetectionJob
* @see AWS API Documentation
*/
StartTopicsDetectionJobResult startTopicsDetectionJob(StartTopicsDetectionJobRequest startTopicsDetectionJobRequest);
/**
*
* 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 Result of the StopDominantLanguageDetectionJob operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws JobNotFoundException
* The specified job was not found. Check the job ID and try again.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.StopDominantLanguageDetectionJob
* @see AWS API Documentation
*/
StopDominantLanguageDetectionJobResult stopDominantLanguageDetectionJob(StopDominantLanguageDetectionJobRequest stopDominantLanguageDetectionJobRequest);
/**
*
* 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 Result of the StopEntitiesDetectionJob operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws JobNotFoundException
* The specified job was not found. Check the job ID and try again.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.StopEntitiesDetectionJob
* @see AWS API Documentation
*/
StopEntitiesDetectionJobResult stopEntitiesDetectionJob(StopEntitiesDetectionJobRequest stopEntitiesDetectionJobRequest);
/**
*
* Stops an events detection job in progress.
*
*
* @param stopEventsDetectionJobRequest
* @return Result of the StopEventsDetectionJob operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws JobNotFoundException
* The specified job was not found. Check the job ID and try again.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.StopEventsDetectionJob
* @see AWS API Documentation
*/
StopEventsDetectionJobResult stopEventsDetectionJob(StopEventsDetectionJobRequest stopEventsDetectionJobRequest);
/**
*
* 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 Result of the StopKeyPhrasesDetectionJob operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws JobNotFoundException
* The specified job was not found. Check the job ID and try again.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.StopKeyPhrasesDetectionJob
* @see AWS API Documentation
*/
StopKeyPhrasesDetectionJobResult stopKeyPhrasesDetectionJob(StopKeyPhrasesDetectionJobRequest stopKeyPhrasesDetectionJobRequest);
/**
*
* Stops a PII entities detection job in progress.
*
*
* @param stopPiiEntitiesDetectionJobRequest
* @return Result of the StopPiiEntitiesDetectionJob operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws JobNotFoundException
* The specified job was not found. Check the job ID and try again.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.StopPiiEntitiesDetectionJob
* @see AWS API Documentation
*/
StopPiiEntitiesDetectionJobResult stopPiiEntitiesDetectionJob(StopPiiEntitiesDetectionJobRequest stopPiiEntitiesDetectionJobRequest);
/**
*
* 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 Result of the StopSentimentDetectionJob operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws JobNotFoundException
* The specified job was not found. Check the job ID and try again.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.StopSentimentDetectionJob
* @see AWS API Documentation
*/
StopSentimentDetectionJobResult stopSentimentDetectionJob(StopSentimentDetectionJobRequest stopSentimentDetectionJobRequest);
/**
*
* 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 Result of the StopTrainingDocumentClassifier operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws ResourceNotFoundException
* The specified resource ARN was not found. Check the ARN and try your request again.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.StopTrainingDocumentClassifier
* @see AWS API Documentation
*/
StopTrainingDocumentClassifierResult stopTrainingDocumentClassifier(StopTrainingDocumentClassifierRequest stopTrainingDocumentClassifierRequest);
/**
*
* 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 Result of the StopTrainingEntityRecognizer operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws ResourceNotFoundException
* The specified resource ARN was not found. Check the ARN and try your request again.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.StopTrainingEntityRecognizer
* @see AWS API Documentation
*/
StopTrainingEntityRecognizerResult stopTrainingEntityRecognizer(StopTrainingEntityRecognizerRequest stopTrainingEntityRecognizerRequest);
/**
*
* 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 Result of the TagResource operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws ConcurrentModificationException
* Concurrent modification of the tags associated with an Amazon Comprehend resource is not supported.
* @throws ResourceNotFoundException
* The specified resource ARN was not found. Check the ARN and try your request again.
* @throws TooManyTagsException
* The request contains more tags than can be associated with a resource (50 tags per resource). The maximum
* number of tags includes both existing tags and those included in your current request.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.TagResource
* @see AWS API
* Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* Removes a specific tag associated with an Amazon Comprehend resource.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws TooManyTagKeysException
* The request contains more tag keys than can be associated with a resource (50 tag keys per resource).
* @throws InvalidRequestException
* The request is invalid.
* @throws ConcurrentModificationException
* Concurrent modification of the tags associated with an Amazon Comprehend resource is not supported.
* @throws ResourceNotFoundException
* The specified resource ARN was not found. Check the ARN and try your request again.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.UntagResource
* @see AWS API
* Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
* Updates information about the specified endpoint.
*
*
* @param updateEndpointRequest
* @return Result of the UpdateEndpoint operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws ResourceInUseException
* The specified resource name is already in use. Use a different name and try your request again.
* @throws ResourceLimitExceededException
* The maximum number of resources per account has been exceeded. Review the resources, and then try your
* request again.
* @throws ResourceNotFoundException
* The specified resource ARN was not found. Check the ARN and try your request again.
* @throws ResourceUnavailableException
* The specified resource is not available. Check the resource and try your request again.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.UpdateEndpoint
* @see AWS API
* Documentation
*/
UpdateEndpointResult updateEndpoint(UpdateEndpointRequest updateEndpointRequest);
/**
* 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.
*/
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.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}