@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonComprehendClient extends AmazonWebServiceClient implements AmazonComprehend
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.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
BatchDetectDominantLanguageResult |
batchDetectDominantLanguage(BatchDetectDominantLanguageRequest request)
Determines the dominant language of the input text for a batch of documents.
|
BatchDetectEntitiesResult |
batchDetectEntities(BatchDetectEntitiesRequest request)
Inspects the text of a batch of documents for named entities and returns information about them.
|
BatchDetectKeyPhrasesResult |
batchDetectKeyPhrases(BatchDetectKeyPhrasesRequest request)
Detects the key noun phrases found in a batch of documents.
|
BatchDetectSentimentResult |
batchDetectSentiment(BatchDetectSentimentRequest request)
Inspects a batch of documents and returns an inference of the prevailing sentiment,
POSITIVE ,
NEUTRAL , MIXED , or NEGATIVE , in each one. |
BatchDetectSyntaxResult |
batchDetectSyntax(BatchDetectSyntaxRequest request)
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.
|
BatchDetectTargetedSentimentResult |
batchDetectTargetedSentiment(BatchDetectTargetedSentimentRequest request)
Inspects a batch of documents and returns a sentiment analysis for each entity identified in the documents.
|
static AmazonComprehendClientBuilder |
builder() |
ClassifyDocumentResult |
classifyDocument(ClassifyDocumentRequest request)
Creates a classification request to analyze a single document in real-time.
|
ContainsPiiEntitiesResult |
containsPiiEntities(ContainsPiiEntitiesRequest request)
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.
|
CreateDatasetResult |
createDataset(CreateDatasetRequest request)
Creates a dataset to upload training or test data for a model associated with a flywheel.
|
CreateDocumentClassifierResult |
createDocumentClassifier(CreateDocumentClassifierRequest request)
Creates a new document classifier that you can use to categorize documents.
|
CreateEndpointResult |
createEndpoint(CreateEndpointRequest request)
Creates a model-specific endpoint for synchronous inference for a previously trained custom model For information
about endpoints, see Managing
endpoints.
|
CreateEntityRecognizerResult |
createEntityRecognizer(CreateEntityRecognizerRequest request)
Creates an entity recognizer using submitted files.
|
CreateFlywheelResult |
createFlywheel(CreateFlywheelRequest request)
A flywheel is an Amazon Web Services resource that orchestrates the ongoing training of a model for custom
classification or custom entity recognition.
|
DeleteDocumentClassifierResult |
deleteDocumentClassifier(DeleteDocumentClassifierRequest request)
Deletes a previously created document classifier
|
DeleteEndpointResult |
deleteEndpoint(DeleteEndpointRequest request)
Deletes a model-specific endpoint for a previously-trained custom model.
|
DeleteEntityRecognizerResult |
deleteEntityRecognizer(DeleteEntityRecognizerRequest request)
Deletes an entity recognizer.
|
DeleteFlywheelResult |
deleteFlywheel(DeleteFlywheelRequest request)
Deletes a flywheel.
|
DeleteResourcePolicyResult |
deleteResourcePolicy(DeleteResourcePolicyRequest request)
Deletes a resource-based policy that is attached to a custom model.
|
DescribeDatasetResult |
describeDataset(DescribeDatasetRequest request)
Returns information about the dataset that you specify.
|
DescribeDocumentClassificationJobResult |
describeDocumentClassificationJob(DescribeDocumentClassificationJobRequest request)
Gets the properties associated with a document classification job.
|
DescribeDocumentClassifierResult |
describeDocumentClassifier(DescribeDocumentClassifierRequest request)
Gets the properties associated with a document classifier.
|
DescribeDominantLanguageDetectionJobResult |
describeDominantLanguageDetectionJob(DescribeDominantLanguageDetectionJobRequest request)
Gets the properties associated with a dominant language detection job.
|
DescribeEndpointResult |
describeEndpoint(DescribeEndpointRequest request)
Gets the properties associated with a specific endpoint.
|
DescribeEntitiesDetectionJobResult |
describeEntitiesDetectionJob(DescribeEntitiesDetectionJobRequest request)
Gets the properties associated with an entities detection job.
|
DescribeEntityRecognizerResult |
describeEntityRecognizer(DescribeEntityRecognizerRequest request)
Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer
metadata, metrics, and so on.
|
DescribeEventsDetectionJobResult |
describeEventsDetectionJob(DescribeEventsDetectionJobRequest request)
Gets the status and details of an events detection job.
|
DescribeFlywheelResult |
describeFlywheel(DescribeFlywheelRequest request)
Provides configuration information about the flywheel.
|
DescribeFlywheelIterationResult |
describeFlywheelIteration(DescribeFlywheelIterationRequest request)
Retrieve the configuration properties of a flywheel iteration.
|
DescribeKeyPhrasesDetectionJobResult |
describeKeyPhrasesDetectionJob(DescribeKeyPhrasesDetectionJobRequest request)
Gets the properties associated with a key phrases detection job.
|
DescribePiiEntitiesDetectionJobResult |
describePiiEntitiesDetectionJob(DescribePiiEntitiesDetectionJobRequest request)
Gets the properties associated with a PII entities detection job.
|
DescribeResourcePolicyResult |
describeResourcePolicy(DescribeResourcePolicyRequest request)
Gets the details of a resource-based policy that is attached to a custom model, including the JSON body of the
policy.
|
DescribeSentimentDetectionJobResult |
describeSentimentDetectionJob(DescribeSentimentDetectionJobRequest request)
Gets the properties associated with a sentiment detection job.
|
DescribeTargetedSentimentDetectionJobResult |
describeTargetedSentimentDetectionJob(DescribeTargetedSentimentDetectionJobRequest request)
Gets the properties associated with a targeted sentiment detection job.
|
DescribeTopicsDetectionJobResult |
describeTopicsDetectionJob(DescribeTopicsDetectionJobRequest request)
Gets the properties associated with a topic detection job.
|
DetectDominantLanguageResult |
detectDominantLanguage(DetectDominantLanguageRequest request)
Determines the dominant language of the input text.
|
DetectEntitiesResult |
detectEntities(DetectEntitiesRequest request)
Detects named entities in input text when you use the pre-trained model.
|
DetectKeyPhrasesResult |
detectKeyPhrases(DetectKeyPhrasesRequest request)
Detects the key noun phrases found in the text.
|
DetectPiiEntitiesResult |
detectPiiEntities(DetectPiiEntitiesRequest request)
Inspects the input text for entities that contain personally identifiable information (PII) and returns
information about them.
|
DetectSentimentResult |
detectSentiment(DetectSentimentRequest request)
Inspects text and returns an inference of the prevailing sentiment (
POSITIVE , NEUTRAL ,
MIXED , or NEGATIVE ). |
DetectSyntaxResult |
detectSyntax(DetectSyntaxRequest request)
Inspects text for syntax and the part of speech of words in the document.
|
DetectTargetedSentimentResult |
detectTargetedSentiment(DetectTargetedSentimentRequest request)
Inspects the input text and returns a sentiment analysis for each entity identified in the text.
|
DetectToxicContentResult |
detectToxicContent(DetectToxicContentRequest request)
Performs toxicity analysis on the list of text strings that you provide as input.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
ImportModelResult |
importModel(ImportModelRequest request)
Creates a new custom model that replicates a source custom model that you import.
|
ListDatasetsResult |
listDatasets(ListDatasetsRequest request)
List the datasets that you have configured in this Region.
|
ListDocumentClassificationJobsResult |
listDocumentClassificationJobs(ListDocumentClassificationJobsRequest request)
Gets a list of the documentation classification jobs that you have submitted.
|
ListDocumentClassifiersResult |
listDocumentClassifiers(ListDocumentClassifiersRequest request)
Gets a list of the document classifiers that you have created.
|
ListDocumentClassifierSummariesResult |
listDocumentClassifierSummaries(ListDocumentClassifierSummariesRequest request)
Gets a list of summaries of the document classifiers that you have created
|
ListDominantLanguageDetectionJobsResult |
listDominantLanguageDetectionJobs(ListDominantLanguageDetectionJobsRequest request)
Gets a list of the dominant language detection jobs that you have submitted.
|
ListEndpointsResult |
listEndpoints(ListEndpointsRequest request)
Gets a list of all existing endpoints that you've created.
|
ListEntitiesDetectionJobsResult |
listEntitiesDetectionJobs(ListEntitiesDetectionJobsRequest request)
Gets a list of the entity detection jobs that you have submitted.
|
ListEntityRecognizersResult |
listEntityRecognizers(ListEntityRecognizersRequest request)
Gets a list of the properties of all entity recognizers that you created, including recognizers currently in
training.
|
ListEntityRecognizerSummariesResult |
listEntityRecognizerSummaries(ListEntityRecognizerSummariesRequest request)
Gets a list of summaries for the entity recognizers that you have created.
|
ListEventsDetectionJobsResult |
listEventsDetectionJobs(ListEventsDetectionJobsRequest request)
Gets a list of the events detection jobs that you have submitted.
|
ListFlywheelIterationHistoryResult |
listFlywheelIterationHistory(ListFlywheelIterationHistoryRequest request)
Information about the history of a flywheel iteration.
|
ListFlywheelsResult |
listFlywheels(ListFlywheelsRequest request)
Gets a list of the flywheels that you have created.
|
ListKeyPhrasesDetectionJobsResult |
listKeyPhrasesDetectionJobs(ListKeyPhrasesDetectionJobsRequest request)
Get a list of key phrase detection jobs that you have submitted.
|
ListPiiEntitiesDetectionJobsResult |
listPiiEntitiesDetectionJobs(ListPiiEntitiesDetectionJobsRequest request)
Gets a list of the PII entity detection jobs that you have submitted.
|
ListSentimentDetectionJobsResult |
listSentimentDetectionJobs(ListSentimentDetectionJobsRequest request)
Gets a list of sentiment detection jobs that you have submitted.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Lists all tags associated with a given Amazon Comprehend resource.
|
ListTargetedSentimentDetectionJobsResult |
listTargetedSentimentDetectionJobs(ListTargetedSentimentDetectionJobsRequest request)
Gets a list of targeted sentiment detection jobs that you have submitted.
|
ListTopicsDetectionJobsResult |
listTopicsDetectionJobs(ListTopicsDetectionJobsRequest request)
Gets a list of the topic detection jobs that you have submitted.
|
PutResourcePolicyResult |
putResourcePolicy(PutResourcePolicyRequest request)
Attaches a resource-based policy to a custom model.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
StartDocumentClassificationJobResult |
startDocumentClassificationJob(StartDocumentClassificationJobRequest request)
Starts an asynchronous document classification job.
|
StartDominantLanguageDetectionJobResult |
startDominantLanguageDetectionJob(StartDominantLanguageDetectionJobRequest request)
Starts an asynchronous dominant language detection job for a collection of documents.
|
StartEntitiesDetectionJobResult |
startEntitiesDetectionJob(StartEntitiesDetectionJobRequest request)
Starts an asynchronous entity detection job for a collection of documents.
|
StartEventsDetectionJobResult |
startEventsDetectionJob(StartEventsDetectionJobRequest request)
Starts an asynchronous event detection job for a collection of documents.
|
StartFlywheelIterationResult |
startFlywheelIteration(StartFlywheelIterationRequest request)
Start the flywheel iteration.This operation uses any new datasets to train a new model version.
|
StartKeyPhrasesDetectionJobResult |
startKeyPhrasesDetectionJob(StartKeyPhrasesDetectionJobRequest request)
Starts an asynchronous key phrase detection job for a collection of documents.
|
StartPiiEntitiesDetectionJobResult |
startPiiEntitiesDetectionJob(StartPiiEntitiesDetectionJobRequest request)
Starts an asynchronous PII entity detection job for a collection of documents.
|
StartSentimentDetectionJobResult |
startSentimentDetectionJob(StartSentimentDetectionJobRequest request)
Starts an asynchronous sentiment detection job for a collection of documents.
|
StartTargetedSentimentDetectionJobResult |
startTargetedSentimentDetectionJob(StartTargetedSentimentDetectionJobRequest request)
Starts an asynchronous targeted sentiment detection job for a collection of documents.
|
StartTopicsDetectionJobResult |
startTopicsDetectionJob(StartTopicsDetectionJobRequest request)
Starts an asynchronous topic detection job.
|
StopDominantLanguageDetectionJobResult |
stopDominantLanguageDetectionJob(StopDominantLanguageDetectionJobRequest request)
Stops a dominant language detection job in progress.
|
StopEntitiesDetectionJobResult |
stopEntitiesDetectionJob(StopEntitiesDetectionJobRequest request)
Stops an entities detection job in progress.
|
StopEventsDetectionJobResult |
stopEventsDetectionJob(StopEventsDetectionJobRequest request)
Stops an events detection job in progress.
|
StopKeyPhrasesDetectionJobResult |
stopKeyPhrasesDetectionJob(StopKeyPhrasesDetectionJobRequest request)
Stops a key phrases detection job in progress.
|
StopPiiEntitiesDetectionJobResult |
stopPiiEntitiesDetectionJob(StopPiiEntitiesDetectionJobRequest request)
Stops a PII entities detection job in progress.
|
StopSentimentDetectionJobResult |
stopSentimentDetectionJob(StopSentimentDetectionJobRequest request)
Stops a sentiment detection job in progress.
|
StopTargetedSentimentDetectionJobResult |
stopTargetedSentimentDetectionJob(StopTargetedSentimentDetectionJobRequest request)
Stops a targeted sentiment detection job in progress.
|
StopTrainingDocumentClassifierResult |
stopTrainingDocumentClassifier(StopTrainingDocumentClassifierRequest request)
Stops a document classifier training job while in progress.
|
StopTrainingEntityRecognizerResult |
stopTrainingEntityRecognizer(StopTrainingEntityRecognizerRequest request)
Stops an entity recognizer training job while in progress.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Associates a specific tag with an Amazon Comprehend resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes a specific tag associated with an Amazon Comprehend resource.
|
UpdateEndpointResult |
updateEndpoint(UpdateEndpointRequest request)
Updates information about the specified endpoint.
|
UpdateFlywheelResult |
updateFlywheel(UpdateFlywheelRequest request)
Update the configuration information for an existing flywheel.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
public static AmazonComprehendClientBuilder builder()
public BatchDetectDominantLanguageResult batchDetectDominantLanguage(BatchDetectDominantLanguageRequest request)
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.
batchDetectDominantLanguage
in interface AmazonComprehend
batchDetectDominantLanguageRequest
- InvalidRequestException
- The request is invalid.TextSizeLimitExceededException
- The size of the input text exceeds the limit. Use a smaller document.BatchSizeLimitExceededException
- The number of documents in the request exceeds the limit of 25. Try your request again with fewer
documents.InternalServerException
- An internal server error occurred. Retry your request.public BatchDetectEntitiesResult batchDetectEntities(BatchDetectEntitiesRequest request)
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.
batchDetectEntities
in interface AmazonComprehend
batchDetectEntitiesRequest
- InvalidRequestException
- The request is invalid.TextSizeLimitExceededException
- The size of the input text exceeds the limit. Use a smaller document.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,
Supported
languages in the Comprehend Developer Guide.BatchSizeLimitExceededException
- The number of documents in the request exceeds the limit of 25. Try your request again with fewer
documents.InternalServerException
- An internal server error occurred. Retry your request.public BatchDetectKeyPhrasesResult batchDetectKeyPhrases(BatchDetectKeyPhrasesRequest request)
Detects the key noun phrases found in a batch of documents.
batchDetectKeyPhrases
in interface AmazonComprehend
batchDetectKeyPhrasesRequest
- InvalidRequestException
- The request is invalid.TextSizeLimitExceededException
- The size of the input text exceeds the limit. Use a smaller document.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,
Supported
languages in the Comprehend Developer Guide.BatchSizeLimitExceededException
- The number of documents in the request exceeds the limit of 25. Try your request again with fewer
documents.InternalServerException
- An internal server error occurred. Retry your request.public BatchDetectSentimentResult batchDetectSentiment(BatchDetectSentimentRequest request)
Inspects a batch of documents and returns an inference of the prevailing sentiment, POSITIVE
,
NEUTRAL
, MIXED
, or NEGATIVE
, in each one.
batchDetectSentiment
in interface AmazonComprehend
batchDetectSentimentRequest
- InvalidRequestException
- The request is invalid.TextSizeLimitExceededException
- The size of the input text exceeds the limit. Use a smaller document.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,
Supported
languages in the Comprehend Developer Guide.BatchSizeLimitExceededException
- The number of documents in the request exceeds the limit of 25. Try your request again with fewer
documents.InternalServerException
- An internal server error occurred. Retry your request.public BatchDetectSyntaxResult batchDetectSyntax(BatchDetectSyntaxRequest request)
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.
batchDetectSyntax
in interface AmazonComprehend
batchDetectSyntaxRequest
- InvalidRequestException
- The request is invalid.TextSizeLimitExceededException
- The size of the input text exceeds the limit. Use a smaller document.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,
Supported
languages in the Comprehend Developer Guide.BatchSizeLimitExceededException
- The number of documents in the request exceeds the limit of 25. Try your request again with fewer
documents.InternalServerException
- An internal server error occurred. Retry your request.public BatchDetectTargetedSentimentResult batchDetectTargetedSentiment(BatchDetectTargetedSentimentRequest request)
Inspects a batch of documents and returns a sentiment analysis for each entity identified in the documents.
For more information about targeted sentiment, see Targeted sentiment in the Amazon Comprehend Developer Guide.
batchDetectTargetedSentiment
in interface AmazonComprehend
batchDetectTargetedSentimentRequest
- InvalidRequestException
- The request is invalid.TextSizeLimitExceededException
- The size of the input text exceeds the limit. Use a smaller document.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,
Supported
languages in the Comprehend Developer Guide.BatchSizeLimitExceededException
- The number of documents in the request exceeds the limit of 25. Try your request again with fewer
documents.InternalServerException
- An internal server error occurred. Retry your request.public ClassifyDocumentResult classifyDocument(ClassifyDocumentRequest request)
Creates a classification request to analyze a single document in real-time. ClassifyDocument
supports the following model types:
Custom classifier - a custom model that you have created and trained. For input, you can provide plain text, a single-page document (PDF, Word, or image), or Textract API output. For more information, see Custom classification in the Amazon Comprehend Developer Guide.
Prompt classifier - Amazon Comprehend provides a model for classifying prompts. For input, you provide English
plain text input. For prompt classification, the response includes only the Classes
field. For more
information about prompt classifiers, see Prompt classifiers in the
Amazon Comprehend Developer Guide.
If the system detects errors while processing a page in the input document, the API response includes an entry in
Errors
that describes the errors.
If the system detects a document-level error in your input document, the API returns an
InvalidRequestException
error response. For details about this exception, see Errors in semi-structured
documents in the Comprehend Developer Guide.
classifyDocument
in interface AmazonComprehend
classifyDocumentRequest
- InvalidRequestException
- The request is invalid.ResourceUnavailableException
- The specified resource is not available. Check the resource and try your request again.TextSizeLimitExceededException
- The size of the input text exceeds the limit. Use a smaller document.InternalServerException
- An internal server error occurred. Retry your request.public ContainsPiiEntitiesResult containsPiiEntities(ContainsPiiEntitiesRequest request)
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.
containsPiiEntities
in interface AmazonComprehend
containsPiiEntitiesRequest
- InvalidRequestException
- The request is invalid.TextSizeLimitExceededException
- The size of the input text exceeds the limit. Use a smaller document.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,
Supported
languages in the Comprehend Developer Guide.InternalServerException
- An internal server error occurred. Retry your request.public CreateDatasetResult createDataset(CreateDatasetRequest request)
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.
createDataset
in interface AmazonComprehend
createDatasetRequest
- InvalidRequestException
- The request is invalid.ResourceInUseException
- The specified resource name is already in use. Use a different name and try your request again.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.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.ResourceLimitExceededException
- The maximum number of resources per account has been exceeded. Review the resources, and then try your
request again.ResourceNotFoundException
- The specified resource ARN was not found. Check the ARN and try your request again.InternalServerException
- An internal server error occurred. Retry your request.public CreateDocumentClassifierResult createDocumentClassifier(CreateDocumentClassifierRequest request)
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.
createDocumentClassifier
in interface AmazonComprehend
createDocumentClassifierRequest
- InvalidRequestException
- The request is invalid.ResourceInUseException
- The specified resource name is already in use. Use a different name and try your request again.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.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.ResourceLimitExceededException
- The maximum number of resources per account has been exceeded. Review the resources, and then try your
request again.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,
Supported
languages in the Comprehend Developer Guide.KmsKeyValidationException
- The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.InternalServerException
- An internal server error occurred. Retry your request.public CreateEndpointResult createEndpoint(CreateEndpointRequest request)
Creates a model-specific endpoint for synchronous inference for a previously trained custom model For information about endpoints, see Managing endpoints.
createEndpoint
in interface AmazonComprehend
createEndpointRequest
- InvalidRequestException
- The request is invalid.ResourceInUseException
- The specified resource name is already in use. Use a different name and try your request again.ResourceLimitExceededException
- The maximum number of resources per account has been exceeded. Review the resources, and then try your
request again.ResourceNotFoundException
- The specified resource ARN was not found. Check the ARN and try your request again.ResourceUnavailableException
- The specified resource is not available. Check the resource and try your request again.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.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.InternalServerException
- An internal server error occurred. Retry your request.public CreateEntityRecognizerResult createEntityRecognizer(CreateEntityRecognizerRequest request)
Creates an entity recognizer using submitted files. After your CreateEntityRecognizer
request is
submitted, you can check job status using the DescribeEntityRecognizer
API.
createEntityRecognizer
in interface AmazonComprehend
createEntityRecognizerRequest
- InvalidRequestException
- The request is invalid.ResourceInUseException
- The specified resource name is already in use. Use a different name and try your request again.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.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.ResourceLimitExceededException
- The maximum number of resources per account has been exceeded. Review the resources, and then try your
request again.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,
Supported
languages in the Comprehend Developer Guide.KmsKeyValidationException
- The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.InternalServerException
- An internal server error occurred. Retry your request.public CreateFlywheelResult createFlywheel(CreateFlywheelRequest request)
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.
createFlywheel
in interface AmazonComprehend
createFlywheelRequest
- InvalidRequestException
- The request is invalid.ResourceInUseException
- The specified resource name is already in use. Use a different name and try your request again.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.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.ResourceLimitExceededException
- The maximum number of resources per account has been exceeded. Review the resources, and then try your
request again.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,
Supported
languages in the Comprehend Developer Guide.KmsKeyValidationException
- The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.ResourceNotFoundException
- The specified resource ARN was not found. Check the ARN and try your request again.ResourceUnavailableException
- The specified resource is not available. Check the resource and try your request again.InternalServerException
- An internal server error occurred. Retry your request.public DeleteDocumentClassifierResult deleteDocumentClassifier(DeleteDocumentClassifierRequest request)
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.
deleteDocumentClassifier
in interface AmazonComprehend
deleteDocumentClassifierRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.ResourceNotFoundException
- The specified resource ARN was not found. Check the ARN and try your request again.ResourceUnavailableException
- The specified resource is not available. Check the resource and try your request again.ResourceInUseException
- The specified resource name is already in use. Use a different name and try your request again.InternalServerException
- An internal server error occurred. Retry your request.public DeleteEndpointResult deleteEndpoint(DeleteEndpointRequest request)
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.
deleteEndpoint
in interface AmazonComprehend
deleteEndpointRequest
- InvalidRequestException
- The request is invalid.ResourceInUseException
- The specified resource name is already in use. Use a different name and try your request again.ResourceNotFoundException
- The specified resource ARN was not found. Check the ARN and try your request again.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InternalServerException
- An internal server error occurred. Retry your request.public DeleteEntityRecognizerResult deleteEntityRecognizer(DeleteEntityRecognizerRequest request)
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.
deleteEntityRecognizer
in interface AmazonComprehend
deleteEntityRecognizerRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.ResourceNotFoundException
- The specified resource ARN was not found. Check the ARN and try your request again.ResourceUnavailableException
- The specified resource is not available. Check the resource and try your request again.ResourceInUseException
- The specified resource name is already in use. Use a different name and try your request again.InternalServerException
- An internal server error occurred. Retry your request.public DeleteFlywheelResult deleteFlywheel(DeleteFlywheelRequest request)
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.
deleteFlywheel
in interface AmazonComprehend
deleteFlywheelRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.ResourceNotFoundException
- The specified resource ARN was not found. Check the ARN and try your request again.ResourceUnavailableException
- The specified resource is not available. Check the resource and try your request again.ResourceInUseException
- The specified resource name is already in use. Use a different name and try your request again.InternalServerException
- An internal server error occurred. Retry your request.public DeleteResourcePolicyResult deleteResourcePolicy(DeleteResourcePolicyRequest request)
Deletes a resource-based policy that is attached to a custom model.
deleteResourcePolicy
in interface AmazonComprehend
deleteResourcePolicyRequest
- InvalidRequestException
- The request is invalid.ResourceNotFoundException
- The specified resource ARN was not found. Check the ARN and try your request again.InternalServerException
- An internal server error occurred. Retry your request.public DescribeDatasetResult describeDataset(DescribeDatasetRequest request)
Returns information about the dataset that you specify. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.
describeDataset
in interface AmazonComprehend
describeDatasetRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.ResourceNotFoundException
- The specified resource ARN was not found. Check the ARN and try your request again.InternalServerException
- An internal server error occurred. Retry your request.public DescribeDocumentClassificationJobResult describeDocumentClassificationJob(DescribeDocumentClassificationJobRequest request)
Gets the properties associated with a document classification job. Use this operation to get the status of a classification job.
describeDocumentClassificationJob
in interface AmazonComprehend
describeDocumentClassificationJobRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.JobNotFoundException
- The specified job was not found. Check the job ID and try again.InternalServerException
- An internal server error occurred. Retry your request.public DescribeDocumentClassifierResult describeDocumentClassifier(DescribeDocumentClassifierRequest request)
Gets the properties associated with a document classifier.
describeDocumentClassifier
in interface AmazonComprehend
describeDocumentClassifierRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.ResourceNotFoundException
- The specified resource ARN was not found. Check the ARN and try your request again.InternalServerException
- An internal server error occurred. Retry your request.public DescribeDominantLanguageDetectionJobResult describeDominantLanguageDetectionJob(DescribeDominantLanguageDetectionJobRequest request)
Gets the properties associated with a dominant language detection job. Use this operation to get the status of a detection job.
describeDominantLanguageDetectionJob
in interface AmazonComprehend
describeDominantLanguageDetectionJobRequest
- InvalidRequestException
- The request is invalid.JobNotFoundException
- The specified job was not found. Check the job ID and try again.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InternalServerException
- An internal server error occurred. Retry your request.public DescribeEndpointResult describeEndpoint(DescribeEndpointRequest request)
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.
describeEndpoint
in interface AmazonComprehend
describeEndpointRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.ResourceNotFoundException
- The specified resource ARN was not found. Check the ARN and try your request again.InternalServerException
- An internal server error occurred. Retry your request.public DescribeEntitiesDetectionJobResult describeEntitiesDetectionJob(DescribeEntitiesDetectionJobRequest request)
Gets the properties associated with an entities detection job. Use this operation to get the status of a detection job.
describeEntitiesDetectionJob
in interface AmazonComprehend
describeEntitiesDetectionJobRequest
- InvalidRequestException
- The request is invalid.JobNotFoundException
- The specified job was not found. Check the job ID and try again.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InternalServerException
- An internal server error occurred. Retry your request.public DescribeEntityRecognizerResult describeEntityRecognizer(DescribeEntityRecognizerRequest request)
Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on.
describeEntityRecognizer
in interface AmazonComprehend
describeEntityRecognizerRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.ResourceNotFoundException
- The specified resource ARN was not found. Check the ARN and try your request again.InternalServerException
- An internal server error occurred. Retry your request.public DescribeEventsDetectionJobResult describeEventsDetectionJob(DescribeEventsDetectionJobRequest request)
Gets the status and details of an events detection job.
describeEventsDetectionJob
in interface AmazonComprehend
describeEventsDetectionJobRequest
- InvalidRequestException
- The request is invalid.JobNotFoundException
- The specified job was not found. Check the job ID and try again.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InternalServerException
- An internal server error occurred. Retry your request.public DescribeFlywheelResult describeFlywheel(DescribeFlywheelRequest request)
Provides configuration information about the flywheel. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
describeFlywheel
in interface AmazonComprehend
describeFlywheelRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.ResourceNotFoundException
- The specified resource ARN was not found. Check the ARN and try your request again.InternalServerException
- An internal server error occurred. Retry your request.public DescribeFlywheelIterationResult describeFlywheelIteration(DescribeFlywheelIterationRequest request)
Retrieve the configuration properties of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
describeFlywheelIteration
in interface AmazonComprehend
describeFlywheelIterationRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.ResourceNotFoundException
- The specified resource ARN was not found. Check the ARN and try your request again.InternalServerException
- An internal server error occurred. Retry your request.public DescribeKeyPhrasesDetectionJobResult describeKeyPhrasesDetectionJob(DescribeKeyPhrasesDetectionJobRequest request)
Gets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job.
describeKeyPhrasesDetectionJob
in interface AmazonComprehend
describeKeyPhrasesDetectionJobRequest
- InvalidRequestException
- The request is invalid.JobNotFoundException
- The specified job was not found. Check the job ID and try again.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InternalServerException
- An internal server error occurred. Retry your request.public DescribePiiEntitiesDetectionJobResult describePiiEntitiesDetectionJob(DescribePiiEntitiesDetectionJobRequest request)
Gets the properties associated with a PII entities detection job. For example, you can use this operation to get the job status.
describePiiEntitiesDetectionJob
in interface AmazonComprehend
describePiiEntitiesDetectionJobRequest
- InvalidRequestException
- The request is invalid.JobNotFoundException
- The specified job was not found. Check the job ID and try again.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InternalServerException
- An internal server error occurred. Retry your request.public DescribeResourcePolicyResult describeResourcePolicy(DescribeResourcePolicyRequest request)
Gets the details of a resource-based policy that is attached to a custom model, including the JSON body of the policy.
describeResourcePolicy
in interface AmazonComprehend
describeResourcePolicyRequest
- InvalidRequestException
- The request is invalid.ResourceNotFoundException
- The specified resource ARN was not found. Check the ARN and try your request again.InternalServerException
- An internal server error occurred. Retry your request.public DescribeSentimentDetectionJobResult describeSentimentDetectionJob(DescribeSentimentDetectionJobRequest request)
Gets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job.
describeSentimentDetectionJob
in interface AmazonComprehend
describeSentimentDetectionJobRequest
- InvalidRequestException
- The request is invalid.JobNotFoundException
- The specified job was not found. Check the job ID and try again.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InternalServerException
- An internal server error occurred. Retry your request.public DescribeTargetedSentimentDetectionJobResult describeTargetedSentimentDetectionJob(DescribeTargetedSentimentDetectionJobRequest request)
Gets the properties associated with a targeted sentiment detection job. Use this operation to get the status of the job.
describeTargetedSentimentDetectionJob
in interface AmazonComprehend
describeTargetedSentimentDetectionJobRequest
- InvalidRequestException
- The request is invalid.JobNotFoundException
- The specified job was not found. Check the job ID and try again.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InternalServerException
- An internal server error occurred. Retry your request.public DescribeTopicsDetectionJobResult describeTopicsDetectionJob(DescribeTopicsDetectionJobRequest request)
Gets the properties associated with a topic detection job. Use this operation to get the status of a detection job.
describeTopicsDetectionJob
in interface AmazonComprehend
describeTopicsDetectionJobRequest
- InvalidRequestException
- The request is invalid.JobNotFoundException
- The specified job was not found. Check the job ID and try again.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InternalServerException
- An internal server error occurred. Retry your request.public DetectDominantLanguageResult detectDominantLanguage(DetectDominantLanguageRequest request)
Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.
detectDominantLanguage
in interface AmazonComprehend
detectDominantLanguageRequest
- InvalidRequestException
- The request is invalid.TextSizeLimitExceededException
- The size of the input text exceeds the limit. Use a smaller document.InternalServerException
- An internal server error occurred. Retry your request.public DetectEntitiesResult detectEntities(DetectEntitiesRequest request)
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.
detectEntities
in interface AmazonComprehend
detectEntitiesRequest
- InvalidRequestException
- The request is invalid.ResourceUnavailableException
- The specified resource is not available. Check the resource and try your request again.TextSizeLimitExceededException
- The size of the input text exceeds the limit. Use a smaller document.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,
Supported
languages in the Comprehend Developer Guide.InternalServerException
- An internal server error occurred. Retry your request.public DetectKeyPhrasesResult detectKeyPhrases(DetectKeyPhrasesRequest request)
Detects the key noun phrases found in the text.
detectKeyPhrases
in interface AmazonComprehend
detectKeyPhrasesRequest
- InvalidRequestException
- The request is invalid.TextSizeLimitExceededException
- The size of the input text exceeds the limit. Use a smaller document.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,
Supported
languages in the Comprehend Developer Guide.InternalServerException
- An internal server error occurred. Retry your request.public DetectPiiEntitiesResult detectPiiEntities(DetectPiiEntitiesRequest request)
Inspects the input text for entities that contain personally identifiable information (PII) and returns information about them.
detectPiiEntities
in interface AmazonComprehend
detectPiiEntitiesRequest
- InvalidRequestException
- The request is invalid.TextSizeLimitExceededException
- The size of the input text exceeds the limit. Use a smaller document.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,
Supported
languages in the Comprehend Developer Guide.InternalServerException
- An internal server error occurred. Retry your request.public DetectSentimentResult detectSentiment(DetectSentimentRequest request)
Inspects text and returns an inference of the prevailing sentiment (POSITIVE
, NEUTRAL
,
MIXED
, or NEGATIVE
).
detectSentiment
in interface AmazonComprehend
detectSentimentRequest
- InvalidRequestException
- The request is invalid.TextSizeLimitExceededException
- The size of the input text exceeds the limit. Use a smaller document.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,
Supported
languages in the Comprehend Developer Guide.InternalServerException
- An internal server error occurred. Retry your request.public DetectSyntaxResult detectSyntax(DetectSyntaxRequest request)
Inspects text for syntax and the part of speech of words in the document. For more information, see Syntax in the Comprehend Developer Guide.
detectSyntax
in interface AmazonComprehend
detectSyntaxRequest
- InvalidRequestException
- The request is invalid.TextSizeLimitExceededException
- The size of the input text exceeds the limit. Use a smaller document.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,
Supported
languages in the Comprehend Developer Guide.InternalServerException
- An internal server error occurred. Retry your request.public DetectTargetedSentimentResult detectTargetedSentiment(DetectTargetedSentimentRequest request)
Inspects the input text and returns a sentiment analysis for each entity identified in the text.
For more information about targeted sentiment, see Targeted sentiment in the Amazon Comprehend Developer Guide.
detectTargetedSentiment
in interface AmazonComprehend
detectTargetedSentimentRequest
- InvalidRequestException
- The request is invalid.TextSizeLimitExceededException
- The size of the input text exceeds the limit. Use a smaller document.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,
Supported
languages in the Comprehend Developer Guide.InternalServerException
- An internal server error occurred. Retry your request.public DetectToxicContentResult detectToxicContent(DetectToxicContentRequest request)
Performs toxicity analysis on the list of text strings that you provide as input. The analysis uses the order of strings in the list to determine context when predicting toxicity. The API response contains a results list that matches the size of the input list. For more information about toxicity detection, see Toxicity detection in the Amazon Comprehend Developer Guide
detectToxicContent
in interface AmazonComprehend
detectToxicContentRequest
- InvalidRequestException
- The request is invalid.TextSizeLimitExceededException
- The size of the input text exceeds the limit. Use a smaller document.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,
Supported
languages in the Comprehend Developer Guide.InternalServerException
- An internal server error occurred. Retry your request.public ImportModelResult importModel(ImportModelRequest request)
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.
importModel
in interface AmazonComprehend
importModelRequest
- InvalidRequestException
- The request is invalid.ResourceNotFoundException
- The specified resource ARN was not found. Check the ARN and try your request again.ResourceInUseException
- The specified resource name is already in use. Use a different name and try your request again.ResourceUnavailableException
- The specified resource is not available. Check the resource and try your request again.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.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.ResourceLimitExceededException
- The maximum number of resources per account has been exceeded. Review the resources, and then try your
request again.KmsKeyValidationException
- The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.InternalServerException
- An internal server error occurred. Retry your request.public ListDatasetsResult listDatasets(ListDatasetsRequest request)
List the datasets that you have configured in this Region. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.
listDatasets
in interface AmazonComprehend
listDatasetsRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the operation is invalid. Specify a different filter.ResourceNotFoundException
- The specified resource ARN was not found. Check the ARN and try your request again.InternalServerException
- An internal server error occurred. Retry your request.public ListDocumentClassificationJobsResult listDocumentClassificationJobs(ListDocumentClassificationJobsRequest request)
Gets a list of the documentation classification jobs that you have submitted.
listDocumentClassificationJobs
in interface AmazonComprehend
listDocumentClassificationJobsRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the operation is invalid. Specify a different filter.InternalServerException
- An internal server error occurred. Retry your request.public ListDocumentClassifierSummariesResult listDocumentClassifierSummaries(ListDocumentClassifierSummariesRequest request)
Gets a list of summaries of the document classifiers that you have created
listDocumentClassifierSummaries
in interface AmazonComprehend
listDocumentClassifierSummariesRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InternalServerException
- An internal server error occurred. Retry your request.public ListDocumentClassifiersResult listDocumentClassifiers(ListDocumentClassifiersRequest request)
Gets a list of the document classifiers that you have created.
listDocumentClassifiers
in interface AmazonComprehend
listDocumentClassifiersRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the operation is invalid. Specify a different filter.InternalServerException
- An internal server error occurred. Retry your request.public ListDominantLanguageDetectionJobsResult listDominantLanguageDetectionJobs(ListDominantLanguageDetectionJobsRequest request)
Gets a list of the dominant language detection jobs that you have submitted.
listDominantLanguageDetectionJobs
in interface AmazonComprehend
listDominantLanguageDetectionJobsRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the operation is invalid. Specify a different filter.InternalServerException
- An internal server error occurred. Retry your request.public ListEndpointsResult listEndpoints(ListEndpointsRequest request)
Gets a list of all existing endpoints that you've created. For information about endpoints, see Managing endpoints.
listEndpoints
in interface AmazonComprehend
listEndpointsRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InternalServerException
- An internal server error occurred. Retry your request.public ListEntitiesDetectionJobsResult listEntitiesDetectionJobs(ListEntitiesDetectionJobsRequest request)
Gets a list of the entity detection jobs that you have submitted.
listEntitiesDetectionJobs
in interface AmazonComprehend
listEntitiesDetectionJobsRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the operation is invalid. Specify a different filter.InternalServerException
- An internal server error occurred. Retry your request.public ListEntityRecognizerSummariesResult listEntityRecognizerSummaries(ListEntityRecognizerSummariesRequest request)
Gets a list of summaries for the entity recognizers that you have created.
listEntityRecognizerSummaries
in interface AmazonComprehend
listEntityRecognizerSummariesRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InternalServerException
- An internal server error occurred. Retry your request.public ListEntityRecognizersResult listEntityRecognizers(ListEntityRecognizersRequest request)
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.
listEntityRecognizers
in interface AmazonComprehend
listEntityRecognizersRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the operation is invalid. Specify a different filter.InternalServerException
- An internal server error occurred. Retry your request.public ListEventsDetectionJobsResult listEventsDetectionJobs(ListEventsDetectionJobsRequest request)
Gets a list of the events detection jobs that you have submitted.
listEventsDetectionJobs
in interface AmazonComprehend
listEventsDetectionJobsRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the operation is invalid. Specify a different filter.InternalServerException
- An internal server error occurred. Retry your request.public ListFlywheelIterationHistoryResult listFlywheelIterationHistory(ListFlywheelIterationHistoryRequest request)
Information about the history of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
listFlywheelIterationHistory
in interface AmazonComprehend
listFlywheelIterationHistoryRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the operation is invalid. Specify a different filter.ResourceNotFoundException
- The specified resource ARN was not found. Check the ARN and try your request again.InternalServerException
- An internal server error occurred. Retry your request.public ListFlywheelsResult listFlywheels(ListFlywheelsRequest request)
Gets a list of the flywheels that you have created.
listFlywheels
in interface AmazonComprehend
listFlywheelsRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the operation is invalid. Specify a different filter.InternalServerException
- An internal server error occurred. Retry your request.public ListKeyPhrasesDetectionJobsResult listKeyPhrasesDetectionJobs(ListKeyPhrasesDetectionJobsRequest request)
Get a list of key phrase detection jobs that you have submitted.
listKeyPhrasesDetectionJobs
in interface AmazonComprehend
listKeyPhrasesDetectionJobsRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the operation is invalid. Specify a different filter.InternalServerException
- An internal server error occurred. Retry your request.public ListPiiEntitiesDetectionJobsResult listPiiEntitiesDetectionJobs(ListPiiEntitiesDetectionJobsRequest request)
Gets a list of the PII entity detection jobs that you have submitted.
listPiiEntitiesDetectionJobs
in interface AmazonComprehend
listPiiEntitiesDetectionJobsRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the operation is invalid. Specify a different filter.InternalServerException
- An internal server error occurred. Retry your request.public ListSentimentDetectionJobsResult listSentimentDetectionJobs(ListSentimentDetectionJobsRequest request)
Gets a list of sentiment detection jobs that you have submitted.
listSentimentDetectionJobs
in interface AmazonComprehend
listSentimentDetectionJobsRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the operation is invalid. Specify a different filter.InternalServerException
- An internal server error occurred. Retry your request.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Lists all tags associated with a given Amazon Comprehend resource.
listTagsForResource
in interface AmazonComprehend
listTagsForResourceRequest
- InvalidRequestException
- The request is invalid.ResourceNotFoundException
- The specified resource ARN was not found. Check the ARN and try your request again.InternalServerException
- An internal server error occurred. Retry your request.public ListTargetedSentimentDetectionJobsResult listTargetedSentimentDetectionJobs(ListTargetedSentimentDetectionJobsRequest request)
Gets a list of targeted sentiment detection jobs that you have submitted.
listTargetedSentimentDetectionJobs
in interface AmazonComprehend
listTargetedSentimentDetectionJobsRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the operation is invalid. Specify a different filter.InternalServerException
- An internal server error occurred. Retry your request.public ListTopicsDetectionJobsResult listTopicsDetectionJobs(ListTopicsDetectionJobsRequest request)
Gets a list of the topic detection jobs that you have submitted.
listTopicsDetectionJobs
in interface AmazonComprehend
listTopicsDetectionJobsRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.InvalidFilterException
- The filter specified for the operation is invalid. Specify a different filter.InternalServerException
- An internal server error occurred. Retry your request.public PutResourcePolicyResult putResourcePolicy(PutResourcePolicyRequest request)
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.
putResourcePolicy
in interface AmazonComprehend
putResourcePolicyRequest
- InvalidRequestException
- The request is invalid.ResourceNotFoundException
- The specified resource ARN was not found. Check the ARN and try your request again.InternalServerException
- An internal server error occurred. Retry your request.public StartDocumentClassificationJobResult startDocumentClassificationJob(StartDocumentClassificationJobRequest request)
Starts an asynchronous document classification job. Use the DescribeDocumentClassificationJob
operation to track the progress of the job.
startDocumentClassificationJob
in interface AmazonComprehend
startDocumentClassificationJobRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.ResourceNotFoundException
- The specified resource ARN was not found. Check the ARN and try your request again.ResourceUnavailableException
- The specified resource is not available. Check the resource and try your request again.KmsKeyValidationException
- The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.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.ResourceInUseException
- The specified resource name is already in use. Use a different name and try your request again.InternalServerException
- An internal server error occurred. Retry your request.public StartDominantLanguageDetectionJobResult startDominantLanguageDetectionJob(StartDominantLanguageDetectionJobRequest request)
Starts an asynchronous dominant language detection job for a collection of documents. Use the operation to track the status of a job.
startDominantLanguageDetectionJob
in interface AmazonComprehend
startDominantLanguageDetectionJobRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.KmsKeyValidationException
- The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.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.ResourceInUseException
- The specified resource name is already in use. Use a different name and try your request again.InternalServerException
- An internal server error occurred. Retry your request.public StartEntitiesDetectionJobResult startEntitiesDetectionJob(StartEntitiesDetectionJobRequest request)
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.
startEntitiesDetectionJob
in interface AmazonComprehend
startEntitiesDetectionJobRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.ResourceNotFoundException
- The specified resource ARN was not found. Check the ARN and try your request again.ResourceUnavailableException
- The specified resource is not available. Check the resource and try your request again.KmsKeyValidationException
- The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.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.ResourceInUseException
- The specified resource name is already in use. Use a different name and try your request again.InternalServerException
- An internal server error occurred. Retry your request.public StartEventsDetectionJobResult startEventsDetectionJob(StartEventsDetectionJobRequest request)
Starts an asynchronous event detection job for a collection of documents.
startEventsDetectionJob
in interface AmazonComprehend
startEventsDetectionJobRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.KmsKeyValidationException
- The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.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.ResourceInUseException
- The specified resource name is already in use. Use a different name and try your request again.InternalServerException
- An internal server error occurred. Retry your request.public StartFlywheelIterationResult startFlywheelIteration(StartFlywheelIterationRequest request)
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.
startFlywheelIteration
in interface AmazonComprehend
startFlywheelIterationRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.ResourceInUseException
- The specified resource name is already in use. Use a different name and try your request again.ResourceNotFoundException
- The specified resource ARN was not found. Check the ARN and try your request again.InternalServerException
- An internal server error occurred. Retry your request.public StartKeyPhrasesDetectionJobResult startKeyPhrasesDetectionJob(StartKeyPhrasesDetectionJobRequest request)
Starts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the status of a job.
startKeyPhrasesDetectionJob
in interface AmazonComprehend
startKeyPhrasesDetectionJobRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.KmsKeyValidationException
- The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.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.ResourceInUseException
- The specified resource name is already in use. Use a different name and try your request again.InternalServerException
- An internal server error occurred. Retry your request.public StartPiiEntitiesDetectionJobResult startPiiEntitiesDetectionJob(StartPiiEntitiesDetectionJobRequest request)
Starts an asynchronous PII entity detection job for a collection of documents.
startPiiEntitiesDetectionJob
in interface AmazonComprehend
startPiiEntitiesDetectionJobRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.KmsKeyValidationException
- The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.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.ResourceInUseException
- The specified resource name is already in use. Use a different name and try your request again.InternalServerException
- An internal server error occurred. Retry your request.public StartSentimentDetectionJobResult startSentimentDetectionJob(StartSentimentDetectionJobRequest request)
Starts an asynchronous sentiment detection job for a collection of documents. Use the operation to track the status of a job.
startSentimentDetectionJob
in interface AmazonComprehend
startSentimentDetectionJobRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.KmsKeyValidationException
- The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.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.ResourceInUseException
- The specified resource name is already in use. Use a different name and try your request again.InternalServerException
- An internal server error occurred. Retry your request.public StartTargetedSentimentDetectionJobResult startTargetedSentimentDetectionJob(StartTargetedSentimentDetectionJobRequest request)
Starts an asynchronous targeted sentiment detection job for a collection of documents. Use the
DescribeTargetedSentimentDetectionJob
operation to track the status of a job.
startTargetedSentimentDetectionJob
in interface AmazonComprehend
startTargetedSentimentDetectionJobRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.KmsKeyValidationException
- The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.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.ResourceInUseException
- The specified resource name is already in use. Use a different name and try your request again.InternalServerException
- An internal server error occurred. Retry your request.public StartTopicsDetectionJobResult startTopicsDetectionJob(StartTopicsDetectionJobRequest request)
Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob
operation to track the
status of a job.
startTopicsDetectionJob
in interface AmazonComprehend
startTopicsDetectionJobRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.KmsKeyValidationException
- The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.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.ResourceInUseException
- The specified resource name is already in use. Use a different name and try your request again.InternalServerException
- An internal server error occurred. Retry your request.public StopDominantLanguageDetectionJobResult stopDominantLanguageDetectionJob(StopDominantLanguageDetectionJobRequest request)
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.
stopDominantLanguageDetectionJob
in interface AmazonComprehend
stopDominantLanguageDetectionJobRequest
- InvalidRequestException
- The request is invalid.JobNotFoundException
- The specified job was not found. Check the job ID and try again.InternalServerException
- An internal server error occurred. Retry your request.public StopEntitiesDetectionJobResult stopEntitiesDetectionJob(StopEntitiesDetectionJobRequest request)
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.
stopEntitiesDetectionJob
in interface AmazonComprehend
stopEntitiesDetectionJobRequest
- InvalidRequestException
- The request is invalid.JobNotFoundException
- The specified job was not found. Check the job ID and try again.InternalServerException
- An internal server error occurred. Retry your request.public StopEventsDetectionJobResult stopEventsDetectionJob(StopEventsDetectionJobRequest request)
Stops an events detection job in progress.
stopEventsDetectionJob
in interface AmazonComprehend
stopEventsDetectionJobRequest
- InvalidRequestException
- The request is invalid.JobNotFoundException
- The specified job was not found. Check the job ID and try again.InternalServerException
- An internal server error occurred. Retry your request.public StopKeyPhrasesDetectionJobResult stopKeyPhrasesDetectionJob(StopKeyPhrasesDetectionJobRequest request)
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.
stopKeyPhrasesDetectionJob
in interface AmazonComprehend
stopKeyPhrasesDetectionJobRequest
- InvalidRequestException
- The request is invalid.JobNotFoundException
- The specified job was not found. Check the job ID and try again.InternalServerException
- An internal server error occurred. Retry your request.public StopPiiEntitiesDetectionJobResult stopPiiEntitiesDetectionJob(StopPiiEntitiesDetectionJobRequest request)
Stops a PII entities detection job in progress.
stopPiiEntitiesDetectionJob
in interface AmazonComprehend
stopPiiEntitiesDetectionJobRequest
- InvalidRequestException
- The request is invalid.JobNotFoundException
- The specified job was not found. Check the job ID and try again.InternalServerException
- An internal server error occurred. Retry your request.public StopSentimentDetectionJobResult stopSentimentDetectionJob(StopSentimentDetectionJobRequest request)
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.
stopSentimentDetectionJob
in interface AmazonComprehend
stopSentimentDetectionJobRequest
- InvalidRequestException
- The request is invalid.JobNotFoundException
- The specified job was not found. Check the job ID and try again.InternalServerException
- An internal server error occurred. Retry your request.public StopTargetedSentimentDetectionJobResult stopTargetedSentimentDetectionJob(StopTargetedSentimentDetectionJobRequest request)
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.
stopTargetedSentimentDetectionJob
in interface AmazonComprehend
stopTargetedSentimentDetectionJobRequest
- InvalidRequestException
- The request is invalid.JobNotFoundException
- The specified job was not found. Check the job ID and try again.InternalServerException
- An internal server error occurred. Retry your request.public StopTrainingDocumentClassifierResult stopTrainingDocumentClassifier(StopTrainingDocumentClassifierRequest request)
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.
stopTrainingDocumentClassifier
in interface AmazonComprehend
stopTrainingDocumentClassifierRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.ResourceNotFoundException
- The specified resource ARN was not found. Check the ARN and try your request again.InternalServerException
- An internal server error occurred. Retry your request.public StopTrainingEntityRecognizerResult stopTrainingEntityRecognizer(StopTrainingEntityRecognizerRequest request)
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.
stopTrainingEntityRecognizer
in interface AmazonComprehend
stopTrainingEntityRecognizerRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.ResourceNotFoundException
- The specified resource ARN was not found. Check the ARN and try your request again.InternalServerException
- An internal server error occurred. Retry your request.public TagResourceResult tagResource(TagResourceRequest request)
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.
tagResource
in interface AmazonComprehend
tagResourceRequest
- InvalidRequestException
- The request is invalid.ConcurrentModificationException
- Concurrent modification of the tags associated with an Amazon Comprehend resource is not supported.ResourceNotFoundException
- The specified resource ARN was not found. Check the ARN and try your request again.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.InternalServerException
- An internal server error occurred. Retry your request.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes a specific tag associated with an Amazon Comprehend resource.
untagResource
in interface AmazonComprehend
untagResourceRequest
- TooManyTagKeysException
- The request contains more tag keys than can be associated with a resource (50 tag keys per resource).InvalidRequestException
- The request is invalid.ConcurrentModificationException
- Concurrent modification of the tags associated with an Amazon Comprehend resource is not supported.ResourceNotFoundException
- The specified resource ARN was not found. Check the ARN and try your request again.InternalServerException
- An internal server error occurred. Retry your request.public UpdateEndpointResult updateEndpoint(UpdateEndpointRequest request)
Updates information about the specified endpoint. For information about endpoints, see Managing endpoints.
updateEndpoint
in interface AmazonComprehend
updateEndpointRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.ResourceInUseException
- The specified resource name is already in use. Use a different name and try your request again.ResourceLimitExceededException
- The maximum number of resources per account has been exceeded. Review the resources, and then try your
request again.ResourceNotFoundException
- The specified resource ARN was not found. Check the ARN and try your request again.ResourceUnavailableException
- The specified resource is not available. Check the resource and try your request again.InternalServerException
- An internal server error occurred. Retry your request.public UpdateFlywheelResult updateFlywheel(UpdateFlywheelRequest request)
Update the configuration information for an existing flywheel.
updateFlywheel
in interface AmazonComprehend
updateFlywheelRequest
- InvalidRequestException
- The request is invalid.TooManyRequestsException
- The number of requests exceeds the limit. Resubmit your request later.KmsKeyValidationException
- The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.ResourceNotFoundException
- The specified resource ARN was not found. Check the ARN and try your request again.InternalServerException
- An internal server error occurred. Retry your request.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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 the request.
getCachedResponseMetadata
in interface AmazonComprehend
request
- The originally executed requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AmazonComprehend
shutdown
in class AmazonWebServiceClient