Serialized Form (AWS Java SDK for Amazon Comprehend 1.11.590 API)

Package com.amazonaws.services.comprehend.model
- Class com.amazonaws.services.comprehend.model.AmazonComprehendException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.comprehend.model.BatchDetectDominantLanguageItemResult extends Object implements Serializable
  - Serialized Fields
    - index
```
Integer index
```
      The zero-based index of the document in the input list.
    - languages
```
List<E> languages
```
      One or more DominantLanguage objects describing the dominant languages in the document.
- Class com.amazonaws.services.comprehend.model.BatchDetectDominantLanguageRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - textList
```
List<E> textList
```
      A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document should contain at least 20 characters and must contain fewer than 5,000 bytes of UTF-8 encoded characters.
- Class com.amazonaws.services.comprehend.model.BatchDetectDominantLanguageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - resultList
```
List<E> resultList
```
      A list of objects containing the results of the operation. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty.
    - errorList
```
List<E> errorList
```
      A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty.
- Class com.amazonaws.services.comprehend.model.BatchDetectEntitiesItemResult extends Object implements Serializable
  - Serialized Fields
    - index
```
Integer index
```
      The zero-based index of the document in the input list.
    - entities
```
List<E> entities
```
      One or more Entity objects, one for each entity detected in the document.
- Class com.amazonaws.services.comprehend.model.BatchDetectEntitiesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - textList
```
List<E> textList
```
      A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer than 5,000 bytes of UTF-8 encoded characters.
    - languageCode
```
String languageCode
```
      The language of the input documents. You can specify English ("en") or Spanish ("es"). All documents must be in the same language.
- Class com.amazonaws.services.comprehend.model.BatchDetectEntitiesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - resultList
```
List<E> resultList
```
      A list of objects containing the results of the operation. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty.
    - errorList
```
List<E> errorList
```
      A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty.
- Class com.amazonaws.services.comprehend.model.BatchDetectKeyPhrasesItemResult extends Object implements Serializable
  - Serialized Fields
    - index
```
Integer index
```
      The zero-based index of the document in the input list.
    - keyPhrases
```
List<E> keyPhrases
```
      One or more KeyPhrase objects, one for each key phrase detected in the document.
- Class com.amazonaws.services.comprehend.model.BatchDetectKeyPhrasesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - textList
```
List<E> textList
```
      A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.
    - languageCode
```
String languageCode
```
      The language of the input documents. You can specify English ("en") or Spanish ("es"). All documents must be in the same language.
- Class com.amazonaws.services.comprehend.model.BatchDetectKeyPhrasesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - resultList
```
List<E> resultList
```
      A list of objects containing the results of the operation. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty.
    - errorList
```
List<E> errorList
```
      A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty.
- Class com.amazonaws.services.comprehend.model.BatchDetectSentimentItemResult extends Object implements Serializable
  - Serialized Fields
    - index
```
Integer index
```
      The zero-based index of the document in the input list.
    - sentiment
```
String sentiment
```
      The sentiment detected in the document.
    - sentimentScore
```
SentimentScore sentimentScore
```
      The level of confidence that Amazon Comprehend has in the accuracy of its sentiment detection.
- Class com.amazonaws.services.comprehend.model.BatchDetectSentimentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - textList
```
List<E> textList
```
      A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.
    - languageCode
```
String languageCode
```
      The language of the input documents. You can specify English ("en") or Spanish ("es"). All documents must be in the same language.
- Class com.amazonaws.services.comprehend.model.BatchDetectSentimentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - resultList
```
List<E> resultList
```
      A list of objects containing the results of the operation. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty.
    - errorList
```
List<E> errorList
```
      A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty.
- Class com.amazonaws.services.comprehend.model.BatchDetectSyntaxItemResult extends Object implements Serializable
  - Serialized Fields
    - index
```
Integer index
```
      The zero-based index of the document in the input list.
    - syntaxTokens
```
List<E> syntaxTokens
```
      The syntax tokens for the words in the document, one token for each word.
- Class com.amazonaws.services.comprehend.model.BatchDetectSyntaxRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - textList
```
List<E> textList
```
      A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.
    - languageCode
```
String languageCode
```
      The language of the input documents. You can specify English ("en") or Spanish ("es"). All documents must be in the same language.
- Class com.amazonaws.services.comprehend.model.BatchDetectSyntaxResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - resultList
```
List<E> resultList
```
      A list of objects containing the results of the operation. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty.
    - errorList
```
List<E> errorList
```
      A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty.
- Class com.amazonaws.services.comprehend.model.BatchItemError extends Object implements Serializable
  - Serialized Fields
    - index
```
Integer index
```
      The zero-based index of the document in the input list.
    - errorCode
```
String errorCode
```
      The numeric error code of the error.
    - errorMessage
```
String errorMessage
```
      A text description of the error.
- Class com.amazonaws.services.comprehend.model.BatchSizeLimitExceededException extends AmazonComprehendException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.comprehend.model.ClassifierEvaluationMetrics extends Object implements Serializable
  - Serialized Fields
    - accuracy
```
Double accuracy
```
      The fraction of the labels that were correct recognized. It is computed by dividing the number of labels in the test documents that were correctly recognized by the total number of labels in the test documents.
    - precision
```
Double precision
```
      A measure of the usefulness of the classifier results in the test data. High precision means that the classifier returned substantially more relevant results than irrelevant ones.
    - recall
```
Double recall
```
      A measure of how complete the classifier results are for the test data. High recall means that the classifier returned most of the relevant results.
    - f1Score
```
Double f1Score
```
      A measure of how accurate the classifier results are for the test data. It is derived from the Precision and Recall values. The F1Score is the harmonic average of the two scores. The highest score is 1, and the worst score is 0.
- Class com.amazonaws.services.comprehend.model.ClassifierMetadata extends Object implements Serializable
  - Serialized Fields
    - numberOfLabels
```
Integer numberOfLabels
```
      The number of labels in the input data.
    - numberOfTrainedDocuments
```
Integer numberOfTrainedDocuments
```
      The number of documents in the input data that were used to train the classifier. Typically this is 80 to 90 percent of the input documents.
    - numberOfTestDocuments
```
Integer numberOfTestDocuments
```
      The number of documents in the input data that were used to test the classifier. Typically this is 10 to 20 percent of the input documents.
    - evaluationMetrics
```
ClassifierEvaluationMetrics evaluationMetrics
```
      Describes the result metrics for the test data associated with an documentation classifier.
- Class com.amazonaws.services.comprehend.model.ConcurrentModificationException extends AmazonComprehendException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.comprehend.model.CreateDocumentClassifierRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - documentClassifierName
```
String documentClassifierName
```
      The name of the document classifier.
    - dataAccessRoleArn
```
String dataAccessRoleArn
```
      The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
    - tags
```
List<E> tags
```
      Tags to be associated with the document classifier being created. 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.
    - inputDataConfig
```
DocumentClassifierInputDataConfig inputDataConfig
```
      Specifies the format and location of the input data for the job.
    - outputDataConfig
```
DocumentClassifierOutputDataConfig outputDataConfig
```
      Enables the addition of output results configuration parameters for custom classifier jobs.
    - clientRequestToken
```
String clientRequestToken
```
      A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
    - languageCode
```
String languageCode
```
      The language of the input documents. You can specify English ("en") or Spanish ("es"). All documents must be in the same language.
    - volumeKmsKeyId
