AbstractAmazonComprehend (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.comprehend

Class AbstractAmazonComprehend

java.lang.Object
- com.amazonaws.services.comprehend.AbstractAmazonComprehend

All Implemented Interfaces:

AmazonComprehend

Direct Known Subclasses:

AbstractAmazonComprehendAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonComprehend
extends Object
implements AmazonComprehend 
```
Abstract implementation of AmazonComprehend. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.comprehend.AmazonComprehend
  ENDPOINT_PREFIX

Method Summary

All Methods
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.
`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 using a custom classification model.
`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.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - batchDetectDominantLanguage
```
public BatchDetectDominantLanguageResult batchDetectDominantLanguage(BatchDetectDominantLanguageRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Determines the dominant language of the input text for a batch of documents. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.
    
    Specified by:
    
    batchDetectDominantLanguage in interface AmazonComprehend
    
    Returns:
    
    Result of the BatchDetectDominantLanguage operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - batchDetectEntities
```
public BatchDetectEntitiesResult batchDetectEntities(BatchDetectEntitiesRequest request)
```
    Description copied from interface: AmazonComprehend
    
    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.
    
    Specified by:
    
    batchDetectEntities in interface AmazonComprehend
    
    Returns:
    
    Result of the BatchDetectEntities operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - batchDetectKeyPhrases
```
public BatchDetectKeyPhrasesResult batchDetectKeyPhrases(BatchDetectKeyPhrasesRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Detects the key noun phrases found in a batch of documents.
    
    Specified by:
    
    batchDetectKeyPhrases in interface AmazonComprehend
    
    Returns:
    
    Result of the BatchDetectKeyPhrases operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - batchDetectSentiment
```
public BatchDetectSentimentResult batchDetectSentiment(BatchDetectSentimentRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Inspects a batch of documents and returns an inference of the prevailing sentiment, POSITIVE, NEUTRAL, MIXED, or NEGATIVE, in each one.
    
    Specified by:
    
    batchDetectSentiment in interface AmazonComprehend
    
    Returns:
    
    Result of the BatchDetectSentiment operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - batchDetectSyntax
```
public BatchDetectSyntaxResult batchDetectSyntax(BatchDetectSyntaxRequest request)
```
    Description copied from interface: AmazonComprehend
    
    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.
    
    Specified by:
    
    batchDetectSyntax in interface AmazonComprehend
    
    Returns:
    
    Result of the BatchDetectSyntax operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - batchDetectTargetedSentiment
```
public BatchDetectTargetedSentimentResult batchDetectTargetedSentiment(BatchDetectTargetedSentimentRequest request)
```
    Description copied from interface: AmazonComprehend
    
    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.
    
    Specified by:
    
    batchDetectTargetedSentiment in interface AmazonComprehend
    
    Returns:
    
    Result of the BatchDetectTargetedSentiment operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - classifyDocument
```
public ClassifyDocumentResult classifyDocument(ClassifyDocumentRequest request)
```
    Description copied from interface: AmazonComprehend
    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.
    Specified by:
    
    classifyDocument in interface AmazonComprehend
    
    Returns:
    
    Result of the ClassifyDocument operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - containsPiiEntities
```
public ContainsPiiEntitiesResult containsPiiEntities(ContainsPiiEntitiesRequest request)
```
    Description copied from interface: AmazonComprehend
    
    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.
    
    Specified by:
    
    containsPiiEntities in interface AmazonComprehend
    
    Returns:
    
    Result of the ContainsPiiEntities operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createDataset
```
public CreateDatasetResult createDataset(CreateDatasetRequest request)
```
    Description copied from interface: AmazonComprehend
    
    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.
    
    Specified by:
    
    createDataset in interface AmazonComprehend
    
    Returns:
    
    Result of the CreateDataset operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createDocumentClassifier
```
public CreateDocumentClassifierResult createDocumentClassifier(CreateDocumentClassifierRequest request)
```
    Description copied from interface: AmazonComprehend
    
    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.
    
    Specified by:
    
    createDocumentClassifier in interface AmazonComprehend
    
    Returns:
    
    Result of the CreateDocumentClassifier operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createEndpoint
```
public CreateEndpointResult createEndpoint(CreateEndpointRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Creates a model-specific endpoint for synchronous inference for a previously trained custom model For information about endpoints, see Managing endpoints.
    
    Specified by:
    
    createEndpoint in interface AmazonComprehend
    
    Returns:
    
    Result of the CreateEndpoint operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createEntityRecognizer
```
public CreateEntityRecognizerResult createEntityRecognizer(CreateEntityRecognizerRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Creates an entity recognizer using submitted files. After your CreateEntityRecognizer request is submitted, you can check job status using the DescribeEntityRecognizer API.
    
    Specified by:
    
    createEntityRecognizer in interface AmazonComprehend
    
    Returns:
    
    Result of the CreateEntityRecognizer operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createFlywheel
```
public CreateFlywheelResult createFlywheel(CreateFlywheelRequest request)
```
    Description copied from interface: AmazonComprehend
    
    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.
    
    Specified by:
    
    createFlywheel in interface AmazonComprehend
    
    Returns:
    
    Result of the CreateFlywheel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteDocumentClassifier
```
public DeleteDocumentClassifierResult deleteDocumentClassifier(DeleteDocumentClassifierRequest request)
```
    Description copied from interface: AmazonComprehend
    
    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.
    
    Specified by:
    
    deleteDocumentClassifier in interface AmazonComprehend
    
    Returns:
    
    Result of the DeleteDocumentClassifier operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteEndpoint
```
public DeleteEndpointResult deleteEndpoint(DeleteEndpointRequest request)
```
    Description copied from interface: AmazonComprehend
    
    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.
    
    Specified by:
    
    deleteEndpoint in interface AmazonComprehend
    
    Returns:
    
    Result of the DeleteEndpoint operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteEntityRecognizer
```
public DeleteEntityRecognizerResult deleteEntityRecognizer(DeleteEntityRecognizerRequest request)
```
    Description copied from interface: AmazonComprehend
    
    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.
    
    Specified by:
    
    deleteEntityRecognizer in interface AmazonComprehend
    
    Returns:
    
    Result of the DeleteEntityRecognizer operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteFlywheel
```
public DeleteFlywheelResult deleteFlywheel(DeleteFlywheelRequest request)
```
    Description copied from interface: AmazonComprehend
    
    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.
    
    Specified by:
    
    deleteFlywheel in interface AmazonComprehend
    
    Returns:
    
    Result of the DeleteFlywheel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteResourcePolicy
```
public DeleteResourcePolicyResult deleteResourcePolicy(DeleteResourcePolicyRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Deletes a resource-based policy that is attached to a custom model.
    
    Specified by:
    
    deleteResourcePolicy in interface AmazonComprehend
    
    Returns:
    
    Result of the DeleteResourcePolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeDataset
```
public DescribeDatasetResult describeDataset(DescribeDatasetRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Returns information about the dataset that you specify. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.
    
    Specified by:
    
    describeDataset in interface AmazonComprehend
    
    Returns:
    
    Result of the DescribeDataset operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeDocumentClassificationJob
```
public DescribeDocumentClassificationJobResult describeDocumentClassificationJob(DescribeDocumentClassificationJobRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Gets the properties associated with a document classification job. Use this operation to get the status of a classification job.
    
    Specified by:
    
    describeDocumentClassificationJob in interface AmazonComprehend
    
    Returns:
    
    Result of the DescribeDocumentClassificationJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeDocumentClassifier
```
public DescribeDocumentClassifierResult describeDocumentClassifier(DescribeDocumentClassifierRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Gets the properties associated with a document classifier.
    
    Specified by:
    
    describeDocumentClassifier in interface AmazonComprehend
    
    Returns:
    
    Result of the DescribeDocumentClassifier operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeDominantLanguageDetectionJob
```
public DescribeDominantLanguageDetectionJobResult describeDominantLanguageDetectionJob(DescribeDominantLanguageDetectionJobRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Gets the properties associated with a dominant language detection job. Use this operation to get the status of a detection job.
    
    Specified by:
    
    describeDominantLanguageDetectionJob in interface AmazonComprehend
    
    Returns:
    
    Result of the DescribeDominantLanguageDetectionJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeEndpoint
```
public DescribeEndpointResult describeEndpoint(DescribeEndpointRequest request)
```
    Description copied from interface: AmazonComprehend
    
    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.
    
    Specified by:
    
    describeEndpoint in interface AmazonComprehend
    
    Returns:
    
    Result of the DescribeEndpoint operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeEntitiesDetectionJob
```
public DescribeEntitiesDetectionJobResult describeEntitiesDetectionJob(DescribeEntitiesDetectionJobRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Gets the properties associated with an entities detection job. Use this operation to get the status of a detection job.
    
    Specified by:
    
    describeEntitiesDetectionJob in interface AmazonComprehend
    
    Returns:
    
    Result of the DescribeEntitiesDetectionJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeEntityRecognizer
```
public DescribeEntityRecognizerResult describeEntityRecognizer(DescribeEntityRecognizerRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on.
    
    Specified by:
    
    describeEntityRecognizer in interface AmazonComprehend
    
    Returns:
    
    Result of the DescribeEntityRecognizer operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeEventsDetectionJob
```
public DescribeEventsDetectionJobResult describeEventsDetectionJob(DescribeEventsDetectionJobRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Gets the status and details of an events detection job.
    
    Specified by:
    
    describeEventsDetectionJob in interface AmazonComprehend
    
    Returns:
    
    Result of the DescribeEventsDetectionJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeFlywheel
```
public DescribeFlywheelResult describeFlywheel(DescribeFlywheelRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Provides configuration information about the flywheel. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
    
    Specified by:
    
    describeFlywheel in interface AmazonComprehend
    
    Returns:
    
    Result of the DescribeFlywheel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeFlywheelIteration
```
public DescribeFlywheelIterationResult describeFlywheelIteration(DescribeFlywheelIterationRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Retrieve the configuration properties of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
    
    Specified by:
    
    describeFlywheelIteration in interface AmazonComprehend
    
    Returns:
    
    Result of the DescribeFlywheelIteration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeKeyPhrasesDetectionJob
```
public DescribeKeyPhrasesDetectionJobResult describeKeyPhrasesDetectionJob(DescribeKeyPhrasesDetectionJobRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Gets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job.
    
    Specified by:
    
    describeKeyPhrasesDetectionJob in interface AmazonComprehend
    
    Returns:
    
    Result of the DescribeKeyPhrasesDetectionJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describePiiEntitiesDetectionJob
```
public DescribePiiEntitiesDetectionJobResult describePiiEntitiesDetectionJob(DescribePiiEntitiesDetectionJobRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Gets the properties associated with a PII entities detection job. For example, you can use this operation to get the job status.
    
    Specified by:
    
    describePiiEntitiesDetectionJob in interface AmazonComprehend
    
    Returns:
    
    Result of the DescribePiiEntitiesDetectionJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeResourcePolicy
```
public DescribeResourcePolicyResult describeResourcePolicy(DescribeResourcePolicyRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Gets the details of a resource-based policy that is attached to a custom model, including the JSON body of the policy.
    
    Specified by:
    
    describeResourcePolicy in interface AmazonComprehend
    
    Returns:
    
    Result of the DescribeResourcePolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeSentimentDetectionJob
```
public DescribeSentimentDetectionJobResult describeSentimentDetectionJob(DescribeSentimentDetectionJobRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Gets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job.
    
    Specified by:
    
    describeSentimentDetectionJob in interface AmazonComprehend
    
    Returns:
    
    Result of the DescribeSentimentDetectionJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeTargetedSentimentDetectionJob
```
public DescribeTargetedSentimentDetectionJobResult describeTargetedSentimentDetectionJob(DescribeTargetedSentimentDetectionJobRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Gets the properties associated with a targeted sentiment detection job. Use this operation to get the status of the job.
    
    Specified by:
    
    describeTargetedSentimentDetectionJob in interface AmazonComprehend
    
    Returns:
    
    Result of the DescribeTargetedSentimentDetectionJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeTopicsDetectionJob
```
public DescribeTopicsDetectionJobResult describeTopicsDetectionJob(DescribeTopicsDetectionJobRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Gets the properties associated with a topic detection job. Use this operation to get the status of a detection job.
    
    Specified by:
    
    describeTopicsDetectionJob in interface AmazonComprehend
    
    Returns:
    
    Result of the DescribeTopicsDetectionJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - detectDominantLanguage
```
public DetectDominantLanguageResult detectDominantLanguage(DetectDominantLanguageRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.
    
    Specified by:
    
    detectDominantLanguage in interface AmazonComprehend
    
    Returns:
    
    Result of the DetectDominantLanguage operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - detectEntities
```
public DetectEntitiesResult detectEntities(DetectEntitiesRequest request)
```
    Description copied from interface: AmazonComprehend
    
    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.
    
    Specified by:
    
    detectEntities in interface AmazonComprehend
    
    Returns:
    
    Result of the DetectEntities operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - detectKeyPhrases
```
public DetectKeyPhrasesResult detectKeyPhrases(DetectKeyPhrasesRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Detects the key noun phrases found in the text.
    
    Specified by:
    
    detectKeyPhrases in interface AmazonComprehend
    
    Returns:
    
    Result of the DetectKeyPhrases operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - detectPiiEntities
```
public DetectPiiEntitiesResult detectPiiEntities(DetectPiiEntitiesRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Inspects the input text for entities that contain personally identifiable information (PII) and returns information about them.
    
    Specified by:
    
    detectPiiEntities in interface AmazonComprehend
    
    Returns:
    
    Result of the DetectPiiEntities operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - detectSentiment
```
public DetectSentimentResult detectSentiment(DetectSentimentRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Inspects text and returns an inference of the prevailing sentiment (POSITIVE, NEUTRAL, MIXED, or NEGATIVE).
    
    Specified by:
    
    detectSentiment in interface AmazonComprehend
    
    Returns:
    
    Result of the DetectSentiment operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - detectSyntax
```
public DetectSyntaxResult detectSyntax(DetectSyntaxRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Inspects text for syntax and the part of speech of words in the document. For more information, see Syntax in the Comprehend Developer Guide.
    
    Specified by:
    
    detectSyntax in interface AmazonComprehend
    
    Returns:
    
    Result of the DetectSyntax operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - detectTargetedSentiment
```
public DetectTargetedSentimentResult detectTargetedSentiment(DetectTargetedSentimentRequest request)
```
    Description copied from interface: AmazonComprehend
    
    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.
    
    Specified by:
    
    detectTargetedSentiment in interface AmazonComprehend
    
    Returns:
    
    Result of the DetectTargetedSentiment operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - detectToxicContent
```
public DetectToxicContentResult detectToxicContent(DetectToxicContentRequest request)
```
    Description copied from interface: AmazonComprehend
    
    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.
    
    Specified by:
    
    detectToxicContent in interface AmazonComprehend
    
    Returns:
    
    Result of the DetectToxicContent operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - importModel
```
public ImportModelResult importModel(ImportModelRequest request)
```
    Description copied from interface: AmazonComprehend
    
    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.
    
    Specified by:
    
    importModel in interface AmazonComprehend
    
    Returns:
    
    Result of the ImportModel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDatasets
```
public ListDatasetsResult listDatasets(ListDatasetsRequest request)
```
    Description copied from interface: AmazonComprehend
    
    List the datasets that you have configured in this Region. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.
    
    Specified by:
    
    listDatasets in interface AmazonComprehend
    
    Returns:
    
    Result of the ListDatasets operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDocumentClassificationJobs
```
public ListDocumentClassificationJobsResult listDocumentClassificationJobs(ListDocumentClassificationJobsRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Gets a list of the documentation classification jobs that you have submitted.
    
    Specified by:
    
    listDocumentClassificationJobs in interface AmazonComprehend
    
    Returns:
    
    Result of the ListDocumentClassificationJobs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDocumentClassifierSummaries
```
public ListDocumentClassifierSummariesResult listDocumentClassifierSummaries(ListDocumentClassifierSummariesRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Gets a list of summaries of the document classifiers that you have created
    
    Specified by:
    
    listDocumentClassifierSummaries in interface AmazonComprehend
    
    Returns:
    
    Result of the ListDocumentClassifierSummaries operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDocumentClassifiers
```
public ListDocumentClassifiersResult listDocumentClassifiers(ListDocumentClassifiersRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Gets a list of the document classifiers that you have created.
    
    Specified by:
    
    listDocumentClassifiers in interface AmazonComprehend
    
    Returns:
    
    Result of the ListDocumentClassifiers operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDominantLanguageDetectionJobs
```
public ListDominantLanguageDetectionJobsResult listDominantLanguageDetectionJobs(ListDominantLanguageDetectionJobsRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Gets a list of the dominant language detection jobs that you have submitted.
    
    Specified by:
    
    listDominantLanguageDetectionJobs in interface AmazonComprehend
    
    Returns:
    
    Result of the ListDominantLanguageDetectionJobs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listEndpoints
```
public ListEndpointsResult listEndpoints(ListEndpointsRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Gets a list of all existing endpoints that you've created. For information about endpoints, see Managing endpoints.
    
    Specified by:
    
    listEndpoints in interface AmazonComprehend
    
    Returns:
    
    Result of the ListEndpoints operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listEntitiesDetectionJobs
```
public ListEntitiesDetectionJobsResult listEntitiesDetectionJobs(ListEntitiesDetectionJobsRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Gets a list of the entity detection jobs that you have submitted.
    
    Specified by:
    
    listEntitiesDetectionJobs in interface AmazonComprehend
    
    Returns:
    
    Result of the ListEntitiesDetectionJobs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listEntityRecognizerSummaries
```
public ListEntityRecognizerSummariesResult listEntityRecognizerSummaries(ListEntityRecognizerSummariesRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Gets a list of summaries for the entity recognizers that you have created.
    
    Specified by:
    
    listEntityRecognizerSummaries in interface AmazonComprehend
    
    Returns:
    
    Result of the ListEntityRecognizerSummaries operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listEntityRecognizers
```
public ListEntityRecognizersResult listEntityRecognizers(ListEntityRecognizersRequest request)
```
    Description copied from interface: AmazonComprehend
    
    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.
    
    Specified by:
    
    listEntityRecognizers in interface AmazonComprehend
    
    Returns:
    
    Result of the ListEntityRecognizers operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listEventsDetectionJobs
```
public ListEventsDetectionJobsResult listEventsDetectionJobs(ListEventsDetectionJobsRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Gets a list of the events detection jobs that you have submitted.
    
    Specified by:
    
    listEventsDetectionJobs in interface AmazonComprehend
    
    Returns:
    
    Result of the ListEventsDetectionJobs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listFlywheelIterationHistory
```
public ListFlywheelIterationHistoryResult listFlywheelIterationHistory(ListFlywheelIterationHistoryRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Information about the history of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
    
    Specified by:
    
    listFlywheelIterationHistory in interface AmazonComprehend
    
    Returns:
    
    Result of the ListFlywheelIterationHistory operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listFlywheels
```
public ListFlywheelsResult listFlywheels(ListFlywheelsRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Gets a list of the flywheels that you have created.
    
    Specified by:
    
    listFlywheels in interface AmazonComprehend
    
    Returns:
    
    Result of the ListFlywheels operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listKeyPhrasesDetectionJobs
```
public ListKeyPhrasesDetectionJobsResult listKeyPhrasesDetectionJobs(ListKeyPhrasesDetectionJobsRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Get a list of key phrase detection jobs that you have submitted.
    
    Specified by:
    
    listKeyPhrasesDetectionJobs in interface AmazonComprehend
    
    Returns:
    
    Result of the ListKeyPhrasesDetectionJobs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listPiiEntitiesDetectionJobs
```
public ListPiiEntitiesDetectionJobsResult listPiiEntitiesDetectionJobs(ListPiiEntitiesDetectionJobsRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Gets a list of the PII entity detection jobs that you have submitted.
    
    Specified by:
    
    listPiiEntitiesDetectionJobs in interface AmazonComprehend
    
    Returns:
    
    Result of the ListPiiEntitiesDetectionJobs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listSentimentDetectionJobs
```
public ListSentimentDetectionJobsResult listSentimentDetectionJobs(ListSentimentDetectionJobsRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Gets a list of sentiment detection jobs that you have submitted.
    
    Specified by:
    
    listSentimentDetectionJobs in interface AmazonComprehend
    
    Returns:
    
    Result of the ListSentimentDetectionJobs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Lists all tags associated with a given Amazon Comprehend resource.
    
    Specified by:
    
    listTagsForResource in interface AmazonComprehend
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTargetedSentimentDetectionJobs
```
public ListTargetedSentimentDetectionJobsResult listTargetedSentimentDetectionJobs(ListTargetedSentimentDetectionJobsRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Gets a list of targeted sentiment detection jobs that you have submitted.
    
    Specified by:
    
    listTargetedSentimentDetectionJobs in interface AmazonComprehend
    
    Returns:
    
    Result of the ListTargetedSentimentDetectionJobs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTopicsDetectionJobs
```
public ListTopicsDetectionJobsResult listTopicsDetectionJobs(ListTopicsDetectionJobsRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Gets a list of the topic detection jobs that you have submitted.
    
    Specified by:
    
    listTopicsDetectionJobs in interface AmazonComprehend
    
    Returns:
    
    Result of the ListTopicsDetectionJobs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putResourcePolicy
```
public PutResourcePolicyResult putResourcePolicy(PutResourcePolicyRequest request)
```
    Description copied from interface: AmazonComprehend
    
    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.
    
    Specified by:
    
    putResourcePolicy in interface AmazonComprehend
    
    Returns:
    
    Result of the PutResourcePolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startDocumentClassificationJob
```
public StartDocumentClassificationJobResult startDocumentClassificationJob(StartDocumentClassificationJobRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Starts an asynchronous document classification job using a custom classification model. Use the DescribeDocumentClassificationJob operation to track the progress of the job.
    
    Specified by:
    
    startDocumentClassificationJob in interface AmazonComprehend
    
    Returns:
    
    Result of the StartDocumentClassificationJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startDominantLanguageDetectionJob
```
public StartDominantLanguageDetectionJobResult startDominantLanguageDetectionJob(StartDominantLanguageDetectionJobRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Starts an asynchronous dominant language detection job for a collection of documents. Use the operation to track the status of a job.
    
    Specified by:
    
    startDominantLanguageDetectionJob in interface AmazonComprehend
    
    Returns:
    
    Result of the StartDominantLanguageDetectionJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startEntitiesDetectionJob
```
public StartEntitiesDetectionJobResult startEntitiesDetectionJob(StartEntitiesDetectionJobRequest request)
```
    Description copied from interface: AmazonComprehend
    
    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.
    
    Specified by:
    
    startEntitiesDetectionJob in interface AmazonComprehend
    
    Returns:
    
    Result of the StartEntitiesDetectionJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startEventsDetectionJob
```
public StartEventsDetectionJobResult startEventsDetectionJob(StartEventsDetectionJobRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Starts an asynchronous event detection job for a collection of documents.
    
    Specified by:
    
    startEventsDetectionJob in interface AmazonComprehend
    
    Returns:
    
    Result of the StartEventsDetectionJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startFlywheelIteration
```
public StartFlywheelIterationResult startFlywheelIteration(StartFlywheelIterationRequest request)
```
    Description copied from interface: AmazonComprehend
    
    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.
    
    Specified by:
    
    startFlywheelIteration in interface AmazonComprehend
    
    Returns:
    
    Result of the StartFlywheelIteration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startKeyPhrasesDetectionJob
```
public StartKeyPhrasesDetectionJobResult startKeyPhrasesDetectionJob(StartKeyPhrasesDetectionJobRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Starts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the status of a job.
    
    Specified by:
    
    startKeyPhrasesDetectionJob in interface AmazonComprehend
    
    Returns:
    
    Result of the StartKeyPhrasesDetectionJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startPiiEntitiesDetectionJob
```
public StartPiiEntitiesDetectionJobResult startPiiEntitiesDetectionJob(StartPiiEntitiesDetectionJobRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Starts an asynchronous PII entity detection job for a collection of documents.
    
    Specified by:
    
    startPiiEntitiesDetectionJob in interface AmazonComprehend
    
    Returns:
    
    Result of the StartPiiEntitiesDetectionJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startSentimentDetectionJob
```
public StartSentimentDetectionJobResult startSentimentDetectionJob(StartSentimentDetectionJobRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Starts an asynchronous sentiment detection job for a collection of documents. Use the operation to track the status of a job.
    
    Specified by:
    
    startSentimentDetectionJob in interface AmazonComprehend
    
    Returns:
    
    Result of the StartSentimentDetectionJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startTargetedSentimentDetectionJob
```
public StartTargetedSentimentDetectionJobResult startTargetedSentimentDetectionJob(StartTargetedSentimentDetectionJobRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Starts an asynchronous targeted sentiment detection job for a collection of documents. Use the DescribeTargetedSentimentDetectionJob operation to track the status of a job.
    
    Specified by:
    
    startTargetedSentimentDetectionJob in interface AmazonComprehend
    
    Returns:
    
    Result of the StartTargetedSentimentDetectionJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startTopicsDetectionJob
```
public StartTopicsDetectionJobResult startTopicsDetectionJob(StartTopicsDetectionJobRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob operation to track the status of a job.
    
    Specified by:
    
    startTopicsDetectionJob in interface AmazonComprehend
    
    Returns:
    
    Result of the StartTopicsDetectionJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - stopDominantLanguageDetectionJob
```
public StopDominantLanguageDetectionJobResult stopDominantLanguageDetectionJob(StopDominantLanguageDetectionJobRequest request)
```
    Description copied from interface: AmazonComprehend
    
    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.
    
    Specified by:
    
    stopDominantLanguageDetectionJob in interface AmazonComprehend
    
    Returns:
    
    Result of the StopDominantLanguageDetectionJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - stopEntitiesDetectionJob
```
public StopEntitiesDetectionJobResult stopEntitiesDetectionJob(StopEntitiesDetectionJobRequest request)
```
    Description copied from interface: AmazonComprehend
    
    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.
    
    Specified by:
    
    stopEntitiesDetectionJob in interface AmazonComprehend
    
    Returns:
    
    Result of the StopEntitiesDetectionJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - stopEventsDetectionJob
```
public StopEventsDetectionJobResult stopEventsDetectionJob(StopEventsDetectionJobRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Stops an events detection job in progress.
    
    Specified by:
    
    stopEventsDetectionJob in interface AmazonComprehend
    
    Returns:
    
    Result of the StopEventsDetectionJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - stopKeyPhrasesDetectionJob
```
public StopKeyPhrasesDetectionJobResult stopKeyPhrasesDetectionJob(StopKeyPhrasesDetectionJobRequest request)
```
    Description copied from interface: AmazonComprehend
    
    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.
    
    Specified by:
    
    stopKeyPhrasesDetectionJob in interface AmazonComprehend
    
    Returns:
    
    Result of the StopKeyPhrasesDetectionJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - stopPiiEntitiesDetectionJob
```
public StopPiiEntitiesDetectionJobResult stopPiiEntitiesDetectionJob(StopPiiEntitiesDetectionJobRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Stops a PII entities detection job in progress.
    
    Specified by:
    
    stopPiiEntitiesDetectionJob in interface AmazonComprehend
    
    Returns:
    
    Result of the StopPiiEntitiesDetectionJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - stopSentimentDetectionJob
```
public StopSentimentDetectionJobResult stopSentimentDetectionJob(StopSentimentDetectionJobRequest request)
```
    Description copied from interface: AmazonComprehend
    
    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.
    
    Specified by:
    
    stopSentimentDetectionJob in interface AmazonComprehend
    
    Returns:
    
    Result of the StopSentimentDetectionJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - stopTargetedSentimentDetectionJob
```
public StopTargetedSentimentDetectionJobResult stopTargetedSentimentDetectionJob(StopTargetedSentimentDetectionJobRequest request)
```
    Description copied from interface: AmazonComprehend
    
    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.
    
    Specified by:
    
    stopTargetedSentimentDetectionJob in interface AmazonComprehend
    
    Returns:
    
    Result of the StopTargetedSentimentDetectionJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - stopTrainingDocumentClassifier
```
public StopTrainingDocumentClassifierResult stopTrainingDocumentClassifier(StopTrainingDocumentClassifierRequest request)
```
    Description copied from interface: AmazonComprehend
    
    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.
    
    Specified by:
    
    stopTrainingDocumentClassifier in interface AmazonComprehend
    
    Returns:
    
    Result of the StopTrainingDocumentClassifier operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - stopTrainingEntityRecognizer
```
public StopTrainingEntityRecognizerResult stopTrainingEntityRecognizer(StopTrainingEntityRecognizerRequest request)
```
    Description copied from interface: AmazonComprehend
    
    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.
    
    Specified by:
    
    stopTrainingEntityRecognizer in interface AmazonComprehend
    
    Returns:
    
    Result of the StopTrainingEntityRecognizer operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AmazonComprehend
    
    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.
    
    Specified by:
    
    tagResource in interface AmazonComprehend
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Removes a specific tag associated with an Amazon Comprehend resource.
    
    Specified by:
    
    untagResource in interface AmazonComprehend
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateEndpoint
```
public UpdateEndpointResult updateEndpoint(UpdateEndpointRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Updates information about the specified endpoint. For information about endpoints, see Managing endpoints.
    
    Specified by:
    
    updateEndpoint in interface AmazonComprehend
    
    Returns:
    
    Result of the UpdateEndpoint operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateFlywheel
```
public UpdateFlywheelResult updateFlywheel(UpdateFlywheelRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Update the configuration information for an existing flywheel.
    
    Specified by:
    
    updateFlywheel in interface AmazonComprehend
    
    Returns:
    
    Result of the UpdateFlywheel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AmazonComprehend
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AmazonComprehend
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AmazonComprehend
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonComprehend
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Skip navigation links

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class AbstractAmazonComprehend

Field Summary

Fields inherited from interface com.amazonaws.services.comprehend.AmazonComprehend

Method Summary

Methods inherited from class java.lang.Object

Method Detail

batchDetectDominantLanguage

batchDetectEntities

batchDetectKeyPhrases

batchDetectSentiment

batchDetectSyntax

batchDetectTargetedSentiment

classifyDocument

containsPiiEntities

createDataset

createDocumentClassifier

createEndpoint

createEntityRecognizer

createFlywheel

deleteDocumentClassifier

deleteEndpoint

deleteEntityRecognizer

deleteFlywheel

deleteResourcePolicy

describeDataset

describeDocumentClassificationJob

describeDocumentClassifier

describeDominantLanguageDetectionJob

describeEndpoint

describeEntitiesDetectionJob

describeEntityRecognizer

describeEventsDetectionJob

describeFlywheel

describeFlywheelIteration

describeKeyPhrasesDetectionJob

describePiiEntitiesDetectionJob

describeResourcePolicy

describeSentimentDetectionJob

describeTargetedSentimentDetectionJob

describeTopicsDetectionJob

detectDominantLanguage

detectEntities

detectKeyPhrases

detectPiiEntities

detectSentiment

detectSyntax

detectTargetedSentiment

detectToxicContent

importModel

listDatasets

listDocumentClassificationJobs

listDocumentClassifierSummaries

listDocumentClassifiers

listDominantLanguageDetectionJobs

listEndpoints

listEntitiesDetectionJobs

listEntityRecognizerSummaries

listEntityRecognizers

listEventsDetectionJobs

listFlywheelIterationHistory

listFlywheels

listKeyPhrasesDetectionJobs

listPiiEntitiesDetectionJobs

listSentimentDetectionJobs

listTagsForResource

listTargetedSentimentDetectionJobs

listTopicsDetectionJobs

putResourcePolicy

startDocumentClassificationJob

startDominantLanguageDetectionJob

startEntitiesDetectionJob

startEventsDetectionJob

startFlywheelIteration

startKeyPhrasesDetectionJob

startPiiEntitiesDetectionJob

startSentimentDetectionJob

startTargetedSentimentDetectionJob

startTopicsDetectionJob

stopDominantLanguageDetectionJob