Serialized Form (AWS Java SDK for Amazon Comprehend 1.12.675 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.AugmentedManifestsListItem extends Object implements Serializable
  - Serialized Fields
    - s3Uri
```
String s3Uri
```
      The Amazon S3 location of the augmented manifest file.
    - split
```
String split
```
      The purpose of the data you've provided in the augmented manifest. You can either train or test this data. If you don't specify, the default is train.
      
      TRAIN - all of the documents in the manifest will be used for training. If no test documents are provided, Amazon Comprehend will automatically reserve a portion of the training documents for testing.
      
      TEST - all of the documents in the manifest will be used for testing.
    - attributeNames
```
List<E> attributeNames
```
      The JSON attribute that contains the annotations for your training documents. The number of attribute names that you specify depends on whether your augmented manifest file is the output of a single labeling job or a chained labeling job.
      
      If your file is the output of a single labeling job, specify the LabelAttributeName key that was used when the job was created in Ground Truth.
      
      If your file is the output of a chained labeling job, specify the LabelAttributeName key for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from an individual job.
    - annotationDataS3Uri
```
String annotationDataS3Uri
```
      The S3 prefix to the annotation files that are referred in the augmented manifest file.
    - sourceDocumentsS3Uri
```
String sourceDocumentsS3Uri
```
      The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.
    - documentType
```
String documentType
```
      The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't specify, the default is PlainTextDocument.
      
      PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is encoded in UTF-8.
      
      SEMI_STRUCTURED_DOCUMENT A document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. For inference, Amazon Comprehend support PDFs, DOCX and TXT.
- 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 UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. Each document should contain at least 20 characters. The maximum size of each document is 5 KB.
- 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 UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size of each document is 5 KB.
    - languageCode
```
String languageCode
```
      The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. 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 UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size of each document is 5 KB.
    - languageCode
```
String languageCode
```
      The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. 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 UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size of each document is 5 KB.
    - languageCode
```
String languageCode
```
      The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. 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 UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size for each document is 5 KB.
    - languageCode
```
String languageCode
```
      The language of the input documents. You can specify any of the following languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). 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.BatchDetectTargetedSentimentItemResult extends Object implements Serializable
  - Serialized Fields
    - index
```
Integer index
```
      The zero-based index of this result in the input list.
    - entities
```
List<E> entities
```
      An array of targeted sentiment entities.
- Class com.amazonaws.services.comprehend.model.BatchDetectTargetedSentimentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - textList
```
List<E> textList
```
      A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size of each document is 5 KB.
    - languageCode
```
String languageCode
```
      The language of the input documents. Currently, English is the only supported language.
- Class com.amazonaws.services.comprehend.model.BatchDetectTargetedSentimentResult 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
```
      List of errors that the operation can return.
- 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.Block extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      Unique identifier for the block.
    - blockType
```
String blockType
```
      The block represents a line of text or one word of text.
      
      WORD - A word that's detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
      
      LINE - A string of tab-delimited, contiguous words that are detected on a document page
    - text
```
String text
```
      The word or line of text extracted from the block.
    - page
```
Integer page
```
      Page number where the block appears.
    - geometry
```
Geometry geometry
```
      Co-ordinates of the rectangle or polygon that contains the text.
    - relationships
```
List<E> relationships
```
      A list of child blocks of the current block. For example, a LINE object has child blocks for each WORD block that's part of the line of text.
- Class com.amazonaws.services.comprehend.model.BlockReference extends Object implements Serializable
  - Serialized Fields
    - blockId
```
String blockId
```
      Unique identifier for the block.
    - beginOffset
```
Integer beginOffset
```
      Offset of the start of the block within its parent block.
    - endOffset
```
Integer endOffset
```
      Offset of the end of the block within its parent block.
    - childBlocks
```
List<E> childBlocks
```
      List of child blocks within this block.
- Class com.amazonaws.services.comprehend.model.BoundingBox extends Object implements Serializable
  - Serialized Fields
    - height
```
Float height
```
      The height of the bounding box as a ratio of the overall document page height.
    - left
```
Float left
```
      The left coordinate of the bounding box as a ratio of overall document page width.
    - top
```
Float top
```
      The top coordinate of the bounding box as a ratio of overall document page height.
    - width
```
Float width
```
      The width of the bounding box as a ratio of the overall document page width.
- Class com.amazonaws.services.comprehend.model.ChildBlock extends Object implements Serializable
  - Serialized Fields
    - childBlockId
```
String childBlockId
```
      Unique identifier for the child block.
    - beginOffset
```
Integer beginOffset
```
      Offset of the start of the child block within its parent block.
    - endOffset
```
Integer endOffset
```
      Offset of the end of the child block within its parent block.
- 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.
    - microPrecision
```
Double microPrecision
```
      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. Unlike the Precision metric which comes from averaging the precision of all available labels, this is based on the overall score of all precision scores added together.
    - microRecall
```
Double microRecall
```
      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. Specifically, this indicates how many of the correct categories in the text that the model can predict. It is a percentage of correct categories in the text that can found. Instead of averaging the recall scores of all labels (as with Recall), micro Recall is based on the overall score of all recall scores added together.
    - microF1Score
```
Double microF1Score
```
      A measure of how accurate the classifier results are for the test data. It is a combination of the Micro Precision and Micro Recall values. The Micro F1Score is the harmonic mean of the two scores. The highest score is 1, and the worst score is 0.
    - hammingLoss
```
Double hammingLoss
```
      Indicates the fraction of labels that are incorrectly predicted. Also seen as the fraction of wrong labels compared to the total number of labels. Scores closer to zero are better.
- 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, up to 10,000 documents.
    - evaluationMetrics
```
ClassifierEvaluationMetrics evaluationMetrics
```
      Describes the result metrics for the test data associated with an documentation classifier.
- Class com.amazonaws.services.comprehend.model.ClassifyDocumentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - text
```
String text
```
      The document text to be analyzed. If you enter text using this parameter, do not use the Bytes parameter.
    - endpointArn
```
String endpointArn
```
      The Amazon Resource Number (ARN) of the endpoint.
      
      For prompt safety classification, Amazon Comprehend provides the endpoint ARN. For more information about prompt safety classifiers, see Prompt safety classification in the Amazon Comprehend Developer Guide
      
      For custom classification, you create an endpoint for your custom model. For more information, see Using Amazon Comprehend endpoints.
    - bytes
```
ByteBuffer bytes
```
      Use the Bytes parameter to input a text, PDF, Word or image file.
      
      When you classify a document using a custom model, you can also use the Bytes parameter to input an Amazon Textract DetectDocumentText or AnalyzeDocument output file.
      
      To classify a document using the prompt safety classifier, use the Text parameter for input.
      
      Provide the input document as a sequence of base64-encoded bytes. If your code uses an Amazon Web Services SDK to classify documents, the SDK may encode the document file bytes for you.
      
      The maximum length of this field depends on the input document type. For details, see Inputs for real-time custom analysis in the Comprehend Developer Guide.
      
      If you use the Bytes parameter, do not use the Text parameter.
    - documentReaderConfig
```
DocumentReaderConfig documentReaderConfig
```
      Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
- Class com.amazonaws.services.comprehend.model.ClassifyDocumentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - classes
```
List<E> classes
```
      The classes used by the document being analyzed. These are used for models trained in multi-class mode. Individual classes are mutually exclusive and each document is expected to have only a single class assigned to it. For example, an animal can be a dog or a cat, but not both at the same time.
      
      For prompt safety classification, the response includes only two classes (SAFE_PROMPT and UNSAFE_PROMPT), along with a confidence score for each class. The value range of the score is zero to one, where one is the highest confidence.
    - labels
```
List<E> labels
```
      The labels used in the document being analyzed. These are used for multi-label trained models. Individual labels represent different categories that are related in some manner and are not mutually exclusive. For example, a movie can be just an action movie, or it can be an action movie, a science fiction movie, and a comedy, all at the same time.
    - documentMetadata
```
DocumentMetadata documentMetadata
```
      Extraction information about the document. This field is present in the response only if your request includes the Byte parameter.
    - documentType
```
List<E> documentType
```
      The document type for each page in the input document. This field is present in the response only if your request includes the Byte parameter.
    - errors
```
List<E> errors
```
      Page-level errors that the system detected while processing the input document. The field is empty if the system encountered no errors.
    - warnings
```
List<E> warnings
```
      Warnings detected while processing the input document. The response includes a warning if there is a mismatch between the input document type and the model type associated with the endpoint that you specified. The response can also include warnings for individual pages that have a mismatch.
      
      The field is empty if the system generated no warnings.
- Class com.amazonaws.services.comprehend.model.ConcurrentModificationException extends AmazonComprehendException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.comprehend.model.ContainsPiiEntitiesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - text
```
String text
```
      A UTF-8 text string. The maximum string size is 100 KB.
    - languageCode
```
String languageCode
```
      The language of the input documents.
- Class com.amazonaws.services.comprehend.model.ContainsPiiEntitiesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - labels
```
List<E> labels
```
      The labels used in the document being analyzed. Individual labels represent personally identifiable information (PII) entity types.
- Class com.amazonaws.services.comprehend.model.CreateDatasetRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - flywheelArn
```
String flywheelArn
```
      The Amazon Resource Number (ARN) of the flywheel of the flywheel to receive the data.
    - datasetName
```
String datasetName
```
      Name of the dataset.
    - datasetType
```
String datasetType
```
      The dataset type. You can specify that the data in a dataset is for training the model or for testing the model.
    - description
```
String description
```
      Description of the dataset.
    - inputDataConfig
```
DatasetInputDataConfig inputDataConfig
```
      Information about the input data configuration. The type of input data varies based on the format of the input and whether the data is for a classifier model or an entity recognition model.
    - clientRequestToken
```
String clientRequestToken
```
      A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
    - tags
```
List<E> tags
```
      Tags for the dataset.
- Class com.amazonaws.services.comprehend.model.CreateDatasetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - datasetArn
```
String datasetArn
```
      The ARN of the dataset.
- Class com.amazonaws.services.comprehend.model.CreateDocumentClassifierRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - documentClassifierName
```
String documentClassifierName
```
      The name of the document classifier.
    - versionName
```
String versionName
```
      The version name given to the newly created classifier. Version names can have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same classifier name in the Amazon Web Services account/Amazon Web Services Region.
    - dataAccessRoleArn
```
String dataAccessRoleArn
```
      The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
    - tags
```
List<E> tags
```
      Tags to associate with the document classifier. 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
```
      Specifies the location for the output files from a custom classifier job. This parameter is required for a request that creates a native document model.
    - 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 any of the languages supported by Amazon Comprehend. All documents must be in the same language.
    - volumeKmsKeyId