```
String volumeKmsKeyId
```
      ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
      
      KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
      
      Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    - vpcConfig
```
VpcConfig vpcConfig
```
      Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. For more information, see Amazon VPC.
- Class com.amazonaws.services.comprehend.model.CreateDocumentClassifierResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - documentClassifierArn
```
String documentClassifierArn
```
      The Amazon Resource Name (ARN) that identifies the document classifier.
- Class com.amazonaws.services.comprehend.model.CreateEntityRecognizerRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - recognizerName
```
String recognizerName
```
      The name given to the newly created recognizer. Recognizer names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The name must be unique in the account/region.
    - dataAccessRoleArn
```
String dataAccessRoleArn
```
      The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
    - tags
```
List<E> tags
```
      Tags to be associated with the entity recognizer being created. 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.
    - inputDataConfig
```
EntityRecognizerInputDataConfig inputDataConfig
```
      Specifies the format and location of the input data. The S3 bucket containing the input data must be located in the same region as the entity recognizer being created.
    - clientRequestToken
```
String clientRequestToken
```
      A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
    - languageCode
```
String languageCode
```
      The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported.
    - volumeKmsKeyId
```
String volumeKmsKeyId
```
      ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
      
      KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
      
      Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    - vpcConfig
```
VpcConfig vpcConfig
```
      Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom entity recognizer. For more information, see Amazon VPC.
- Class com.amazonaws.services.comprehend.model.CreateEntityRecognizerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - entityRecognizerArn
```
String entityRecognizerArn
```
      The Amazon Resource Name (ARN) that identifies the entity recognizer.
- Class com.amazonaws.services.comprehend.model.DeleteDocumentClassifierRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - documentClassifierArn
```
String documentClassifierArn
```
      The Amazon Resource Name (ARN) that identifies the document classifier.
- Class com.amazonaws.services.comprehend.model.DeleteDocumentClassifierResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.comprehend.model.DeleteEntityRecognizerRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - entityRecognizerArn
```
String entityRecognizerArn
```
      The Amazon Resource Name (ARN) that identifies the entity recognizer.
- Class com.amazonaws.services.comprehend.model.DeleteEntityRecognizerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.comprehend.model.DescribeDocumentClassificationJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
- Class com.amazonaws.services.comprehend.model.DescribeDocumentClassificationJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - documentClassificationJobProperties
```
DocumentClassificationJobProperties documentClassificationJobProperties
```
      An object that describes the properties associated with the document classification job.
- Class com.amazonaws.services.comprehend.model.DescribeDocumentClassifierRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - documentClassifierArn
```
String documentClassifierArn
```
      The Amazon Resource Name (ARN) that identifies the document classifier. The operation returns this identifier in its response.
- Class com.amazonaws.services.comprehend.model.DescribeDocumentClassifierResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - documentClassifierProperties
```
DocumentClassifierProperties documentClassifierProperties
```
      An object that contains the properties associated with a document classifier.
- Class com.amazonaws.services.comprehend.model.DescribeDominantLanguageDetectionJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
- Class com.amazonaws.services.comprehend.model.DescribeDominantLanguageDetectionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - dominantLanguageDetectionJobProperties
```
DominantLanguageDetectionJobProperties dominantLanguageDetectionJobProperties
```
      An object that contains the properties associated with a dominant language detection job.
- Class com.amazonaws.services.comprehend.model.DescribeEntitiesDetectionJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
- Class com.amazonaws.services.comprehend.model.DescribeEntitiesDetectionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - entitiesDetectionJobProperties
```
EntitiesDetectionJobProperties entitiesDetectionJobProperties
```
      An object that contains the properties associated with an entities detection job.
- Class com.amazonaws.services.comprehend.model.DescribeEntityRecognizerRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - entityRecognizerArn
```
String entityRecognizerArn
```
      The Amazon Resource Name (ARN) that identifies the entity recognizer.
- Class com.amazonaws.services.comprehend.model.DescribeEntityRecognizerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - entityRecognizerProperties
```
EntityRecognizerProperties entityRecognizerProperties
```
      Describes information associated with an entity recognizer.
- Class com.amazonaws.services.comprehend.model.DescribeKeyPhrasesDetectionJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
- Class com.amazonaws.services.comprehend.model.DescribeKeyPhrasesDetectionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - keyPhrasesDetectionJobProperties
```
KeyPhrasesDetectionJobProperties keyPhrasesDetectionJobProperties
```
      An object that contains the properties associated with a key phrases detection job.
- Class com.amazonaws.services.comprehend.model.DescribeSentimentDetectionJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
- Class com.amazonaws.services.comprehend.model.DescribeSentimentDetectionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - sentimentDetectionJobProperties
```
SentimentDetectionJobProperties sentimentDetectionJobProperties
```
      An object that contains the properties associated with a sentiment detection job.
- Class com.amazonaws.services.comprehend.model.DescribeTopicsDetectionJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier assigned by the user to the detection job.
- Class com.amazonaws.services.comprehend.model.DescribeTopicsDetectionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - topicsDetectionJobProperties
```
TopicsDetectionJobProperties topicsDetectionJobProperties
```
      The list of properties for the requested job.
- Class com.amazonaws.services.comprehend.model.DetectDominantLanguageRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - text
```
String text
```
      A UTF-8 text string. Each string should contain at least 20 characters and must contain fewer that 5,000 bytes of UTF-8 encoded characters.
- Class com.amazonaws.services.comprehend.model.DetectDominantLanguageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - languages
```
List<E> languages
```
      The languages that Amazon Comprehend detected in the input text. For each language, the response returns the RFC 5646 language code and the level of confidence that Amazon Comprehend has in the accuracy of its inference. For more information about RFC 5646, see Tags for Identifying Languages on the IETF Tools web site.
- Class com.amazonaws.services.comprehend.model.DetectEntitiesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - text
```
String text
```
      A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.
    - languageCode
```
String languageCode
```
      The language of the input documents. You can specify English ("en") or Spanish ("es"). All documents must be in the same language.
- Class com.amazonaws.services.comprehend.model.DetectEntitiesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - entities
```
List<E> entities
```
      A collection of entities identified in the input text. For each entity, the response provides the entity text, entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection. For a list of entity types, see how-entities.
- Class com.amazonaws.services.comprehend.model.DetectKeyPhrasesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - text
```
String text
```
      A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.
    - languageCode
```
String languageCode
```
      The language of the input documents. You can specify English ("en") or Spanish ("es"). All documents must be in the same language.
- Class com.amazonaws.services.comprehend.model.DetectKeyPhrasesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - keyPhrases
```
List<E> keyPhrases
```
      A collection of key phrases that Amazon Comprehend identified in the input text. For each key phrase, the response provides the text of the key phrase, where the key phrase begins and ends, and the level of confidence that Amazon Comprehend has in the accuracy of the detection.
- Class com.amazonaws.services.comprehend.model.DetectSentimentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - text
```
String text
```
      A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.
    - languageCode
```
String languageCode
```
      The language of the input documents. You can specify English ("en") or Spanish ("es"). All documents must be in the same language.
- Class com.amazonaws.services.comprehend.model.DetectSentimentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - sentiment
```
String sentiment
```
      The inferred sentiment that Amazon Comprehend has the highest level of confidence in.
    - sentimentScore
```
SentimentScore sentimentScore
```
      An object that lists the sentiments, and their corresponding confidence levels.
- Class com.amazonaws.services.comprehend.model.DetectSyntaxRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - text
```
String text
```
      A UTF-8 string. Each string must contain fewer that 5,000 bytes of UTF encoded characters.
    - languageCode
