Interface StartDocumentClassificationJobRequest

interface StartDocumentClassificationJobRequest {
    ClientRequestToken?: string;
    DataAccessRoleArn: undefined | string;
    DocumentClassifierArn?: string;
    FlywheelArn?: string;
    InputDataConfig: undefined | InputDataConfig;
    JobName?: string;
    OutputDataConfig: undefined | OutputDataConfig;
    Tags?: Tag[];
    VolumeKmsKeyId?: string;
    VpcConfig?: VpcConfig;
}

Hierarchy (view full)

Properties

ClientRequestToken? DataAccessRoleArn DocumentClassifierArn? FlywheelArn? InputDataConfig JobName? OutputDataConfig Tags? VolumeKmsKeyId? VpcConfig?

Properties

Optional ClientRequestToken

ClientRequestToken?: string

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

DataAccessRoleArn

DataAccessRoleArn: undefined | string

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

Optional DocumentClassifierArn

DocumentClassifierArn?: string

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

Optional FlywheelArn

FlywheelArn?: string

The Amazon Resource Number (ARN) of the flywheel associated with the model to use.

InputDataConfig

InputDataConfig: undefined | InputDataConfig

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

Optional JobName

JobName?: string

The identifier of the job.

OutputDataConfig

OutputDataConfig: undefined | OutputDataConfig

Specifies where to send the output files.

Optional Tags

Tags?: Tag[]

Tags to associate 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.

Optional VolumeKmsKeyId

VolumeKmsKeyId?: 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"

Optional VpcConfig

VpcConfig?: VpcConfig

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.

Settings

Member Visibility

Theme

On This Page