```
String volumeKmsKeyId
```
      ID for the Amazon Web Services 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.
    - mode
```
String mode
```
      Indicates the mode in which the classifier will be trained. The classifier can be trained in multi-class (single-label) mode or multi-label mode. Multi-class mode identifies a single class label for each document and multi-label mode identifies one or more class labels for each document. Multiple labels for an individual document are separated by a delimiter. The default delimiter between labels is a pipe (|).
    - modelKmsKeyId
```
String modelKmsKeyId
```
      ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId 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"
    - modelPolicy
```
String modelPolicy
```
      The resource-based policy to attach to your custom document classifier model. You can use this policy to allow another Amazon Web Services account to import your custom model.
      
      Provide your policy as a JSON body that you enter as a UTF-8 encoded string without line breaks. To provide valid JSON, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy:
      
      "{\"attribute\": \"value\", \"attribute\": [\"value\"]}"
      
      To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values:
      
      '{"attribute": "value", "attribute": ["value"]}'
- 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.CreateEndpointRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - endpointName
```
String endpointName
```
      This is the descriptive suffix that becomes part of the EndpointArn used for all subsequent requests to this resource.
    - modelArn
```
String modelArn
```
      The Amazon Resource Number (ARN) of the model to which the endpoint will be attached.
    - desiredInferenceUnits
```
Integer desiredInferenceUnits
```
      The desired number of inference units to be used by the model using this endpoint. Each inference unit represents of a throughput of 100 characters per second.
    - clientRequestToken
```
String clientRequestToken
```
      An idempotency token provided by the customer. If this token matches a previous endpoint creation request, Amazon Comprehend will not return a ResourceInUseException.
    - tags
```
List<E> tags
```
      Tags to associate with the endpoint. A tag is a key-value pair that adds metadata to the endpoint. For example, a tag with "Sales" as the key might be added to an endpoint to indicate its use by the sales department.
    - dataAccessRoleArn
```
String dataAccessRoleArn
```
      The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).
    - flywheelArn
```
String flywheelArn
```
      The Amazon Resource Number (ARN) of the flywheel to which the endpoint will be attached.
- Class com.amazonaws.services.comprehend.model.CreateEndpointResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - endpointArn
```
String endpointArn
```
      The Amazon Resource Number (ARN) of the endpoint being created.
    - modelArn
```
String modelArn
```
      The Amazon Resource Number (ARN) of the model to which the endpoint is attached.
- 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.
    - versionName
```
String versionName
```
      The version name given to the newly created recognizer. Version names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same recognizer name in the account/Region.
    - dataAccessRoleArn
```
String dataAccessRoleArn
```
      The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
    - tags
```
List<E> tags
```
      Tags to associate with the entity recognizer. 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