```
String languageCode
```
      The language code of the input documents. You can specify English ("en") or Spanish ("es").
- Class com.amazonaws.services.comprehend.model.DetectSyntaxResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - syntaxTokens
```
List<E> syntaxTokens
```
      A collection of syntax tokens describing the text. For each token, the response provides the text, the token type, where the text begins and ends, and the level of confidence that Amazon Comprehend has that the token is correct. For a list of token types, see how-syntax.
- Class com.amazonaws.services.comprehend.model.DocumentClassificationJobFilter extends Object implements Serializable
  - Serialized Fields
    - jobName
```
String jobName
```
      Filters on the name of the job.
    - jobStatus
```
String jobStatus
```
      Filters the list based on job status. Returns only jobs with the specified status.
    - submitTimeBefore
```
Date submitTimeBefore
```
      Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in ascending order, oldest to newest.
    - submitTimeAfter
```
Date submitTimeAfter
```
      Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in descending order, newest to oldest.
- Class com.amazonaws.services.comprehend.model.DocumentClassificationJobProperties extends Object implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier assigned to the document classification job.
    - jobName
```
String jobName
```
      The name that you assigned to the document classification job.
    - jobStatus
```
String jobStatus
```
      The current status of the document classification job. If the status is FAILED, the Message field shows the reason for the failure.
    - message
```
String message
```
      A description of the status of the job.
    - submitTime
```
Date submitTime
```
      The time that the document classification job was submitted for processing.
    - endTime
```
Date endTime
```
      The time that the document classification job completed.
    - documentClassifierArn
```
String documentClassifierArn
```
      The Amazon Resource Name (ARN) that identifies the document classifier.
    - inputDataConfig
```
InputDataConfig inputDataConfig
```
      The input data configuration that you supplied when you created the document classification job.
    - outputDataConfig
```
OutputDataConfig outputDataConfig
```
      The output data configuration that you supplied when you created the document classification job.
    - dataAccessRoleArn
```
String dataAccessRoleArn
```
      The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
    - volumeKmsKeyId
```
String volumeKmsKeyId
```
      ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
      
      KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
      
      Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    - vpcConfig
```
VpcConfig vpcConfig
```
      Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. For more information, see Amazon VPC.
- Class com.amazonaws.services.comprehend.model.DocumentClassifierFilter extends Object implements Serializable
  - Serialized Fields
    - status
```
String status
```
      Filters the list of classifiers based on status.
    - submitTimeBefore
```
Date submitTimeBefore
```
      Filters the list of classifiers based on the time that the classifier was submitted for processing. Returns only classifiers submitted before the specified time. Classifiers are returned in ascending order, oldest to newest.
    - submitTimeAfter
```
Date submitTimeAfter
```
      Filters the list of classifiers based on the time that the classifier was submitted for processing. Returns only classifiers submitted after the specified time. Classifiers are returned in descending order, newest to oldest.
- Class com.amazonaws.services.comprehend.model.DocumentClassifierInputDataConfig extends Object implements Serializable
  - Serialized Fields
    - s3Uri
```
String s3Uri
```
      The Amazon S3 URI for the input data. The S3 bucket must be in the same region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of input files.
      
      For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.
- Class com.amazonaws.services.comprehend.model.DocumentClassifierOutputDataConfig extends Object implements Serializable
  - Serialized Fields
    - s3Uri
```
String s3Uri
```
      When you use the OutputDataConfig object while creating a custom classifier, you specify the Amazon S3 location where you want to write the confusion matrix. The URI must be in the same region as the API endpoint that you are calling. The location is used as the prefix for the actual location of this output file.
      
      When the custom classifier job is finished, the service creates the output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the confusion matrix.
    - kmsKeyId
```
String kmsKeyId
```
      ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:
      
      KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
      
      Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
      
      KMS Key Alias: "alias/ExampleAlias"
      
      ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
- Class com.amazonaws.services.comprehend.model.DocumentClassifierProperties extends Object implements Serializable
  - Serialized Fields
    - documentClassifierArn
```
String documentClassifierArn
```
      The Amazon Resource Name (ARN) that identifies the document classifier.
    - languageCode
```
String languageCode
```
      The language code for the language of the documents that the classifier was trained on.
    - status
```
String status
```
      The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.
    - message
```
String message
```
      Additional information about the status of the classifier.
    - submitTime
```
Date submitTime
```
      The time that the document classifier was submitted for training.
    - endTime
```
Date endTime
```
      The time that training the document classifier completed.
    - trainingStartTime
```
Date trainingStartTime
```
      Indicates the time when the training starts on documentation classifiers. You are billed for the time interval between this time and the value of TrainingEndTime.
    - trainingEndTime
```
Date trainingEndTime
```
      The time that training of the document classifier was completed. Indicates the time when the training completes on documentation classifiers. You are billed for the time interval between this time and the value of TrainingStartTime.
    - inputDataConfig
```
DocumentClassifierInputDataConfig inputDataConfig
```
      The input data configuration that you supplied when you created the document classifier for training.
    - outputDataConfig
```
DocumentClassifierOutputDataConfig outputDataConfig
```
      Provides output results configuration parameters for custom classifier jobs.
    - classifierMetadata
```
ClassifierMetadata classifierMetadata
```
      Information about the document classifier, including the number of documents used for training the classifier, the number of documents used for test the classifier, and an accuracy rating.
    - dataAccessRoleArn
```
String dataAccessRoleArn
```
      The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
    - volumeKmsKeyId
```
String volumeKmsKeyId
```
      ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
      
      KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
      
      Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    - vpcConfig
```
VpcConfig vpcConfig
```
      Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. For more information, see Amazon VPC.
- Class com.amazonaws.services.comprehend.model.DominantLanguage extends Object implements Serializable
  - Serialized Fields
    - languageCode
```
String languageCode
```
      The RFC 5646 language code for the dominant language. For more information about RFC 5646, see Tags for Identifying Languages on the IETF Tools web site.
    - score
```
Float score
```
      The level of confidence that Amazon Comprehend has in the accuracy of the detection.
- Class com.amazonaws.services.comprehend.model.DominantLanguageDetectionJobFilter extends Object implements Serializable
  - Serialized Fields
    - jobName
```
String jobName
```
      Filters on the name of the job.
    - jobStatus
```
String jobStatus
```
      Filters the list of jobs based on job status. Returns only jobs with the specified status.
    - submitTimeBefore
```
Date submitTimeBefore
```
      Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.
    - submitTimeAfter
```
Date submitTimeAfter
```
      Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.
- Class com.amazonaws.services.comprehend.model.DominantLanguageDetectionJobProperties extends Object implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier assigned to the dominant language detection job.
    - jobName
```
String jobName
```
      The name that you assigned to the dominant language detection job.
    - jobStatus
```
String jobStatus
```
      The current status of the dominant language detection job. If the status is FAILED, the Message field shows the reason for the failure.
    - message
```
String message
```
      A description for the status of a job.
    - submitTime
```
Date submitTime
```
      The time that the dominant language detection job was submitted for processing.
    - endTime
```
Date endTime
```
      The time that the dominant language detection job completed.
    - inputDataConfig
```
InputDataConfig inputDataConfig
```
      The input data configuration that you supplied when you created the dominant language detection job.
    - outputDataConfig
```
OutputDataConfig outputDataConfig
```
      The output data configuration that you supplied when you created the dominant language detection job.
    - dataAccessRoleArn
