AWS Fundamentals Logo
AWS Fundamentals
AWS::Comprehend::DocumentClassifier

Comprehend DocumentClassifier

Document Classifier enables training document classifier models.

Properties

12 configurable properties. 4 required. Click a row to see details.

Filter:
PropertyTypeFlags
DataAccessRoleArn
string
RequiredCreate-only
DocumentClassifierName
string
RequiredCreate-only
InputDataConfig
DocumentClassifierInputDataConfig
RequiredCreate-only
LanguageCode
string
RequiredCreate-only
Mode
string
Create-only
ModelKmsKeyId
string
Create-only
ModelPolicy
string
OutputDataConfig
DocumentClassifierOutputDataConfig
Create-only
Tags
Array<Tag>
VersionName
string
Create-only
VolumeKmsKeyId
string
Create-only
VpcConfig
VpcConfig
Create-only

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
Arnstring-

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::Comprehend::DocumentClassifier

Resources:
  MyResource:
    Type: AWS::Comprehend::DocumentClassifier
    Properties:
      DocumentClassifierName: "my-documentclassifiername"
      DataAccessRoleArn: "arn:aws:service:region:account:resource"
      InputDataConfig: "value"
      LanguageCode: "en"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

iam:PassRolecomprehend:CreateDocumentClassifiercomprehend:DescribeDocumentClassifiercomprehend:DescribeResourcePolicycomprehend:ListTagsForResourcetextract:DetectDocumentText

read

comprehend:DescribeDocumentClassifiercomprehend:DescribeResourcePolicycomprehend:ListTagsForResource

update

iam:PassRolecomprehend:PutResourcePolicycomprehend:DeleteResourcePolicycomprehend:DescribeResourcePolicycomprehend:DescribeDocumentClassifiercomprehend:ListTagsForResourcecomprehend:TagResourcecomprehend:UntagResource

delete

comprehend:DescribeDocumentClassifiercomprehend:DeleteDocumentClassifier

list

comprehend:ListDocumentClassifiers

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceComprehend
Properties13
Required4
TaggingSupported
Primary IDArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

DataAccessRoleArnInputDataConfigOutputDataConfigLanguageCodeModelKmsKeyIdDocumentClassifierNameVersionNameModeVolumeKmsKeyIdVpcConfig

Related Resources

External Links