DocumentClassifierProperties

Gets and sets the property 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.

Gets and sets the property DataAccessRoleArn.

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.

Gets and sets the property DocumentClassifierArn.

The Amazon Resource Name (ARN) that identifies the document classifier.

Gets and sets the property EndTime.

The time that training the document classifier completed.

Gets and sets the property FlywheelArn.

The Amazon Resource Number (ARN) of the flywheel

Gets and sets the property InputDataConfig.

The input data configuration that you supplied when you created the document classifier for training.

Gets and sets the property LanguageCode.

The language code for the language of the documents that the classifier was trained on.

Gets and sets the property Message.

Additional information about the status of the classifier.

Gets and sets the property 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.

Gets and sets the property 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"

Gets and sets the property OutputDataConfig.

Provides output results configuration parameters for custom classifier jobs.

Gets and sets the property 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.

Gets and sets the property 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.

Gets and sets the property SubmitTime.

The time that the document classifier was submitted for training.

Gets and sets the property 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.

Gets and sets the property 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.

Gets and sets the property VersionName.

The version name that you assigned to the document classifier.

Gets and sets the property 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"

Gets and sets the property 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.