```
String dataAccessRoleArn
```
      The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
    - volumeKmsKeyId
```
String volumeKmsKeyId
```
      ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
      
      KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
      
      Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    - vpcConfig
```
VpcConfig vpcConfig
```
      Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your dominant language detection job. For more information, see Amazon VPC.
- Class com.amazonaws.services.comprehend.model.EntitiesDetectionJobFilter extends Object implements Serializable
  - Serialized Fields
    - jobName
```
String jobName
```
      Filters on the name of the job.
    - jobStatus
```
String jobStatus
```
      Filters the list of jobs based on job status. Returns only jobs with the specified status.
    - submitTimeBefore
```
Date submitTimeBefore
```
      Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.
    - submitTimeAfter
```
Date submitTimeAfter
```
      Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.
- Class com.amazonaws.services.comprehend.model.EntitiesDetectionJobProperties extends Object implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier assigned to the entities detection job.
    - jobName
```
String jobName
```
      The name that you assigned the entities detection job.
    - jobStatus
```
String jobStatus
```
      The current status of the entities detection job. If the status is FAILED, the Message field shows the reason for the failure.
    - message
```
String message
```
      A description of the status of a job.
    - submitTime
```
Date submitTime
```
      The time that the entities detection job was submitted for processing.
    - endTime
```
Date endTime
```
      The time that the entities detection job completed
    - entityRecognizerArn
```
String entityRecognizerArn
```
      The Amazon Resource Name (ARN) that identifies the entity recognizer.
    - inputDataConfig
```
InputDataConfig inputDataConfig
```
      The input data configuration that you supplied when you created the entities detection job.
    - outputDataConfig
```
OutputDataConfig outputDataConfig
```
      The output data configuration that you supplied when you created the entities detection job.
    - languageCode
```
String languageCode
```
      The language code of the input documents.
    - dataAccessRoleArn
```
String dataAccessRoleArn
```
      The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
    - volumeKmsKeyId
```
String volumeKmsKeyId
```
      ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
      
      KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
      
      Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    - vpcConfig
```
VpcConfig vpcConfig
```
      Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job. For more information, see Amazon VPC.
- Class com.amazonaws.services.comprehend.model.Entity extends Object implements Serializable
  - Serialized Fields
    - score
```
Float score
```
      The level of confidence that Amazon Comprehend has in the accuracy of the detection.
    - type
```
String type
```
      The entity's type.
    - text
```
String text
```
      The text of the entity.
    - beginOffset
```
Integer beginOffset
```
      A character offset in the input text that shows where the entity begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.
    - endOffset
```
Integer endOffset
```
      A character offset in the input text that shows where the entity ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.
- Class com.amazonaws.services.comprehend.model.EntityRecognizerAnnotations extends Object implements Serializable
  - Serialized Fields
    - s3Uri
```
String s3Uri
```
      Specifies the Amazon S3 location where the annotations for an entity recognizer are located. The URI must be in the same region as the API endpoint that you are calling.
- Class com.amazonaws.services.comprehend.model.EntityRecognizerDocuments extends Object implements Serializable
  - Serialized Fields
    - s3Uri
```
String s3Uri
```
      Specifies the Amazon S3 location where the training documents for an entity recognizer are located. The URI must be in the same region as the API endpoint that you are calling.
- Class com.amazonaws.services.comprehend.model.EntityRecognizerEntityList extends Object implements Serializable
  - Serialized Fields
    - s3Uri
```
String s3Uri
```
      Specifies the Amazon S3 location where the entity list is located. The URI must be in the same region as the API endpoint that you are calling.
- Class com.amazonaws.services.comprehend.model.EntityRecognizerEvaluationMetrics extends Object implements Serializable
  - Serialized Fields
    - precision
```
Double precision
```
      A measure of the usefulness of the recognizer results in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones.
    - recall
```
Double recall
```
      A measure of how complete the recognizer results are for the test data. High recall means that the recognizer returned most of the relevant results.
    - f1Score
```
Double f1Score
```
      A measure of how accurate the recognizer results are for the test data. It is derived from the Precision and Recall values. The F1Score is the harmonic average of the two scores. The highest score is 1, and the worst score is 0.
- Class com.amazonaws.services.comprehend.model.EntityRecognizerFilter extends Object implements Serializable
  - Serialized Fields
    - status
```
String status
```
      The status of an entity recognizer.
    - submitTimeBefore
```
Date submitTimeBefore
```
      Filters the list of entities based on the time that the list was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in descending order, newest to oldest.
    - submitTimeAfter
```
Date submitTimeAfter
```
      Filters the list of entities based on the time that the list was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in ascending order, oldest to newest.
- Class com.amazonaws.services.comprehend.model.EntityRecognizerInputDataConfig extends Object implements Serializable
  - Serialized Fields
    - entityTypes
```
List<E> entityTypes
```
      The entity types in the input data for an entity recognizer.
    - documents
```
EntityRecognizerDocuments documents
```
      S3 location of the documents folder for an entity recognizer
    - annotations
```
EntityRecognizerAnnotations annotations
```
      S3 location of the annotations file for an entity recognizer.
    - entityList
```
EntityRecognizerEntityList entityList
```
      S3 location of the entity list for an entity recognizer.
- Class com.amazonaws.services.comprehend.model.EntityRecognizerMetadata extends Object implements Serializable
  - Serialized Fields
    - numberOfTrainedDocuments
```
Integer numberOfTrainedDocuments
```
      The number of documents in the input data that were used to train the entity recognizer. Typically this is 80 to 90 percent of the input documents.
    - numberOfTestDocuments
```
Integer numberOfTestDocuments
```
      The number of documents in the input data that were used to test the entity recognizer. Typically this is 10 to 20 percent of the input documents.
    - evaluationMetrics
```
EntityRecognizerEvaluationMetrics evaluationMetrics
```
      Detailed information about the accuracy of an entity recognizer.
    - entityTypes
```
List<E> entityTypes
```
      Entity types from the metadata of an entity recognizer.
- Class com.amazonaws.services.comprehend.model.EntityRecognizerMetadataEntityTypesListItem extends Object implements Serializable
  - Serialized Fields
    - type
```
String type
```
      Type of entity from the list of entity types in the metadata of an entity recognizer.
- Class com.amazonaws.services.comprehend.model.EntityRecognizerProperties extends Object implements Serializable
  - Serialized Fields
    - entityRecognizerArn
```
String entityRecognizerArn
```
      The Amazon Resource Name (ARN) that identifies the entity recognizer.
    - languageCode
```
String languageCode
```
      The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported.
    - status
```
String status
```
      Provides the status of the entity recognizer.
    - message
```
String message
```
      A description of the status of the recognizer.
    - submitTime
```
Date submitTime
```
      The time that the recognizer was submitted for processing.
    - endTime
```
Date endTime
```
      The time that the recognizer creation completed.
    - trainingStartTime
```
Date trainingStartTime
```
      The time that training of the entity recognizer started.
    - trainingEndTime
```
Date trainingEndTime
```
      The time that training of the entity recognizer was completed.
    - inputDataConfig
```
EntityRecognizerInputDataConfig inputDataConfig
```
      The input data properties of an entity recognizer.
    - recognizerMetadata
```
EntityRecognizerMetadata recognizerMetadata
```
      Provides information about an entity recognizer.
    - dataAccessRoleArn
```
String dataAccessRoleArn
```
      The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
    - volumeKmsKeyId
