Aws/iottwinmaker

@swamp/aws/iottwinmakerv2026.10.25.1· AGPL-3.0-or-later· 1d agoBEHAVIORS

01README

AWS IOTTWINMAKER infrastructure models

02Release Notes

Updated: component_type, entity

03Behaviors5

@swamp/aws/iottwinmaker/component-typev2026.10.25.1component_type.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	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	no	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	no	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	no	AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
WorkspaceId	string	yes	The ID of the workspace that contains the component type.
ComponentTypeId	string	yes	The ID of the component type.
Description?	string	no	The description of the component type.
ExtendsFrom?	array	no	Specifies the parent component type to extend.
Functions?	record	no	a Map of functions in the component type. Each function's key must be unique to this map.
IsSingleton?	boolean	no	A Boolean value that specifies whether an entity can have more than one component of this type.
PropertyDefinitions?	record	no	An map of the property definitions in the component type. Each property definition's key must be unique to this map.
PropertyGroups?	record	no	An map of the property groups in the component type. Each property group's key must be unique to this map.
CompositeComponentTypes?	record	no	An map of the composite component types in the component type. Each composite component type's key must be unique to this map.
Status?	object	no	The current status of the component type.
Tags?	record	no	A map of key-value pairs to associate with a resource.

fn create()

Create a IoTTwinMaker ComponentType

fn get(identifier: string)

Get a IoTTwinMaker ComponentType

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IoTTwinMaker ComponentType

fn update()

Update a IoTTwinMaker ComponentType

fn delete(identifier: string)

Delete a IoTTwinMaker ComponentType

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IoTTwinMaker ComponentType

fn sync()

Sync IoTTwinMaker ComponentType state from AWS

fn list(maxPages?: number, resourceModel?: string)

List IoTTwinMaker ComponentType resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— IoTTwinMaker ComponentType resource state

@swamp/aws/iottwinmaker/entityv2026.10.25.1entity.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	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	no	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	no	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	no	AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
EntityId?	string	no	The ID of the entity.
EntityName	string	yes	The name of the entity.
Status?	object	no	The current status of the entity.
ParentEntityId?	string	no	The ID of the parent entity.
Description?	string	no	The description of the entity.
Tags?	record	no	A key-value pair to associate with a resource.
WorkspaceId	string	yes	The ID of the workspace.
Components?	record	no	A map that sets information about a component type.
CompositeComponents?	record	no	A map that sets information about a composite component.

fn create()

Create a IoTTwinMaker Entity

fn get(identifier: string)

Get a IoTTwinMaker Entity

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IoTTwinMaker Entity

fn update()

Update a IoTTwinMaker Entity

fn delete(identifier: string)

Delete a IoTTwinMaker Entity

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IoTTwinMaker Entity

fn sync()

Sync IoTTwinMaker Entity state from AWS

fn list(maxPages?: number, resourceModel?: string)

List IoTTwinMaker Entity resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— IoTTwinMaker Entity resource state

@swamp/aws/iottwinmaker/scenev2026.10.23.1scene.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	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	no	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	no	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	no	AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
SceneId	string	yes	The ID of the scene.
Description?	string	no	The description of the scene.
ContentLocation	string	yes	The relative path that specifies the location of the content definition file.
Tags?	record	no	A key-value pair to associate with a resource.
WorkspaceId	string	yes	The ID of the scene.
Capabilities?	array	no	A list of capabilities that the scene uses to render.
SceneMetadata?	record	no	A key-value pair of scene metadata for the scene.

fn create()

Create a IoTTwinMaker Scene

fn get(identifier: string)

Get a IoTTwinMaker Scene

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IoTTwinMaker Scene

fn update()

Update a IoTTwinMaker Scene

fn delete(identifier: string)

Delete a IoTTwinMaker Scene

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IoTTwinMaker Scene

fn sync()

Sync IoTTwinMaker Scene state from AWS

fn list(maxPages?: number, resourceModel?: string)

List IoTTwinMaker Scene resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— IoTTwinMaker Scene resource state

@swamp/aws/iottwinmaker/sync-jobv2026.10.23.1sync_job.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	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	no	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	no	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	no	AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
WorkspaceId	string	yes	The ID of the workspace.
SyncSource	string	yes	The source of the SyncJob.
SyncRole	string	yes	The IAM Role that execute SyncJob.
Tags?	record	no	A key-value pair to associate with a resource.

fn create()

Create a IoTTwinMaker SyncJob

fn get(identifier: string)

Get a IoTTwinMaker SyncJob

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IoTTwinMaker SyncJob

fn delete(identifier: string)

Delete a IoTTwinMaker SyncJob

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IoTTwinMaker SyncJob

fn sync()

Sync IoTTwinMaker SyncJob state from AWS

fn list(maxPages?: number, resourceModel?: string)

List IoTTwinMaker SyncJob resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— IoTTwinMaker SyncJob resource state

@swamp/aws/iottwinmaker/workspacev2026.10.23.1workspace.ts

Global Arguments

Argument	Type	Required	Description
accessKeyId?	string	no	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	no	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	no	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	no	AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
WorkspaceId	string	yes	The ID of the workspace.
Description?	string	no	The description of the workspace.
Role	string	yes	The ARN of the execution role associated with the workspace.
S3Location	string	yes	The ARN of the S3 bucket where resources associated with the workspace are stored.
Tags?	record	no	A map of key-value pairs to associate with a resource.

fn create()

Create a IoTTwinMaker Workspace

fn get(identifier: string)

Get a IoTTwinMaker Workspace

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IoTTwinMaker Workspace

fn update()

Update a IoTTwinMaker Workspace

fn delete(identifier: string)

Delete a IoTTwinMaker Workspace

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IoTTwinMaker Workspace

fn sync()

Sync IoTTwinMaker Workspace state from AWS

fn list(maxPages?: number, resourceModel?: string)

List IoTTwinMaker Workspace resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— IoTTwinMaker Workspace resource state

04Previous Versions19

2026.10.24.1AGPL-3.0-or-laterOct 24, 2026

2026.10.23.1AGPL-3.0-or-later(was none)Oct 24, 2026

Updated: component_type, entity, scene, sync_job, workspace

2026.10.13.1Oct 13, 2026

Updated: component_type, entity, scene, sync_job, workspace

2026.10.08.1Oct 8, 2026

2026.10.06.1Oct 6, 2026

2026.10.04.1Oct 4, 2026

2026.10.03.1Oct 3, 2026

2026.10.02.1Oct 2, 2026

2026.10.01.1Oct 1, 2026

2026.09.30.1Sep 30, 2026

2026.09.29.1Sep 29, 2026

2026.09.28.1Sep 28, 2026

2026.09.27.1Sep 27, 2026

2026.09.26.1Sep 26, 2026

2026.09.25.1Sep 25, 2026

2026.09.24.1Sep 24, 2026

2026.09.23.1Sep 23, 2026

2026.09.22.1Sep 22, 2026

2026.09.21.1Sep 21, 2026

05Stats

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

Repository

https://github.com/swamp-club/swamp-extensions

06Platforms

linux · x86_64 linux · aarch64 macOS · x86_64 macOS · aarch64 windows · x86_64

07Labels

#aws #iottwinmaker #cloud #infrastructure