# AWS::Comprehend Construct Library

This module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.

```ts
import * as comprehend from 'aws-cdk-lib/aws-comprehend';
```

There are no official hand-written ([L2](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib)) constructs for this service yet. Here are some suggestions on how to proceed:

- Search [Construct Hub for Comprehend construct libraries](https://constructs.dev/search?q=comprehend)
- Use the automatically generated [L1](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_l1_using) constructs, in the same way you would use [the CloudFormation AWS::Comprehend resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_Comprehend.html) directly.

There are no hand-written ([L2](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib)) constructs for this service yet.
However, you can still use the automatically generated [L1](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_l1_using) 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_Comprehend.html).

(Read the [CDK Contributing Guide](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and submit an RFC if you are interested in contributing to this construct library.)

## Types

| Name | Kind | Summary |
| --- | --- | --- |
| [`CfnDocumentClassifier`](/v2/docs/aws-cdk-lib.aws_comprehend.CfnDocumentClassifier) | Construct (L1) | This resource creates and trains a document classifier to categorize documents. |
| [`CfnDocumentClassifierEndpoint`](/v2/docs/aws-cdk-lib.aws_comprehend.CfnDocumentClassifierEndpoint) | Construct (L1) | An Amazon Comprehend endpoint that hosts a custom document classification model for real-time inference. |
| [`CfnEntityRecognizer`](/v2/docs/aws-cdk-lib.aws_comprehend.CfnEntityRecognizer) | Construct (L1) | An Amazon Comprehend custom entity recognizer: a trained model that identifies custom entity types in text, created via an asynchronous training job. |
| [`CfnEntityRecognizerEndpoint`](/v2/docs/aws-cdk-lib.aws_comprehend.CfnEntityRecognizerEndpoint) | Construct (L1) | An Amazon Comprehend endpoint that hosts a custom entity recognizer model for real-time inference. |
| [`CfnFlywheel`](/v2/docs/aws-cdk-lib.aws_comprehend.CfnFlywheel) | Construct (L1) | A flywheel is an AWS resource that orchestrates the ongoing training of a model for custom classification or custom entity recognition. |
| [`CfnDocumentClassifier.AugmentedManifestsListItemProperty`](/v2/docs/aws-cdk-lib.aws_comprehend.CfnDocumentClassifier.AugmentedManifestsListItemProperty) | Struct | An augmented manifest file that provides training data for your custom model. |
| [`CfnDocumentClassifier.DocumentClassifierDocumentsProperty`](/v2/docs/aws-cdk-lib.aws_comprehend.CfnDocumentClassifier.DocumentClassifierDocumentsProperty) | Struct | The location of the training documents. |
| [`CfnDocumentClassifier.DocumentClassifierInputDataConfigProperty`](/v2/docs/aws-cdk-lib.aws_comprehend.CfnDocumentClassifier.DocumentClassifierInputDataConfigProperty) | Struct | The input properties for training a document classifier. |
| [`CfnDocumentClassifier.DocumentClassifierOutputDataConfigProperty`](/v2/docs/aws-cdk-lib.aws_comprehend.CfnDocumentClassifier.DocumentClassifierOutputDataConfigProperty) | Struct | Provide the location for output data from a custom classifier job. |
| [`CfnDocumentClassifier.DocumentReaderConfigProperty`](/v2/docs/aws-cdk-lib.aws_comprehend.CfnDocumentClassifier.DocumentReaderConfigProperty) | Struct | Provides configuration parameters to override the default actions for extracting text from PDF documents and image files. |
| [`CfnDocumentClassifier.VpcConfigProperty`](/v2/docs/aws-cdk-lib.aws_comprehend.CfnDocumentClassifier.VpcConfigProperty) | Struct | Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job. |
| [`CfnDocumentClassifierEndpointProps`](/v2/docs/aws-cdk-lib.aws_comprehend.CfnDocumentClassifierEndpointProps) | Struct | Properties for defining a `CfnDocumentClassifierEndpoint`. |
| [`CfnDocumentClassifierProps`](/v2/docs/aws-cdk-lib.aws_comprehend.CfnDocumentClassifierProps) | Struct | Properties for defining a `CfnDocumentClassifier`. |
| [`CfnEntityRecognizer.AugmentedManifestsListItemProperty`](/v2/docs/aws-cdk-lib.aws_comprehend.CfnEntityRecognizer.AugmentedManifestsListItemProperty) | Struct | An augmented manifest file that provides training data for your custom model. |
| [`CfnEntityRecognizer.EntityRecognizerAnnotationsProperty`](/v2/docs/aws-cdk-lib.aws_comprehend.CfnEntityRecognizer.EntityRecognizerAnnotationsProperty) | Struct | Describes the annotations associated with an entity recognizer. |
| [`CfnEntityRecognizer.EntityRecognizerDocumentsProperty`](/v2/docs/aws-cdk-lib.aws_comprehend.CfnEntityRecognizer.EntityRecognizerDocumentsProperty) | Struct | Describes the training documents submitted with an entity recognizer. |
| [`CfnEntityRecognizer.EntityRecognizerEntityListProperty`](/v2/docs/aws-cdk-lib.aws_comprehend.CfnEntityRecognizer.EntityRecognizerEntityListProperty) | Struct | Describes the entity list submitted with an entity recognizer. |
| [`CfnEntityRecognizer.EntityRecognizerInputDataConfigProperty`](/v2/docs/aws-cdk-lib.aws_comprehend.CfnEntityRecognizer.EntityRecognizerInputDataConfigProperty) | Struct | Specifies the format and location of the input data for an entity recognizer. |
| [`CfnEntityRecognizer.EntityTypesListItemProperty`](/v2/docs/aws-cdk-lib.aws_comprehend.CfnEntityRecognizer.EntityTypesListItemProperty) | Struct | An entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer. |
| [`CfnEntityRecognizer.VpcConfigProperty`](/v2/docs/aws-cdk-lib.aws_comprehend.CfnEntityRecognizer.VpcConfigProperty) | Struct | Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job. |
| [`CfnEntityRecognizerEndpointProps`](/v2/docs/aws-cdk-lib.aws_comprehend.CfnEntityRecognizerEndpointProps) | Struct | Properties for defining a `CfnEntityRecognizerEndpoint`. |
| [`CfnEntityRecognizerProps`](/v2/docs/aws-cdk-lib.aws_comprehend.CfnEntityRecognizerProps) | Struct | Properties for defining a `CfnEntityRecognizer`. |
| [`CfnFlywheel.DataSecurityConfigProperty`](/v2/docs/aws-cdk-lib.aws_comprehend.CfnFlywheel.DataSecurityConfigProperty) | Struct | Data security configuration. |
| [`CfnFlywheel.DocumentClassificationConfigProperty`](/v2/docs/aws-cdk-lib.aws_comprehend.CfnFlywheel.DocumentClassificationConfigProperty) | Struct | Configuration required for a document classification model. |
| [`CfnFlywheel.EntityRecognitionConfigProperty`](/v2/docs/aws-cdk-lib.aws_comprehend.CfnFlywheel.EntityRecognitionConfigProperty) | Struct | Configuration required for an entity recognition model. |
| [`CfnFlywheel.EntityTypesListItemProperty`](/v2/docs/aws-cdk-lib.aws_comprehend.CfnFlywheel.EntityTypesListItemProperty) | Struct | An entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer. |
| [`CfnFlywheel.TaskConfigProperty`](/v2/docs/aws-cdk-lib.aws_comprehend.CfnFlywheel.TaskConfigProperty) | Struct | Configuration about the model associated with a flywheel. |
| [`CfnFlywheel.VpcConfigProperty`](/v2/docs/aws-cdk-lib.aws_comprehend.CfnFlywheel.VpcConfigProperty) | Struct | Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job. |
| [`CfnFlywheelProps`](/v2/docs/aws-cdk-lib.aws_comprehend.CfnFlywheelProps) | Struct | Properties for defining a `CfnFlywheel`. |