AWS::Comprehend::DocumentClassifierEndpoint

Comprehend DocumentClassifierEndpoint

An Amazon Comprehend endpoint that hosts a custom document classification model for real-time inference.

Properties

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

Filter:
PropertyTypeFlags
DesiredInferenceUnits
integer
Required
EndpointName
string
RequiredCreate-only
ModelArn
string
Required
Tags
Array<Tag>

Return Values

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

AttributeTypeDescription
ArnstringThe Amazon Resource Name (ARN) of the document classifier endpoint.
CreationTimestringThe creation date and time of the endpoint.
CurrentInferenceUnitsintegerThe number of inference units currently used by the model using this endpoint.
LastModifiedTimestringThe 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::DocumentClassifierEndpoint

Resources:
  MyResource:
    Type: AWS::Comprehend::DocumentClassifierEndpoint
    Properties:
      EndpointName: "my-endpointname"
      ModelArn: "arn:aws:service:region:account:resource"
      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:ListTagsForResource

read

comprehend:DescribeEndpointcomprehend:ListTagsForResource

update

comprehend:UpdateEndpointcomprehend:DescribeEndpointcomprehend:TagResourcecomprehend:UntagResourcecomprehend:ListTagsForResource

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
Properties8
Required3
TaggingSupported
Primary IDArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

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

EndpointName

External Links