```
      You can specify any of the following languages: English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), German ("de"), or Portuguese ("pt"). If you plan to use this entity recognizer with PDF, Word, or image input files, you must specify English as the language. All training documents must be in the same language.
    - volumeKmsKeyId
```
String volumeKmsKeyId
```
      ID for the Amazon Web Services 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.
    - modelKmsKeyId
```
String modelKmsKeyId
```
      ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId 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"
    - modelPolicy
```
String modelPolicy
```
      The JSON resource-based policy to attach to your custom entity recognizer model. You can use this policy to allow another Amazon Web Services account to import your custom model.
      
      Provide your JSON as a UTF-8 encoded string without line breaks. To provide valid JSON for your policy, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy:
      
      "{\"attribute\": \"value\", \"attribute\": [\"value\"]}"
      
      To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values:
      
      '{"attribute": "value", "attribute": ["value"]}'
- 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.CreateFlywheelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - flywheelName
```
String flywheelName
```
      Name for the flywheel.
    - activeModelArn
```
String activeModelArn
```
      To associate an existing model with the flywheel, specify the Amazon Resource Number (ARN) of the model version. Do not set TaskConfig or ModelType if you specify an ActiveModelArn.
    - dataAccessRoleArn
```
String dataAccessRoleArn
```
      The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend the permissions required to access the flywheel data in the data lake.
    - taskConfig
```
TaskConfig taskConfig
```
      Configuration about the model associated with the flywheel. You need to set TaskConfig if you are creating a flywheel for a new model.
    - modelType
```
String modelType
```
      The model type. You need to set ModelType if you are creating a flywheel for a new model.
    - dataLakeS3Uri
```
String dataLakeS3Uri
```
      Enter the S3 location for the data lake. You can specify a new S3 bucket or a new folder of an existing S3 bucket. The flywheel creates the data lake at this location.
    - dataSecurityConfig
```
DataSecurityConfig dataSecurityConfig
```
      Data security configurations.
    - clientRequestToken
```
String clientRequestToken
```
      A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
    - tags
```
List<E> tags
```
      The tags to associate with this flywheel.
- Class com.amazonaws.services.comprehend.model.CreateFlywheelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - flywheelArn
```
String flywheelArn
```
      The Amazon Resource Number (ARN) of the flywheel.
    - activeModelArn
```
String activeModelArn
```
      The Amazon Resource Number (ARN) of the active model version.
- Class com.amazonaws.services.comprehend.model.DataSecurityConfig extends Object implements Serializable
  - Serialized Fields
    - modelKmsKeyId
```
String modelKmsKeyId
```
      ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId 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"
    - volumeKmsKeyId
```
String volumeKmsKeyId
```
      ID for the KMS key that Amazon Comprehend uses to encrypt the volume.
    - dataLakeKmsKeyId
```
String dataLakeKmsKeyId
```
      ID for the KMS key that Amazon Comprehend uses to encrypt the data in the data lake.
    - vpcConfig
```
VpcConfig vpcConfig
```
- Class com.amazonaws.services.comprehend.model.DatasetAugmentedManifestsListItem extends Object implements Serializable
  - Serialized Fields
    - attributeNames
```
List<E> attributeNames
```
      The JSON attribute that contains the annotations for your training documents. The number of attribute names that you specify depends on whether your augmented manifest file is the output of a single labeling job or a chained labeling job.
      
      If your file is the output of a single labeling job, specify the LabelAttributeName key that was used when the job was created in Ground Truth.
      
      If your file is the output of a chained labeling job, specify the LabelAttributeName key for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from an individual job.
    - s3Uri
```
String s3Uri
```
      The Amazon S3 location of the augmented manifest file.
    - annotationDataS3Uri
```
String annotationDataS3Uri
```
      The S3 prefix to the annotation files that are referred in the augmented manifest file.
    - sourceDocumentsS3Uri
```
String sourceDocumentsS3Uri
```
      The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.
    - documentType
```
String documentType
```
      The type of augmented manifest. If you don't specify, the default is PlainTextDocument.
      
      PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is encoded in UTF-8.
- Class com.amazonaws.services.comprehend.model.DatasetDocumentClassifierInputDataConfig 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.
      
      This parameter is required if you set DataFormat to COMPREHEND_CSV.
    - labelDelimiter
```
String labelDelimiter
```
      Indicates the delimiter used to separate each label for training a multi-label classifier. The default delimiter between labels is a pipe (|). You can use a different character as a delimiter (if it's an allowed character) by specifying it under Delimiter for labels. If the training documents use a delimiter other than the default or the delimiter you specify, the labels on that line will be combined to make a single unique label, such as LABELLABELLABEL.
- Class com.amazonaws.services.comprehend.model.DatasetEntityRecognizerAnnotations 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.DatasetEntityRecognizerDocuments extends Object implements Serializable
  - Serialized Fields
    - s3Uri
```
String s3Uri
```
      Specifies the Amazon S3 location where the documents for the dataset are located.
    - inputFormat
```
String inputFormat
```
      Specifies how the text in an input file should be processed. This is optional, and the default is ONE_DOC_PER_LINE. 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.DatasetEntityRecognizerEntityList extends Object implements Serializable
  - Serialized Fields
    - s3Uri
```
String s3Uri
```
      Specifies the Amazon S3 location where the entity list is located.
- Class com.amazonaws.services.comprehend.model.DatasetEntityRecognizerInputDataConfig extends Object implements Serializable
  - Serialized Fields
    - annotations
```
DatasetEntityRecognizerAnnotations annotations
```
      The S3 location of the annotation documents for your custom entity recognizer.
    - documents
```
DatasetEntityRecognizerDocuments documents
```
      The format and location of the training documents for your custom entity recognizer.
    - entityList
```
DatasetEntityRecognizerEntityList entityList
```
      The S3 location of the entity list for your custom entity recognizer.
- Class com.amazonaws.services.comprehend.model.DatasetFilter extends Object implements Serializable
  - Serialized Fields
    - status
```
String status
```
      Filter the datasets based on the dataset status.
    - datasetType
```
String datasetType
```
      Filter the datasets based on the dataset type.
    - creationTimeAfter
```
Date creationTimeAfter
```
      Filter the datasets to include datasets created after the specified time.
    - creationTimeBefore
```
Date creationTimeBefore
```
      Filter the datasets to include datasets created before the specified time.
- Class com.amazonaws.services.comprehend.model.DatasetInputDataConfig extends Object implements Serializable
  - Serialized Fields
    - augmentedManifests
```
List<E> augmentedManifests
```
      A list of augmented manifest files that provide training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.
    - dataFormat
```
String dataFormat
```
      COMPREHEND_CSV: The data format is a two-column CSV file, where the first column contains labels and the second column contains documents.
      
      AUGMENTED_MANIFEST: The data format
    - documentClassifierInputDataConfig
```
DatasetDocumentClassifierInputDataConfig documentClassifierInputDataConfig
```
      The input properties for training a document classifier model.
      
      For more information on how the input file is formatted, see Preparing training data in the Comprehend Developer Guide.
    - entityRecognizerInputDataConfig
```
DatasetEntityRecognizerInputDataConfig entityRecognizerInputDataConfig
```
      The input properties for training an entity recognizer model.
- Class com.amazonaws.services.comprehend.model.DatasetProperties extends Object implements Serializable
  - Serialized Fields
    - datasetArn
```
String datasetArn
```
      The ARN of the dataset.
    - datasetName
```
String datasetName
```
      The name of the dataset.
    - datasetType
```
String datasetType
```
      The dataset type (training data or test data).
    - datasetS3Uri
```
String datasetS3Uri
```
      The S3 URI where the dataset is stored.
    - description
```
String description
```
      Description of the dataset.
    - status
```
String status
```
      The dataset status. While the system creates the dataset, the status is CREATING. When the dataset is ready to use, the status changes to COMPLETED.
    - message
```
String message
```
      A description of the status of the dataset.
    - numberOfDocuments
```
Long numberOfDocuments
```
      The number of documents in the dataset.
    - creationTime
```
Date creationTime
```
      Creation time of the dataset.
    - endTime
```
Date endTime
```
      Time when the data from the dataset becomes available in the data lake.
- 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.DeleteEndpointRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - endpointArn
```
String endpointArn
```
      The Amazon Resource Number (ARN) of the endpoint being deleted.
- Class com.amazonaws.services.comprehend.model.DeleteEndpointResult 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.DeleteFlywheelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - flywheelArn
```
String flywheelArn
```
      The Amazon Resource Number (ARN) of the flywheel to delete.
- Class com.amazonaws.services.comprehend.model.DeleteFlywheelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.comprehend.model.DeleteResourcePolicyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The Amazon Resource Name (ARN) of the custom model version that has the policy to delete.
    - policyRevisionId
```
String policyRevisionId
```
      The revision ID of the policy to delete.
- Class com.amazonaws.services.comprehend.model.DeleteResourcePolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.comprehend.model.DescribeDatasetRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - datasetArn
```
String datasetArn
```
      The ARN of the dataset.
- Class com.amazonaws.services.comprehend.model.DescribeDatasetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - datasetProperties
```
DatasetProperties datasetProperties
```
      The dataset properties.
- 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 StartDocumentClassificationJob 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 CreateDocumentClassifier 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 StartDominantLanguageDetectionJob 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.DescribeEndpointRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - endpointArn
```
String endpointArn
```
      The Amazon Resource Number (ARN) of the endpoint being described.
- Class com.amazonaws.services.comprehend.model.DescribeEndpointResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - endpointProperties
```
EndpointProperties endpointProperties
```
      Describes information associated with the specific endpoint.
- 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 StartEntitiesDetectionJob 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.DescribeEventsDetectionJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier of the events detection job.
- Class com.amazonaws.services.comprehend.model.DescribeEventsDetectionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - eventsDetectionJobProperties
```
EventsDetectionJobProperties eventsDetectionJobProperties
```
      An object that contains the properties associated with an event detection job.
- Class com.amazonaws.services.comprehend.model.DescribeFlywheelIterationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - flywheelArn
```
String flywheelArn
```
    - flywheelIterationId
```
String flywheelIterationId
```
- Class com.amazonaws.services.comprehend.model.DescribeFlywheelIterationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - flywheelIterationProperties
```
FlywheelIterationProperties flywheelIterationProperties
```
      The configuration properties of a flywheel iteration.
- Class com.amazonaws.services.comprehend.model.DescribeFlywheelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - flywheelArn
```
String flywheelArn
```
      The Amazon Resource Number (ARN) of the flywheel.
- Class com.amazonaws.services.comprehend.model.DescribeFlywheelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - flywheelProperties
```
FlywheelProperties flywheelProperties
```
      The flywheel properties.
- 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 StartKeyPhrasesDetectionJob 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.DescribePiiEntitiesDetectionJobRequest 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.DescribePiiEntitiesDetectionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - piiEntitiesDetectionJobProperties
```
PiiEntitiesDetectionJobProperties piiEntitiesDetectionJobProperties
```
- Class com.amazonaws.services.comprehend.model.DescribeResourcePolicyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The Amazon Resource Name (ARN) of the custom model version that has the resource policy.
- Class com.amazonaws.services.comprehend.model.DescribeResourcePolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - resourcePolicy
```
String resourcePolicy
```
      The JSON body of the resource-based policy.
    - creationTime
```
Date creationTime
```
      The time at which the policy was created.
    - lastModifiedTime
```
Date lastModifiedTime
```
      The time at which the policy was last modified.
    - policyRevisionId
```
String policyRevisionId
```
      The revision ID of the policy. Each time you modify a policy, Amazon Comprehend assigns a new revision ID, and it deletes the prior version of the policy.
- 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.DescribeTargetedSentimentDetectionJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier that Amazon Comprehend generated for the job. The StartTargetedSentimentDetectionJob operation returns this identifier in its response.
- Class com.amazonaws.services.comprehend.model.DescribeTargetedSentimentDetectionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - targetedSentimentDetectionJobProperties
```
TargetedSentimentDetectionJobProperties targetedSentimentDetectionJobProperties
```
      An object that contains the properties associated with a targeted 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. The string must contain at least 20 characters. The maximum string size is 100 KB.
- Class com.amazonaws.services.comprehend.model.DetectDominantLanguageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - languages
```
List<E> languages
```
      Array of languages that Amazon Comprehend detected in the input text. The array is sorted in descending order of the score (the dominant language is always the first element in the array).
      
      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. The maximum string size is 100 KB. If you enter text using this parameter, do not use the Bytes parameter.
    - languageCode
```
String languageCode
```
      The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you specify here.
      
      All input documents must be in the same language.
    - endpointArn
```
String endpointArn
```
      The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model. Provide an endpoint if you want to detect entities by using your own custom model instead of the default model that is used by Amazon Comprehend.
      
      If you specify an endpoint, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you provide in your request.
      
      For information about endpoints, see Managing endpoints.
    - bytes
```
ByteBuffer bytes
```
      This field applies only when you use a custom entity recognition model that was trained with PDF annotations. For other cases, enter your text input in the Text field.
      
      Use the Bytes parameter to input a text, PDF, Word or image file. Using a plain-text file in the Bytes parameter is equivelent to using the Text parameter (the Entities field in the response is identical).
      
      You can also use the Bytes parameter to input an Amazon Textract DetectDocumentText or AnalyzeDocument output file.
      
      Provide the input document as a sequence of base64-encoded bytes. If your code uses an Amazon Web Services SDK to detect entities, the SDK may encode the document file bytes for you.
      
      The maximum length of this field depends on the input document type. For details, see Inputs for real-time custom analysis in the Comprehend Developer Guide.
      
      If you use the Bytes parameter, do not use the Text parameter.
    - documentReaderConfig
```
DocumentReaderConfig documentReaderConfig
```
      Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
- 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.
      
      If your request uses a custom entity recognition model, Amazon Comprehend detects the entities that the model is trained to recognize. Otherwise, it detects the default entity types. For a list of default entity types, see Entities in the Comprehend Developer Guide.
    - documentMetadata
```
DocumentMetadata documentMetadata
```
      Information about the document, discovered during text extraction. This field is present in the response only if your request used the Byte parameter.
    - documentType
```
List<E> documentType
```
      The document type for each page in the input document. This field is present in the response only if your request used the Byte parameter.
    - blocks
```
List<E> blocks
```
      Information about each block of text in the input document. Blocks are nested. A page block contains a block for each line of text, which contains a block for each word.
      
      The Block content for a Word input document does not include a Geometry field.
      
      The Block field is not present in the response for plain-text inputs.
    - errors
```
List<E> errors
```
      Page-level errors that the system detected while processing the input document. The field is empty if the system encountered no errors.
- Class com.amazonaws.services.comprehend.model.DetectKeyPhrasesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - text
```
String text
```
      A UTF-8 text string. The string must contain less than 100 KB of UTF-8 encoded characters.
    - languageCode
```
String languageCode
```
      The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. 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.DetectPiiEntitiesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - text
```
String text
```
      A UTF-8 text string. The maximum string size is 100 KB.
    - languageCode
```
String languageCode
```
      The language of the input text. Enter the language code for English (en) or Spanish (es).
- Class com.amazonaws.services.comprehend.model.DetectPiiEntitiesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - entities
```
List<E> entities
```
      A collection of PII entities identified in the input text. For each entity, the response provides the entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection.
- Class com.amazonaws.services.comprehend.model.DetectSentimentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - text
```
String text
```
      A UTF-8 text string. The maximum string size is 5 KB.
    - languageCode
```
String languageCode
```
      The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. 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. The maximum string size is 5 KB.
    - languageCode
```
String languageCode
```
      The language code of the input documents. You can specify any of the following languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt").
- 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 Syntax in the Comprehend Developer Guide.
- Class com.amazonaws.services.comprehend.model.DetectTargetedSentimentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - text
```
String text
```
      A UTF-8 text string. The maximum string length is 5 KB.
    - languageCode
```
String languageCode
```
      The language of the input documents. Currently, English is the only supported language.
- Class com.amazonaws.services.comprehend.model.DetectTargetedSentimentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - entities
```
List<E> entities
```
      Targeted sentiment analysis for each of the entities identified in the input text.
- Class com.amazonaws.services.comprehend.model.DetectToxicContentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - textSegments
```
List<E> textSegments
```
      A list of up to 10 text strings. Each string has a maximum size of 1 KB, and the maximum size of the list is 10 KB.
    - languageCode
```
String languageCode
```
      The language of the input text. Currently, English is the only supported language.
- Class com.amazonaws.services.comprehend.model.DetectToxicContentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - resultList
```
List<E> resultList
```
      Results of the content moderation analysis. Each entry in the results list contains a list of toxic content types identified in the text, along with a confidence score for each content type. The results list also includes a toxicity score for each entry in the results list.
- Class com.amazonaws.services.comprehend.model.DocumentClass extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the class.
    - score
```
Float score
```
      The confidence score that Amazon Comprehend has this class correctly attributed.
    - page
```
Integer page
```
      Page number in the input document. This field is present in the response only if your request includes the Byte parameter.
- Class com.amazonaws.services.comprehend.model.DocumentClassificationConfig extends Object implements Serializable
  - Serialized Fields
    - mode
```
String mode
```
      Classification mode indicates whether the documents are MULTI_CLASS or MULTI_LABEL.
    - labels
```
List<E> labels
```
      One or more labels to associate with the custom classifier.
- 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 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.DocumentClassificationJobProperties extends Object implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier assigned to the document classification job.
    - jobArn
```
String jobArn
```
      The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
      
      arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>
      
      The following is an example job ARN:
      
      arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
    - 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 IAM role that grants Amazon Comprehend read access to your input data.
    - volumeKmsKeyId
```
String volumeKmsKeyId
```
      ID for the Amazon Web Services 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.
    - flywheelArn
```
String flywheelArn
```
      The Amazon Resource Number (ARN) of the flywheel
- Class com.amazonaws.services.comprehend.model.DocumentClassifierDocuments extends Object implements Serializable
  - Serialized Fields
    - s3Uri
```
String s3Uri
```
      The S3 URI location of the training documents specified in the S3Uri CSV file.
    - testS3Uri
```
String testS3Uri
```
      The S3 URI location of the test documents included in the TestS3Uri CSV file. This field is not required if you do not specify a test CSV file.
- Class com.amazonaws.services.comprehend.model.DocumentClassifierFilter extends Object implements Serializable
  - Serialized Fields
    - status
```
String status
```
      Filters the list of classifiers based on status.
    - documentClassifierName
```
String documentClassifierName
```
      The name that you assigned to the document classifier
    - 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
    - dataFormat
```
String dataFormat
```
      The format of your training data:
      
      COMPREHEND_CSV: A two-column CSV file, where labels are provided in the first column, and documents are provided in the second. If you use this value, you must provide the S3Uri parameter in your request.
      
      AUGMENTED_MANIFEST: A labeled dataset that is produced by Amazon SageMaker Ground Truth. This file is in JSON lines format. Each line is a complete JSON object that contains a training document and its associated labels.
      
      If you use this value, you must provide the AugmentedManifests parameter in your request.
      
      If you don't specify a value, Amazon Comprehend uses COMPREHEND_CSV as the default.
    - 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.
      
      This parameter is required if you set DataFormat to COMPREHEND_CSV.
    - testS3Uri
```
String testS3Uri
```
      This specifies the Amazon S3 location that contains the test annotations for the document classifier. The URI must be in the same Amazon Web Services Region as the API endpoint that you are calling.
    - labelDelimiter
```
String labelDelimiter
```
      Indicates the delimiter used to separate each label for training a multi-label classifier. The default delimiter between labels is a pipe (|). You can use a different character as a delimiter (if it's an allowed character) by specifying it under Delimiter for labels. If the training documents use a delimiter other than the default or the delimiter you specify, the labels on that line will be combined to make a single unique label, such as LABELLABELLABEL.
    - augmentedManifests
```
List<E> augmentedManifests
```
      A list of augmented manifest files that provide training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.
      
      This parameter is required if you set DataFormat to AUGMENTED_MANIFEST.
    - documentType
```
String documentType
```
      The type of input documents for training the model. Provide plain-text documents to create a plain-text model, and provide semi-structured documents to create a native document model.
    - documents
```
DocumentClassifierDocuments documents
```
      The S3 location of the training documents. This parameter is required in a request to create a native document model.
    - documentReaderConfig
```
DocumentReaderConfig documentReaderConfig
```
- 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 and other output files. 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 Amazon Web Services 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"
    - flywheelStatsS3Prefix
```
String flywheelStatsS3Prefix
```
      The Amazon S3 prefix for the data lake location of the flywheel statistics.
- 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 TRAINED_WITH_WARNINGS the classifier training succeeded, but you should review the warnings returned in the CreateDocumentClassifier response.
      
      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 IAM role that grants Amazon Comprehend read access to your input data.
    - volumeKmsKeyId
```
String volumeKmsKeyId
```
      ID for the Amazon Web Services 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.
    - mode
```
String mode
```
      Indicates the mode in which the specific classifier was trained. This also indicates the format of input documents and the format of the confusion matrix. Each classifier can only be trained in one mode and this cannot be changed once the classifier is trained.
    - modelKmsKeyId
```
String modelKmsKeyId
```
      ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId 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"
    - versionName
```
String versionName
```
      The version name that you assigned to the document classifier.
    - sourceModelArn
```
String sourceModelArn
```
      The Amazon Resource Name (ARN) of the source model. This model was imported from a different Amazon Web Services account to create the document classifier model in your Amazon Web Services account.
    - flywheelArn
```
String flywheelArn
```
      The Amazon Resource Number (ARN) of the flywheel
- Class com.amazonaws.services.comprehend.model.DocumentClassifierSummary extends Object implements Serializable
  - Serialized Fields
    - documentClassifierName
```
String documentClassifierName
```
      The name that you assigned the document classifier.
    - numberOfVersions
```
Integer numberOfVersions
```
      The number of versions you created.
    - latestVersionCreatedAt
```
Date latestVersionCreatedAt
```
      The time that the latest document classifier version was submitted for processing.
    - latestVersionName
```
String latestVersionName
```
      The version name you assigned to the latest document classifier version.
    - latestVersionStatus
```
String latestVersionStatus
```
      Provides the status of the latest document classifier version.
- Class com.amazonaws.services.comprehend.model.DocumentLabel extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the label.
    - score
```
Float score
```
      The confidence score that Amazon Comprehend has this label correctly attributed.
    - page
```
Integer page
```
      Page number where the label occurs. This field is present in the response only if your request includes the Byte parameter.
- Class com.amazonaws.services.comprehend.model.DocumentMetadata extends Object implements Serializable
  - Serialized Fields
    - pages
```
Integer pages
```
      Number of pages in the document.
    - extractedCharacters
```
List<E> extractedCharacters
```
      List of pages in the document, with the number of characters extracted from each page.
- Class com.amazonaws.services.comprehend.model.DocumentReaderConfig extends Object implements Serializable
  - Serialized Fields
    - documentReadAction
```
String documentReadAction
```
      This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:
      
      TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.
      
      TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.
    - documentReadMode
```
String documentReadMode
```
      Determines the text extraction actions for PDF files. Enter one of the following values:
      
      SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.
      
      FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.
    - featureTypes
```
List<E> featureTypes
```
      Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
      
      TABLES - Returns additional information about any tables that are detected in the input document.
      
      FORMS - Returns additional information about any forms that are detected in the input document.
- Class com.amazonaws.services.comprehend.model.DocumentTypeListItem extends Object implements Serializable
  - Serialized Fields
    - page
```
Integer page
```
      Page number.
    - type
```
String type
```
      Document type.
- 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.
    - jobArn
```
String jobArn
```
      The Amazon Resource Name (ARN) of the dominant language detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
      
      arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>
      
      The following is an example job ARN:
      
      arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab
    - 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) of the IAM role that grants Amazon Comprehend read access to your input data.
    - volumeKmsKeyId
```
String volumeKmsKeyId
```
      ID for the Amazon Web Services 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.EndpointFilter extends Object implements Serializable
  - Serialized Fields
    - modelArn
```
String modelArn
```
      The Amazon Resource Number (ARN) of the model to which the endpoint is attached.
    - status
```
String status
```
      Specifies the status of the endpoint being returned. Possible values are: Creating, Ready, Updating, Deleting, Failed.
    - creationTimeBefore
```
Date creationTimeBefore
```
      Specifies a date before which the returned endpoint or endpoints were created.
    - creationTimeAfter
```
Date creationTimeAfter
```
      Specifies a date after which the returned endpoint or endpoints were created.
- Class com.amazonaws.services.comprehend.model.EndpointProperties extends Object implements Serializable
  - Serialized Fields
    - endpointArn
```
String endpointArn
```
      The Amazon Resource Number (ARN) of the endpoint.
    - status
```
String status
```
      Specifies the status of the endpoint. Because the endpoint updates and creation are asynchronous, so customers will need to wait for the endpoint to be Ready status before making inference requests.
    - message
```
String message
```
      Specifies a reason for failure in cases of Failed status.
    - modelArn
```
String modelArn
```
      The Amazon Resource Number (ARN) of the model to which the endpoint is attached.
    - desiredModelArn
```
String desiredModelArn
```
      ARN of the new model to use for updating an existing endpoint. This ARN is going to be different from the model ARN when the update is in progress
    - desiredInferenceUnits
```
Integer desiredInferenceUnits
```
      The desired number of inference units to be used by the model using this endpoint. Each inference unit represents of a throughput of 100 characters per second.
    - currentInferenceUnits
```
Integer currentInferenceUnits
```
      The number of inference units currently used by the model using this endpoint.
    - creationTime
```
Date creationTime
```
      The creation date and time of the endpoint.
    - lastModifiedTime
```
Date lastModifiedTime
```
      The date and time that the endpoint was last modified.
    - dataAccessRoleArn
```
String dataAccessRoleArn
```
      The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).
    - desiredDataAccessRoleArn
```
String desiredDataAccessRoleArn
```
      Data access role ARN to use in case the new model is encrypted with a customer KMS key.
    - flywheelArn
```
String flywheelArn
```
      The Amazon Resource Number (ARN) of the flywheel
- 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.
    - jobArn
```
String jobArn
```
      The Amazon Resource Name (ARN) of the entities detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
      
      arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>
      
      The following is an example job ARN:
      
      arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
    - 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) of the IAM role that grants Amazon Comprehend read access to your input data.
    - volumeKmsKeyId
```
String volumeKmsKeyId
```
      ID for the Amazon Web Services 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.
    - flywheelArn
```
String flywheelArn
```
      The Amazon Resource Name (ARN) of the flywheel associated with this job.
- 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 type. For entity detection using the built-in model, this field contains one of the standard entity types listed below.
      
      For custom entity detection, this field contains one of the entity types that you specified when you trained your custom model.
    - text
```
String text
```
      The text of the entity.
    - beginOffset
```
Integer beginOffset
```
      The zero-based offset from the beginning of the source text to the first character in the entity.
      
      This field is empty for non-text input.
    - endOffset
```
Integer endOffset
```
      The zero-based offset from the beginning of the source text to the last character in the entity.
      
      This field is empty for non-text input.
    - blockReferences
```
List<E> blockReferences
```
      A reference to each block for this entity. This field is empty for plain-text input.
- Class com.amazonaws.services.comprehend.model.EntityLabel extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the label.
    - score
```
Float score
```
      The level of confidence that Amazon Comprehend has in the accuracy of the detection.
- Class com.amazonaws.services.comprehend.model.EntityRecognitionConfig extends Object implements Serializable
  - Serialized Fields
    - entityTypes
```
List<E> entityTypes
```
      Up to 25 entity types that the model is trained to recognize.
- 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.
    - testS3Uri
```
String testS3Uri
```
      Specifies the Amazon S3 location where the test 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.
    - testS3Uri
```
String testS3Uri
```
      Specifies the Amazon S3 location where the test documents for an entity recognizer are located. The URI must be in the same Amazon Web Services Region as the API endpoint that you are calling.
    - inputFormat
```
String inputFormat
```
      Specifies how the text in an input file should be processed. This is optional, and the default is ONE_DOC_PER_LINE. 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.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. For plain text entity recognizer models, the range is 0 to 100, where 100 is the best score. For PDF/Word entity recognizer models, the range is 0 to 1, where 1 is the best score.
- Class com.amazonaws.services.comprehend.model.EntityRecognizerFilter extends Object implements Serializable
  - Serialized Fields
    - status
```
String status
```
      The status of an entity recognizer.
    - recognizerName
```
String recognizerName
```
      The name that you assigned the 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
    - dataFormat
```
String dataFormat
```
      The format of your training data:
      
      COMPREHEND_CSV: A CSV file that supplements your training documents. The CSV file contains information about the custom entities that your trained model will detect. The required format of the file depends on whether you are providing annotations or an entity list.
      
      If you use this value, you must provide your CSV file by using either the Annotations or EntityList parameters. You must provide your training documents by using the Documents parameter.
      
      AUGMENTED_MANIFEST: A labeled dataset that is produced by Amazon SageMaker Ground Truth. This file is in JSON lines format. Each line is a complete JSON object that contains a training document and its labels. Each label annotates a named entity in the training document.
      
      If you use this value, you must provide the AugmentedManifests parameter in your request.
      
      If you don't specify a value, Amazon Comprehend uses COMPREHEND_CSV as the default.
    - entityTypes
```
List<E> entityTypes
```
      The entity types in the labeled training data that Amazon Comprehend uses to train the custom entity recognizer. Any entity types that you don't specify are ignored.
      
      A maximum of 25 entity types can be used at one time to train an entity recognizer. Entity types must not contain the following invalid characters: \n (line break), \\n (escaped line break), \r (carriage return), \\r (escaped carriage return), \t (tab), \\t (escaped tab), space, and , (comma).
    - documents
```
EntityRecognizerDocuments documents
```
      The S3 location of the folder that contains the training documents for your custom entity recognizer.
      
      This parameter is required if you set DataFormat to COMPREHEND_CSV.
    - annotations
```
EntityRecognizerAnnotations annotations
```
      The S3 location of the CSV file that annotates your training documents.
    - entityList
```
EntityRecognizerEntityList entityList
```
      The S3 location of the CSV file that has the entity list for your custom entity recognizer.
    - augmentedManifests
```
List<E> augmentedManifests
```
      A list of augmented manifest files that provide training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.
      
      This parameter is required if you set DataFormat to AUGMENTED_MANIFEST.
- 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.
    - evaluationMetrics
```
EntityTypesEvaluationMetrics evaluationMetrics
```
      Detailed information about the accuracy of the entity recognizer for a specific item on the list of entity types.
    - numberOfTrainMentions
```
Integer numberOfTrainMentions
```
      Indicates the number of times the given entity type was seen in the training data.
- Class com.amazonaws.services.comprehend.model.EntityRecognizerOutputDataConfig extends Object implements Serializable
  - Serialized Fields
    - flywheelStatsS3Prefix
```
String flywheelStatsS3Prefix
```
      The Amazon S3 prefix for the data lake location of the flywheel statistics.
- 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 IAM role that grants Amazon Comprehend read access to your input data.
    - volumeKmsKeyId
```
String volumeKmsKeyId
```
      ID for the Amazon Web Services 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.
    - modelKmsKeyId
```
String modelKmsKeyId
```
      ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId 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"
    - versionName
```
String versionName
```
      The version name you assigned to the entity recognizer.
    - sourceModelArn
```
String sourceModelArn
```
      The Amazon Resource Name (ARN) of the source model. This model was imported from a different Amazon Web Services account to create the entity recognizer model in your Amazon Web Services account.
    - flywheelArn
```
String flywheelArn
```
      The Amazon Resource Number (ARN) of the flywheel
    - outputDataConfig
```
EntityRecognizerOutputDataConfig outputDataConfig
```
      Output data configuration.
- Class com.amazonaws.services.comprehend.model.EntityRecognizerSummary extends Object implements Serializable
  - Serialized Fields
    - recognizerName
```
String recognizerName
```
      The name that you assigned the entity recognizer.
    - numberOfVersions
```
Integer numberOfVersions
```
      The number of versions you created.
    - latestVersionCreatedAt
```
Date latestVersionCreatedAt
```
      The time that the latest entity recognizer version was submitted for processing.
    - latestVersionName
```
String latestVersionName
```
      The version name you assigned to the latest entity recognizer version.
    - latestVersionStatus
```
String latestVersionStatus
```
      Provides the status of the latest entity recognizer version.
- Class com.amazonaws.services.comprehend.model.EntityTypesEvaluationMetrics extends Object implements Serializable
  - Serialized Fields
    - precision
```
Double precision
```
      A measure of the usefulness of the recognizer results for a specific entity type 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 a specific entity type in 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 a specific entity type in 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.EntityTypesListItem extends Object implements Serializable
  - Serialized Fields
    - type
```
String type
```
      An entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer.
      
      Entity types must not contain the following invalid characters: \n (line break), \\n (escaped line break, \r (carriage return), \\r (escaped carriage return), \t (tab), \\t (escaped tab), and , (comma).
- Class com.amazonaws.services.comprehend.model.ErrorsListItem extends Object implements Serializable
  - Serialized Fields
    - page
```
Integer page
```
      Page number where the error occurred.
    - errorCode
```
String errorCode
```
      Error code for the cause of the error.
    - errorMessage
```
String errorMessage
```
      Text message explaining the reason for the error.
- Class com.amazonaws.services.comprehend.model.EventsDetectionJobFilter extends Object implements Serializable
  - Serialized Fields
    - jobName
```
String jobName
```
      Filters on the name of the events detection 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.EventsDetectionJobProperties extends Object implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier assigned to the events detection job.
    - jobArn
```
String jobArn
```
      The Amazon Resource Name (ARN) of the events detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
      
      arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>
      
      The following is an example job ARN:
      
      arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab
    - jobName
```
String jobName
```
      The name you assigned the events detection job.
    - jobStatus
```
String jobStatus
```
      The current status of the events detection job.
    - message
```
String message
```
      A description of the status of the events detection job.
    - submitTime
```
Date submitTime
```
      The time that the events detection job was submitted for processing.
    - endTime
```
Date endTime
```
      The time that the events detection job completed.
    - inputDataConfig
```
InputDataConfig inputDataConfig
```
      The input data configuration that you supplied when you created the events detection job.
    - outputDataConfig
```
OutputDataConfig outputDataConfig
```
      The output data configuration that you supplied when you created the events detection job.
    - languageCode
```
String languageCode
```
      The language code of the input documents.
    - dataAccessRoleArn
```
String dataAccessRoleArn
```
      The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
    - targetEventTypes
```
List<E> targetEventTypes
```
      The types of events that are detected by the job.
- Class com.amazonaws.services.comprehend.model.ExtractedCharactersListItem extends Object implements Serializable
  - Serialized Fields
    - page
```
Integer page
```
      Page number.
    - count
```
Integer count
```
      Number of characters extracted from each page.
- Class com.amazonaws.services.comprehend.model.FlywheelFilter extends Object implements Serializable
  - Serialized Fields
    - status
```
String status
```
      Filter the flywheels based on the flywheel status.
    - creationTimeAfter
```
Date creationTimeAfter
```
      Filter the flywheels to include flywheels created after the specified time.
    - creationTimeBefore
```
Date creationTimeBefore
```
      Filter the flywheels to include flywheels created before the specified time.
- Class com.amazonaws.services.comprehend.model.FlywheelIterationFilter extends Object implements Serializable
  - Serialized Fields
    - creationTimeAfter
```
Date creationTimeAfter
```
      Filter the flywheel iterations to include iterations created after the specified time.
    - creationTimeBefore
```
Date creationTimeBefore
```
      Filter the flywheel iterations to include iterations created before the specified time.
- Class com.amazonaws.services.comprehend.model.FlywheelIterationProperties extends Object implements Serializable
  - Serialized Fields
    - flywheelArn
```
String flywheelArn
```
    - flywheelIterationId
```
String flywheelIterationId
```
    - creationTime
```
Date creationTime
```
      The creation start time of the flywheel iteration.
    - endTime
```
Date endTime
```
      The completion time of this flywheel iteration.
    - status
```
String status
```
      The status of the flywheel iteration.
    - message
```
String message
```
      A description of the status of the flywheel iteration.
    - evaluatedModelArn
```
String evaluatedModelArn
```
      The ARN of the evaluated model associated with this flywheel iteration.
    - evaluatedModelMetrics
```
FlywheelModelEvaluationMetrics evaluatedModelMetrics
```
    - trainedModelArn
```
String trainedModelArn
```
      The ARN of the trained model associated with this flywheel iteration.
    - trainedModelMetrics
```
FlywheelModelEvaluationMetrics trainedModelMetrics
```
      The metrics associated with the trained model.
    - evaluationManifestS3Prefix
```
String evaluationManifestS3Prefix
```
- Class com.amazonaws.services.comprehend.model.FlywheelModelEvaluationMetrics extends Object implements Serializable
  - Serialized Fields
    - averageF1Score
```
Double averageF1Score
```
      The average F1 score from the evaluation metrics.
    - averagePrecision
```
Double averagePrecision
```
      Average precision metric for the model.
    - averageRecall
```
Double averageRecall
```
      Average recall metric for the model.
    - averageAccuracy
```
Double averageAccuracy
```
      Average accuracy metric for the model.
- Class com.amazonaws.services.comprehend.model.FlywheelProperties extends Object implements Serializable
  - Serialized Fields
    - flywheelArn
```
String flywheelArn
```
      The Amazon Resource Number (ARN) of the flywheel.
    - activeModelArn
```
String activeModelArn
```
      The Amazon Resource Number (ARN) of the active model version.
    - dataAccessRoleArn
```
String dataAccessRoleArn
```
      The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to access the flywheel data.
    - taskConfig
```
TaskConfig taskConfig
```
      Configuration about the model associated with a flywheel.
    - dataLakeS3Uri
```
String dataLakeS3Uri
```
      Amazon S3 URI of the data lake location.
    - dataSecurityConfig
```
DataSecurityConfig dataSecurityConfig
```
      Data security configuration.
    - status
```
String status
```
      The status of the flywheel.
    - modelType
```
String modelType
```
      Model type of the flywheel's model.
    - message
```
String message
```
      A description of the status of the flywheel.
    - creationTime
```
Date creationTime
```
      Creation time of the flywheel.
    - lastModifiedTime
```
Date lastModifiedTime
```
      Last modified time for the flywheel.
    - latestFlywheelIteration
```
String latestFlywheelIteration
```
      The most recent flywheel iteration.
- Class com.amazonaws.services.comprehend.model.FlywheelSummary extends Object implements Serializable
  - Serialized Fields
    - flywheelArn
```
String flywheelArn
```
      The Amazon Resource Number (ARN) of the flywheel
    - activeModelArn
```
String activeModelArn
```
      ARN of the active model version for the flywheel.
    - dataLakeS3Uri
```
String dataLakeS3Uri
```
      Amazon S3 URI of the data lake location.
    - status
```
String status
```
      The status of the flywheel.
    - modelType
```
String modelType
```
      Model type of the flywheel's model.
    - message
```
String message
```
      A description of the status of the flywheel.
    - creationTime
```
Date creationTime
```
      Creation time of the flywheel.
    - lastModifiedTime
```
Date lastModifiedTime
```
      Last modified time for the flywheel.
    - latestFlywheelIteration
```
String latestFlywheelIteration
```
      The most recent flywheel iteration.
- Class com.amazonaws.services.comprehend.model.Geometry extends Object implements Serializable
  - Serialized Fields
    - boundingBox
```
BoundingBox boundingBox
```
      An axis-aligned coarse representation of the location of the recognized item on the document page.
    - polygon
```
List<E> polygon
```
      Within the bounding box, a fine-grained polygon around the recognized item.
- Class com.amazonaws.services.comprehend.model.ImportModelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - sourceModelArn
```
String sourceModelArn
```
      The Amazon Resource Name (ARN) of the custom model to import.
    - modelName
```
String modelName
```
      The name to assign to the custom model that is created in Amazon Comprehend by this import.
    - versionName
```
String versionName
```
      The version name given to the custom model that is created by this import. Version names can have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same classifier name in the account/Region.
    - modelKmsKeyId
```
String modelKmsKeyId
```
      ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId 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"
    - dataAccessRoleArn
```
String dataAccessRoleArn
```
      The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to use Amazon Key Management Service (KMS) to encrypt or decrypt the custom model.
    - tags
```
List<E> tags
```
      Tags to associate with the custom model that is created by this import. 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.ImportModelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - modelArn
```
String modelArn
```
      The Amazon Resource Name (ARN) of the custom model being imported.
- 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.
    - documentReaderConfig
```
DocumentReaderConfig documentReaderConfig
```
      Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
- 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.InvalidRequestDetail extends Object implements Serializable
  - Serialized Fields
    - reason
```
String reason
```
      Reason codes include the following values:
      
      DOCUMENT_SIZE_EXCEEDED - Document size is too large. Check the size of your file and resubmit the request.
      
      UNSUPPORTED_DOC_TYPE - Document type is not supported. Check the file type and resubmit the request.
      
      PAGE_LIMIT_EXCEEDED - Too many pages in the document. Check the number of pages in your file and resubmit the request.
      
      TEXTRACT_ACCESS_DENIED - Access denied to Amazon Textract. Verify that your account has permission to use Amazon Textract API operations and resubmit the request.
      
      NOT_TEXTRACT_JSON - Document is not Amazon Textract JSON format. Verify the format and resubmit the request.
      
      MISMATCHED_TOTAL_PAGE_COUNT - Check the number of pages in your file and resubmit the request.
      
      INVALID_DOCUMENT - Invalid document. Check the file and resubmit the request.
- Class com.amazonaws.services.comprehend.model.InvalidRequestException extends AmazonComprehendException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - reason
```
String reason
```
    - detail
```
InvalidRequestDetail detail
```
- 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
```
      The zero-based offset from the beginning of the source text to the first character in the key phrase.
    - endOffset
