Skip to content
v2.274.0

AWS::Comprehend Construct Library ​

This module is part of the AWS Cloud Development Kit project.

ts
import * as comprehend from 'aws-cdk-lib/aws-comprehend';
python
import aws_cdk.aws_comprehend as comprehend
java
import software.amazon.awscdk.services.comprehend.*;
csharp
using Amazon.CDK.AWS.Comprehend;
go
import comprehend "github.com/aws/aws-cdk-go/awscdk"

There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:

There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 constructs, and use this service exactly as you would using CloudFormation directly.

For more information on the resources and properties available for this service, see the CloudFormation documentation for AWS::Comprehend.

(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)

Types ​

NameKindSummary
CfnDocumentClassifierConstruct (L1)This resource creates and trains a document classifier to categorize documents.
CfnDocumentClassifierEndpointConstruct (L1)An Amazon Comprehend endpoint that hosts a custom document classification model for real-time inference.
CfnEntityRecognizerConstruct (L1)An Amazon Comprehend custom entity recognizer: a trained model that identifies custom entity types in text, created via an asynchronous training job.
CfnEntityRecognizerEndpointConstruct (L1)An Amazon Comprehend endpoint that hosts a custom entity recognizer model for real-time inference.
CfnFlywheelConstruct (L1)A flywheel is an AWS resource that orchestrates the ongoing training of a model for custom classification or custom entity recognition.
CfnDocumentClassifier.AugmentedManifestsListItemPropertyStructAn augmented manifest file that provides training data for your custom model.
CfnDocumentClassifier.DocumentClassifierDocumentsPropertyStructThe location of the training documents.
CfnDocumentClassifier.DocumentClassifierInputDataConfigPropertyStructThe input properties for training a document classifier.
CfnDocumentClassifier.DocumentClassifierOutputDataConfigPropertyStructProvide the location for output data from a custom classifier job.
CfnDocumentClassifier.DocumentReaderConfigPropertyStructProvides configuration parameters to override the default actions for extracting text from PDF documents and image files.
CfnDocumentClassifier.VpcConfigPropertyStructConfiguration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job.
CfnDocumentClassifierEndpointPropsStructProperties for defining a CfnDocumentClassifierEndpoint.
CfnDocumentClassifierPropsStructProperties for defining a CfnDocumentClassifier.
CfnEntityRecognizer.AugmentedManifestsListItemPropertyStructAn augmented manifest file that provides training data for your custom model.
CfnEntityRecognizer.EntityRecognizerAnnotationsPropertyStructDescribes the annotations associated with an entity recognizer.
CfnEntityRecognizer.EntityRecognizerDocumentsPropertyStructDescribes the training documents submitted with an entity recognizer.
CfnEntityRecognizer.EntityRecognizerEntityListPropertyStructDescribes the entity list submitted with an entity recognizer.
CfnEntityRecognizer.EntityRecognizerInputDataConfigPropertyStructSpecifies the format and location of the input data for an entity recognizer.
CfnEntityRecognizer.EntityTypesListItemPropertyStructAn entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer.
CfnEntityRecognizer.VpcConfigPropertyStructConfiguration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job.
CfnEntityRecognizerEndpointPropsStructProperties for defining a CfnEntityRecognizerEndpoint.
CfnEntityRecognizerPropsStructProperties for defining a CfnEntityRecognizer.
CfnFlywheel.DataSecurityConfigPropertyStructData security configuration.
CfnFlywheel.DocumentClassificationConfigPropertyStructConfiguration required for a document classification model.
CfnFlywheel.EntityRecognitionConfigPropertyStructConfiguration required for an entity recognition model.
CfnFlywheel.EntityTypesListItemPropertyStructAn entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer.
CfnFlywheel.TaskConfigPropertyStructConfiguration about the model associated with a flywheel.
CfnFlywheel.VpcConfigPropertyStructConfiguration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job.
CfnFlywheelPropsStructProperties for defining a CfnFlywheel.