Struct aws_sdk_comprehend::types::EntityRecognizerProperties

#[non_exhaustive]
pub struct EntityRecognizerProperties {

    pub entity_recognizer_arn: Option<String>,
    pub language_code: Option<LanguageCode>,
    pub status: Option<ModelStatus>,
    pub message: Option<String>,
    pub submit_time: Option<DateTime>,
    pub end_time: Option<DateTime>,
    pub training_start_time: Option<DateTime>,
    pub training_end_time: Option<DateTime>,
    pub input_data_config: Option<EntityRecognizerInputDataConfig>,
    pub recognizer_metadata: Option<EntityRecognizerMetadata>,
    pub data_access_role_arn: Option<String>,
    pub volume_kms_key_id: Option<String>,
    pub vpc_config: Option<VpcConfig>,
    pub model_kms_key_id: Option<String>,
    pub version_name: Option<String>,
    pub source_model_arn: Option<String>,
    pub flywheel_arn: Option<String>,
    pub output_data_config: Option<EntityRecognizerOutputDataConfig>,
}

Describes information about an entity recognizer.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

entity_recognizer_arn: Option<String>

The Amazon Resource Name (ARN) that identifies the entity recognizer.

language_code: Option<LanguageCode>

The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported.

status: Option<ModelStatus>

Provides the status of the entity recognizer.

message: Option<String>

A description of the status of the recognizer.

submit_time: Option<DateTime>

The time that the recognizer was submitted for processing.

end_time: Option<DateTime>

The time that the recognizer creation completed.

training_start_time: Option<DateTime>

The time that training of the entity recognizer started.

training_end_time: Option<DateTime>

The time that training of the entity recognizer was completed.

input_data_config: Option<EntityRecognizerInputDataConfig>

The input data properties of an entity recognizer.

recognizer_metadata: Option<EntityRecognizerMetadata>

Provides information about an entity recognizer.

data_access_role_arn: Option<String>

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

volume_kms_key_id: Option<String>

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"

vpc_config: Option<VpcConfig>

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom entity recognizer. For more information, see Amazon VPC.

model_kms_key_id: Option<String>

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"

version_name: Option<String>

The version name you assigned to the entity recognizer.

source_model_arn: Option<String>

The Amazon Resource Name (ARN) of the source model. This model was imported from a different Amazon Web Services account to create the entity recognizer model in your Amazon Web Services account.

flywheel_arn: Option<String>

The Amazon Resource Number (ARN) of the flywheel

output_data_config: Option<EntityRecognizerOutputDataConfig>

Output data configuration.

Implementations

impl EntityRecognizerProperties

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

The Amazon Resource Name (ARN) that identifies the entity recognizer.

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

The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported.

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

Provides the status of the entity recognizer.

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

A description of the status of the recognizer.

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

The time that the recognizer was submitted for processing.

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

The time that the recognizer creation completed.

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

The time that training of the entity recognizer started.

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

The time that training of the entity recognizer was completed.

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

The input data properties of an entity recognizer.

pub fn recognizer_metadata(&self) -> Option<&EntityRecognizerMetadata>

Provides information about an entity recognizer.

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

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

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

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"

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 entity recognizer. For more information, see Amazon VPC.

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

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"

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

The version name you assigned to the entity recognizer.

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

The Amazon Resource Name (ARN) of the source model. This model was imported from a different Amazon Web Services account to create the entity recognizer model in your Amazon Web Services account.

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

The Amazon Resource Number (ARN) of the flywheel

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

Output data configuration.

impl EntityRecognizerProperties

pub fn builder() -> EntityRecognizerPropertiesBuilder

Creates a new builder-style object to manufacture EntityRecognizerProperties.

Trait Implementations

impl Clone for EntityRecognizerProperties

fn clone(&self) -> EntityRecognizerProperties

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EntityRecognizerProperties

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

Formats the value using the given formatter.

impl PartialEq for EntityRecognizerProperties

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for EntityRecognizerProperties