AWS::Comprehend::DocumentClassifier - AWS CloudFormation
SyntaxPropertiesReturn values

AWS::Comprehend::DocumentClassifier

This resource creates and trains a document classifier to categorize documents. You provide a set of training documents that are labeled with the categories that you want to identify. After the classifier is trained you can use it to categorize a set of labeled documents into the categories. For more information, see Document Classification in the Comprehend Developer Guide.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Comprehend::DocumentClassifier",
  "Properties" : {
      "DataAccessRoleArn" : String,
      "DocumentClassifierName" : String,
      "InputDataConfig" : DocumentClassifierInputDataConfig,
      "LanguageCode" : String,
      "Mode" : String,
      "ModelKmsKeyId" : String,
      "ModelPolicy" : String,
      "OutputDataConfig" : DocumentClassifierOutputDataConfig,
      "Tags" : [ Tag, ... ],
      "VersionName" : String,
      "VolumeKmsKeyId" : String,
      "VpcConfig" : VpcConfig
    }
}

Properties

DataAccessRoleArn

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

Required: Yes

Type: String

Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

Minimum: 20

Maximum: 2048

Update requires: Replacement

DocumentClassifierName

The name of the document classifier.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$

Minimum: 1

Maximum: 63

Update requires: Replacement

InputDataConfig

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

Required: Yes

Type: DocumentClassifierInputDataConfig

Update requires: Replacement

LanguageCode

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.

Required: Yes

Type: String

Allowed values: en | es | fr | it | de | pt

Update requires: Replacement

Mode

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 (|).

Required: No

Type: String

Allowed values: MULTI_CLASS | MULTI_LABEL

Update requires: Replacement

ModelKmsKeyId

ID for the AWS KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId 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"

Required: No

Type: String

Minimum: 1

Maximum: 2048

Update requires: Replacement

ModelPolicy

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"]}'

Required: No

Type: String

Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+

Minimum: 1

Maximum: 20000

Update requires: No interruption

OutputDataConfig

Provides output results configuration parameters for custom classifier jobs.

Required: No

Type: DocumentClassifierOutputDataConfig

Update requires: Replacement

Tags

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.

Required: No

Type: Array of Tag

Update requires: No interruption

VersionName

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.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$

Minimum: 1

Maximum: 63

Update requires: Replacement

VolumeKmsKeyId

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"

Required: No

Type: String

Minimum: 1

Maximum: 2048

Update requires: Replacement

VpcConfig

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.

Required: No

Type: VpcConfig

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the Amazon Resource Name (ARN) of the document classifier.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

The Amazon Resource Name (ARN) of the document classifier.