StartDocumentClassificationJobRequest

import type { StartDocumentClassificationJobRequest } from "https://aws-api.deno.dev/v0.3/services/comprehend.ts?docs=full";

interface StartDocumentClassificationJobRequest {

ClientRequestToken?: string | null;

DataAccessRoleArn: string;

DocumentClassifierArn: string;

InputDataConfig: InputDataConfig;

JobName?: string | null;

OutputDataConfig: OutputDataConfig;

Tags?: Tag[] | null;

VolumeKmsKeyId?: string | null;

VpcConfig?: VpcConfig | null;

}

§Properties

ClientRequestToken?: string | null

[src]

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

DataAccessRoleArn: string

[src]

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

DocumentClassifierArn: string

[src]

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

InputDataConfig: InputDataConfig

[src]

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

JobName?: string | null

[src]

The identifier of the job.

OutputDataConfig: OutputDataConfig

[src]

Specifies where to send the output files.

Tags?: Tag[] | null

[src]

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.

VolumeKmsKeyId?: string | null

[src]

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"

VpcConfig?: VpcConfig | null

[src]

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.