Struct aws_sdk_comprehend::model::DocumentClassifierProperties

source · [−]

#[non_exhaustive]
pub struct DocumentClassifierProperties { /* private fields */ }

Expand description

Provides information about a document classifier.

Implementations

source

impl DocumentClassifierProperties

source

pub fn document_classifier_arn(&self) -> Option<&str>

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

source

pub fn language_code(&self) -> Option<&LanguageCode>

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

source

pub fn status(&self) -> Option<&ModelStatus>

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.

source

pub fn message(&self) -> Option<&str>

Additional information about the status of the classifier.

source

pub fn submit_time(&self) -> Option<&DateTime>

The time that the document classifier was submitted for training.

source

pub fn end_time(&self) -> Option<&DateTime>

The time that training the document classifier completed.

source

pub fn training_start_time(&self) -> Option<&DateTime>

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.

source

pub fn training_end_time(&self) -> Option<&DateTime>

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.

source

pub fn input_data_config(&self) -> Option<&DocumentClassifierInputDataConfig>

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

source

pub fn output_data_config(&self) -> Option<&DocumentClassifierOutputDataConfig>

Provides output results configuration parameters for custom classifier jobs.

source

pub fn classifier_metadata(&self) -> Option<&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.

source

pub fn data_access_role_arn(&self) -> Option<&str>

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

source

pub fn volume_kms_key_id(&self) -> Option<&str>

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"

source

pub fn vpc_config(&self) -> Option<&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.

source

pub fn mode(&self) -> Option<&DocumentClassifierMode>

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.

source

pub fn model_kms_key_id(&self) -> Option<&str>

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"

source

pub fn version_name(&self) -> Option<&str>

The version name that you assigned to the document classifier.

source

pub fn source_model_arn(&self) -> Option<&str>

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.

source