String id
The ID of the access policy.
Identity identity
The identity (an AWS SSO user, an AWS SSO group, or an IAM user).
Resource resource
The AWS IoT SiteWise Monitor resource (a portal or project).
String permission
The permissions for the access policy. Note that a project ADMINISTRATOR is also known as a project
owner.
Date creationDate
The date the access policy was created, in Unix epoch time.
Date lastUpdateDate
The date the access policy was last updated, in Unix epoch time.
Date timestamp
The date the aggregating computations occurred, in Unix epoch time.
String quality
The quality of the aggregated data.
Aggregates value
The value of the aggregates.
Double average
The average (mean) value of the time series over a time interval window.
Double count
The count of data points in the time series over a time interval window.
Double maximum
The maximum value of the time series over a time interval window.
Double minimum
The minimum value of the time series over a time interval window.
Double sum
The sum of the time series over a time interval window.
Double standardDeviation
The standard deviation of the time series over a time interval window.
String name
The name of the composite model.
String description
The description of the composite model.
String type
The type of the composite model. For alarm composite models, this type is AWS/ALARM.
List<E> properties
The asset properties that this composite model defines.
String id
The ID of the hierarchy. This ID is a hierarchyId.
String name
The hierarchy name provided in the CreateAssetModel or UpdateAssetModel API operation.
String name
The name of the composite model.
String description
The description of the composite model.
String type
The type of the composite model. For alarm composite models, this type is AWS/ALARM.
List<E> properties
The asset property definitions for this composite model.
String name
The name of the composite model.
String description
The description of the composite model.
String type
The type of the composite model. For alarm composite models, this type is AWS/ALARM.
List<E> properties
The asset property definitions for this composite model.
String id
The ID of the asset model hierarchy. This ID is a hierarchyId.
String name
The name of the asset model hierarchy that you specify by using the CreateAssetModel or UpdateAssetModel API operation.
String childAssetModelId
The ID of the asset model. All assets in this hierarchy must be instances of the childAssetModelId
asset model.
String name
The name of the asset model hierarchy definition (as specified in the CreateAssetModel or UpdateAssetModel API operation).
String childAssetModelId
The ID of an asset model for this hierarchy.
String id
The ID of the asset model property.
String name
The name of the asset model property.
String dataType
The data type of the asset model property.
String dataTypeSpec
The data type of the structure for this property. This parameter exists on properties that have the
STRUCT data type.
String unit
The unit of the asset model property, such as Newtons or RPM.
PropertyType type
The property type (see PropertyType).
String name
The name of the property definition.
String dataType
The data type of the property definition.
If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the
structure for this property.
String dataTypeSpec
The data type of the structure for this property. This parameter is required on properties that have the
STRUCT data type.
The options for this parameter depend on the type of the composite model in which you define this property. Use
AWS/ALARM_STATE for alarm state in alarm composite models.
String unit
The unit of the property definition, such as Newtons or RPM.
PropertyType type
The property definition type (see PropertyType). You can only specify one type in a property
definition.
String state
The current state of the asset model.
ErrorDetails error
Contains associated error information, if any.
String id
The ID of the asset model (used with AWS IoT SiteWise APIs).
String arn
The ARN of the asset model, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}
String name
The name of the asset model.
String description
The asset model description.
Date creationDate
The date the asset model was created, in Unix epoch time.
Date lastUpdateDate
The date the asset model was last updated, in Unix epoch time.
AssetModelStatus status
The current status of the asset model.
String id
The ID of the asset property.
String name
The name of the property.
String alias
The property alias that identifies the property, such as an OPC-UA server data stream path (for example,
/company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial
data streams to asset properties in the AWS IoT SiteWise User Guide.
PropertyNotification notification
The asset property's notification topic and state. For more information, see UpdateAssetProperty.
String dataType
The data type of the asset property.
String dataTypeSpec
The data type of the structure for this property. This parameter exists on properties that have the
STRUCT data type.
String unit
The unit (such as Newtons or RPM) of the asset property.
Variant value
The value of the asset property (see Variant).
TimeInNanos timestamp
The timestamp of the asset property value.
String quality
The quality of the asset property value.
AssetHierarchyInfo hierarchyInfo
The assets that are related through an asset hierarchy.
This object is present if the relationshipType is HIERARCHY.
String relationshipType
The relationship type of the assets in this relationship. This value is one of the following:
HIERARCHY – The assets are related through an asset hierarchy. If you specify this relationship
type, this asset relationship includes the hierarchyInfo object.
String state
The current status of the asset.
ErrorDetails error
Contains associated error information, if any.
String id
The ID of the asset.
String arn
The ARN of the asset, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}
String name
The name of the asset.
String assetModelId
The ID of the asset model used to create this asset.
Date creationDate
The date the asset was created, in Unix epoch time.
Date lastUpdateDate
The date the asset was last updated, in Unix epoch time.
AssetStatus status
The current status of the asset.
List<E> hierarchies
A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed
parent/child asset relationships.
String assetId
The ID of the parent asset.
String hierarchyId
The ID of a hierarchy in the parent asset's model. Hierarchies allow different groupings of assets to be formed that all come from the same asset model. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide.
String childAssetId
The ID of the child asset to be associated.
String clientToken
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
String id
The ID of the asset.
String arn
The ARN of the asset, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}
String name
The name of the asset.
String assetModelId
The ID of the asset model used to create the asset.
Date creationDate
The date the asset was created, in Unix epoch time.
Date lastUpdateDate
The date the asset was last updated, in Unix epoch time.
AssetStatus status
The current status of the asset.
List<E> hierarchies
A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed
parent/child asset relationships.
String defaultValue
The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see Updating attribute values in the AWS IoT SiteWise User Guide.
String projectId
The ID of the project to which to associate the assets.
List<E> assetIds
The IDs of the assets to be associated to the project.
String clientToken
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
String projectId
The ID of the project from which to disassociate the assets.
List<E> assetIds
The IDs of the assets to be disassociated from the project.
String clientToken
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
String state
The current state of the configuration.
ConfigurationErrorDetails error
Contains associated error information, if any.
Identity accessPolicyIdentity
The identity for this access policy. Choose an AWS SSO user, an AWS SSO group, or an IAM user.
Resource accessPolicyResource
The AWS IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project.
String accessPolicyPermission
The permission level for this access policy. Note that a project ADMINISTRATOR is also known as a
project owner.
String clientToken
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
Map<K,V> tags
A list of key-value pairs that contain metadata for the access policy. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.
String assetModelName
A unique, friendly name for the asset model.
String assetModelDescription
A description for the asset model.
List<E> assetModelProperties
The property definitions of the asset model. For more information, see Asset properties in the AWS IoT SiteWise User Guide.
You can specify up to 200 properties per asset model. For more information, see Quotas in the AWS IoT SiteWise User Guide.
List<E> assetModelHierarchies
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. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide.
You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the AWS IoT SiteWise User Guide.
List<E> assetModelCompositeModels
The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties. Each composite model has a type that defines the properties that the composite model supports. Use composite asset models to define alarms on this asset model.
String clientToken
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
Map<K,V> tags
A list of key-value pairs that contain metadata for the asset model. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.
String assetModelId
The ID of the asset model. You can use this ID when you call other AWS IoT SiteWise APIs.
String assetModelArn
The ARN of the asset model, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}
AssetModelStatus assetModelStatus
The status of the asset model, which contains a state (CREATING after successfully calling this
operation) and any error message.
String assetName
A unique, friendly name for the asset.
String assetModelId
The ID of the asset model from which to create the asset.
String clientToken
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
Map<K,V> tags
A list of key-value pairs that contain metadata for the asset. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.
String assetId
The ID of the asset. This ID uniquely identifies the asset within AWS IoT SiteWise and can be used with other AWS IoT SiteWise APIs.
String assetArn
The ARN of the asset, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}
AssetStatus assetStatus
The status of the asset, which contains a state (CREATING after successfully calling this operation)
and any error message.
String projectId
The ID of the project in which to create the dashboard.
String dashboardName
A friendly name for the dashboard.
String dashboardDescription
A description for the dashboard.
String dashboardDefinition
The dashboard definition specified in a JSON literal. For detailed information, see Creating dashboards (CLI) in the AWS IoT SiteWise User Guide.
String clientToken
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
Map<K,V> tags
A list of key-value pairs that contain metadata for the dashboard. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.
String gatewayName
A unique, friendly name for the gateway.
GatewayPlatform gatewayPlatform
The gateway's platform. You can only specify one platform in a gateway.
Map<K,V> tags
A list of key-value pairs that contain metadata for the gateway. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.
String portalName
A friendly name for the portal.
String portalDescription
A description for the portal.
String portalContactEmail
The AWS administrator's contact email address.
String clientToken
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
ImageFile portalLogoImageFile
A logo image to display in the portal. Upload a square, high-resolution image. The image is displayed on a dark background.
String roleArn
The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf. For more information, see Using service roles for AWS IoT SiteWise Monitor in the AWS IoT SiteWise User Guide.
Map<K,V> tags
A list of key-value pairs that contain metadata for the portal. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.
String portalAuthMode
The service to use to authenticate users to the portal. Choose from the following options:
SSO – The portal uses AWS Single Sign-On to authenticate users and manage user permissions. Before
you can create a portal that uses AWS SSO, you must enable AWS SSO. For more information, see Enabling AWS
SSO in the AWS IoT SiteWise User Guide. This option is only available in AWS Regions other than the
China Regions.
IAM – The portal uses AWS Identity and Access Management (IAM) to authenticate users and manage user
permissions. This option is only available in the China Regions.
You can't change this value after you create a portal.
Default: SSO
String portalId
The ID of the created portal.
String portalArn
The ARN of the portal, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}
String portalStartUrl
The URL for the AWS IoT SiteWise Monitor portal. You can use this URL to access portals that use AWS SSO for authentication. For portals that use IAM for authentication, you must use the AWS IoT SiteWise console to get a URL that you can use to access the portal.
PortalStatus portalStatus
The status of the portal, which contains a state (CREATING after successfully calling this
operation) and any error message.
String ssoApplicationId
The associated AWS SSO application ID, if the portal uses AWS SSO.
String portalId
The ID of the portal in which to create the project.
String projectName
A friendly name for the project.
String projectDescription
A description for the project.
String clientToken
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
Map<K,V> tags
A list of key-value pairs that contain metadata for the project. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.
String id
The ID of the dashboard.
String name
The name of the dashboard
String description
The dashboard's description.
Date creationDate
The date the dashboard was created, in Unix epoch time.
Date lastUpdateDate
The date the dashboard was last updated, in Unix epoch time.
AssetModelStatus assetModelStatus
The status of the asset model, which contains a state (DELETING after successfully calling this
operation) and any error message.
AssetStatus assetStatus
The status of the asset, which contains a state (DELETING after successfully calling this operation)
and any error message.
String gatewayId
The ID of the gateway to delete.
PortalStatus portalStatus
The status of the portal, which contains a state (DELETING after successfully calling this
operation) and any error message.
String accessPolicyId
The ID of the access policy.
String accessPolicyId
The ID of the access policy.
String accessPolicyArn
The ARN of the access policy, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId}
Identity accessPolicyIdentity
The identity (AWS SSO user, AWS SSO group, or IAM user) to which this access policy applies.
Resource accessPolicyResource
The AWS IoT SiteWise Monitor resource (portal or project) to which this access policy provides access.
String accessPolicyPermission
The access policy permission. Note that a project ADMINISTRATOR is also known as a project owner.
Date accessPolicyCreationDate
The date the access policy was created, in Unix epoch time.
Date accessPolicyLastUpdateDate
The date the access policy was last updated, in Unix epoch time.
String assetModelId
The ID of the asset model.
String assetModelId
The ID of the asset model.
String assetModelArn
The ARN of the asset model, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}
String assetModelName
The name of the asset model.
String assetModelDescription
The asset model's description.
List<E> assetModelProperties
The list of asset properties for the asset model.
This object doesn't include properties that you define in composite models. You can find composite model
properties in the assetModelCompositeModels object.
List<E> assetModelHierarchies
A list of asset model hierarchies that each contain a childAssetModelId and a
hierarchyId (named id). A hierarchy specifies allowed parent/child asset relationships
for an asset model.
List<E> assetModelCompositeModels
The list of composite asset models for the asset model.
Date assetModelCreationDate
The date the asset model was created, in Unix epoch time.
Date assetModelLastUpdateDate
The date the asset model was last updated, in Unix epoch time.
AssetModelStatus assetModelStatus
The current status of the asset model, which contains a state and any error message.
String assetId
The ID of the asset.
String assetName
The name of the asset.
String assetModelId
The ID of the asset model.
Property assetProperty
The asset property's definition, alias, and notification state.
This response includes this object for normal asset properties. If you describe an asset property in a composite
model, this response includes the asset property information in compositeModel.
CompositeModelProperty compositeModel
The composite asset model that declares this asset property, if this asset property exists in a composite model.
String assetId
The ID of the asset.
String assetId
The ID of the asset.
String assetArn
The ARN of the asset, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}
String assetName
The name of the asset.
String assetModelId
The ID of the asset model that was used to create the asset.
List<E> assetProperties
The list of asset properties for the asset.
This object doesn't include properties that you define in composite models. You can find composite model
properties in the assetCompositeModels object.
List<E> assetHierarchies
A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed
parent/child asset relationships.
List<E> assetCompositeModels
The composite models for the asset.
Date assetCreationDate
The date the asset was created, in Unix epoch time.
Date assetLastUpdateDate
The date the asset was last updated, in Unix epoch time.
AssetStatus assetStatus
The current status of the asset, which contains a state and any error message.
String dashboardId
The ID of the dashboard.
String dashboardId
The ID of the dashboard.
String dashboardArn
The ARN of the dashboard, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}
String dashboardName
The name of the dashboard.
String projectId
The ID of the project that the dashboard is in.
String dashboardDescription
The dashboard's description.
String dashboardDefinition
The dashboard's definition JSON literal. For detailed information, see Creating dashboards (CLI) in the AWS IoT SiteWise User Guide.
Date dashboardCreationDate
The date the dashboard was created, in Unix epoch time.
Date dashboardLastUpdateDate
The date the dashboard was last updated, in Unix epoch time.
String encryptionType
The type of encryption used for the encryption configuration.
String kmsKeyArn
The key ARN of the customer managed customer master key (CMK) used for AWS KMS encryption if you use
KMS_BASED_ENCRYPTION.
ConfigurationStatus configurationStatus
The status of the account configuration. This contains the ConfigurationState. If there's an error,
it also contains the ErrorDetails.
String gatewayId
The ID of the gateway that defines the capability configuration.
String capabilityNamespace
The namespace of the capability configuration. For example, if you configure OPC-UA sources from the AWS IoT
SiteWise console, your OPC-UA capability configuration has the namespace
iotsitewise:opcuacollector:version, where version is a number such as 1.
String gatewayId
The ID of the gateway that defines the capability configuration.
String capabilityNamespace
The namespace of the gateway capability.
String capabilityConfiguration
The JSON document that defines the gateway capability's configuration. For more information, see Configuring data sources (CLI) in the AWS IoT SiteWise User Guide.
String capabilitySyncStatus
The synchronization status of the capability configuration. The sync status can be one of the following:
IN_SYNC – The gateway is running the capability configuration.
OUT_OF_SYNC – The gateway hasn't received the capability configuration.
SYNC_FAILED – The gateway rejected the capability configuration.
String gatewayId
The ID of the gateway device.
String gatewayId
The ID of the gateway device.
String gatewayName
The name of the gateway.
String gatewayArn
The ARN of the gateway, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}
GatewayPlatform gatewayPlatform
The gateway's platform.
List<E> gatewayCapabilitySummaries
A list of gateway capability summaries that each contain a namespace and status. Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use DescribeGatewayCapabilityConfiguration.
Date creationDate
The date the gateway was created, in Unix epoch time.
Date lastUpdateDate
The date the gateway was last updated, in Unix epoch time.
LoggingOptions loggingOptions
The current logging options.
String portalId
The ID of the portal.
String portalId
The ID of the portal.
String portalArn
The ARN of the portal, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}
String portalName
The name of the portal.
String portalDescription
The portal's description.
String portalClientId
The AWS SSO application generated client ID (used with AWS SSO APIs). AWS IoT SiteWise includes
portalClientId for only portals that use AWS SSO to authenticate users.
String portalStartUrl
The URL for the AWS IoT SiteWise Monitor portal. You can use this URL to access portals that use AWS SSO for authentication. For portals that use IAM for authentication, you must use the AWS IoT SiteWise console to get a URL that you can use to access the portal.
String portalContactEmail
The AWS administrator's contact email address.
PortalStatus portalStatus
The current status of the portal, which contains a state and any error message.
Date portalCreationDate
The date the portal was created, in Unix epoch time.
Date portalLastUpdateDate
The date the portal was last updated, in Unix epoch time.
ImageLocation portalLogoImageLocation
The portal's logo image, which is available at a URL.
String roleArn
The ARN of the service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf. For more information, see Using service roles for AWS IoT SiteWise Monitor in the AWS IoT SiteWise User Guide.
String portalAuthMode
The service to use to authenticate users to the portal.
String projectId
The ID of the project.
String projectId
The ID of the project.
String projectArn
The ARN of the project, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}
String projectName
The name of the project.
String portalId
The ID of the portal that the project is in.
String projectDescription
The project's description.
Date projectCreationDate
The date the project was created, in Unix epoch time.
Date projectLastUpdateDate
The date the project was last updated, in Unix epoch time.
String assetId
The ID of the parent asset from which to disassociate the child asset.
String hierarchyId
The ID of a hierarchy in the parent asset's model. Hierarchies allow different groupings of assets to be formed that all come from the same asset model. You can use the hierarchy ID to identify the correct asset to disassociate. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide.
String childAssetId
The ID of the child asset to disassociate.
String clientToken
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
String name
The friendly name of the variable to be used in the expression.
VariableValue value
The variable that identifies an asset property from which to use values.
String capabilityNamespace
The namespace of the capability configuration. For example, if you configure OPC-UA sources from the AWS IoT
SiteWise console, your OPC-UA capability configuration has the namespace
iotsitewise:opcuacollector:version, where version is a number such as 1.
String capabilitySyncStatus
The synchronization status of the capability configuration. The sync status can be one of the following:
IN_SYNC – The gateway is running the capability configuration.
OUT_OF_SYNC – The gateway hasn't received the capability configuration.
SYNC_FAILED – The gateway rejected the capability configuration.
Greengrass greengrass
A gateway that runs on AWS IoT Greengrass.
String gatewayId
The ID of the gateway device.
String gatewayName
The name of the asset.
List<E> gatewayCapabilitySummaries
A list of gateway capability summaries that each contain a namespace and status. Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use DescribeGatewayCapabilityConfiguration.
Date creationDate
The date the gateway was created, in Unix epoch time.
Date lastUpdateDate
The date the gateway was last updated, in Unix epoch time.
String assetId
The ID of the asset.
String propertyId
The ID of the asset property.
String propertyAlias
The property alias that identifies the property, such as an OPC-UA server data stream path (for example,
/company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial
data streams to asset properties in the AWS IoT SiteWise User Guide.
List<E> aggregateTypes
The data aggregating function.
String resolution
The time interval over which to aggregate data.
List<E> qualities
The quality by which to filter asset data.
Date startDate
The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.
Date endDate
The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.
String timeOrdering
The chronological sorting order of the requested information.
Default: ASCENDING
String nextToken
The token to be used for the next set of paginated results.
Integer maxResults
The maximum number of results to be returned per paginated request.
Default: 100
String assetId
The ID of the asset.
String propertyId
The ID of the asset property.
String propertyAlias
The property alias that identifies the property, such as an OPC-UA server data stream path (for example,
/company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial
data streams to asset properties in the AWS IoT SiteWise User Guide.
Date startDate
The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.
Date endDate
The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.
List<E> qualities
The quality by which to filter asset data.
String timeOrdering
The chronological sorting order of the requested information.
Default: ASCENDING
String nextToken
The token to be used for the next set of paginated results.
Integer maxResults
The maximum number of results to be returned per paginated request.
Default: 100
String assetId
The ID of the asset.
String propertyId
The ID of the asset property.
String propertyAlias
The property alias that identifies the property, such as an OPC-UA server data stream path (for example,
/company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial
data streams to asset properties in the AWS IoT SiteWise User Guide.
AssetPropertyValue propertyValue
The current asset property value.
String groupArn
The ARN of the Greengrass group. For more information about how to find a group's ARN, see ListGroups and GetGroup in the AWS IoT Greengrass API Reference.
String id
The AWS SSO ID of the group.
UserIdentity user
An AWS SSO user identity.
GroupIdentity group
An AWS SSO group identity.
IAMUserIdentity iamUser
An IAM user identity.
IAMRoleIdentity iamRole
An IAM role identity.
ByteBuffer data
The image file contents, represented as a base64-encoded string. The file size must be less than 1 MB.
String type
The file type of the image.
String identityType
The type of identity (AWS SSO user, AWS SSO group, or IAM user). This parameter is required if you specify
identityId.
String identityId
The ID of the identity. This parameter is required if you specify USER or GROUP for
identityType.
String resourceType
The type of resource (portal or project). This parameter is required if you specify resourceId.
String resourceId
The ID of the resource. This parameter is required if you specify resourceType.
String iamArn
The ARN of the IAM user. For more information, see IAM ARNs in the IAM
User Guide. This parameter is required if you specify IAM for identityType.
String nextToken
The token to be used for the next set of paginated results.
Integer maxResults
The maximum number of results to be returned per paginated request.
Default: 50
String assetId
The ID of the asset.
String traversalType
The type of traversal to use to identify asset relationships. Choose the following option:
PATH_TO_ROOT – Identify the asset's parent assets up to the root asset. The asset that you specify
in assetId is the first result in the list of assetRelationshipSummaries, and the root
asset is the last result.
String nextToken
The token to be used for the next set of paginated results.
Integer maxResults
The maximum number of results to be returned per paginated request.
String nextToken
The token to be used for the next set of paginated results.
Integer maxResults
The maximum number of results to be returned per paginated request.
Default: 50
String assetModelId
The ID of the asset model by which to filter the list of assets. This parameter is required if you choose
ALL for filter.
String filter
The filter for the requested list of assets. Choose one of the following options:
ALL – The list includes all assets for a given asset model ID. The assetModelId
parameter is required if you filter by ALL.
TOP_LEVEL – The list includes only top-level assets in the asset hierarchy tree.
Default: ALL
String assetId
The ID of the asset to query.
String hierarchyId
The ID of the hierarchy by which child assets are associated to the asset. To find a hierarchy ID, use the DescribeAsset or
DescribeAssetModel operations. This parameter is required if you choose CHILD for
traversalDirection.
For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide.
String traversalDirection
The direction to list associated assets. Choose one of the following options:
CHILD – The list includes all child assets associated to the asset. The hierarchyId
parameter is required if you choose CHILD.
PARENT – The list includes the asset's parent asset.
Default: CHILD
String nextToken
The token to be used for the next set of paginated results.
Integer maxResults
The maximum number of results to be returned per paginated request.
Default: 50
Map<K,V> tags
The list of key-value pairs that contain metadata for the resource. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.
String level
The AWS IoT SiteWise logging verbosity level.
String expression
The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
List<E> variables
The list of variables used in the expression.
MetricWindow window
The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression. AWS IoT
SiteWise computes one data point per window.
TumblingWindow tumbling
The tumbling time interval window.
String id
The ID of the portal.
String state
The current state of the portal.
MonitorErrorDetails error
Contains associated error information, if any.
String id
The ID of the portal.
String name
The name of the portal.
String description
The portal's description.
String startUrl
The URL for the AWS IoT SiteWise Monitor portal. You can use this URL to access portals that use AWS SSO for authentication. For portals that use IAM for authentication, you must use the AWS IoT SiteWise console to get a URL that you can use to access the portal.
Date creationDate
The date the portal was created, in Unix epoch time.
Date lastUpdateDate
The date the portal was last updated, in Unix epoch time.
String roleArn
The ARN of the service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf. For more information, see Using service roles for AWS IoT SiteWise Monitor in the AWS IoT SiteWise User Guide.
PortalStatus status
String id
The ID of the project.
String id
The ID of the project.
String name
The name of the project.
String description
The project's description.
Date creationDate
The date the project was created, in Unix epoch time.
Date lastUpdateDate
The date the project was last updated, in Unix epoch time.
String id
The ID of the asset property.
String name
The name of the property.
String alias
The property alias that identifies the property, such as an OPC-UA server data stream path (for example,
/company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial
data streams to asset properties in the AWS IoT SiteWise User Guide.
PropertyNotification notification
The asset property's notification topic and state. For more information, see UpdateAssetProperty.
String dataType
The property data type.
String unit
The unit (such as Newtons or RPM) of the asset property.
PropertyType type
The property type (see PropertyType). A property contains one type.
Attribute attribute
Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine.
Measurement measurement
Specifies an asset measurement property. A measurement represents a device's raw sensor data stream, such as timestamped temperature values or timestamped power values.
Transform transform
Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.
Metric metric
Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.
String entryId
The user specified ID for the entry. You can use this ID to identify which entries failed.
String assetId
The ID of the asset to update.
String propertyId
The ID of the asset property for this entry.
String propertyAlias
The property alias that identifies the property, such as an OPC-UA server data stream path (for example,
/company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial
data streams to asset properties in the AWS IoT SiteWise User Guide.
List<E> propertyValues
The list of property values to upload. You can specify up to 10 propertyValues array elements.
String encryptionType
The type of encryption used for the encryption configuration.
String kmsKeyArn
The Key ARN of the AWS KMS CMK used for AWS KMS encryption if you use KMS_BASED_ENCRYPTION.
ConfigurationStatus configurationStatus
The status of the account configuration. This contains the ConfigurationState. If there is an error,
it also contains the ErrorDetails.
LoggingOptions loggingOptions
The logging options to set.
PortalResource portal
A portal resource.
ProjectResource project
A project resource.
String resourceName
The name of the resource with too many tags.
String expression
The mathematical expression that defines the transformation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
List<E> variables
The list of variables used in the expression.
String interval
The time interval for the tumbling window. Note that w represents weeks, d represents
days, h represents hours, and m represents minutes. AWS IoT SiteWise computes the
1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end
of each day at midnight (UTC), the 1h interval at the end of each hour, and so on.
When AWS IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. AWS IoT SiteWise places the computed data point at the end of the interval.
String accessPolicyId
The ID of the access policy.
Identity accessPolicyIdentity
The identity for this access policy. Choose an AWS SSO user, an AWS SSO group, or an IAM user.
Resource accessPolicyResource
The AWS IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project.
String accessPolicyPermission
The permission level for this access policy. Note that a project ADMINISTRATOR is also known as a
project owner.
String clientToken
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
String assetModelId
The ID of the asset model to update.
String assetModelName
A unique, friendly name for the asset model.
String assetModelDescription
A description for the asset model.
List<E> assetModelProperties
The updated property definitions of the asset model. For more information, see Asset properties in the AWS IoT SiteWise User Guide.
You can specify up to 200 properties per asset model. For more information, see Quotas in the AWS IoT SiteWise User Guide.
List<E> assetModelHierarchies
The updated 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. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide.
You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the AWS IoT SiteWise User Guide.
List<E> assetModelCompositeModels
The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties. Each composite model has a type that defines the properties that the composite model supports. Use composite asset models to define alarms on this asset model.
String clientToken
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
AssetModelStatus assetModelStatus
The status of the asset model, which contains a state (UPDATING after successfully calling this
operation) and any error message.
String assetId
The ID of the asset to be updated.
String propertyId
The ID of the asset property to be updated.
String propertyAlias
The property alias that identifies the property, such as an OPC-UA server data stream path (for example,
/company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial
data streams to asset properties in the AWS IoT SiteWise User Guide.
If you omit this parameter, the alias is removed from the property.
String propertyNotificationState
The MQTT notification state (enabled or disabled) for this asset property. When the notification state is enabled, AWS IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see Interacting with other services in the AWS IoT SiteWise User Guide.
If you omit this parameter, the notification state is set to DISABLED.
String clientToken
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
String assetId
The ID of the asset to update.
String assetName
A unique, friendly name for the asset.
String clientToken
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
AssetStatus assetStatus
The status of the asset, which contains a state (UPDATING after successfully calling this operation)
and any error message.
String dashboardId
The ID of the dashboard to update.
String dashboardName
A new friendly name for the dashboard.
String dashboardDescription
A new description for the dashboard.
String dashboardDefinition
The new dashboard definition, as specified in a JSON literal. For detailed information, see Creating dashboards (CLI) in the AWS IoT SiteWise User Guide.
String clientToken
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
String gatewayId
The ID of the gateway to be updated.
String capabilityNamespace
The namespace of the gateway capability configuration to be updated. For example, if you configure OPC-UA sources
from the AWS IoT SiteWise console, your OPC-UA capability configuration has the namespace
iotsitewise:opcuacollector:version, where version is a number such as 1.
String capabilityConfiguration
The JSON document that defines the configuration for the gateway capability. For more information, see Configuring data sources (CLI) in the AWS IoT SiteWise User Guide.
String capabilityNamespace
The namespace of the gateway capability.
String capabilitySyncStatus
The synchronization status of the capability configuration. The sync status can be one of the following:
IN_SYNC – The gateway is running the capability configuration.
OUT_OF_SYNC – The gateway hasn't received the capability configuration.
SYNC_FAILED – The gateway rejected the capability configuration.
After you update a capability configuration, its sync status is OUT_OF_SYNC until the gateway
receives and applies or rejects the updated configuration.
String portalId
The ID of the portal to update.
String portalName
A new friendly name for the portal.
String portalDescription
A new description for the portal.
String portalContactEmail
The AWS administrator's contact email address.
Image portalLogoImage
String roleArn
The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf. For more information, see Using service roles for AWS IoT SiteWise Monitor in the AWS IoT SiteWise User Guide.
String clientToken
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
PortalStatus portalStatus
The status of the portal, which contains a state (UPDATING after successfully calling this
operation) and any error message.
String projectId
The ID of the project to update.
String projectName
A new friendly name for the project.
String projectDescription
A new description for the project.
String clientToken
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
String id
The AWS SSO ID of the user.
String propertyId
The ID of the property to use as the variable. You can use the property name if it's from the same
asset model.
String hierarchyId
The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.
You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and
therefore the same propertyId. For example, you might have separately grouped assets that come from
the same asset model. For more information, see Asset hierarchies in
the AWS IoT SiteWise User Guide.
String stringValue
Asset property data of type string (sequence of characters).
Integer integerValue
Asset property data of type integer (whole number).
Double doubleValue
Asset property data of type double (floating point number).
Boolean booleanValue
Asset property data of type Boolean (true or false).
Copyright © 2021. All rights reserved.