```
Integer endOffset
```
      The zero-based offset from the beginning of the source text to the last character in the key phrase.
- 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.
    - jobArn
```
String jobArn
```
      The Amazon Resource Name (ARN) of the key phrases detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
      
      arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id>
      
      The following is an example job ARN:
      
      arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab
    - 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) of the IAM role that grants Amazon Comprehend read access to your input data.
    - volumeKmsKeyId
```
String volumeKmsKeyId
```
      ID for the 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.ListDatasetsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - flywheelArn
```
String flywheelArn
```
      The Amazon Resource Number (ARN) of the flywheel.
    - filter
```
DatasetFilter filter
```
      Filters the datasets to be returned in the response.
    - nextToken
```
String nextToken
```
      Identifies the next page of results to return.
    - maxResults
```
Integer maxResults
```
      Maximum number of results to return in a response. The default is 100.
- Class com.amazonaws.services.comprehend.model.ListDatasetsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - datasetPropertiesList
```
List<E> datasetPropertiesList
```
      The dataset properties list.
    - nextToken
```
String nextToken
```
      Identifies the next page of results to return.
- 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.ListDocumentClassifierSummariesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - 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.ListDocumentClassifierSummariesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - documentClassifierSummariesList
```
List<E> documentClassifierSummariesList
```
      The list of summaries of document classifiers.
    - 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.ListEndpointsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - filter
