DocumentClassifierArgs

data class DocumentClassifierArgs(val dataAccessRoleArn: Output<String>? = null, val documentClassifierName: Output<String>? = null, val inputDataConfig: Output<DocumentClassifierInputDataConfigArgs>? = null, val languageCode: Output<DocumentClassifierLanguageCode>? = null, val mode: Output<DocumentClassifierMode>? = null, val modelKmsKeyId: Output<String>? = null, val modelPolicy: Output<String>? = null, val outputDataConfig: Output<DocumentClassifierOutputDataConfigArgs>? = null, val tags: Output<List<TagArgs>>? = null, val versionName: Output<String>? = null, val volumeKmsKeyId: Output<String>? = null, val vpcConfig: Output<DocumentClassifierVpcConfigArgs>? = null) : ConvertibleToJava<DocumentClassifierArgs>

Document Classifier enables training document classifier models.

Constructors

Link copied to clipboard
constructor(dataAccessRoleArn: Output<String>? = null, documentClassifierName: Output<String>? = null, inputDataConfig: Output<DocumentClassifierInputDataConfigArgs>? = null, languageCode: Output<DocumentClassifierLanguageCode>? = null, mode: Output<DocumentClassifierMode>? = null, modelKmsKeyId: Output<String>? = null, modelPolicy: Output<String>? = null, outputDataConfig: Output<DocumentClassifierOutputDataConfigArgs>? = null, tags: Output<List<TagArgs>>? = null, versionName: Output<String>? = null, volumeKmsKeyId: Output<String>? = null, vpcConfig: Output<DocumentClassifierVpcConfigArgs>? = null)

Properties

Link copied to clipboard
val dataAccessRoleArn: Output<String>? = null

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

Link copied to clipboard
val documentClassifierName: Output<String>? = null

The name of the document classifier.

Link copied to clipboard

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

Link copied to clipboard

The language of the input documents. You can specify any of the languages supported by Amazon Comprehend. All documents must be in the same language.

Link copied to clipboard
val mode: Output<DocumentClassifierMode>? = null

Indicates the mode in which the classifier will be trained. The classifier can be trained in multi-class (single-label) mode or multi-label mode. Multi-class mode identifies a single class label for each document and multi-label mode identifies one or more class labels for each document. Multiple labels for an individual document are separated by a delimiter. The default delimiter between labels is a pipe (|).

Link copied to clipboard
val modelKmsKeyId: Output<String>? = null

ID for the AWS KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:

Link copied to clipboard
val modelPolicy: Output<String>? = null

The resource-based policy to attach to your custom document classifier model. You can use this policy to allow another AWS account to import your custom model. Provide your policy as a JSON body that you enter as a UTF-8 encoded string without line breaks. To provide valid JSON, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy: "{\"attribute\": \"value\", \"attribute\": [\"value\"]}" To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values: '{"attribute": "value", "attribute": ["value"]}'

Link copied to clipboard

Provides output results configuration parameters for custom classifier jobs.

Link copied to clipboard
val tags: Output<List<TagArgs>>? = null

Tags to associate with the document classifier. A tag is a key-value pair that adds as a 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.

Link copied to clipboard
val versionName: Output<String>? = null

The version name given to the newly created classifier. Version names can have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same classifier name in the AWS account / AWS Region .

Link copied to clipboard
val volumeKmsKeyId: Output<String>? = null

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:

Link copied to clipboard

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. For more information, see Amazon VPC .

Functions

Link copied to clipboard
open override fun toJava(): DocumentClassifierArgs