```
String volumeKmsKeyId
```
      ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
      
      KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
      
      Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    - vpcConfig
```
VpcConfig vpcConfig
```
      Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom entity recognizer. For more information, see Amazon VPC.
- Class com.amazonaws.services.comprehend.model.EntityTypesListItem extends Object implements Serializable
  - Serialized Fields
    - type
```
String type
```
      Entity type of an item on an entity type list.
- Class com.amazonaws.services.comprehend.model.InputDataConfig extends Object implements Serializable
  - Serialized Fields
    - s3Uri
```
String s3Uri
```
      The Amazon S3 URI for the input data. The URI must be in same region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files.
      
      For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.
    - inputFormat
```
String inputFormat
```
      Specifies how the text in an input file should be processed:
      
      ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers.
      
      ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.
- Class com.amazonaws.services.comprehend.model.InternalServerException extends AmazonComprehendException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.comprehend.model.InvalidFilterException extends AmazonComprehendException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.comprehend.model.InvalidRequestException extends AmazonComprehendException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.comprehend.model.JobNotFoundException extends AmazonComprehendException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.comprehend.model.KeyPhrase extends Object implements Serializable
  - Serialized Fields
    - score
```
Float score
```
      The level of confidence that Amazon Comprehend has in the accuracy of the detection.
    - text
```
String text
```
      The text of a key noun phrase.
    - beginOffset
```
Integer beginOffset
```
      A character offset in the input text that shows where the key phrase begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.
    - endOffset
```
Integer endOffset
```
      A character offset in the input text where the key phrase ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.
- Class com.amazonaws.services.comprehend.model.KeyPhrasesDetectionJobFilter extends Object implements Serializable
  - Serialized Fields
    - jobName
```
String jobName
```
      Filters on the name of the job.
    - jobStatus
```
String jobStatus
```
      Filters the list of jobs based on job status. Returns only jobs with the specified status.
    - submitTimeBefore
```
Date submitTimeBefore
```
      Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.
    - submitTimeAfter
```
Date submitTimeAfter
```
      Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.
- Class com.amazonaws.services.comprehend.model.KeyPhrasesDetectionJobProperties extends Object implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier assigned to the key phrases detection job.
    - jobName
```
String jobName
```
      The name that you assigned the key phrases detection job.
    - jobStatus
```
String jobStatus
```
      The current status of the key phrases detection job. If the status is FAILED, the Message field shows the reason for the failure.
    - message
```
String message
```
      A description of the status of a job.
    - submitTime
```
Date submitTime
```
      The time that the key phrases detection job was submitted for processing.
    - endTime
```
Date endTime
```
      The time that the key phrases detection job completed.
    - inputDataConfig
```
InputDataConfig inputDataConfig
```
      The input data configuration that you supplied when you created the key phrases detection job.
    - outputDataConfig
```
OutputDataConfig outputDataConfig
```
      The output data configuration that you supplied when you created the key phrases detection job.
    - languageCode
```
String languageCode
```
      The language code of the input documents.
    - dataAccessRoleArn
```
String dataAccessRoleArn
```
      The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
    - volumeKmsKeyId
```
String volumeKmsKeyId
```
      ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
      
      KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
      
      Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    - vpcConfig
```
VpcConfig vpcConfig
```
      Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your key phrases detection job. For more information, see Amazon VPC.
- Class com.amazonaws.services.comprehend.model.KmsKeyValidationException extends AmazonComprehendException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.comprehend.model.ListDocumentClassificationJobsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - filter
```
DocumentClassificationJobFilter filter
```
      Filters the jobs that are returned. You can filter jobs on their names, status, or the date and time that they were submitted. You can only set one filter at a time.
    - nextToken
```
String nextToken
```
      Identifies the next page of results to return.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to return in each page. The default is 100.
- Class com.amazonaws.services.comprehend.model.ListDocumentClassificationJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - documentClassificationJobPropertiesList
```
List<E> documentClassificationJobPropertiesList
```
      A list containing the properties of each job returned.
    - nextToken
```
String nextToken
```
      Identifies the next page of results to return.
- Class com.amazonaws.services.comprehend.model.ListDocumentClassifiersRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - filter
```
DocumentClassifierFilter filter
```
      Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.
    - nextToken
```
String nextToken
```
      Identifies the next page of results to return.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to return in each page. The default is 100.
- Class com.amazonaws.services.comprehend.model.ListDocumentClassifiersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - documentClassifierPropertiesList
```
List<E> documentClassifierPropertiesList
```
      A list containing the properties of each job returned.
    - nextToken
```
String nextToken
```
      Identifies the next page of results to return.
- Class com.amazonaws.services.comprehend.model.ListDominantLanguageDetectionJobsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - filter
```
DominantLanguageDetectionJobFilter filter
```
      Filters that jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.
    - nextToken
```
String nextToken
```
      Identifies the next page of results to return.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to return in each page. The default is 100.
- Class com.amazonaws.services.comprehend.model.ListDominantLanguageDetectionJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - dominantLanguageDetectionJobPropertiesList
```
List<E> dominantLanguageDetectionJobPropertiesList
```
      A list containing the properties of each job that is returned.
    - nextToken
```
String nextToken
```
      Identifies the next page of results to return.
- Class com.amazonaws.services.comprehend.model.ListEntitiesDetectionJobsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - filter
```
EntitiesDetectionJobFilter filter
```
      Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.
    - nextToken
```
String nextToken
```
      Identifies the next page of results to return.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to return in each page. The default is 100.
- Class com.amazonaws.services.comprehend.model.ListEntitiesDetectionJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - entitiesDetectionJobPropertiesList
```
List<E> entitiesDetectionJobPropertiesList
```
      A list containing the properties of each job that is returned.
    - nextToken
```
String nextToken
```
      Identifies the next page of results to return.
- Class com.amazonaws.services.comprehend.model.ListEntityRecognizersRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - filter
```
EntityRecognizerFilter filter
```
      Filters the list of entities returned. You can filter on Status, SubmitTimeBefore, or SubmitTimeAfter. You can only set one filter at a time.
    - nextToken
```
String nextToken
```
      Identifies the next page of results to return.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to return on each page. The default is 100.
- Class com.amazonaws.services.comprehend.model.ListEntityRecognizersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - entityRecognizerPropertiesList
```
List<E> entityRecognizerPropertiesList
```
      The list of properties of an entity recognizer.
    - nextToken
```
String nextToken
```
      Identifies the next page of results to return.
- Class com.amazonaws.services.comprehend.model.ListKeyPhrasesDetectionJobsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - filter
```
KeyPhrasesDetectionJobFilter filter
```
      Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.
    - nextToken
```
String nextToken
```
      Identifies the next page of results to return.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to return in each page. The default is 100.
- Class com.amazonaws.services.comprehend.model.ListKeyPhrasesDetectionJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - keyPhrasesDetectionJobPropertiesList
```
List<E> keyPhrasesDetectionJobPropertiesList
```
      A list containing the properties of each job that is returned.
    - nextToken
```
String nextToken
```
      Identifies the next page of results to return.
- Class com.amazonaws.services.comprehend.model.ListSentimentDetectionJobsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - filter
```
SentimentDetectionJobFilter filter
```
      Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.
    - nextToken
```
String nextToken
```
      Identifies the next page of results to return.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to return in each page. The default is 100.
- Class com.amazonaws.services.comprehend.model.ListSentimentDetectionJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - sentimentDetectionJobPropertiesList
```
List<E> sentimentDetectionJobPropertiesList
```
      A list containing the properties of each job that is returned.
    - nextToken
