Requirements
Connecting AWS Comprehend takes an active account plus an API access token from your account settings — no other setup is required.[3]
Get your AWS Comprehend credentials
- Access Key IDtextRequired
The access key ID of an IAM user or role allowed to call Amazon Comprehend, for example AKIAIOSFODNN7EXAMPLE.
[1] - Secret Access KeypasswordRequired
The secret access key paired with the access key ID. It is stored encrypted and used to sign each request.
[1] - RegionselectRequired
The AWS Region that holds your Comprehend models, endpoints, and jobs. Requests go to comprehend.{region}.amazonaws.com.
[1] - ServiceselectRequired
The SigV4 signing name for Amazon Comprehend. Leave it as comprehend.
[1] - Session Tokenpassword
Only for temporary credentials from AWS STS. Leave blank when you use a long-term IAM access key.
[1]
Connect AWS Comprehend in WEXTL
- Log in to your WEXTL account, add the AWS Comprehend node module to your workflow, and click Create new credential.
- Optional: In the Credential name field, enter a name for the credential.
- Enter the authentication credentials you copied from your AWS Comprehend account, or follow the on-screen instructions to create the credential.
- If prompted, authenticate your account and confirm access.
- If you want to make changes to your credential in the future, follow the steps in Manage credentials →
Notes
Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →
AWS Comprehend node modules
The list below is a reference of every AWS Comprehend node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Expand any AWS Comprehend node module below to see exactly what it takes in, what it returns, and what connection it needs.
| Field | Type |
|---|---|
EndpointRequired | choice |
Text | text |
Document Bytes | text |
Document Reader Settings | object |
Read ActionRequired | choice |
Read Mode | choice |
Feature Types | text |
| Field | Type |
|---|---|
Classes | array |
Labels | array |
Document Metadata | object |
Pages | number |
Extracted Characters | array |
Document Type | array |
Errors | array |
Warnings | array |
| Field | Type |
|---|---|
Document ClassifierRequired | choice |
| Field | Type |
|---|---|
Classifier Properties | object |
Document Classifier ARN | text |
Version Name | text |
Language Code | text |
Status | text |
Message | text |
Mode | text |
Submit Time (Unix Seconds) | number |
End Time (Unix Seconds) | number |
Training Start Time (Unix Seconds) | number |
Training End Time (Unix Seconds) | number |
| Field | Type |
|---|---|
EndpointRequired | choice |
| Field | Type |
|---|---|
Endpoint Properties | object |
Endpoint ARN | text |
Status | text |
Message | text |
Model ARN | text |
Desired Model ARN | text |
Desired Inference Units | number |
Current Inference Units | number |
Creation Time (Unix Seconds) | number |
Last Modified Time (Unix Seconds) | number |
Data Access Role ARN | text |
| Field | Type |
|---|---|
Entity RecognizerRequired | choice |
| Field | Type |
|---|---|
Recognizer Properties | object |
Entity Recognizer ARN | text |
Version Name | text |
Language Code | text |
Status | text |
Message | text |
Submit Time (Unix Seconds) | number |
End Time (Unix Seconds) | number |
Training Start Time (Unix Seconds) | number |
Training End Time (Unix Seconds) | number |
Input Data | object |
| Field | Type |
|---|---|
FlywheelRequired | choice |
| Field | Type |
|---|---|
Iteration Properties | object |
Flywheel ARN | text |
Flywheel Iteration ID | text |
Creation Time (Unix Seconds) | number |
End Time (Unix Seconds) | number |
Status | text |
Message | text |
Evaluated Model ARN | text |
Evaluated Model Metrics | object |
Trained Model ARN | text |
Trained Model Metrics | object |
| Field | Type |
|---|---|
Text | text |
Document Bytes | text |
Language | choice |
Custom Endpoint | choice |
Document Reader Settings | object |
Read ActionRequired | choice |
Read Mode | choice |
Feature Types | text |
| Field | Type |
|---|---|
Entities | array |
Document Metadata | object |
Pages | number |
Extracted Characters | array |
Document Type | array |
Errors | array |
Blocks | array |
| Field | Type |
|---|---|
Flywheel | choice |
Filter | object |
Status | choice |
Dataset Type | choice |
Created After | date |
Created Before | date |
Limit | number |
| Field | Type |
|---|---|
Dataset ARN | text |
Dataset Name | text |
Dataset Type | text |
Dataset S3 URI | text |
Description | text |
Status | text |
Message | text |
Number of Documents | number |
Creation Time (Unix Seconds) | number |
End Time (Unix Seconds) | number |
| Field | Type |
|---|---|
Filter | object |
Job Name | text |
Job Status | choice |
Submitted Before | date |
Submitted After | date |
Limit | number |
| Field | Type |
|---|---|
Job ID | text |
Job ARN | text |
Job Name | text |
Job Status | text |
Message | text |
Submit Time (Unix Seconds) | number |
End Time (Unix Seconds) | number |
Document Classifier ARN | text |
Input Data | object |
S3 URI | text |
Input Format | text |
Document Reader Settings | object |
Output Data | object |
S3 URI | text |
KMS Key | text |
Data Access Role ARN | text |
Volume KMS Key | text |
VPC Settings | object |
Security Group IDs | array |
Subnet IDs | array |
Flywheel ARN | text |
| Field | Type |
|---|---|
Filter | object |
Classifier Name | text |
Status | choice |
Submitted Before | date |
Submitted After | date |
Limit | number |
| Field | Type |
|---|---|
Document Classifier ARN | text |
Version Name | text |
Language Code | text |
Status | text |
Message | text |
Mode | text |
Submit Time (Unix Seconds) | number |
End Time (Unix Seconds) | number |
Training Start Time (Unix Seconds) | number |
Training End Time (Unix Seconds) | number |
Input Data | object |
Data Format | text |
S3 URI | text |
Test S3 URI | text |
Label Delimiter | text |
Augmented Manifests | array |
Document Type | text |
Documents | object |
Document Reader Settings | object |
Output Data | object |
S3 URI | text |
KMS Key | text |
Flywheel Stats S3 Prefix | text |
Classifier Metadata | object |
Number of Labels | number |
Number of Trained Documents | number |
Number of Test Documents | number |
Evaluation Metrics | object |
Data Access Role ARN | text |
| Field | Type |
|---|---|
Filter | object |
Job Name | text |
Job Status | choice |
Submitted Before | date |
Submitted After | date |
Limit | number |
| Field | Type |
|---|---|
Job ID | text |
Job ARN | text |
Job Name | text |
Job Status | text |
Message | text |
Submit Time (Unix Seconds) | number |
End Time (Unix Seconds) | number |
Input Data | object |
S3 URI | text |
Input Format | text |
Document Reader Settings | object |
Output Data | object |
S3 URI | text |
KMS Key | text |
Data Access Role ARN | text |
Volume KMS Key | text |
VPC Settings | object |
Security Group IDs | array |
Subnet IDs | array |
| Field | Type |
|---|---|
Filter | object |
Model ARN | text |
Status | choice |
Created Before | date |
Created After | date |
Limit | number |
| Field | Type |
|---|---|
Endpoint ARN | text |
Status | text |
Message | text |
Model ARN | text |
Desired Model ARN | text |
Desired Inference Units | number |
Current Inference Units | number |
Creation Time (Unix Seconds) | number |
Last Modified Time (Unix Seconds) | number |
Data Access Role ARN | text |
Desired Data Access Role ARN | text |
Flywheel ARN | text |
| Field | Type |
|---|---|
Filter | object |
Job Name | text |
Job Status | choice |
Submitted Before | date |
Submitted After | date |
Limit | number |
| Field | Type |
|---|---|
Job ID | text |
Job ARN | text |
Job Name | text |
Job Status | text |
Message | text |
Submit Time (Unix Seconds) | number |
End Time (Unix Seconds) | number |
Entity Recognizer ARN | text |
Input Data | object |
S3 URI | text |
Input Format | text |
Document Reader Settings | object |
Output Data | object |
S3 URI | text |
KMS Key | text |
Language Code | text |
Data Access Role ARN | text |
Volume KMS Key | text |
VPC Settings | object |
Security Group IDs | array |
Subnet IDs | array |
| Field | Type |
|---|---|
Filter | object |
Recognizer Name | text |
Status | choice |
Submitted Before | date |
Submitted After | date |
Limit | number |
| Field | Type |
|---|---|
Entity Recognizer ARN | text |
Version Name | text |
Language Code | text |
Status | text |
Message | text |
Submit Time (Unix Seconds) | number |
End Time (Unix Seconds) | number |
Training Start Time (Unix Seconds) | number |
Training End Time (Unix Seconds) | number |
Input Data | object |
Data Format | text |
Entity Types | array |
Documents | object |
Annotations | object |
Entity List | object |
Augmented Manifests | array |
Recognizer Metadata | object |
Number of Trained Documents | number |
Number of Test Documents | number |
Evaluation Metrics | object |
Entity Types | array |
Data Access Role ARN | text |
Volume KMS Key | text |
VPC Settings | object |
Security Group IDs | array |
Subnet IDs | array |
| Field | Type |
|---|---|
Filter | object |
Job Name | text |
Job Status | choice |
Submitted Before | date |
Submitted After | date |
Limit | number |
| Field | Type |
|---|---|
Job ID | text |
Job ARN | text |
Job Name | text |
Job Status | text |
Message | text |
Submit Time (Unix Seconds) | number |
End Time (Unix Seconds) | number |
Input Data | object |
S3 URI | text |
Input Format | text |
Document Reader Settings | object |
Output Data | object |
S3 URI | text |
KMS Key | text |
Language Code | text |
Data Access Role ARN | text |
Event Types | array |
| Field | Type |
|---|---|
FlywheelRequired | choice |
Filter | object |
Created After | date |
Created Before | date |
Limit | number |
| Field | Type |
|---|---|
Flywheel ARN | text |
Flywheel Iteration ID | text |
Creation Time (Unix Seconds) | number |
End Time (Unix Seconds) | number |
Status | text |
Message | text |
Evaluated Model ARN | text |
Evaluated Model Metrics | object |
Average F1 Score | number |
Average Precision | number |
Average Recall | number |
Average Accuracy | number |
Trained Model ARN | text |
Trained Model Metrics | object |
Average F1 Score | number |
Average Precision | number |
Average Recall | number |
Average Accuracy | number |
Evaluation Manifest S3 Prefix | text |
| Field | Type |
|---|---|
Filter | object |
Status | choice |
Created After | date |
Created Before | date |
Limit | number |
| Field | Type |
|---|---|
Flywheel ARN | text |
Active Model ARN | text |
Data Lake S3 URI | text |
Status | text |
Model Type | text |
Message | text |
Creation Time (Unix Seconds) | number |
Last Modified Time (Unix Seconds) | number |
Latest Flywheel Iteration | text |
| Field | Type |
|---|---|
Filter | object |
Job Name | text |
Job Status | choice |
Submitted Before | date |
Submitted After | date |
Limit | number |
| Field | Type |
|---|---|
Job ID | text |
Job ARN | text |
Job Name | text |
Job Status | text |
Message | text |
Submit Time (Unix Seconds) | number |
End Time (Unix Seconds) | number |
Input Data | object |
S3 URI | text |
Input Format | text |
Document Reader Settings | object |
Output Data | object |
S3 URI | text |
KMS Key | text |
Language Code | text |
Data Access Role ARN | text |
Volume KMS Key | text |
VPC Settings | object |
Security Group IDs | array |
Subnet IDs | array |
| Field | Type |
|---|---|
Filter | object |
Job Name | text |
Job Status | choice |
Submitted Before | date |
Submitted After | date |
Limit | number |
| Field | Type |
|---|---|
Job ID | text |
Job ARN | text |
Job Name | text |
Job Status | text |
Message | text |
Submit Time (Unix Seconds) | number |
End Time (Unix Seconds) | number |
Input Data | object |
S3 URI | text |
Input Format | text |
Document Reader Settings | object |
Output Data | object |
S3 URI | text |
KMS Key | text |
Redaction | object |
PII Types to Redact | array |
Mask Mode | text |
Mask Character | text |
Language Code | text |
Data Access Role ARN | text |
Output Mode | text |
| Field | Type |
|---|---|
Filter | object |
Job Name | text |
Job Status | choice |
Submitted Before | date |
Submitted After | date |
Limit | number |
| Field | Type |
|---|---|
Job ID | text |
Job ARN | text |
Job Name | text |
Job Status | text |
Message | text |
Submit Time (Unix Seconds) | number |
End Time (Unix Seconds) | number |
Input Data | object |
S3 URI | text |
Input Format | text |
Document Reader Settings | object |
Output Data | object |
S3 URI | text |
KMS Key | text |
Language Code | text |
Data Access Role ARN | text |
Volume KMS Key | text |
VPC Settings | object |
Security Group IDs | array |
Subnet IDs | array |
| Field | Type |
|---|---|
Filter | object |
Job Name | text |
Job Status | choice |
Submitted Before | date |
Submitted After | date |
Limit | number |
| Field | Type |
|---|---|
Job ID | text |
Job ARN | text |
Job Name | text |
Job Status | text |
Message | text |
Submit Time (Unix Seconds) | number |
End Time (Unix Seconds) | number |
Input Data | object |
S3 URI | text |
Input Format | text |
Document Reader Settings | object |
Output Data | object |
S3 URI | text |
KMS Key | text |
Language Code | text |
Data Access Role ARN | text |
Volume KMS Key | text |
VPC Settings | object |
Security Group IDs | array |
Subnet IDs | array |
| Field | Type |
|---|---|
Filter | object |
Job Name | text |
Job Status | choice |
Submitted Before | date |
Submitted After | date |
Limit | number |
| Field | Type |
|---|---|
Job ID | text |
Job ARN | text |
Job Name | text |
Job Status | text |
Message | text |
Submit Time (Unix Seconds) | number |
End Time (Unix Seconds) | number |
Input Data | object |
S3 URI | text |
Input Format | text |
Document Reader Settings | object |
Output Data | object |
S3 URI | text |
KMS Key | text |
Number of Topics | number |
Data Access Role ARN | text |
Volume KMS Key | text |
VPC Settings | object |
Security Group IDs | array |
Subnet IDs | array |
| Field | Type |
|---|---|
Classifier NameRequired | text |
Data Access Role ARNRequired | text |
Training DataRequired | object |
Data Format | choice |
S3 URI | text |
Test S3 URI | text |
Label Delimiter | text |
Augmented Manifests | array |
Document Type | choice |
Training Documents | object |
Document Reader Settings | object |
LanguageRequired | choice |
Version Name | text |
Mode | choice |
Training Output | object |
S3 URI | text |
KMS Key | text |
Tags | array |
Client Request Token | text |
Volume KMS Key | text |
VPC Settings | object |
Security Group IDsRequired | array |
Subnet IDsRequired | array |
Model KMS Key | text |
Model Policy | text |
| Field | Type |
|---|---|
Document Classifier ARN | text |
| Field | Type |
|---|---|
Recognizer NameRequired | text |
Data Access Role ARNRequired | text |
Training DataRequired | object |
Entity TypesRequired | array |
Data Format | choice |
Training Documents | object |
Annotations | object |
Entity List | object |
Augmented Manifests | array |
LanguageRequired | choice |
Version Name | text |
Tags | array |
Client Request Token | text |
Volume KMS Key | text |
VPC Settings | object |
Security Group IDsRequired | array |
Subnet IDsRequired | array |
Model KMS Key | text |
Model Policy | text |
| Field | Type |
|---|---|
Entity Recognizer ARN | text |
| Field | Type |
|---|---|
Flywheel NameRequired | text |
Data Access Role ARNRequired | text |
Data Lake S3 URIRequired | text |
Active Model ARN | text |
Model Type | choice |
Task Settings | object |
LanguageRequired | choice |
Document Classification Settings | object |
Entity Recognition Settings | object |
Data Security Settings | object |
Model KMS Key | text |
Volume KMS Key | text |
Data Lake KMS Key | text |
VPC Settings | object |
Client Request Token | text |
Tags | array |
| Field | Type |
|---|---|
Flywheel ARN | text |
Active Model ARN | text |
| Field | Type |
|---|---|
Input DataRequired | object |
S3 URIRequired | text |
Input Format | choice |
Document Reader Settings | object |
Output DataRequired | object |
S3 URIRequired | text |
KMS Key | text |
Data Access Role ARNRequired | text |
Job Name | text |
Document Classifier | choice |
Flywheel | choice |
Client Request Token | text |
Volume KMS Key | text |
VPC Settings | object |
Security Group IDsRequired | array |
Subnet IDsRequired | array |
Tags | array |
| Field | Type |
|---|---|
Job ID | text |
Job ARN | text |
Job Status | text |
Document Classifier ARN | text |
| Field | Type |
|---|---|
Input DataRequired | object |
S3 URIRequired | text |
Input Format | choice |
Document Reader Settings | object |
Output DataRequired | object |
S3 URIRequired | text |
KMS Key | text |
Data Access Role ARNRequired | text |
Job Name | text |
Client Request Token | text |
Volume KMS Key | text |
VPC Settings | object |
Security Group IDsRequired | array |
Subnet IDsRequired | array |
Tags | array |
| Field | Type |
|---|---|
Job ID | text |
Job ARN | text |
Job Status | text |
| Field | Type |
|---|---|
Input DataRequired | object |
S3 URIRequired | text |
Input Format | choice |
Document Reader Settings | object |
Output DataRequired | object |
S3 URIRequired | text |
KMS Key | text |
Data Access Role ARNRequired | text |
LanguageRequired | choice |
Job Name | text |
Custom Entity Recognizer | choice |
Flywheel | choice |
Client Request Token | text |
Volume KMS Key | text |
VPC Settings | object |
Security Group IDsRequired | array |
Subnet IDsRequired | array |
Tags | array |
| Field | Type |
|---|---|
Job ID | text |
Job ARN | text |
Job Status | text |
Entity Recognizer ARN | text |
| Field | Type |
|---|---|
Input DataRequired | object |
S3 URIRequired | text |
Input Format | choice |
Document Reader Settings | object |
Output DataRequired | object |
S3 URIRequired | text |
KMS Key | text |
Data Access Role ARNRequired | text |
LanguageRequired | choice |
Event TypesRequired | array |
Job Name | text |
Client Request Token | text |
Tags | array |
| Field | Type |
|---|---|
Job ID | text |
Job ARN | text |
Job Status | text |
| Field | Type |
|---|---|
Input DataRequired | object |
S3 URIRequired | text |
Input Format | choice |
Document Reader Settings | object |
Output DataRequired | object |
S3 URIRequired | text |
KMS Key | text |
Data Access Role ARNRequired | text |
LanguageRequired | choice |
Job Name | text |
Client Request Token | text |
Volume KMS Key | text |
VPC Settings | object |
Security Group IDsRequired | array |
Subnet IDsRequired | array |
Tags | array |
| Field | Type |
|---|---|
Job ID | text |
Job ARN | text |
Job Status | text |
| Field | Type |
|---|---|
Input DataRequired | object |
S3 URIRequired | text |
Input Format | choice |
Document Reader Settings | object |
Output DataRequired | object |
S3 URIRequired | text |
KMS Key | text |
Output ModeRequired | choice |
Data Access Role ARNRequired | text |
LanguageRequired | choice |
Redaction | object |
PII Types to Redact | text |
Mask Mode | choice |
Mask Character | text |
Job Name | text |
Client Request Token | text |
Tags | array |
| Field | Type |
|---|---|
Job ID | text |
Job ARN | text |
Job Status | text |
| Field | Type |
|---|---|
Input DataRequired | object |
S3 URIRequired | text |
Input Format | choice |
Document Reader Settings | object |
Output DataRequired | object |
S3 URIRequired | text |
KMS Key | text |
Data Access Role ARNRequired | text |
LanguageRequired | choice |
Job Name | text |
Client Request Token | text |
Volume KMS Key | text |
VPC Settings | object |
Security Group IDsRequired | array |
Subnet IDsRequired | array |
Tags | array |
| Field | Type |
|---|---|
Job ID | text |
Job ARN | text |
Job Status | text |
| Field | Type |
|---|---|
Input DataRequired | object |
S3 URIRequired | text |
Input Format | choice |
Document Reader Settings | object |
Output DataRequired | object |
S3 URIRequired | text |
KMS Key | text |
Data Access Role ARNRequired | text |
LanguageRequired | choice |
Job Name | text |
Client Request Token | text |
Volume KMS Key | text |
VPC Settings | object |
Security Group IDsRequired | array |
Subnet IDsRequired | array |
Tags | array |
| Field | Type |
|---|---|
Job ID | text |
Job ARN | text |
Job Status | text |
| Field | Type |
|---|---|
Input DataRequired | object |
S3 URIRequired | text |
Input Format | choice |
Document Reader Settings | object |
Output DataRequired | object |
S3 URIRequired | text |
KMS Key | text |
Data Access Role ARNRequired | text |
Job Name | text |
Number of Topics | number |
Client Request Token | text |
Volume KMS Key | text |
VPC Settings | object |
Security Group IDsRequired | array |
Subnet IDsRequired | array |
Tags | array |
| Field | Type |
|---|---|
Job ID | text |
Job ARN | text |
Job Status | text |
| Field | Type |
|---|---|
FlywheelRequired | choice |
Active Model ARN | text |
Data Access Role ARN | text |
Data Security Settings | object |
Model KMS Key | text |
Volume KMS Key | text |
VPC Settings | object |
| Field | Type |
|---|---|
Flywheel Properties | object |
Flywheel ARN | text |
Active Model ARN | text |
Data Access Role ARN | text |
Task Settings | object |
Data Lake S3 URI | text |
Data Security Settings | object |
Status | text |
Model Type | text |
Message | text |
Creation Time (Unix Seconds) | number |
Templates
Look for AWS Comprehend templates in the WEXTL template library.
Browse templates →Explore alternative apps
- AWS Rekognition[2]Detect faces, labels, text, and moderation content in images with Amazon Rekognition.
- AWS TextractExtract text, forms, tables, and expense data from documents with Amazon Textract.
- AWS TranscribeTranscribe audio and video files and manage custom vocabularies with Amazon Transcribe.
- Camb AIAI localization for text-to-speech, transcription, and voice dubbing.
- AltText AIAI-generated image alt text for accessibility and SEO.
References
- WEXTL® AWS Comprehend Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for AWS Comprehend.
- WEXTL® visual workflow builder data.
Last updated: Sep 27, 2026 13:38