```
EndpointFilter filter
```
      Filters the endpoints that are returned. You can filter endpoints on their name, model, status, or the date and time that they were created. 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.ListEndpointsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - endpointPropertiesList
```
List<E> endpointPropertiesList
```
      Displays a list of endpoint properties being retrieved by the service in response to the request.
    - 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.ListEntityRecognizerSummariesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - 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.ListEntityRecognizerSummariesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - entityRecognizerSummariesList
```
List<E> entityRecognizerSummariesList
```
      The list entity recognizer summaries.
    - nextToken
```
String nextToken
```
      Identifies the next page of results to return.
- Class com.amazonaws.services.comprehend.model.ListEventsDetectionJobsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - filter
```
EventsDetectionJobFilter 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.
- Class com.amazonaws.services.comprehend.model.ListEventsDetectionJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - eventsDetectionJobPropertiesList
```
List<E> eventsDetectionJobPropertiesList
```
      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.ListFlywheelIterationHistoryRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - flywheelArn
```
String flywheelArn
```
      The ARN of the flywheel.
    - filter
```
FlywheelIterationFilter filter
```
      Filter the flywheel iteration history based on creation time.
    - nextToken
```
String nextToken
```
      Next token
    - maxResults
```
Integer maxResults
```
      Maximum number of iteration history results to return
- Class com.amazonaws.services.comprehend.model.ListFlywheelIterationHistoryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - flywheelIterationPropertiesList
```
List<E> flywheelIterationPropertiesList
```
      List of flywheel iteration properties
    - nextToken
```
String nextToken
```
      Next token
- Class com.amazonaws.services.comprehend.model.ListFlywheelsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - filter
```
FlywheelFilter filter
```
      Filters the flywheels that are returned. You can filter flywheels on their 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
```
      Maximum number of results to return in a response. The default is 100.
