Aws/rekognition
@swamp/aws/rekognitionv2026.10.25.1
01README
AWS REKOGNITION infrastructure models
02Release Notes
- Updated: stream_processor
03Behaviors
@swamp/aws/rekognition/collectionv2026.10.23.1collection.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| 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. |
| CollectionId | string | The name of the collection |
| Tags? | array | An array of key-value pairs to apply to this resource. |
fn create()
Create a Rekognition Collection
fn get(identifier: string)
Get a Rekognition Collection
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Rekognition Collection |
fn update()
Update a Rekognition Collection
fn delete(identifier: string)
Delete a Rekognition Collection
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Rekognition Collection |
fn sync()
Sync Rekognition Collection state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Rekognition Collection 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)— Rekognition Collection resource state
@swamp/aws/rekognition/datasetv2026.10.23.1dataset.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. |
| ProjectArn? | string | The ARN of the project to which the dataset belongs. |
| DatasetType | enum | The type of the dataset. Specify TRAIN to create a training dataset. Specify TEST to create a test dataset. |
| Tags? | array | An array of key-value pairs to apply to this resource. |
fn create()
Create a Rekognition Dataset
fn get(identifier: string)
Get a Rekognition Dataset
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Rekognition Dataset |
fn update()
Update a Rekognition Dataset
fn delete(identifier: string)
Delete a Rekognition Dataset
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Rekognition Dataset |
fn sync()
Sync Rekognition Dataset state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Rekognition Dataset 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)— Rekognition Dataset resource state
@swamp/aws/rekognition/projectv2026.10.23.1project.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| 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. |
| ProjectName | string | The name of the project |
| Tags? | array | An array of key-value pairs to apply to this resource. |
fn create()
Create a Rekognition Project
fn get(identifier: string)
Get a Rekognition Project
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Rekognition Project |
fn update()
Update a Rekognition Project
fn delete(identifier: string)
Delete a Rekognition Project
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Rekognition Project |
fn sync()
Sync Rekognition Project state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Rekognition Project 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)— Rekognition Project resource state
@swamp/aws/rekognition/stream-processorv2026.10.25.1stream_processor.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| 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. |
| Name? | string | Name of the stream processor. It's an identifier you assign to the stream processor. You can use it to manage the stream processor. |
| KmsKeyId? | string | The KMS key that is used by Rekognition to encrypt any intermediate customer metadata and store in the customer's S3 bucket. |
| RoleArn | string | ARN of the IAM role that allows access to the stream processor, and provides Rekognition read permissions for KVS stream and write permissions to S3 bucket and SNS topic. |
| KinesisVideoStream | object | The Kinesis Video Stream that streams the source video. |
| FaceSearchSettings? | object | Face search settings to use on a streaming video. Note that either FaceSearchSettings or ConnectedHomeSettings should be set. Not both |
| ConnectedHomeSettings? | object | Connected home settings to use on a streaming video. Note that either ConnectedHomeSettings or FaceSearchSettings should be set. Not both |
| KinesisDataStream? | object | The Amazon Kinesis Data Stream stream to which the Amazon Rekognition stream processor streams the analysis results, as part of face search feature. |
| S3Destination? | object | The S3 location in customer's account where inference output & artifacts are stored, as part of connected home feature. |
| NotificationChannel? | object | The ARN of the SNS notification channel where events of interests are published, as part of connected home feature. |
| DataSharingPreference? | object | Indicates whether Rekognition is allowed to store the video stream data for model-training. |
| PolygonRegionsOfInterest? | array | The PolygonRegionsOfInterest specifies a set of polygon areas of interest in the video frames to analyze, as part of connected home feature. Each polygon is in turn, an ordered list of Point |
| BoundingBoxRegionsOfInterest? | array | The BoundingBoxRegionsOfInterest specifies an array of bounding boxes of interest in the video frames to analyze, as part of connected home feature. If an object is partially in a region of interest, Rekognition will tag it as detected if the overlap of the object with the region-of-interest is greater than 20%. |
| Tags? | array | An array of key-value pairs to apply to this resource. |
fn create()
Create a Rekognition StreamProcessor
fn get(identifier: string)
Get a Rekognition StreamProcessor
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Rekognition StreamProcessor |
fn update()
Update a Rekognition StreamProcessor
fn delete(identifier: string)
Delete a Rekognition StreamProcessor
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Rekognition StreamProcessor |
fn sync()
Sync Rekognition StreamProcessor state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Rekognition StreamProcessor 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)— Rekognition StreamProcessor resource state
04Previous Versions
2026.10.24.1AGPL-3.0-or-later
2026.10.23.1AGPL-3.0-or-later(was none)
- Updated: collection, dataset, project, stream_processor
2026.10.13.1
- Updated: collection, dataset, project, stream_processor
2026.10.08.1
2026.10.06.1
2026.10.04.1
2026.10.03.1
2026.10.02.1
2026.10.01.1
2026.09.30.1
2026.09.29.1
2026.09.28.1
2026.09.27.1
2026.09.26.1
2026.09.25.1
2026.09.24.1
2026.09.23.1
2026.09.22.1
2026.09.21.1
05Stats
A
100 / 100
Downloads
191
Archive size
827.1 KB
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
06Platforms
07Labels