AWS::Comprehend::EntityRecognizerEndpoint

Comprehend EntityRecognizerEndpoint

An Amazon Comprehend endpoint that hosts a custom entity recognizer model for real-time inference.

Properties

6 configurable properties. 2 required. Click a row to see details.

Filter:

Property	Type	Flags
`DesiredInferenceUnits`	`integer`	Required
`EndpointName`	`string`	RequiredCreate-only
`DataAccessRoleArn`	`string`
`FlywheelArn`	`string`	Create-only
`ModelArn`	`string`
`Tags`	`Array<Tag>`

Return Values

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

Attribute	Type	Description
`Arn`	`string`	The Amazon Resource Name (ARN) of the entity recognizer endpoint.
`CreationTime`	`string`	The creation date and time of the endpoint.
`CurrentInferenceUnits`	`integer`	The number of inference units currently used by the model using this endpoint.
`EndpointStatus`	`string`	The current status of the endpoint. Because the endpoint updates and creation are asynchronous, wait for the endpoint to be IN_SERVICE before making inference requests.
`LastModifiedTime`	`string`	The date and time that the endpoint was last modified.

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

Resources:
  MyResource:
    Type: AWS::Comprehend::EntityRecognizerEndpoint
    Properties:
      EndpointName: "my-endpointname"
      DesiredInferenceUnits: 1
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

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

create

comprehend:CreateEndpointcomprehend:DescribeEndpointcomprehend:TagResourcecomprehend:ListTagsForResourceiam:PassRole

read

comprehend:DescribeEndpointcomprehend:ListTagsForResource

update

comprehend:UpdateEndpointcomprehend:DescribeEndpointcomprehend:TagResourcecomprehend:UntagResourcecomprehend:ListTagsForResourceiam:PassRole

delete

comprehend:DeleteEndpointcomprehend:DescribeEndpointcomprehend:ListTagsForResource

list

comprehend:ListEndpoints

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

Required2

TaggingSupported

Primary IDArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

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

EndpointNameFlywheelArn

Related Resources

External Links

AWS Documentation