Aws/iotsitewise

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

01README

AWS IOTSITEWISE infrastructure models

02Release Notes

Updated: computation_model

03Behaviors13

@swamp/aws/iotsitewise/access-policyv2026.10.23.1access_policy.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.
AccessPolicyIdentity	object	yes	The identity for this access policy. Choose either a user or a group but not both.
AccessPolicyPermission	string	yes	The permission level for this access policy. Valid values are ADMINISTRATOR or VIEWER.
AccessPolicyResource	object	yes	The AWS IoT SiteWise Monitor resource for this access policy. Choose either portal or project but not both.

fn create()

Create a IoTSiteWise AccessPolicy

fn get(identifier: string)

Get a IoTSiteWise AccessPolicy

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IoTSiteWise AccessPolicy

fn update()

Update a IoTSiteWise AccessPolicy

fn delete(identifier: string)

Delete a IoTSiteWise AccessPolicy

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IoTSiteWise AccessPolicy

fn sync()

Sync IoTSiteWise AccessPolicy state from AWS

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

List IoTSiteWise AccessPolicy 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)— IoTSiteWise AccessPolicy resource state

@swamp/aws/iotsitewise/applicationv2026.10.23.1application.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.
WorkspaceName	string	yes	The name of the workspace that the application belongs to.
Name	string	yes	The name of the application.
Description?	string	no	A description of the application.
IdcInstanceArn?	string	no	The ARN of the IAM Identity Center instance used to create the application.
Tags?	array	no	An array of key-value pairs to apply to this resource.

fn create()

Create a IoTSiteWise Application

fn get(identifier: string)

Get a IoTSiteWise Application

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IoTSiteWise Application

fn update()

Update a IoTSiteWise Application

fn delete(identifier: string)

Delete a IoTSiteWise Application

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IoTSiteWise Application

fn sync()

Sync IoTSiteWise Application state from AWS

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

List IoTSiteWise Application 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)— IoTSiteWise Application resource state

@swamp/aws/iotsitewise/assetv2026.10.23.1asset.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.
AssetExternalId?	string	no	The External ID of the asset
AssetModelId	string	yes	The ID of the asset model from which to create the asset.
AssetName	string	yes	A unique, friendly name for the asset.
AssetDescription?	string	no	A description for the asset
AssetProperties?	array	no
AssetHierarchies?	array	no
Tags?	array	no	A list of key-value pairs that contain metadata for the asset.

fn create()

Create a IoTSiteWise Asset

fn get(identifier: string)

Get a IoTSiteWise Asset

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IoTSiteWise Asset

fn update()

Update a IoTSiteWise Asset

fn delete(identifier: string)

Delete a IoTSiteWise Asset

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IoTSiteWise Asset

fn sync()

Sync IoTSiteWise Asset state from AWS

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

List IoTSiteWise Asset 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)— IoTSiteWise Asset resource state

@swamp/aws/iotsitewise/asset-modelv2026.10.23.1asset_model.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.
AssetModelType?	string	no	The type of the asset model (ASSET_MODEL OR COMPONENT_MODEL or INTERFACE)
AssetModelExternalId?	string	no	The external ID of the asset model.
AssetModelName	string	yes	A unique, friendly name for the asset model.
AssetModelDescription?	string	no	A description for the asset model.
AssetModelProperties?	array	no	The property definitions of the asset model. You can specify up to 200 properties per asset model.
AssetModelCompositeModels?	array	no	The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties.
AssetModelHierarchies?	array	no	The hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. You can specify up to 10 hierarchies per asset model.
EnforcedAssetModelInterfaceRelationships?	array	no	a list of asset model and interface relationships
Tags?	array	no	A list of key-value pairs that contain metadata for the asset model.

fn create()

Create a IoTSiteWise AssetModel

fn get(identifier: string)

Get a IoTSiteWise AssetModel

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IoTSiteWise AssetModel

fn update()

Update a IoTSiteWise AssetModel

fn delete(identifier: string)

Delete a IoTSiteWise AssetModel

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IoTSiteWise AssetModel

fn sync()

Sync IoTSiteWise AssetModel state from AWS

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

List IoTSiteWise AssetModel 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)— IoTSiteWise AssetModel resource state

@swamp/aws/iotsitewise/computation-modelv2026.10.25.1computation_model.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.
ComputationModelName	string	yes	The name of the computation model.
ComputationModelDescription?	string	no	A description about the computation model.
ComputationModelConfiguration	object	yes	The configuration for the computation model.
ComputationModelDataBinding	record	yes	The data binding for the computation model.
Tags?	array	no	An array of key-value pairs to apply to this resource.

