AWS::Comprehend::EntityRecognizer

Comprehend EntityRecognizer

An Amazon Comprehend custom entity recognizer: a trained model that identifies custom entity types in text, created via an asynchronous training job.

Properties

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

Filter:
PropertyTypeFlags
DataAccessRoleArn
string
RequiredCreate-only
InputDataConfig
EntityRecognizerInputDataConfig
RequiredCreate-only
LanguageCode
string
RequiredCreate-only
RecognizerName
string
RequiredCreate-only
ModelKmsKeyId
string
Create-only
ModelPolicy
string
Create-onlyWrite-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
ArnstringThe Amazon Resource Name (ARN) that identifies the entity recognizer.

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::EntityRecognizer

Resources:
  MyResource:
    Type: AWS::Comprehend::EntityRecognizer
    Properties:
      RecognizerName: "my-recognizername"
      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

comprehend:CreateEntityRecognizercomprehend:DescribeEntityRecognizercomprehend:TagResourceiam:PassRole

read

comprehend:DescribeEntityRecognizercomprehend:ListTagsForResource

update

comprehend:DescribeEntityRecognizercomprehend:ListTagsForResourcecomprehend:TagResourcecomprehend:UntagResource

delete

comprehend:DeleteEntityRecognizercomprehend:DescribeEntityRecognizer

list

comprehend:ListEntityRecognizers

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
Properties11
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.

RecognizerNameVersionNameDataAccessRoleArnInputDataConfigLanguageCodeVolumeKmsKeyIdModelKmsKeyIdVpcConfigModelPolicy

Related Resources

External Links