Skip to main content

@swamp/aws/iotsitewise

v2026.04.23.3

AWS IOTSITEWISE infrastructure models

Repository

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

Labels

awsiotsitewisecloudinfrastructure

Contents

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

100%

Grade A

  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types1/1earned
  • Has description1/1earned
  • At least one platform tag (or universal)1/1earned
  • Two or more platform tags (or universal)1/1earned
  • License declared1/1earned
  • Verified public repository2/2earned

Install

$ swamp extension pull @swamp/aws/iotsitewise

@swamp/aws/iotsitewise/access-policyv2026.04.23.2access_policy.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
AccessPolicyIdentityobjectThe identity for this access policy. Choose either a user or a group but not both.
AccessPolicyPermissionstringThe permission level for this access policy. Valid values are ADMINISTRATOR or VIEWER.
AccessPolicyResourceobjectThe AWS IoT SiteWise Monitor resource for this access policy. Choose either portal or project but not both.
createCreate a IoTSiteWise AccessPolicy
getGet a IoTSiteWise AccessPolicy
ArgumentTypeDescription
identifierstringThe primary identifier of the IoTSiteWise AccessPolicy
updateUpdate a IoTSiteWise AccessPolicy
deleteDelete a IoTSiteWise AccessPolicy
ArgumentTypeDescription
identifierstringThe primary identifier of the IoTSiteWise AccessPolicy
syncSync IoTSiteWise AccessPolicy state from AWS

Resources

state(infinite)— IoTSiteWise AccessPolicy resource state
@swamp/aws/iotsitewise/assetv2026.04.23.2asset.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
AssetExternalId?stringThe External ID of the asset
AssetModelIdstringThe ID of the asset model from which to create the asset.
AssetNamestringA unique, friendly name for the asset.
AssetDescription?stringA description for the asset
AssetProperties?array
AssetHierarchies?array
Tags?arrayA list of key-value pairs that contain metadata for the asset.
createCreate a IoTSiteWise Asset
getGet a IoTSiteWise Asset
ArgumentTypeDescription
identifierstringThe primary identifier of the IoTSiteWise Asset
updateUpdate a IoTSiteWise Asset
deleteDelete a IoTSiteWise Asset
ArgumentTypeDescription
identifierstringThe primary identifier of the IoTSiteWise Asset
syncSync IoTSiteWise Asset state from AWS

Resources

state(infinite)— IoTSiteWise Asset resource state
@swamp/aws/iotsitewise/asset-modelv2026.04.23.2asset_model.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
AssetModelType?stringThe type of the asset model (ASSET_MODEL OR COMPONENT_MODEL or INTERFACE)
AssetModelExternalId?stringThe external ID of the asset model.
AssetModelNamestringA unique, friendly name for the asset model.
AssetModelDescription?stringA description for the asset model.
AssetModelProperties?arrayThe property definitions of the asset model. You can specify up to 200 properties per asset model.
AssetModelCompositeModels?arrayThe composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties.
AssetModelHierarchies?arrayThe 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?arraya list of asset model and interface relationships
Tags?arrayA list of key-value pairs that contain metadata for the asset model.
createCreate a IoTSiteWise AssetModel
getGet a IoTSiteWise AssetModel
ArgumentTypeDescription
identifierstringThe primary identifier of the IoTSiteWise AssetModel
updateUpdate a IoTSiteWise AssetModel
deleteDelete a IoTSiteWise AssetModel
ArgumentTypeDescription
identifierstringThe primary identifier of the IoTSiteWise AssetModel
syncSync IoTSiteWise AssetModel state from AWS

Resources

state(infinite)— IoTSiteWise AssetModel resource state
@swamp/aws/iotsitewise/computation-modelv2026.04.23.2computation_model.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
ComputationModelNamestringThe name of the computation model.
ComputationModelDescription?stringA description about the computation model.
ComputationModelConfigurationobjectThe configuration for the computation model.
Tags?arrayAn array of key-value pairs to apply to this resource.
createCreate a IoTSiteWise ComputationModel
getGet a IoTSiteWise ComputationModel
ArgumentTypeDescription
identifierstringThe primary identifier of the IoTSiteWise ComputationModel
updateUpdate a IoTSiteWise ComputationModel
deleteDelete a IoTSiteWise ComputationModel
ArgumentTypeDescription
identifierstringThe primary identifier of the IoTSiteWise ComputationModel
syncSync IoTSiteWise ComputationModel state from AWS

Resources