fn create()

Create a IoTSiteWise ComputationModel

fn get(identifier: string)

Get a IoTSiteWise ComputationModel

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IoTSiteWise ComputationModel

fn update()

Update a IoTSiteWise ComputationModel

fn delete(identifier: string)

Delete a IoTSiteWise ComputationModel

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IoTSiteWise ComputationModel

fn sync()

Sync IoTSiteWise ComputationModel state from AWS

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

List IoTSiteWise ComputationModel 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)— IoTSiteWise ComputationModel resource state

@swamp/aws/iotsitewise/dashboardv2026.10.23.1dashboard.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.
ProjectId?	string	no	The ID of the project in which to create the dashboard.
DashboardName	string	yes	A friendly name for the dashboard.
DashboardDescription	string	yes	A description for the dashboard.
DashboardDefinition	string	yes	The dashboard definition specified in a JSON literal.
Tags?	array	no	A list of key-value pairs that contain metadata for the dashboard.

fn create()

Create a IoTSiteWise Dashboard

fn get(identifier: string)

Get a IoTSiteWise Dashboard

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IoTSiteWise Dashboard

fn update()

Update a IoTSiteWise Dashboard

fn delete(identifier: string)

Delete a IoTSiteWise Dashboard

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IoTSiteWise Dashboard

fn sync()

Sync IoTSiteWise Dashboard state from AWS

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

List IoTSiteWise Dashboard 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)— IoTSiteWise Dashboard resource state

@swamp/aws/iotsitewise/datasetv2026.10.23.1dataset.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.
DatasetName	string	yes	The name of the dataset.
DatasetDescription?	string	no	A description about the dataset, and its functionality.
DatasetSource?	object	no	The data source for the dataset.
DatasetType?	enum	no	The type of the dataset.
WorkspaceName?	string	no	The name of the workspace associated with the dataset.
DatasetConfig?	object	no	The configuration for the dataset.
Tags?	array	no	An array of key-value pairs to apply to this resource.

fn create()

Create a IoTSiteWise Dataset

fn get(identifier: string)

Get a IoTSiteWise Dataset

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IoTSiteWise Dataset

fn update()

Update a IoTSiteWise Dataset

fn delete(identifier: string)

Delete a IoTSiteWise Dataset

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IoTSiteWise Dataset

fn sync()

Sync IoTSiteWise Dataset state from AWS

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

List IoTSiteWise Dataset 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)— IoTSiteWise Dataset resource state

@swamp/aws/iotsitewise/gatewayv2026.10.23.1gateway.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.
GatewayName	string	yes	A unique, friendly name for the gateway.
GatewayPlatform	object	yes	The gateway's platform. You can only specify one platform in a gateway.
GatewayVersion?	string	no	The version of the gateway you want to create.
Tags?	array	no	A list of key-value pairs that contain metadata for the gateway.
GatewayCapabilitySummaries?	array	no	A list of gateway capability summaries that each contain a namespace and status.

fn create()

Create a IoTSiteWise Gateway

fn get(identifier: string)

Get a IoTSiteWise Gateway

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IoTSiteWise Gateway

fn update()

Update a IoTSiteWise Gateway

fn delete(identifier: string)

Delete a IoTSiteWise Gateway

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IoTSiteWise Gateway

fn sync()

Sync IoTSiteWise Gateway state from AWS

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

List IoTSiteWise Gateway 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)— IoTSiteWise Gateway resource state

@swamp/aws/iotsitewise/pipelinev2026.10.23.1pipeline.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.
WorkspaceName	string	yes	The name of the workspace.
PipelineName	string	yes	The name of the pipeline. Must be unique within the workspace.
Description?	string	no	A description of the pipeline.
EnvironmentVariables?	record	no	Environment variables shared across all compute nodes in the pipeline.
Computations	array	yes	The list of compute nodes that form the pipeline DAG.
Tags?	array	no	An array of key-value pairs to apply to this resource.

fn create()

Create a IoTSiteWise Pipeline

fn get(identifier: string)

Get a IoTSiteWise Pipeline

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IoTSiteWise Pipeline

fn update()

Update a IoTSiteWise Pipeline

fn delete(identifier: string)

Delete a IoTSiteWise Pipeline

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IoTSiteWise Pipeline

