Struct DocumentClassifierOutputDataConfig

#[non_exhaustive]
pub struct DocumentClassifierOutputDataConfig {
    pub s3_uri: Option<String>,
    pub kms_key_id: Option<String>,
    pub flywheel_stats_s3_prefix: Option<String>,
}

Provide the location for output data from a custom classifier job. This field is mandatory if you are training a native document model.

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.

s3_uri: Option<String>

When you use the OutputDataConfig object while creating a custom classifier, you specify the Amazon S3 location where you want to write the confusion matrix and other output files. The URI must be in the same Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of this output file.

When the custom classifier job is finished, the service creates the output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the confusion matrix.

kms_key_id: Option<String>

ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one 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"

• KMS Key Alias: "alias/ExampleAlias"

• ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

flywheel_stats_s3_prefix: Option<String>

The Amazon S3 prefix for the data lake location of the flywheel statistics.

Implementations

impl DocumentClassifierOutputDataConfig

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

When you use the OutputDataConfig object while creating a custom classifier, you specify the Amazon S3 location where you want to write the confusion matrix and other output files. The URI must be in the same Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of this output file.

When the custom classifier job is finished, the service creates the output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the confusion matrix.

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

ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one 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"

• KMS Key Alias: "alias/ExampleAlias"

• ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

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

The Amazon S3 prefix for the data lake location of the flywheel statistics.

impl DocumentClassifierOutputDataConfig

pub fn builder() -> DocumentClassifierOutputDataConfigBuilder

Creates a new builder-style object to manufacture DocumentClassifierOutputDataConfig.

Trait Implementations

impl Clone for DocumentClassifierOutputDataConfig

fn clone(&self) -> DocumentClassifierOutputDataConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentClassifierOutputDataConfig

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

Formats the value using the given formatter.

impl PartialEq for DocumentClassifierOutputDataConfig

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for DocumentClassifierOutputDataConfig