```
String nextToken
```
      Identifies the next page of results to return.
- Class com.amazonaws.services.comprehend.model.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The Amazon Resource Name (ARN) of the given Amazon Comprehend resource you are querying.
- Class com.amazonaws.services.comprehend.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The Amazon Resource Name (ARN) of the given Amazon Comprehend resource you are querying.
    - tags
```
List<E> tags
```
      Tags associated with the Amazon Comprehend resource being queried. 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.
- Class com.amazonaws.services.comprehend.model.ListTopicsDetectionJobsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - filter
```
TopicsDetectionJobFilter filter
```
      Filters the jobs that are returned. Jobs can be filtered on their name, status, or the date and time that they were submitted. You can set only one filter at a time.
    - nextToken
```
String nextToken
```
      Identifies the next page of results to return.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to return in each page. The default is 100.
- Class com.amazonaws.services.comprehend.model.ListTopicsDetectionJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - topicsDetectionJobPropertiesList
```
List<E> topicsDetectionJobPropertiesList
```
      A list containing the properties of each job that is returned.
    - nextToken
```
String nextToken
```
      Identifies the next page of results to return.
- Class com.amazonaws.services.comprehend.model.OutputDataConfig extends Object implements Serializable
  - Serialized Fields
    - s3Uri
```
String s3Uri
```
      When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output file.
      
      When the topic detection job is finished, the service creates an output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the ouput of the operation.
    - kmsKeyId
```
String kmsKeyId
```
      ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:
      
      KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
      
      Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
      
      KMS Key Alias: "alias/ExampleAlias"
      
      ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
- Class com.amazonaws.services.comprehend.model.PartOfSpeechTag extends Object implements Serializable
  - Serialized Fields
    - tag
```
String tag
```
      Identifies the part of speech that the token represents.
    - score
```
Float score
```
      The confidence that Amazon Comprehend has that the part of speech was correctly identified.
- Class com.amazonaws.services.comprehend.model.ResourceInUseException extends AmazonComprehendException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.comprehend.model.ResourceLimitExceededException extends AmazonComprehendException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.comprehend.model.ResourceNotFoundException extends AmazonComprehendException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.comprehend.model.ResourceUnavailableException extends AmazonComprehendException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.comprehend.model.SentimentDetectionJobFilter extends Object implements Serializable
  - Serialized Fields
    - jobName
```
String jobName
```
      Filters on the name of the job.
    - jobStatus
```
String jobStatus
```
      Filters the list of jobs based on job status. Returns only jobs with the specified status.
    - submitTimeBefore
```
Date submitTimeBefore
```
      Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.
    - submitTimeAfter
```
Date submitTimeAfter
```
      Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.
- Class com.amazonaws.services.comprehend.model.SentimentDetectionJobProperties extends Object implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier assigned to the sentiment detection job.
    - jobName
```
String jobName
```
      The name that you assigned to the sentiment detection job
    - jobStatus
```
String jobStatus
```
      The current status of the sentiment detection job. If the status is FAILED, the Messages field shows the reason for the failure.
    - message
```
String message
```
      A description of the status of a job.
    - submitTime
```
Date submitTime
```
      The time that the sentiment detection job was submitted for processing.
    - endTime
```
Date endTime
```
      The time that the sentiment detection job ended.
    - inputDataConfig
```
InputDataConfig inputDataConfig
```
      The input data configuration that you supplied when you created the sentiment detection job.
    - outputDataConfig
```
OutputDataConfig outputDataConfig
```
      The output data configuration that you supplied when you created the sentiment detection job.
    - languageCode
```
String languageCode
```
      The language code of the input documents.
    - dataAccessRoleArn
```
String dataAccessRoleArn
```
      The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
    - volumeKmsKeyId
```
String volumeKmsKeyId
```
      ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
      
      KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
      
      Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    - vpcConfig
```
VpcConfig vpcConfig
```
      Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your sentiment detection job. For more information, see Amazon VPC.
- Class com.amazonaws.services.comprehend.model.SentimentScore extends Object implements Serializable
  - Serialized Fields
    - positive
```
Float positive
```
      The level of confidence that Amazon Comprehend has in the accuracy of its detection of the POSITIVE sentiment.
    - negative
```
Float negative
```
      The level of confidence that Amazon Comprehend has in the accuracy of its detection of the NEGATIVE sentiment.
    - neutral
```
Float neutral
```
      The level of confidence that Amazon Comprehend has in the accuracy of its detection of the NEUTRAL sentiment.
    - mixed
```
Float mixed
```
      The level of confidence that Amazon Comprehend has in the accuracy of its detection of the MIXED sentiment.
- Class com.amazonaws.services.comprehend.model.StartDocumentClassificationJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobName
```
String jobName
```
      The identifier of the job.
    - documentClassifierArn
```
String documentClassifierArn
```
      The Amazon Resource Name (ARN) of the document classifier to use to process the job.
    - inputDataConfig
```
InputDataConfig inputDataConfig
```
      Specifies the format and location of the input data for the job.
    - outputDataConfig
```
OutputDataConfig outputDataConfig
```
      Specifies where to send the output files.
    - dataAccessRoleArn
```
String dataAccessRoleArn
```
      The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
    - clientRequestToken
```
String clientRequestToken
```
      A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.
    - volumeKmsKeyId
```
String volumeKmsKeyId
```
      ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
      
      KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
      
      Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    - vpcConfig
```
VpcConfig vpcConfig
```
      Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. For more information, see Amazon VPC.
- Class com.amazonaws.services.comprehend.model.StartDocumentClassificationJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier generated for the job. To get the status of the job, use this identifier with the operation.
    - jobStatus
```
String jobStatus
```
      The status of the job:
      
      SUBMITTED - The job has been received and queued for processing.
      
      IN_PROGRESS - Amazon Comprehend is processing the job.
      
      COMPLETED - The job was successfully completed and the output is available.
      
      FAILED - The job did not complete. For details, use the operation.
      
      STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.
      
      STOPPED - The job was successfully stopped without completing.
- Class com.amazonaws.services.comprehend.model.StartDominantLanguageDetectionJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - inputDataConfig
```
InputDataConfig inputDataConfig
```
      Specifies the format and location of the input data for the job.
    - outputDataConfig
```
OutputDataConfig outputDataConfig
```
      Specifies where to send the output files.
    - dataAccessRoleArn
```
String dataAccessRoleArn
```
      The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions< /a>.
    - jobName
      
      String jobName
      
      An identifier for the job.
    - clientRequestToken
```
String clientRequestToken
```
      A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.
    - volumeKmsKeyId
```
String volumeKmsKeyId
```
      ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
      
      KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
      
      Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    - vpcConfig
```
VpcConfig vpcConfig
```
      Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your dominant language detection job. For more information, see Amazon VPC.
- Class com.amazonaws.services.comprehend.model.StartDominantLanguageDetectionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier generated for the job. To get the status of a job, use this identifier with the operation.
    - jobStatus
```
String jobStatus
```
      The status of the job.
      
      SUBMITTED - The job has been received and is queued for processing.
      
      IN_PROGRESS - Amazon Comprehend is processing the job.
      
      COMPLETED - The job was successfully completed and the output is available.
      
      FAILED - The job did not complete. To get details, use the operation.
