class Aws::Comprehend::Types::DocumentClassifierProperties

Provides information about a document classifier.

@!attribute [rw] document_classifier_arn

The Amazon Resource Name (ARN) that identifies the document
classifier.
@return [String]

@!attribute [rw] language_code

The language code for the language of the documents that the
classifier was trained on.
@return [String]

@!attribute [rw] status

The status of the document classifier. If the status is `TRAINED`
the classifier is ready to use. If the status is `FAILED` you can
see additional information about why the classifier wasn't trained
in the `Message` field.
@return [String]

@!attribute [rw] message

Additional information about the status of the classifier.
@return [String]

@!attribute [rw] submit_time

The time that the document classifier was submitted for training.
@return [Time]

@!attribute [rw] end_time

The time that training the document classifier completed.
@return [Time]

@!attribute [rw] training_start_time

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.
@return [Time]

@!attribute [rw] training_end_time

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.
@return [Time]

@!attribute [rw] input_data_config

The input data configuration that you supplied when you created the
document classifier for training.
@return [Types::DocumentClassifierInputDataConfig]

@!attribute [rw] output_data_config

Provides output results configuration parameters for custom
classifier jobs.
@return [Types::DocumentClassifierOutputDataConfig]

@!attribute [rw] classifier_metadata

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.
@return [Types::ClassifierMetadata]

@!attribute [rw] data_access_role_arn

The Amazon Resource Name (ARN) of the AWS Identity and Management
(IAM) role that grants Amazon Comprehend read access to your input
data.
@return [String]

@!attribute [rw] volume_kms_key_id

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"`
@return [String]

@!attribute [rw] vpc_config

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][1].

[1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
@return [Types::VpcConfig]

@!attribute [rw] 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.
@return [String]

@!attribute [rw] model_kms_key_id

ID for the AWS Key Management Service (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"`
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClassifierProperties AWS API Documentation

Constants

SENSITIVE