Struct aws_sdk_comprehend::client::fluent_builders::StartDocumentClassificationJob

pub struct StartDocumentClassificationJob<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }

Fluent builder constructing a request to StartDocumentClassificationJob.

Starts an asynchronous document classification job. Use the operation to track the progress of the job.

Implementations

impl<C, M, R> StartDocumentClassificationJob<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<StartDocumentClassificationJobOutput, SdkError<StartDocumentClassificationJobError>> where
    R::Policy: SmithyRetryPolicy<StartDocumentClassificationJobInputOperationOutputAlias, StartDocumentClassificationJobOutput, StartDocumentClassificationJobError, StartDocumentClassificationJobInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

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

The identifier of the job.

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

The identifier of the job.

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

The Amazon Resource Name (ARN) of the document classifier to use to process the job.

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

The Amazon Resource Name (ARN) of the document classifier to use to process the job.

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

Specifies the format and location of the input data for the job.

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

Specifies the format and location of the input data for the job.

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

Specifies where to send the output files.

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

Specifies where to send the output files.

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

A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

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

A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

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 an optional 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 an optional private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. For more information, see Amazon VPC.

pub fn tags(self, input: Tag) -> Self

Appends an item to Tags.

To override the contents of this collection use set_tags.

Tags to be associated with the document classification job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

Tags to be associated with the document classification job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

Trait Implementations

impl<C: Clone, M: Clone, R: Clone> Clone for StartDocumentClassificationJob<C, M, R>

fn clone(&self) -> StartDocumentClassificationJob<C, M, R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for StartDocumentClassificationJob<C, M, R>

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

Formats the value using the given formatter.