- Class com.amazonaws.services.comprehend.model.StartEntitiesDetectionJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - inputDataConfig
```
InputDataConfig inputDataConfig
```
      Specifies the format and location of the input data for the job.
    - outputDataConfig
```
OutputDataConfig outputDataConfig
```
      Specifies where to send the output files.
    - dataAccessRoleArn
```
String dataAccessRoleArn
```
      The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions< /a>.
    - jobName
      
      String jobName
      
      The identifier of the job.
    - entityRecognizerArn
```
String entityRecognizerArn
```
      The Amazon Resource Name (ARN) that identifies the specific entity recognizer to be used by the StartEntitiesDetectionJob. This ARN is optional and is only used for a custom entity recognition job.
    - languageCode
```
String languageCode
```
      The language of the input documents. All documents must be in the same language. You can specify any of the languages supported by Amazon Comprehend: English ("en"), Spanish ("es"), French ("fr"), German ("de"), Italian ("it"), or Portuguese ("pt"). If custom entities recognition is used, this parameter is ignored and the language used for training the model is used instead.
    - clientRequestToken
```
String clientRequestToken
```
      A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
    - volumeKmsKeyId
```
String volumeKmsKeyId
```
      ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
      
      KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
      
      Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    - vpcConfig
```
VpcConfig vpcConfig
```
      Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job. For more information, see Amazon VPC.
- Class com.amazonaws.services.comprehend.model.StartEntitiesDetectionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier generated for the job. To get the status of job, use this identifier with the operation.
    - jobStatus
```
String jobStatus
```
      The status of the job.
      
      SUBMITTED - The job has been received and is queued for processing.
      
      IN_PROGRESS - Amazon Comprehend is processing the job.
      
      COMPLETED - The job was successfully completed and the output is available.
      
      FAILED - The job did not complete. To get details, use the operation.
      
      STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.
      
      STOPPED - The job was successfully stopped without completing.
- Class com.amazonaws.services.comprehend.model.StartKeyPhrasesDetectionJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - inputDataConfig
```
InputDataConfig inputDataConfig
```
      Specifies the format and location of the input data for the job.
    - outputDataConfig
```
OutputDataConfig outputDataConfig
```
      Specifies where to send the output files.
    - dataAccessRoleArn
```
String dataAccessRoleArn
```
      The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions< /a>.
    - jobName
      
      String jobName
      
      The identifier of the job.
    - languageCode
```
String languageCode
```
      The language of the input documents. You can specify English ("en") or Spanish ("es"). All documents must be in the same language.
    - clientRequestToken
```
String clientRequestToken
```
      A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
    - volumeKmsKeyId
```
String volumeKmsKeyId
```
      ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
      
      KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
      
      Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    - vpcConfig
```
VpcConfig vpcConfig
```
      Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your key phrases detection job. For more information, see Amazon VPC.
- Class com.amazonaws.services.comprehend.model.StartKeyPhrasesDetectionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier generated for the job. To get the status of a job, use this identifier with the operation.
    - jobStatus
```
String jobStatus
```
      The status of the job.
      
      SUBMITTED - The job has been received and is queued for processing.
      
      IN_PROGRESS - Amazon Comprehend is processing the job.
      
      COMPLETED - The job was successfully completed and the output is available.
      
      FAILED - The job did not complete. To get details, use the operation.
- Class com.amazonaws.services.comprehend.model.StartSentimentDetectionJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - inputDataConfig
```
InputDataConfig inputDataConfig
```
      Specifies the format and location of the input data for the job.
    - outputDataConfig
```
OutputDataConfig outputDataConfig
```
      Specifies where to send the output files.
    - dataAccessRoleArn
```
String dataAccessRoleArn
```
      The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions< /a>.
    - jobName
      
      String jobName
      
      The identifier of the job.
    - languageCode
```
String languageCode
```
      The language of the input documents. You can specify English ("en") or Spanish ("es"). All documents must be in the same language.
    - clientRequestToken
```
String clientRequestToken
```
      A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
    - volumeKmsKeyId
```
String volumeKmsKeyId
```
      ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
      
      KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
      
      Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    - vpcConfig
```
VpcConfig vpcConfig
```
      Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your sentiment detection job. For more information, see Amazon VPC.
- Class com.amazonaws.services.comprehend.model.StartSentimentDetectionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier generated for the job. To get the status of a job, use this identifier with the operation.
    - jobStatus
```
String jobStatus
```
      The status of the job.
      
      SUBMITTED - The job has been received and is queued for processing.
      
      IN_PROGRESS - Amazon Comprehend is processing the job.
      
      COMPLETED - The job was successfully completed and the output is available.
      
      FAILED - The job did not complete. To get details, use the operation.
- Class com.amazonaws.services.comprehend.model.StartTopicsDetectionJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - inputDataConfig
```
InputDataConfig inputDataConfig
```
      Specifies the format and location of the input data for the job.
    - outputDataConfig
```
OutputDataConfig outputDataConfig
```
      Specifies where to send the output files. The output is a compressed archive with two files, topic-terms.csv that lists the terms associated with each topic, and doc-topics.csv that lists the documents associated with each topic
    - dataAccessRoleArn
```
String dataAccessRoleArn
```
      The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions< /a>.
    - jobName
      
      String jobName
      
      The identifier of the job.
    - numberOfTopics
```
Integer numberOfTopics
```
      The number of topics to detect.
    - clientRequestToken
```
String clientRequestToken
```
      A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.
    - volumeKmsKeyId
```
String volumeKmsKeyId
```
      ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
      
      KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
      
      Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    - vpcConfig
```
VpcConfig vpcConfig
```
      Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job. For more information, see Amazon VPC.
- Class com.amazonaws.services.comprehend.model.StartTopicsDetectionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier generated for the job. To get the status of the job, use this identifier with the DescribeTopicDetectionJob operation.
    - jobStatus
```
String jobStatus
```
      The status of the job:
      
      SUBMITTED - The job has been received and is queued for processing.
      
      IN_PROGRESS - Amazon Comprehend is processing the job.
      
      COMPLETED - The job was successfully completed and the output is available.
      
      FAILED - The job did not complete. To get details, use the DescribeTopicDetectionJob operation.
- Class com.amazonaws.services.comprehend.model.StopDominantLanguageDetectionJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier of the dominant language detection job to stop.
- Class com.amazonaws.services.comprehend.model.StopDominantLanguageDetectionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier of the dominant language detection job to stop.
    - jobStatus
```
String jobStatus
```
      Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopDominantLanguageDetectionJob operation.
- Class com.amazonaws.services.comprehend.model.StopEntitiesDetectionJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier of the entities detection job to stop.
- Class com.amazonaws.services.comprehend.model.StopEntitiesDetectionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier of the entities detection job to stop.
    - jobStatus
```
String jobStatus
```
      Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopEntitiesDetectionJob operation.
- Class com.amazonaws.services.comprehend.model.StopKeyPhrasesDetectionJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier of the key phrases detection job to stop.
- Class com.amazonaws.services.comprehend.model.StopKeyPhrasesDetectionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier of the key phrases detection job to stop.
    - jobStatus
```
String jobStatus
```
      Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopKeyPhrasesDetectionJob operation.
- Class com.amazonaws.services.comprehend.model.StopSentimentDetectionJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier of the sentiment detection job to stop.
- Class com.amazonaws.services.comprehend.model.StopSentimentDetectionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier of the sentiment detection job to stop.
    - jobStatus
```
String jobStatus
```
      Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopSentimentDetectionJob operation.