fn sync()

Sync IoTSiteWise Pipeline state from AWS

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

List IoTSiteWise Pipeline 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)— IoTSiteWise Pipeline resource state

@swamp/aws/iotsitewise/portalv2026.10.23.1portal.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.
PortalAuthMode?	string	no	The service to use to authenticate users to the portal. Choose from SSO or IAM. You can't change this value after you create a portal.
PortalContactEmail	string	yes	The AWS administrator's contact email address.
PortalDescription?	string	no	A description for the portal.
PortalName	string	yes	A friendly name for the portal.
PortalType?	enum	no	The type of portal
PortalTypeConfiguration?	record	no	Map to associate detail of configuration related with a PortalType.
RoleArn	string	yes	The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf.
NotificationSenderEmail?	string	no	The email address that sends alarm notifications.
Alarms?	object	no	Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range.
Tags?	array	no	A list of key-value pairs that contain metadata for the portal.

fn create()

Create a IoTSiteWise Portal

fn get(identifier: string)

Get a IoTSiteWise Portal

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IoTSiteWise Portal

fn update()

Update a IoTSiteWise Portal

fn delete(identifier: string)

Delete a IoTSiteWise Portal

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IoTSiteWise Portal

fn sync()

Sync IoTSiteWise Portal state from AWS

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

List IoTSiteWise Portal 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)— IoTSiteWise Portal resource state

@swamp/aws/iotsitewise/projectv2026.10.23.1project.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.
PortalId	string	yes	The ID of the portal in which to create the project.
ProjectName	string	yes	A friendly name for the project.
ProjectDescription?	string	no	A description for the project.
AssetIds?	array	no	The IDs of the assets to be associated to the project.
Tags?	array	no	A list of key-value pairs that contain metadata for the project.

fn create()

Create a IoTSiteWise Project

fn get(identifier: string)

Get a IoTSiteWise Project

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IoTSiteWise Project

fn update()

Update a IoTSiteWise Project

fn delete(identifier: string)

Delete a IoTSiteWise Project

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IoTSiteWise Project

fn sync()

Sync IoTSiteWise Project state from AWS

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

List IoTSiteWise Project 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)— IoTSiteWise Project resource state

@swamp/aws/iotsitewise/taskv2026.10.23.1task.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.
WorkspaceName	string	yes	The name of the workspace.
TaskName	string	yes	The name of the task. Must be unique within the workspace.
Description?	string	no	A description of the task.
TaskConfiguration	object	yes	The task execution configuration.
Tags?	array	no	An array of key-value pairs to apply to this resource.

fn create()

Create a IoTSiteWise Task

fn get(identifier: string)

Get a IoTSiteWise Task

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IoTSiteWise Task

fn update()

Update a IoTSiteWise Task

fn delete(identifier: string)

Delete a IoTSiteWise Task

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the IoTSiteWise Task

fn sync()

Sync IoTSiteWise Task state from AWS

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

List IoTSiteWise Task 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)— IoTSiteWise Task resource state

@swamp/aws/iotsitewise/workspacev2026.10.23.1workspace.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.
WorkspaceName	string	yes	The name of the workspace.
WorkspaceDescription?	string	no	A description of the workspace.
EncryptionConfiguration	object	yes	The encryption configuration for the workspace.
KmsKeyId?	string	no	The ARN of the AWS KMS key used for KMS_BASED_ENCRYPTION. Required when EncryptionConfiguration.EncryptionType is KMS_BASED_ENCRYPTION.
Tags?	array	no	An array of key-value pairs to apply to this resource.

fn create()

Create a IoTSiteWise Workspace

fn get(identifier: string)

Get a IoTSiteWise Workspace

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

fn update()

Update a IoTSiteWise Workspace

fn delete(identifier: string)

Delete a IoTSiteWise Workspace

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

fn sync()

Sync IoTSiteWise Workspace state from AWS

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

List IoTSiteWise 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)— IoTSiteWise 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: access_policy, application, asset, asset_model, computation_model, dashboard, dataset, gateway, pipeline, portal, project, task, workspace

2026.10.13.1Oct 13, 2026

Updated: access_policy, application, asset, asset_model, computation_model, dashboard, dataset, gateway, pipeline, portal, project, task, 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

Updated: dataset

2026.09.21.1Sep 21, 2026

05Stats

100 / 100

Downloads

115

Archive size

2.6 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 #iotsitewise #cloud #infrastructure