- Class com.amazonaws.services.comprehend.model.ListFlywheelsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - flywheelSummaryList
```
List<E> flywheelSummaryList
```
      A list of flywheel properties retrieved by the service in response to the request.
    - 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.ListPiiEntitiesDetectionJobsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - filter
```
PiiEntitiesDetectionJobFilter 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.
- Class com.amazonaws.services.comprehend.model.ListPiiEntitiesDetectionJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - piiEntitiesDetectionJobPropertiesList
```
List<E> piiEntitiesDetectionJobPropertiesList
```
      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.ListTargetedSentimentDetectionJobsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - filter
```
TargetedSentimentDetectionJobFilter 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.ListTargetedSentimentDetectionJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - targetedSentimentDetectionJobPropertiesList
```
List<E> targetedSentimentDetectionJobPropertiesList
```
      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.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.MentionSentiment extends Object implements Serializable
  - Serialized Fields
    - sentiment
```
String sentiment
```
      The sentiment of the mention.
    - sentimentScore
```
SentimentScore sentimentScore
```
- 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.
      
      For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.
    - kmsKeyId
```
String kmsKeyId
```
      ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. Specify the Key Id of a symmetric key, because you cannot use an asymmetric key for uploading data to S3.
      
      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.PiiEntitiesDetectionJobFilter 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.PiiEntitiesDetectionJobProperties extends Object implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier assigned to the PII entities detection job.
    - jobArn