- Class com.amazonaws.services.comprehend.model.StopTrainingDocumentClassifierRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - documentClassifierArn
```
String documentClassifierArn
```
      The Amazon Resource Name (ARN) that identifies the document classifier currently being trained.
- Class com.amazonaws.services.comprehend.model.StopTrainingDocumentClassifierResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.comprehend.model.StopTrainingEntityRecognizerRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - entityRecognizerArn
```
String entityRecognizerArn
```
      The Amazon Resource Name (ARN) that identifies the entity recognizer currently being trained.
- Class com.amazonaws.services.comprehend.model.StopTrainingEntityRecognizerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.comprehend.model.SyntaxToken extends Object implements Serializable
  - Serialized Fields
    - tokenId
```
Integer tokenId
```
      A unique identifier for a token.
    - text
```
String text
```
      The word that was recognized in the source text.
    - beginOffset
```
Integer beginOffset
```
      The zero-based offset from the beginning of the source text to the first character in the word.
    - endOffset
```
Integer endOffset
```
      The zero-based offset from the beginning of the source text to the last character in the word.
    - partOfSpeech
```
PartOfSpeechTag partOfSpeech
```
      Provides the part of speech label and the confidence level that Amazon Comprehend has that the part of speech was correctly identified. For more information, see how-syntax.
- Class com.amazonaws.services.comprehend.model.Tag extends Object implements Serializable
  - Serialized Fields
    - key
```
String key
```
      The initial part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the key portion of the pair, with multiple possible values such as “sales,” “legal,” and “administration.”
    - value
```
String value
```
      The second part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the sales department.
- Class com.amazonaws.services.comprehend.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The Amazon Resource Name (ARN) of the given Amazon Comprehend resource to which you want to associate the tags.
    - tags
```
List<E> tags
```
      Tags being associated with a specific Amazon Comprehend resource. There can be a maximum of 50 tags (both existing and pending) associated with a specific resource.
- Class com.amazonaws.services.comprehend.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.comprehend.model.TextSizeLimitExceededException extends AmazonComprehendException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.comprehend.model.TooManyRequestsException extends AmazonComprehendException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.comprehend.model.TooManyTagKeysException extends AmazonComprehendException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.comprehend.model.TooManyTagsException extends AmazonComprehendException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.comprehend.model.TopicsDetectionJobFilter extends Object implements Serializable
  - Serialized Fields
    - jobName
```
String jobName
```
    - jobStatus
```
String jobStatus
```
      Filters the list of topic detection jobs based on job status. Returns only jobs with the specified status.
    - submitTimeBefore
```
Date submitTimeBefore
```
      Filters the list of jobs based on the time that the job was submitted for processing. Only returns jobs submitted before the specified time. Jobs are returned in descending order, newest to oldest.
    - submitTimeAfter
```
Date submitTimeAfter
```
      Filters the list of jobs based on the time that the job was submitted for processing. Only returns jobs submitted after the specified time. Jobs are returned in ascending order, oldest to newest.
- Class com.amazonaws.services.comprehend.model.TopicsDetectionJobProperties extends Object implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier assigned to the topic detection job.
    - jobName
```
String jobName
```
      The name of the topic detection job.
    - jobStatus
```
String jobStatus
```
      The current status of the topic detection job. If the status is Failed, the reason for the failure is shown in the Message field.
    - message
```
String message
```
      A description for the status of a job.
    - submitTime
```
Date submitTime
```
      The time that the topic detection job was submitted for processing.
    - endTime
```
Date endTime
```
      The time that the topic detection job was completed.
    - inputDataConfig
```
InputDataConfig inputDataConfig
```
      The input data configuration supplied when you created the topic detection job.
    - outputDataConfig
```
OutputDataConfig outputDataConfig
```
      The output data configuration supplied when you created the topic detection job.
    - numberOfTopics
```
Integer numberOfTopics
```
      The number of topics to detect supplied when you created the topic detection job. The default is 10.
    - dataAccessRoleArn
```
String dataAccessRoleArn
```
      The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your job data.
    - volumeKmsKeyId
```
String volumeKmsKeyId
```
      ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
      
      KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
      
      Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    - vpcConfig
```
VpcConfig vpcConfig
```
      Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job. For more information, see Amazon VPC.
- Class com.amazonaws.services.comprehend.model.UnsupportedLanguageException extends AmazonComprehendException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.comprehend.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The Amazon Resource Name (ARN) of the given Amazon Comprehend resource from which you want to remove the tags.
    - tagKeys
```
List<E> tagKeys
```
      The initial part of a key-value pair that forms a tag being removed from a given resource. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department. Keys must be unique and cannot be duplicated for a particular resource.
- Class com.amazonaws.services.comprehend.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.comprehend.model.VpcConfig extends Object implements Serializable
  - Serialized Fields
    - securityGroupIds
```
List<E> securityGroupIds
```
      The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.
    - subnets
```
List<E> subnets
```
      The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.

Serialized Form

Package com.amazonaws.services.comprehend.model

Class com.amazonaws.services.comprehend.model.AmazonComprehendException extends AmazonServiceException implements Serializable

Class com.amazonaws.services.comprehend.model.BatchDetectDominantLanguageItemResult extends Object implements Serializable

Serialized Fields

index

languages

Class com.amazonaws.services.comprehend.model.BatchDetectDominantLanguageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

textList

Class com.amazonaws.services.comprehend.model.BatchDetectDominantLanguageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

resultList

errorList

Class com.amazonaws.services.comprehend.model.BatchDetectEntitiesItemResult extends Object implements Serializable

Serialized Fields

index

entities

Class com.amazonaws.services.comprehend.model.BatchDetectEntitiesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

textList

languageCode

Class com.amazonaws.services.comprehend.model.BatchDetectEntitiesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

resultList

errorList

Class com.amazonaws.services.comprehend.model.BatchDetectKeyPhrasesItemResult extends Object implements Serializable

Serialized Fields

index

keyPhrases

Class com.amazonaws.services.comprehend.model.BatchDetectKeyPhrasesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

textList

languageCode

Class com.amazonaws.services.comprehend.model.BatchDetectKeyPhrasesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

resultList

errorList

Class com.amazonaws.services.comprehend.model.BatchDetectSentimentItemResult extends Object implements Serializable

Serialized Fields

index

sentiment

sentimentScore

Class com.amazonaws.services.comprehend.model.BatchDetectSentimentRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

textList

languageCode

Class com.amazonaws.services.comprehend.model.BatchDetectSentimentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

resultList

errorList

Class com.amazonaws.services.comprehend.model.BatchDetectSyntaxItemResult extends Object implements Serializable

Serialized Fields

index

syntaxTokens

Class com.amazonaws.services.comprehend.model.BatchDetectSyntaxRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

textList

languageCode

Class com.amazonaws.services.comprehend.model.BatchDetectSyntaxResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

resultList

errorList

Class com.amazonaws.services.comprehend.model.BatchItemError extends Object implements Serializable

Serialized Fields

index

errorCode

errorMessage

Class com.amazonaws.services.comprehend.model.BatchSizeLimitExceededException extends AmazonComprehendException implements Serializable

Class com.amazonaws.services.comprehend.model.ClassifierEvaluationMetrics extends Object implements Serializable

Serialized Fields

accuracy

precision

recall

f1Score

Class com.amazonaws.services.comprehend.model.ClassifierMetadata extends Object implements Serializable

Serialized Fields

numberOfLabels

numberOfTrainedDocuments

numberOfTestDocuments