Aws/comprehend
@swamp/aws/comprehendv2026.10.25.1
01README
AWS COMPREHEND infrastructure models
02Behaviors
@swamp/aws/comprehend/document-classifierv2026.10.23.1document_classifier.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| DataAccessRoleArn | string | |
| InputDataConfig | object | |
| OutputDataConfig? | object | |
| LanguageCode | enum | |
| ModelKmsKeyId? | string | |
| ModelPolicy? | string | |
| DocumentClassifierName | string | |
| Mode? | enum | |
| Tags? | array | |
| VersionName? | string | |
| VolumeKmsKeyId? | string | |
| VpcConfig? | object |
fn create()
Create a Comprehend DocumentClassifier
fn get(identifier: string)
Get a Comprehend DocumentClassifier
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Comprehend DocumentClassifier |
fn update()
Update a Comprehend DocumentClassifier
fn delete(identifier: string)
Delete a Comprehend DocumentClassifier
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Comprehend DocumentClassifier |
fn sync()
Sync Comprehend DocumentClassifier state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Comprehend DocumentClassifier resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Comprehend DocumentClassifier resource state
@swamp/aws/comprehend/document-classifier-endpointv2026.10.23.1document_classifier_endpoint.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| EndpointName | string | The name of the endpoint. The name must be unique within the AWS Region and account. |
| ModelArn | string | The Amazon Resource Name (ARN) of the document classifier model to which the endpoint is attached. |
| DesiredInferenceUnits | number | The desired number of inference units to be used by the model. Each inference unit represents throughput of 100 characters per second. |
| Tags? | array | Tags associated with the endpoint being created. |
fn create()
Create a Comprehend DocumentClassifierEndpoint
fn get(identifier: string)
Get a Comprehend DocumentClassifierEndpoint
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Comprehend DocumentClassifierEndpoint |
fn update()
Update a Comprehend DocumentClassifierEndpoint
fn delete(identifier: string)
Delete a Comprehend DocumentClassifierEndpoint
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Comprehend DocumentClassifierEndpoint |
fn sync()
Sync Comprehend DocumentClassifierEndpoint state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Comprehend DocumentClassifierEndpoint resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Comprehend DocumentClassifierEndpoint resource state
@swamp/aws/comprehend/entity-recognizerv2026.10.23.1entity_recognizer.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| RecognizerName | string | The name given to the entity recognizer. |
| VersionName? | string | The version name given to the entity recognizer. |
| DataAccessRoleArn | string | The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. |
| LanguageCode | enum | The language of the input documents. All documents must be in the same language. |
| InputDataConfig | object | Specifies the format and location of the input data. The S3 bucket containing the input data must be located in the same Region as the entity recognizer being created. |
| VolumeKmsKeyId? | string | ID for the AWS KMS key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s). |
| ModelKmsKeyId? | string | ID for the AWS KMS key that Amazon Comprehend uses to encrypt trained custom models. |
| VpcConfig? | object | Configuration parameters for an optional private VPC containing the resources you are using for your custom entity recognizer. |
| ModelPolicy? | string | The JSON resource-based policy to attach to your custom entity recognizer model. |
| Tags? | array | Tags to associate with the entity recognizer. |
fn create()
Create a Comprehend EntityRecognizer
fn get(identifier: string)
Get a Comprehend EntityRecognizer
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Comprehend EntityRecognizer |
fn update()
Update a Comprehend EntityRecognizer
fn delete(identifier: string)
Delete a Comprehend EntityRecognizer
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Comprehend EntityRecognizer |
fn sync()
Sync Comprehend EntityRecognizer state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Comprehend EntityRecognizer resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Comprehend EntityRecognizer resource state
@swamp/aws/comprehend/entity-recognizer-endpointv2026.10.23.1entity_recognizer_endpoint.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| EndpointName | string | The name of the endpoint. The name must be unique within the AWS Region and account. |
| ModelArn? | string | The Amazon Resource Name (ARN) of the entity recognizer model to which the endpoint is attached. |
| DesiredInferenceUnits | number | The desired number of inference units to be used by the model. Each inference unit represents throughput of 100 characters per second. |
| DataAccessRoleArn? | string | The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId). |
| FlywheelArn? | string | The Amazon Resource Name (ARN) of the flywheel to which the endpoint is attached. |
| Tags? | array | Tags associated with the endpoint being created. |
fn create()
Create a Comprehend EntityRecognizerEndpoint
fn get(identifier: string)
Get a Comprehend EntityRecognizerEndpoint
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Comprehend EntityRecognizerEndpoint |
fn update()
Update a Comprehend EntityRecognizerEndpoint
fn delete(identifier: string)
Delete a Comprehend EntityRecognizerEndpoint
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Comprehend EntityRecognizerEndpoint |
fn sync()
Sync Comprehend EntityRecognizerEndpoint state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Comprehend EntityRecognizerEndpoint resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Comprehend EntityRecognizerEndpoint resource state
@swamp/aws/comprehend/flywheelv2026.10.23.1flywheel.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| ActiveModelArn? | string | |
| DataAccessRoleArn | string | |
| DataLakeS3Uri | string | |
| DataSecurityConfig? | object | |
| FlywheelName | string | |
| ModelType? | enum | |
| Tags? | array | |
| TaskConfig? | object |
fn create()
Create a Comprehend Flywheel
fn get(identifier: string)
Get a Comprehend Flywheel
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Comprehend Flywheel |
fn update()
Update a Comprehend Flywheel
fn delete(identifier: string)
Delete a Comprehend Flywheel
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Comprehend Flywheel |
fn sync()
Sync Comprehend Flywheel state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Comprehend Flywheel resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Comprehend Flywheel resource state
03Previous Versions
2026.10.24.1AGPL-3.0-or-later
2026.10.23.1AGPL-3.0-or-later(was none)
- Updated: document_classifier, document_classifier_endpoint, entity_recognizer, entity_recognizer_endpoint, flywheel
2026.10.13.1
- Updated: document_classifier, document_classifier_endpoint, entity_recognizer, entity_recognizer_endpoint, flywheel
2026.10.08.1
2026.10.06.1
2026.10.04.1
2026.10.03.1
2026.10.02.1
2026.10.01.1
- Added: entity_recognizer_endpoint
Added 1 behaviors
2026.09.30.1
2026.09.29.1
2026.09.28.1
2026.09.27.1
2026.09.26.1
2026.09.25.1
- Added: entity_recognizer
Added 1 behaviors
2026.09.24.1
2026.09.23.1
2026.09.21.1
2026.09.20.1
04Stats
A
100 / 100
Downloads
116
Archive size
1.0 MB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Docs keep secrets in a vault1/1earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License2/2earned
- Verified public repository2/2earned
05Platforms
06Labels