```
String jobArn
```
      The Amazon Resource Name (ARN) of the PII entities detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
      
      arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>
      
      The following is an example job ARN:
      
      arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab
    - jobName
```
String jobName
```
      The name that you assigned the PII entities detection job.
    - jobStatus
```
String jobStatus
```
      The current status of the PII 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 PII entities detection job was submitted for processing.
    - endTime
```
Date endTime
```
      The time that the PII entities detection job completed.
    - inputDataConfig
```
InputDataConfig inputDataConfig
```
      The input properties for a PII entities detection job.
    - outputDataConfig
```
PiiOutputDataConfig outputDataConfig
```
      The output data configuration that you supplied when you created the PII entities detection job.
    - redactionConfig
```
RedactionConfig redactionConfig
```
      Provides configuration parameters for PII entity redaction.
      
      This parameter is required if you set the Mode parameter to ONLY_REDACTION. In that case, you must provide a RedactionConfig definition that includes the PiiEntityTypes parameter.
    - languageCode
```
String languageCode
```
      The language code of the input documents.
    - dataAccessRoleArn
```
String dataAccessRoleArn
```
      The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
    - mode
```
String mode
```
      Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.
- Class com.amazonaws.services.comprehend.model.PiiEntity 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.
    - beginOffset
```
Integer beginOffset
```
      The zero-based offset from the beginning of the source text to the first character in the entity.
    - endOffset
```
Integer endOffset
```
      The zero-based offset from the beginning of the source text to the last character in the entity.
- Class com.amazonaws.services.comprehend.model.PiiOutputDataConfig extends Object implements Serializable
  - Serialized Fields
    - s3Uri
```
String s3Uri
```
      When you use the PiiOutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data.
      
      For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.
    - kmsKeyId
```
String kmsKeyId
```
      ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job.
- Class com.amazonaws.services.comprehend.model.Point extends Object implements Serializable
  - Serialized Fields
    - x
```
Float x
```
      The value of the X coordinate for a point on a polygon
    - y
```
Float y
```
      The value of the Y coordinate for a point on a polygon
- Class com.amazonaws.services.comprehend.model.PutResourcePolicyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The Amazon Resource Name (ARN) of the custom model to attach the policy to.
    - resourcePolicy
```
String resourcePolicy
```
      The JSON resource-based policy to attach to your custom model. Provide your JSON as a UTF-8 encoded string without line breaks. To provide valid JSON for your policy, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy:
      
      "{\"attribute\": \"value\", \"attribute\": [\"value\"]}"
      
      To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values:
      
      '{"attribute": "value", "attribute": ["value"]}'
    - policyRevisionId
```
String policyRevisionId
```
      The revision ID that Amazon Comprehend assigned to the policy that you are updating. If you are creating a new policy that has no prior version, don't use this parameter. Amazon Comprehend creates the revision ID for you.
- Class com.amazonaws.services.comprehend.model.PutResourcePolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - policyRevisionId
```
String policyRevisionId
```
      The revision ID of the policy. Each time you modify a policy, Amazon Comprehend assigns a new revision ID, and it deletes the prior version of the policy.
- Class com.amazonaws.services.comprehend.model.RedactionConfig extends Object implements Serializable
  - Serialized Fields
    - piiEntityTypes
```
List<E> piiEntityTypes
```
      An array of the types of PII entities that Amazon Comprehend detects in the input text for your request.
    - maskMode
```
String maskMode
```
      Specifies whether the PII entity is redacted with the mask character or the entity type.
    - maskCharacter
```
String maskCharacter
```
      A character that replaces each character in the redacted PII entity.
- Class com.amazonaws.services.comprehend.model.RelationshipsListItem extends Object implements Serializable
  - Serialized Fields
    - ids
```
List<E> ids
```
      Identifers of the child blocks.
    - type
```
String type
```
      Only supported relationship is a child relationship.
- 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.
    - jobArn
```
String jobArn
```
      The Amazon Resource Name (ARN) of the sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
      
      arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id>
      
      The following is an example job ARN:
      
      arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
    - 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) of the IAM role that grants Amazon Comprehend read access to your input data.
    - volumeKmsKeyId
```
String volumeKmsKeyId
```
      ID for the Amazon Web Services 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 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 Amazon Web Services 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.
    - tags
```
List<E> tags
```
      Tags to associate with the document classification job. A tag is a key-value pair that adds 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.
    - flywheelArn
```
String flywheelArn
```
      The Amazon Resource Number (ARN) of the flywheel associated with the model to use.
- 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 DescribeDocumentClassificationJob operation.
    - jobArn
```
String jobArn
```
      The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
      
      arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>
      
      The following is an example job ARN:
      
      arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
    - 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 DescribeDocumentClassificationJob 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.
    - documentClassifierArn
```
String documentClassifierArn
```
      The ARN of the custom classification model.
- 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 IAM role that grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.
    - 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 Amazon Web Services 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.
    - tags
```
List<E> tags
```
      Tags to associate with the dominant language detection job. A tag is a key-value pair that adds 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.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.
    - jobArn
```
String jobArn
```
      The Amazon Resource Name (ARN) of the dominant language detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
      
      arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>
      
      The following is an example job ARN:
      
      arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab
    - 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 IAM role that grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.
    - 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. 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 Amazon Web Services 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.
    - tags
```
List<E> tags
```
      Tags to associate with the entities detection job. A tag is a key-value pair that adds 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.
    - flywheelArn
```
String flywheelArn
```
      The Amazon Resource Number (ARN) of the flywheel associated with the model to use.
- 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.
    - jobArn
```
String jobArn
```
      The Amazon Resource Name (ARN) of the entities detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
      
      arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>
      
      The following is an example job ARN:
      
      arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
    - 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.
    - entityRecognizerArn
```
String entityRecognizerArn
```
      The ARN of the custom entity recognition model.
- Class com.amazonaws.services.comprehend.model.StartEventsDetectionJobRequest 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 IAM role that grants Amazon Comprehend read access to your input data.
    - jobName
```
String jobName
```
      The identifier of the events detection job.
    - languageCode
```
String languageCode
```
      The language code of the input documents.
    - clientRequestToken
```
String clientRequestToken
```
      An unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
    - targetEventTypes
```
List<E> targetEventTypes
```
      The types of events to detect in the input documents.
    - tags
```
List<E> tags
```
      Tags to associate with the events detection job. A tag is a key-value pair that adds 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.StartEventsDetectionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      An unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
    - jobArn
```
String jobArn
```
      The Amazon Resource Name (ARN) of the events detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
      
      arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>
      
      The following is an example job ARN:
      
      arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab
    - jobStatus
```
String jobStatus
```
      The status of the events detection job.
- Class com.amazonaws.services.comprehend.model.StartFlywheelIterationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - flywheelArn
```
String flywheelArn
```
      The ARN of the flywheel.
    - clientRequestToken
```
String clientRequestToken
```
      A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
- Class com.amazonaws.services.comprehend.model.StartFlywheelIterationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - flywheelArn
```
String flywheelArn
```
    - flywheelIterationId
```
String flywheelIterationId
```
- 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 IAM role that grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.
    - jobName
```
String jobName
```
      The identifier of the job.
    - languageCode
```
String languageCode
```
      The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. 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 Amazon Web Services 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.
    - tags
```
List<E> tags
```
      Tags to associate with the key phrases detection job. A tag is a key-value pair that adds 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.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.
    - jobArn
```
String jobArn
```
      The Amazon Resource Name (ARN) of the key phrase detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
      
      arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id>
      
      The following is an example job ARN:
      
      arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab
    - 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.StartPiiEntitiesDetectionJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - inputDataConfig
```
InputDataConfig inputDataConfig
```
      The input properties for a PII entities detection job.
    - outputDataConfig
```
OutputDataConfig outputDataConfig
```
      Provides conﬁguration parameters for the output of PII entity detection jobs.
    - mode
```
String mode
```
      Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.
    - redactionConfig
```
RedactionConfig redactionConfig
```
      Provides configuration parameters for PII entity redaction.
      
      This parameter is required if you set the Mode parameter to ONLY_REDACTION. In that case, you must provide a RedactionConfig definition that includes the PiiEntityTypes parameter.
    - dataAccessRoleArn
```
String dataAccessRoleArn
```
      The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
    - jobName