state(infinite)— IoTSiteWise ComputationModel resource state
@swamp/aws/iotsitewise/dashboardv2026.04.23.2dashboard.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
ProjectId?stringThe ID of the project in which to create the dashboard.
DashboardNamestringA friendly name for the dashboard.
DashboardDescriptionstringA description for the dashboard.
DashboardDefinitionstringThe dashboard definition specified in a JSON literal.
Tags?arrayA list of key-value pairs that contain metadata for the dashboard.
createCreate a IoTSiteWise Dashboard
getGet a IoTSiteWise Dashboard
ArgumentTypeDescription
identifierstringThe primary identifier of the IoTSiteWise Dashboard
updateUpdate a IoTSiteWise Dashboard
deleteDelete a IoTSiteWise Dashboard
ArgumentTypeDescription
identifierstringThe primary identifier of the IoTSiteWise Dashboard
syncSync IoTSiteWise Dashboard state from AWS

Resources

state(infinite)— IoTSiteWise Dashboard resource state
@swamp/aws/iotsitewise/datasetv2026.04.23.2dataset.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
DatasetNamestringThe name of the dataset.
DatasetDescription?stringA description about the dataset, and its functionality.
DatasetSourceobjectThe data source for the dataset.
Tags?arrayAn array of key-value pairs to apply to this resource.
createCreate a IoTSiteWise Dataset
getGet a IoTSiteWise Dataset
ArgumentTypeDescription
identifierstringThe primary identifier of the IoTSiteWise Dataset
updateUpdate a IoTSiteWise Dataset
deleteDelete a IoTSiteWise Dataset
ArgumentTypeDescription
identifierstringThe primary identifier of the IoTSiteWise Dataset
syncSync IoTSiteWise Dataset state from AWS

Resources

state(infinite)— IoTSiteWise Dataset resource state
@swamp/aws/iotsitewise/gatewayv2026.04.23.2gateway.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
GatewayNamestringA unique, friendly name for the gateway.
GatewayPlatformobjectThe gateway's platform. You can only specify one platform in a gateway.
GatewayVersion?stringThe version of the gateway you want to create.
Tags?arrayA list of key-value pairs that contain metadata for the gateway.
GatewayCapabilitySummaries?arrayA list of gateway capability summaries that each contain a namespace and status.
createCreate a IoTSiteWise Gateway
getGet a IoTSiteWise Gateway
ArgumentTypeDescription
identifierstringThe primary identifier of the IoTSiteWise Gateway
updateUpdate a IoTSiteWise Gateway
deleteDelete a IoTSiteWise Gateway
ArgumentTypeDescription
identifierstringThe primary identifier of the IoTSiteWise Gateway
syncSync IoTSiteWise Gateway state from AWS

Resources

state(infinite)— IoTSiteWise Gateway resource state
@swamp/aws/iotsitewise/portalv2026.04.23.2portal.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
PortalAuthMode?stringThe 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.
PortalContactEmailstringThe AWS administrator's contact email address.
PortalDescription?stringA description for the portal.
PortalNamestringA friendly name for the portal.
PortalType?enumThe type of portal
PortalTypeConfiguration?recordMap to associate detail of configuration related with a PortalType.
RoleArnstringThe ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf.
NotificationSenderEmail?stringThe email address that sends alarm notifications.
Alarms?objectContains 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?arrayA list of key-value pairs that contain metadata for the portal.
createCreate a IoTSiteWise Portal
getGet a IoTSiteWise Portal
ArgumentTypeDescription
identifierstringThe primary identifier of the IoTSiteWise Portal
updateUpdate a IoTSiteWise Portal
deleteDelete a IoTSiteWise Portal
ArgumentTypeDescription
identifierstringThe primary identifier of the IoTSiteWise Portal
syncSync IoTSiteWise Portal state from AWS

Resources

state(infinite)— IoTSiteWise Portal resource state
@swamp/aws/iotsitewise/projectv2026.04.23.2project.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
PortalIdstringThe ID of the portal in which to create the project.
ProjectNamestringA friendly name for the project.
ProjectDescription?stringA description for the project.
AssetIds?arrayThe IDs of the assets to be associated to the project.
Tags?arrayA list of key-value pairs that contain metadata for the project.
createCreate a IoTSiteWise Project
getGet a IoTSiteWise Project
ArgumentTypeDescription
identifierstringThe primary identifier of the IoTSiteWise Project
updateUpdate a IoTSiteWise Project
deleteDelete a IoTSiteWise Project
ArgumentTypeDescription
identifierstringThe primary identifier of the IoTSiteWise Project
syncSync IoTSiteWise Project state from AWS

Resources

state(infinite)— IoTSiteWise Project resource state