Package-level declarations

Types

Link copied to clipboard
data class AccessPolicyIamRole(val arn: String? = null)

Contains information for an IAM role identity in an access policy.

Link copied to clipboard
data class AccessPolicyIamUser(val arn: String? = null)

Contains information for an IAM user identity in an access policy.

Link copied to clipboard
data class AccessPolicyIdentity(val iamRole: AccessPolicyIamRole? = null, val iamUser: AccessPolicyIamUser? = null, val user: AccessPolicyUser? = null)

The identity for this access policy. Choose either an SSO user or group or an IAM user or role.

Link copied to clipboard
data class AccessPolicyPortal(val id: String? = null)

A portal resource.

Link copied to clipboard
data class AccessPolicyProject(val id: String? = null)

A project resource.

Link copied to clipboard
data class AccessPolicyResource(val portal: AccessPolicyPortal? = null, val project: AccessPolicyProject? = null)

The AWS IoT SiteWise Monitor resource for this access policy. Choose either portal or project but not both.

Link copied to clipboard
data class AccessPolicyUser(val id: String? = null)

Contains information for a user identity in an access policy.

Link copied to clipboard
data class AlarmsProperties(val alarmRoleArn: String? = null, val notificationLambdaArn: String? = null)

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.

Link copied to clipboard
data class AssetHierarchy(val childAssetId: String, val externalId: String? = null, val id: String? = null, val logicalId: String? = null)

A hierarchy specifies allowed parent/child asset relationships.

Link copied to clipboard
data class AssetModelAttribute(val defaultValue: String? = null)
Link copied to clipboard
data class AssetModelCompositeModel(val composedAssetModelId: String? = null, val compositeModelProperties: List<AssetModelProperty>? = null, val description: String? = null, val externalId: String? = null, val id: String? = null, val name: String, val parentAssetModelCompositeModelExternalId: String? = null, val path: List<String>? = null, val type: String)

Contains a composite model definition in an asset model. This composite model definition is applied to all assets created from the asset model.

Link copied to clipboard
Link copied to clipboard
data class AssetModelHierarchy(val childAssetModelId: String, val externalId: String? = null, val id: String? = null, val logicalId: String? = null, val name: String)

Contains information about an asset model hierarchy.

Link copied to clipboard
data class AssetModelMetric(val expression: String, val variables: List<AssetModelExpressionVariable>, val window: AssetModelMetricWindow)
Link copied to clipboard
data class AssetModelMetricWindow(val tumbling: AssetModelTumblingWindow? = null)

Contains a time interval window used for data aggregate computations (for example, average, sum, count, and so on).

Link copied to clipboard
data class AssetModelProperty(val dataType: AssetModelDataType, val dataTypeSpec: AssetModelDataTypeSpec? = null, val externalId: String? = null, val id: String? = null, val logicalId: String? = null, val name: String, val type: AssetModelPropertyType, val unit: String? = null)

Contains information about an asset model property.

Link copied to clipboard

The definition for property path which is used to reference properties in transforms/metrics

Link copied to clipboard
data class AssetModelPropertyType(val attribute: AssetModelAttribute? = null, val metric: AssetModelMetric? = null, val transform: AssetModelTransform? = null, val typeName: AssetModelTypeName)

Contains a property type, which can be one of attribute, measurement, metric, or transform.

Link copied to clipboard
data class AssetModelTransform(val expression: String, val variables: List<AssetModelExpressionVariable>)
Link copied to clipboard
data class AssetModelTumblingWindow(val interval: String, val offset: String? = null)

Contains a tumbling window, which is a repeating fixed-sized, non-overlapping, and contiguous time interval. This window is used in metric and aggregation computations.

Link copied to clipboard
data class AssetModelVariableValue(val hierarchyExternalId: String? = null, val hierarchyId: String? = null, val hierarchyLogicalId: String? = null, val propertyExternalId: String? = null, val propertyId: String? = null, val propertyLogicalId: String? = null, val propertyPath: List<AssetModelPropertyPathDefinition>? = null)
Link copied to clipboard
data class AssetProperty(val alias: String? = null, val externalId: String? = null, val id: String? = null, val logicalId: String? = null, val notificationState: AssetPropertyNotificationState? = null, val unit: String? = null)

The asset property's definition, alias, unit, and notification state.

Link copied to clipboard
data class GatewayCapabilitySummary(val capabilityConfiguration: String? = null, val capabilityNamespace: String)

Contains a summary of a gateway capability configuration.

Link copied to clipboard
data class GatewayGreengrass(val groupArn: String)

Contains the ARN of AWS IoT Greengrass Group V1 that the gateway runs on.

Link copied to clipboard
data class GatewayGreengrassV2(val coreDeviceThingName: String)

Contains the CoreDeviceThingName of AWS IoT Greengrass Group V2 that the gateway runs on.

Link copied to clipboard
data class GatewayPlatform(val greengrass: GatewayGreengrass? = null, val greengrassV2: GatewayGreengrassV2? = null, val siemensIe: GatewaySiemensIe? = null)

Contains a gateway's platform information.

Link copied to clipboard
data class GatewaySiemensIe(val iotCoreThingName: String)

Contains the IotCoreThingName of AWS IoT Thing that the gateway runs on.

Link copied to clipboard
data class GetAccessPolicyResult(val accessPolicyArn: String? = null, val accessPolicyId: String? = null, val accessPolicyIdentity: AccessPolicyIdentity? = null, val accessPolicyPermission: String? = null, val accessPolicyResource: AccessPolicyResource? = null)
Link copied to clipboard
data class GetAssetModelResult(val assetModelArn: String? = null, val assetModelCompositeModels: List<AssetModelCompositeModel>? = null, val assetModelDescription: String? = null, val assetModelExternalId: String? = null, val assetModelHierarchies: List<AssetModelHierarchy>? = null, val assetModelId: String? = null, val assetModelName: String? = null, val assetModelProperties: List<AssetModelProperty>? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetAssetResult(val assetArn: String? = null, val assetDescription: String? = null, val assetExternalId: String? = null, val assetHierarchies: List<AssetHierarchy>? = null, val assetId: String? = null, val assetModelId: String? = null, val assetName: String? = null, val assetProperties: List<AssetProperty>? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetDashboardResult(val dashboardArn: String? = null, val dashboardDefinition: String? = null, val dashboardDescription: String? = null, val dashboardId: String? = null, val dashboardName: String? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetGatewayResult(val gatewayCapabilitySummaries: List<GatewayCapabilitySummary>? = null, val gatewayId: String? = null, val gatewayName: String? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetPortalResult(val alarms: AlarmsProperties? = null, val notificationSenderEmail: String? = null, val portalArn: String? = null, val portalClientId: String? = null, val portalContactEmail: String? = null, val portalDescription: String? = null, val portalId: String? = null, val portalName: String? = null, val portalStartUrl: String? = null, val roleArn: String? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetProjectResult(val assetIds: List<String>? = null, val projectArn: String? = null, val projectDescription: String? = null, val projectId: String? = null, val projectName: String? = null, val tags: List<Tag>? = null)