```
String jobName
```
      The identifier of the job.
    - languageCode
```
String languageCode
```
      The language of the input documents. Enter the language code for English (en) or Spanish (es).
    - clientRequestToken
```
String clientRequestToken
```
      A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
    - tags
```
List<E> tags
```
      Tags to associate with the PII entities detection job. A tag is a key-value pair that adds 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.StartPiiEntitiesDetectionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier generated for the job.
    - jobArn
```
String jobArn
```
      The Amazon Resource Name (ARN) of the PII entity detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
      
      arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>
      
      The following is an example job ARN:
      
      arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab
    - jobStatus
```
String jobStatus
```
      The status of the job.
- 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 IAM role that grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.
    - jobName
```
String jobName
```
      The identifier of the job.
    - languageCode
```
String languageCode
```
      The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. 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 Amazon Web Services 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.
    - tags
```
List<E> tags
```
      Tags to associate with the sentiment detection job. A tag is a key-value pair that adds 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.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.
    - jobArn
```
String jobArn
```
      The Amazon Resource Name (ARN) of the sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
      
      arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id>
      
      The following is an example job ARN:
      
      arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
    - 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.StartTargetedSentimentDetectionJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - inputDataConfig
```
InputDataConfig inputDataConfig
```
    - outputDataConfig
```
OutputDataConfig outputDataConfig
```
      Specifies where to send the output files.
    - dataAccessRoleArn
```
String dataAccessRoleArn
```
      The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.
    - jobName
```
String jobName
```
      The identifier of the job.
    - languageCode
```
String languageCode
```
      The language of the input documents. Currently, English is the only supported 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 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
```
    - tags
```
List<E> tags
```
      Tags to associate with the targeted sentiment detection job. A tag is a key-value pair that adds 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.StartTargetedSentimentDetectionJobResult 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 DescribeTargetedSentimentDetectionJob operation.
    - jobArn
```
String jobArn
```
      The Amazon Resource Name (ARN) of the targeted sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
      
      arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>
      
      The following is an example job ARN:
      
      arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
    - 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 DescribeTargetedSentimentDetectionJob 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 IAM role that grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.
    - 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 Amazon Web Services 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.
    - tags
```
List<E> tags
```
      Tags to associate with the topics detection job. A tag is a key-value pair that adds 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.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.
    - jobArn
```
String jobArn
```
      The Amazon Resource Name (ARN) of the topics detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
      
      arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>
      
      The following is an example job ARN:
      
      arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
    - 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.StopEventsDetectionJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier of the events detection job to stop.
- Class com.amazonaws.services.comprehend.model.StopEventsDetectionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier of the events detection job to stop.
    - jobStatus
```
String jobStatus
```
      The status of the events detection job.
- 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.StopPiiEntitiesDetectionJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier of the PII entities detection job to stop.
- Class com.amazonaws.services.comprehend.model.StopPiiEntitiesDetectionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier of the PII entities detection job to stop.
    - jobStatus
```
String jobStatus
```
      The status of the PII entities detection job.
- 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.StopTargetedSentimentDetectionJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier of the targeted sentiment detection job to stop.
- Class com.amazonaws.services.comprehend.model.StopTargetedSentimentDetectionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier of the targeted 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 Syntax in the Comprehend Developer Guide.
- 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.TargetedSentimentDetectionJobFilter 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.TargetedSentimentDetectionJobProperties extends Object implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier assigned to the targeted sentiment detection job.
    - jobArn
```
String jobArn
```
      The Amazon Resource Name (ARN) of the targeted sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
      
      arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>
      
      The following is an example job ARN:
      
      arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
    - jobName
```
String jobName
```
      The name that you assigned to the targeted sentiment detection job.
    - jobStatus
```
String jobStatus
```
      The current status of the targeted 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 targeted sentiment detection job was submitted for processing.
    - endTime
```
Date endTime
```
      The time that the targeted sentiment detection job ended.
    - inputDataConfig
```
InputDataConfig inputDataConfig
```
    - outputDataConfig
```
OutputDataConfig outputDataConfig
```
    - languageCode
```
String languageCode
```
      The language code of the input documents.
    - dataAccessRoleArn
```
String dataAccessRoleArn
```
      The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
    - volumeKmsKeyId
```
String volumeKmsKeyId
```
      ID for the KMS key that Amazon Comprehend uses to encrypt the data on the storage volume attached to the ML compute instance(s) that process the targeted sentiment detection 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
```
- Class com.amazonaws.services.comprehend.model.TargetedSentimentEntity extends Object implements Serializable
  - Serialized Fields
    - descriptiveMentionIndex
```
List<E> descriptiveMentionIndex
```
      One or more index into the Mentions array that provides the best name for the entity group.
    - mentions
```
List<E> mentions
```
      An array of mentions of the entity in the document. The array represents a co-reference group. See Co-reference group for an example.
- Class com.amazonaws.services.comprehend.model.TargetedSentimentMention extends Object implements Serializable
  - Serialized Fields
    - score
```
Float score
```
      Model confidence that the entity is relevant. Value range is zero to one, where one is highest confidence.
    - groupScore
```
Float groupScore
```
      The confidence that all the entities mentioned in the group relate to the same entity.
    - text
```
String text
```
      The text in the document that identifies the entity.
    - type
```
String type
```
      The type of the entity. Amazon Comprehend supports a variety of entity types.
    - mentionSentiment
```
MentionSentiment mentionSentiment
```
      Contains the sentiment and sentiment score for the mention.
    - beginOffset
```
Integer beginOffset
```
      The offset into the document text where the mention begins.
    - endOffset
```
Integer endOffset
```
      The offset into the document text where the mention ends.
- Class com.amazonaws.services.comprehend.model.TaskConfig extends Object implements Serializable
  - Serialized Fields
    - languageCode
```
String languageCode
```
      Language code for the language that the model supports.
    - documentClassificationConfig
```
DocumentClassificationConfig documentClassificationConfig
```
      Configuration required for a document classification model.
    - entityRecognitionConfig
```
EntityRecognitionConfig entityRecognitionConfig
```
      Configuration required for an entity recognition model.
- Class com.amazonaws.services.comprehend.model.TextSegment extends Object implements Serializable
  - Serialized Fields
    - text
```
String text
```
      The text content.
- 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.
    - jobArn
```
String jobArn
```
      The Amazon Resource Name (ARN) of the topics detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
      
      arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>
      
      The following is an example job ARN:
      
      arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/1234abcd12ab34cd56ef1234567890ab
    - 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 IAM role that grants Amazon Comprehend read access to your job data.
    - volumeKmsKeyId
```
String volumeKmsKeyId
```
      ID for the Amazon Web Services 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.ToxicContent extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the toxic content type.
    - score
```
Float score
```
      Model confidence in the detected content type. Value range is zero to one, where one is highest confidence.
- Class com.amazonaws.services.comprehend.model.ToxicLabels extends Object implements Serializable
  - Serialized Fields
    - labels
```
List<E> labels
```
      Array of toxic content types identified in the string.
    - toxicity
```
Float toxicity
```
      Overall toxicity score for the string. Value range is zero to one, where one is the highest confidence.
- 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.UpdateDataSecurityConfig extends Object implements Serializable
  - Serialized Fields
    - modelKmsKeyId
```
String modelKmsKeyId
```
      ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId 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"
    - volumeKmsKeyId
```
String volumeKmsKeyId
```
      ID for the KMS key that Amazon Comprehend uses to encrypt the volume.
    - vpcConfig
```
VpcConfig vpcConfig
```
- Class com.amazonaws.services.comprehend.model.UpdateEndpointRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - endpointArn
```
String endpointArn
```
      The Amazon Resource Number (ARN) of the endpoint being updated.
    - desiredModelArn
```
String desiredModelArn
```
      The ARN of the new model to use when updating an existing endpoint.
    - desiredInferenceUnits
```
Integer desiredInferenceUnits
```
      The desired number of inference units to be used by the model using this endpoint. Each inference unit represents of a throughput of 100 characters per second.
    - desiredDataAccessRoleArn
```
String desiredDataAccessRoleArn
```
      Data access role ARN to use in case the new model is encrypted with a customer CMK.
    - flywheelArn
```
String flywheelArn
```
      The Amazon Resource Number (ARN) of the flywheel
- Class com.amazonaws.services.comprehend.model.UpdateEndpointResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - desiredModelArn
```
String desiredModelArn
```
      The Amazon Resource Number (ARN) of the new model.
- Class com.amazonaws.services.comprehend.model.UpdateFlywheelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - flywheelArn
```
String flywheelArn
```
      The Amazon Resource Number (ARN) of the flywheel to update.
    - activeModelArn
```
String activeModelArn
```
      The Amazon Resource Number (ARN) of the active model version.
    - dataAccessRoleArn
```
String dataAccessRoleArn
```
      The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to access the flywheel data.
    - dataSecurityConfig
```
UpdateDataSecurityConfig dataSecurityConfig
```
      Flywheel data security configuration.
- Class com.amazonaws.services.comprehend.model.UpdateFlywheelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - flywheelProperties
```
FlywheelProperties flywheelProperties
```
      The flywheel properties.
- 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.
- Class com.amazonaws.services.comprehend.model.WarningsListItem extends Object implements Serializable
  - Serialized Fields
    - page
```
Integer page
```
      Page number in the input document.
    - warnCode
```
String warnCode
```
      The type of warning.
    - warnMessage
```
String warnMessage
```
      Text message associated with the warning.

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.AugmentedManifestsListItem extends Object implements Serializable

Serialized Fields

s3Uri

split

attributeNames

annotationDataS3Uri

sourceDocumentsS3Uri

documentType

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.BatchDetectTargetedSentimentItemResult extends Object implements Serializable

Serialized Fields

index

entities

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

Serialized Fields

textList

languageCode

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