Struct aws_sdk_comprehend::types::DocumentClassificationJobProperties

#[non_exhaustive]
pub struct DocumentClassificationJobProperties {

    pub job_id: Option<String>,
    pub job_arn: Option<String>,
    pub job_name: Option<String>,
    pub job_status: Option<JobStatus>,
    pub message: Option<String>,
    pub submit_time: Option<DateTime>,
    pub end_time: Option<DateTime>,
    pub document_classifier_arn: Option<String>,
    pub input_data_config: Option<InputDataConfig>,
    pub output_data_config: Option<OutputDataConfig>,
    pub data_access_role_arn: Option<String>,
    pub volume_kms_key_id: Option<String>,
    pub vpc_config: Option<VpcConfig>,
    pub flywheel_arn: Option<String>,
}

Provides information about a document classification job.

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.

job_id: Option<String>

The identifier assigned to the document classification job.

job_arn: Option<String>

The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

arn: :comprehend: : :document-classification-job/

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab

job_name: Option<String>

The name that you assigned to the document classification job.

job_status: Option<JobStatus>

The current status of the document classification job. If the status is FAILED, the Message field shows the reason for the failure.

message: Option<String>

A description of the status of the job.

submit_time: Option<DateTime>

The time that the document classification job was submitted for processing.

end_time: Option<DateTime>

The time that the document classification job completed.

document_classifier_arn: Option<String>

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

input_data_config: Option<InputDataConfig>

The input data configuration that you supplied when you created the document classification job.

output_data_config: Option<OutputDataConfig>

The output data configuration that you supplied when you created the document classification job.

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 document classification job. For more information, see Amazon VPC.

flywheel_arn: Option<String>

The Amazon Resource Number (ARN) of the flywheel

Implementations

impl DocumentClassificationJobProperties

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

The identifier assigned to the document classification job.

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

The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

arn: :comprehend: : :document-classification-job/

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab

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

The name that you assigned to the document classification job.

pub fn job_status(&self) -> Option<&JobStatus>

The current status of the document classification job. If the status is FAILED, the Message field shows the reason for the failure.

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

A description of the status of the job.

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

The time that the document classification job was submitted for processing.

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

The time that the document classification job completed.

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

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

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

The input data configuration that you supplied when you created the document classification job.

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

The output data configuration that you supplied when you created the document classification job.

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 document classification job. For more information, see Amazon VPC.

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

The Amazon Resource Number (ARN) of the flywheel

impl DocumentClassificationJobProperties

pub fn builder() -> DocumentClassificationJobPropertiesBuilder

Creates a new builder-style object to manufacture DocumentClassificationJobProperties.

Trait Implementations

impl Clone for DocumentClassificationJobProperties

fn clone(&self) -> DocumentClassificationJobProperties

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentClassificationJobProperties

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

Formats the value using the given formatter.

impl PartialEq<DocumentClassificationJobProperties> for DocumentClassificationJobProperties

fn eq(&self, other: &DocumentClassificationJobProperties) -> 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 DocumentClassificationJobProperties