Struct aws_sdk_comprehend::model::document_classification_job_properties::Builder

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

A builder for DocumentClassificationJobProperties

Implementations

impl Builder

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

The identifier assigned to the document classification job.

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

The identifier assigned to the document classification job.

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

The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the AWS account, 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 set_job_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the AWS account, 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, input: impl Into<String>) -> Self

The name that you assigned to the document classification job.

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

The name that you assigned to the document classification job.

pub fn job_status(self, input: JobStatus) -> Self

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

pub fn set_job_status(self, input: Option<JobStatus>) -> Self

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, input: impl Into<String>) -> Self

A description of the status of the job.

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

A description of the status of the job.

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

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

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

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

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

The time that the document classification job completed.

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

The time that the document classification job completed.

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 input_data_config(self, input: InputDataConfig) -> Self

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

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

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

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

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

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

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

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

The Amazon Resource Name (ARN) of the AWS identity and Access 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 Access 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 document classification job. 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 document classification job. For more information, see Amazon VPC.

pub fn build(self) -> DocumentClassificationJobProperties

Consumes the builder and constructs a DocumentClassificationJobProperties

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