Struct aws_sdk_comprehend::model::document_classifier_properties::Builder

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

A builder for DocumentClassifierProperties

Implementations

impl Builder

pub fn document_classifier_arn(self, input: impl Into<String>) -> Self

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

pub fn set_document_classifier_arn(self, input: Option<String>) -> Self

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

pub fn language_code(self, input: LanguageCode) -> Self

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

pub fn set_language_code(self, input: Option<LanguageCode>) -> Self

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

pub fn status(self, input: ModelStatus) -> Self

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.

pub fn set_status(self, input: Option<ModelStatus>) -> Self

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.

pub fn message(self, input: impl Into<String>) -> Self

Additional information about the status of the classifier.

pub fn set_message(self, input: Option<String>) -> Self

Additional information about the status of the classifier.

pub fn submit_time(self, input: DateTime) -> Self

The time that the document classifier was submitted for training.

pub fn set_submit_time(self, input: Option<DateTime>) -> Self

The time that the document classifier was submitted for training.

pub fn end_time(self, input: DateTime) -> Self

The time that training the document classifier completed.

pub fn set_end_time(self, input: Option<DateTime>) -> Self

The time that training the document classifier completed.

pub fn training_start_time(self, input: DateTime) -> Self

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.

pub fn set_training_start_time(self, input: Option<DateTime>) -> Self

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.

pub fn training_end_time(self, input: DateTime) -> Self

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.

pub fn set_training_end_time(self, input: Option<DateTime>) -> Self

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.

pub fn input_data_config(self, input: DocumentClassifierInputDataConfig) -> Self

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

pub fn set_input_data_config(
    self,
    input: Option<DocumentClassifierInputDataConfig>
) -> Self

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

pub fn output_data_config(
    self,
    input: DocumentClassifierOutputDataConfig
) -> Self

Provides output results configuration parameters for custom classifier jobs.

pub fn set_output_data_config(
    self,
    input: Option<DocumentClassifierOutputDataConfig>
) -> Self

Provides output results configuration parameters for custom classifier jobs.

pub fn classifier_metadata(self, input: ClassifierMetadata) -> Self

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.

pub fn set_classifier_metadata(self, input: Option<ClassifierMetadata>) -> Self

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.

pub fn data_access_role_arn(self, input: impl Into<String>) -> Self

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

pub fn set_data_access_role_arn(self, input: Option<String>) -> Self

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

pub fn volume_kms_key_id(self, input: impl Into<String>) -> Self

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"

pub fn set_volume_kms_key_id(self, input: Option<String>) -> Self

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"

pub fn vpc_config(self, input: VpcConfig) -> Self

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.

pub fn set_vpc_config(self, input: Option<VpcConfig>) -> Self

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.

pub fn mode(self, input: DocumentClassifierMode) -> Self

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.

pub fn set_mode(self, input: Option<DocumentClassifierMode>) -> Self

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.

pub fn model_kms_key_id(self, input: impl Into<String>) -> Self

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"

pub fn set_model_kms_key_id(self, input: Option<String>) -> Self

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"

pub fn version_name(self, input: impl Into<String>) -> Self

The version name that you assigned to the document classifier.

pub fn set_version_name(self, input: Option<String>) -> Self

The version name that you assigned to the document classifier.

pub fn source_model_arn(self, input: impl Into<String>) -> Self

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.

pub fn set_source_model_arn(self, input: Option<String>) -> Self

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.

pub fn build(self) -> DocumentClassifierProperties

Consumes the builder and constructs a DocumentClassifierProperties

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Builder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

fn eq(&self, other: &Builder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Builder) -> bool

This method tests for !=.

impl StructuralPartialEq for Builder