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