# DocumentClassifierProperties
<a name="API_DocumentClassifierProperties"></a>

Provides information about a document classifier.

## Contents
<a name="API_DocumentClassifierProperties_Contents"></a>

 ** ClassifierMetadata **   <a name="comprehend-Type-DocumentClassifierProperties-ClassifierMetadata"></a>
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.  
Type: [ClassifierMetadata](API_ClassifierMetadata.md) object  
Required: No

 ** DataAccessRoleArn **   <a name="comprehend-Type-DocumentClassifierProperties-DataAccessRoleArn"></a>
The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+`   
Required: No

 ** DocumentClassifierArn **   <a name="comprehend-Type-DocumentClassifierProperties-DocumentClassifierArn"></a>
The Amazon Resource Name (ARN) that identifies the document classifier.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:aws[A-Za-z0-9-]{0,63}:comprehend:[A-Za-z0-9-]{0,63}:([0-9]{12}|aws):document-classifier/[A-Za-z0-9-]{0,63}(/version/[A-Za-z0-9-]{0,63})?`   
Required: No

 ** EndTime **   <a name="comprehend-Type-DocumentClassifierProperties-EndTime"></a>
The time that training the document classifier completed.  
Type: Timestamp  
Required: No

 ** FlywheelArn **   <a name="comprehend-Type-DocumentClassifierProperties-FlywheelArn"></a>
The Amazon Resource Number (ARN) of the flywheel  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:flywheel/[a-zA-Z0-9](-*[a-zA-Z0-9])*`   
Required: No

 ** InputDataConfig **   <a name="comprehend-Type-DocumentClassifierProperties-InputDataConfig"></a>
The input data configuration that you supplied when you created the document classifier for training.  
Type: [DocumentClassifierInputDataConfig](API_DocumentClassifierInputDataConfig.md) object  
Required: No

 ** LanguageCode **   <a name="comprehend-Type-DocumentClassifierProperties-LanguageCode"></a>
The language code for the language of the documents that the classifier was trained on.  
Type: String  
Valid Values: `en | es | fr | de | it | pt | ar | hi | ja | ko | zh | zh-TW`   
Required: No

 ** Message **   <a name="comprehend-Type-DocumentClassifierProperties-Message"></a>
Additional information about the status of the classifier.  
Type: String  
Required: No

 ** Mode **   <a name="comprehend-Type-DocumentClassifierProperties-Mode"></a>
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.  
Type: String  
Valid Values: `MULTI_CLASS | MULTI_LABEL`   
Required: No

 ** ModelKmsKeyId **   <a name="comprehend-Type-DocumentClassifierProperties-ModelKmsKeyId"></a>
ID for the AWS 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"` 
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^\p{ASCII}+$`   
Required: No

 ** OutputDataConfig **   <a name="comprehend-Type-DocumentClassifierProperties-OutputDataConfig"></a>
 Provides output results configuration parameters for custom classifier jobs.  
Type: [DocumentClassifierOutputDataConfig](API_DocumentClassifierOutputDataConfig.md) object  
Required: No

 ** SourceModelArn **   <a name="comprehend-Type-DocumentClassifierProperties-SourceModelArn"></a>
The Amazon Resource Name (ARN) of the source model. This model was imported from a different AWS account to create the document classifier model in your AWS account.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:aws[A-Za-z0-9-]{0,63}:comprehend:[A-Za-z0-9-]{0,63}:([0-9]{12}|aws):document-classifier/[A-Za-z0-9-]{0,63}(/version/[A-Za-z0-9-]{0,63})?`   
Required: No

 ** Status **   <a name="comprehend-Type-DocumentClassifierProperties-Status"></a>
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.  
Type: String  
Valid Values: `SUBMITTED | TRAINING | DELETING | STOP_REQUESTED | STOPPED | IN_ERROR | TRAINED | TRAINED_WITH_WARNING`   
Required: No

 ** SubmitTime **   <a name="comprehend-Type-DocumentClassifierProperties-SubmitTime"></a>
The time that the document classifier was submitted for training.  
Type: Timestamp  
Required: No

 ** TrainingEndTime **   <a name="comprehend-Type-DocumentClassifierProperties-TrainingEndTime"></a>
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.  
Type: Timestamp  
Required: No

 ** TrainingStartTime **   <a name="comprehend-Type-DocumentClassifierProperties-TrainingStartTime"></a>
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.   
Type: Timestamp  
Required: No

 ** VersionName **   <a name="comprehend-Type-DocumentClassifierProperties-VersionName"></a>
The version name that you assigned to the document classifier.  
Type: String  
Length Constraints: Maximum length of 63.  
Pattern: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*$`   
Required: No

 ** VolumeKmsKeyId **   <a name="comprehend-Type-DocumentClassifierProperties-VolumeKmsKeyId"></a>
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:  
+ KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"` 
+ Amazon Resource Name (ARN) of a KMS Key: `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"` 
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^\p{ASCII}+$`   
Required: No

 ** VpcConfig **   <a name="comprehend-Type-DocumentClassifierProperties-VpcConfig"></a>
 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](https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).   
Type: [VpcConfig](API_VpcConfig.md) object  
Required: No

## See Also
<a name="API_DocumentClassifierProperties_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/comprehend-2017-11-27/DocumentClassifierProperties) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/comprehend-2017-11-27/DocumentClassifierProperties) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/comprehend-2017-11-27/DocumentClassifierProperties)