String id
The ID of the access policy.
Identity identity
The identity (an IAM Identity Center user, an IAM Identity Center group, or an IAM user).
Resource resource
The 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.
String stringValue
The payload of the action in a JSON string.
String actionId
The ID of the action.
String actionDefinitionId
The ID of the action definition.
TargetResource targetResource
The resource the action will be taken on.
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 alarmRoleArn
The ARN of the IAM role that allows the alarm to perform actions and access Amazon Web Services resources and services, such as IoT Events.
String notificationLambdaArn
The ARN of the Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the IoT Events Developer Guide.
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 asset composite model.
String externalId
The external ID of the asset composite model. For more information, see Using external IDs in the IoT SiteWise User Guide.
String id
The ID of the composite model that this summary describes.
String externalId
An external ID to assign to the asset model.
If the composite model is a derived composite model, or one nested inside a component model, you can only set the
external ID using UpdateAssetModelCompositeModel and specifying the derived ID of the model or
property from the created model it's a part of.
String name
The name of the composite model that this summary describes.
String type
The type of asset model.
ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.
COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
String description
A description of the composite model that this summary describes.
List<E> path
The path that includes all the components of the asset model for the asset.
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 externalId
The external ID of the hierarchy, if it has one. When you update an asset hierarchy, you may assign an external ID if it doesn't already have one. You can't change the external ID of an asset hierarchy that already has one. For more information, see Using external IDs in the IoT SiteWise User Guide.
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 composite model.
String externalId
The external ID of the asset model composite model. For more information, see Using external IDs in the IoT SiteWise User Guide.
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 to assign to the composite model, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
String externalId
An external ID to assign to the composite model. The external ID must be unique among composite models within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
String id
The ID of the the composite model that this summary describes..
String externalId
The external ID of a composite model on this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
String name
The name of the the composite model that this summary describes..
String type
The type of asset model.
ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.
COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
String description
The description of the the composite model that this summary describes..
List<E> path
The path that includes all the pieces that make up the composite model.
String id
The ID of the asset model hierarchy. This ID is a hierarchyId.
If you are callling UpdateAssetModel to create a new hierarchy: You can specify its ID here, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
If you are calling UpdateAssetModel to modify an existing hierarchy: This can be either the actual ID in
UUID format, or else externalId: followed by the external ID, if it has one. For more information,
see
Referencing objects with external IDs in the IoT SiteWise User Guide.
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, in UUID format. All assets in this hierarchy must be instances of the
childAssetModelId asset model. IoT SiteWise will always return the actual asset model ID for this
value. However, when you are specifying this value as part of a call to UpdateAssetModel, you may provide either the asset model ID or else externalId: followed by the
asset model's external ID. For more information, see Using external
IDs in the IoT SiteWise User Guide.
String externalId
The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call to UpdateAssetModel. However, you can't change the external ID if one is already assigned. For more information, see Using external IDs in the IoT SiteWise User Guide.
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. This can be either the actual ID in UUID format, or else
externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
String id
The ID to assign to the asset model hierarchy, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
String externalId
An external ID to assign to the asset model hierarchy. The external ID must be unique among asset model hierarchies within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
String id
The ID of the asset model property.
If you are callling UpdateAssetModel to create a new property: You can specify its ID here, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
If you are calling UpdateAssetModel to modify an existing property: This can be either the actual ID in
UUID format, or else externalId: followed by the external ID, if it has one. For more information,
see
Referencing objects with external IDs in the IoT SiteWise User Guide.
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).
List<E> path
The structured path to the property from the root of the asset model.
String externalId
The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call to UpdateAssetModel. However, you can't change the external ID if one is already assigned. For more information, see Using external IDs in the IoT SiteWise User Guide.
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 id
The ID to assign to the asset model property, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
String externalId
An external ID to assign to the property definition. The external ID must be unique among property definitions within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
String id
The ID of the property.
String name
The name of the property.
String dataType
The data type of the 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 property.
PropertyType type
String assetModelCompositeModelId
The ID of the composite model that contains the asset model property.
List<E> path
The structured path to the property from the root of the asset model.
String externalId
The external ID of the property. For more information, see Using external IDs in the IoT SiteWise User Guide.
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 IoT SiteWise API operations).
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 assetModelType
The type of asset model.
ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.
COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
String externalId
The external ID of the asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
String id
The ID of the asset property.
String name
The name of the property.
String alias
The 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 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.
List<E> path
The structured path to the property from the root of the asset.
String externalId
The external ID of the asset property. For more information, see Using external IDs in the IoT SiteWise User Guide.
String id
The ID of the property.
String alias
The 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 IoT SiteWise User Guide.
String unit
The unit of measure (such as Newtons or RPM) of the asset property.
PropertyNotification notification
String assetCompositeModelId
The ID of the composite model that contains the asset property.
List<E> path
The structured path to the property from the root of the asset.
String externalId
The external ID of the property. For more information, see Using external IDs in the IoT SiteWise User Guide.
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, in UUID format.
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 description
A description for the asset.
String externalId
The external ID of the asset. For more information, see Using external IDs in the IoT SiteWise User Guide.
String assetId
The ID of the parent asset. This can be either the actual ID in UUID format, or else externalId:
followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
String hierarchyId
The ID of a hierarchy in the parent asset's model. (This can be either the actual ID in UUID format, or else
externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.) 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 IoT SiteWise User Guide.
String childAssetId
The ID of the child asset to be associated. This can be either the actual ID in UUID format, or else
externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the 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 id
The ID of the asset, in UUID format.
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 description
A description for the asset.
String externalId
The external ID of the asset. For more information, see Using external IDs in the IoT SiteWise User Guide.
String alias
The alias that identifies the time series.
String assetId
The ID of the asset in which the asset property was created. This can be either the actual ID in UUID format, or
else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
String propertyId
The ID of the asset property. This can be either the actual ID in UUID format, or else externalId:
followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the 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 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 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 entryId
The ID of the entry.
String assetId
The ID of the asset in which the asset property was created.
String propertyId
The ID of the asset property, in UUID format.
String propertyAlias
The 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 IoT SiteWise User Guide.
List<E> aggregateTypes
The data aggregating function.
String resolution
The time interval over which to aggregate 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.
List<E> qualities
The quality by which to filter asset data.
String timeOrdering
The chronological sorting order of the requested information.
Default: ASCENDING
List<E> entries
The list of asset property aggregate entries for the batch get request. You can specify up to 16 entries per request.
String nextToken
The token to be used for the next set of paginated results.
Integer maxResults
The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first.
The size of the result set is equal to 1 MB.
The number of data points in the result set is equal to the value of maxResults. The maximum value
of maxResults is 4000.
List<E> errorEntries
A list of the errors (if any) associated with the batch request. Each error entry contains the
entryId of the entry that failed.
List<E> successEntries
A list of entries that were processed successfully by this batch request. Each success entry contains the
entryId of the entry that succeeded and the latest query result.
List<E> skippedEntries
A list of entries that were not processed by this batch request. because these entries had been completely
processed by previous paginated requests. Each skipped entry contains the entryId of the entry that
skipped.
String nextToken
The token for the next set of results, or null if there are no additional results.
String entryId
The ID of the entry.
String completionStatus
The completion status of each entry that is associated with the BatchGetAssetPropertyAggregates API.
BatchGetAssetPropertyAggregatesErrorInfo errorInfo
The error information, such as the error code and the timestamp.
String entryId
The ID of the entry.
String assetId
The ID of the asset in which the asset property was created.
String propertyId
The ID of the asset property, in UUID format.
String propertyAlias
The 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 IoT SiteWise User Guide.
String entryId
The ID of the entry.
String assetId
The ID of the asset in which the asset property was created.
String propertyId
The ID of the asset property, in UUID format.
String propertyAlias
The 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 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
List<E> entries
The list of asset property historical value entries for the batch get request. You can specify up to 16 entries per request.
String nextToken
The token to be used for the next set of paginated results.
Integer maxResults
The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first.
The size of the result set is equal to 4 MB.
The number of data points in the result set is equal to the value of maxResults. The maximum value
of maxResults is 20000.
List<E> errorEntries
A list of the errors (if any) associated with the batch request. Each error entry contains the
entryId of the entry that failed.
List<E> successEntries
A list of entries that were processed successfully by this batch request. Each success entry contains the
entryId of the entry that succeeded and the latest query result.
List<E> skippedEntries
A list of entries that were not processed by this batch request. because these entries had been completely
processed by previous paginated requests. Each skipped entry contains the entryId of the entry that
skipped.
String nextToken
The token for the next set of results, or null if there are no additional results.
String entryId
The ID of the entry.
String completionStatus
The completion status of each entry that is associated with the BatchGetAssetPropertyValueHistory API.
BatchGetAssetPropertyValueHistoryErrorInfo errorInfo
The error information, such as the error code and the timestamp.
List<E> errorEntries
A list of the errors (if any) associated with the batch request. Each error entry contains the
entryId of the entry that failed.
List<E> successEntries
A list of entries that were processed successfully by this batch request. Each success entry contains the
entryId of the entry that succeeded and the latest query result.
List<E> skippedEntries
A list of entries that were not processed by this batch request. because these entries had been completely
processed by previous paginated requests. Each skipped entry contains the entryId of the entry that
skipped.
String nextToken
The token for the next set of results, or null if there are no additional results.
String entryId
The ID of the entry.
String completionStatus
The completion status of each entry that is associated with the BatchGetAssetPropertyValue request.
BatchGetAssetPropertyValueErrorInfo errorInfo
The error information, such as the error code and the timestamp.
String entryId
The ID of the entry.
AssetPropertyValue assetPropertyValue
String name
The name of the column description.
ColumnType type
The type of the column description.
String scalarType
The allowed data types that the column has as it's value.
String name
The name of the property.
String type
The type of the composite model that defines this property.
Property assetProperty
String id
The ID of the composite model that contains the property.
String externalId
The external ID of the composite model that contains the property. For more information, see Using external IDs in the IoT SiteWise User Guide.
String id
The ID of the component.
String assetModelId
The ID of the asset model, in UUID format.
String assetModelCompositeModelId
The ID of a composite model on this asset model.
String assetModelCompositeModelType
The composite model type. Valid values are AWS/ALARM, CUSTOM, or
AWS/L4E_ANOMALY.
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 IAM Identity Center user, an IAM Identity Center group, or an IAM user.
Resource accessPolicyResource
The 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 IoT SiteWise resources in the IoT SiteWise User Guide.
String assetModelId
The ID of the asset model this composite model is a part of.
String parentAssetModelCompositeModelId
The ID of the parent composite model in this asset model relationship.
String assetModelCompositeModelExternalId
An external ID to assign to the composite model.
If the composite model is a derived composite model, or one nested inside a component model, you can only set the
external ID using UpdateAssetModelCompositeModel and specifying the derived ID of the model or
property from the created model it's a part of.
String assetModelCompositeModelId
The ID of the composite model. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
String assetModelCompositeModelDescription
A description for the composite model.
String assetModelCompositeModelName
A unique, friendly name for the composite model.
String assetModelCompositeModelType
The composite model type. Valid values are AWS/ALARM, CUSTOM, or
AWS/L4E_ANOMALY.
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 composedAssetModelId
The ID of a composite model on this asset.
List<E> assetModelCompositeModelProperties
The property definitions of the composite model. For more information, see <LINK>.
You can specify up to 200 properties per composite model. For more information, see Quotas in the IoT SiteWise User Guide.
String assetModelCompositeModelId
The ID of the composed asset model. You can use this ID when you call other IoT SiteWise APIs.
List<E> assetModelCompositeModelPath
The path to the composite model listing the parent composite models.
AssetModelStatus assetModelStatus
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 IoT SiteWise User Guide.
You can specify up to 200 properties per asset model. For more information, see Quotas in the 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 IoT SiteWise User Guide.
You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the IoT SiteWise User Guide.
List<E> assetModelCompositeModels
The composite models that are part of this asset model. It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model.
When creating custom composite models, you need to use CreateAssetModelCompositeModel. For more information, see <LINK>.
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 IoT SiteWise resources in the IoT SiteWise User Guide.
String assetModelId
The ID to assign to the asset model, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
String assetModelExternalId
An external ID to assign to the asset model. The external ID must be unique within your Amazon Web Services account. For more information, see Using external IDs in the IoT SiteWise User Guide.
String assetModelType
The type of asset model.
ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.
COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
String assetModelId
The ID of the asset model, in UUID format. You can use this ID when you call other IoT SiteWise API operations.
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 friendly name for the asset.
String assetModelId
The ID of the asset model from which to create the asset. This can be either the actual ID in UUID format, or
else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the 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 asset. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.
String assetDescription
A description for the asset.
String assetId
The ID to assign to the asset, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
String assetExternalId
An external ID to assign to the asset. The external ID must be unique within your Amazon Web Services account. For more information, see Using external IDs in the IoT SiteWise User Guide.
String assetId
The ID of the asset, in UUID format. This ID uniquely identifies the asset within IoT SiteWise and can be used with other IoT SiteWise API operations.
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 jobName
The unique name that helps identify the job request.
String jobRoleArn
The ARN of the IAM role that allows IoT SiteWise to read Amazon S3 data.
List<E> files
The files in the specified Amazon S3 bucket that contain your data.
ErrorReportLocation errorReportLocation
The Amazon S3 destination where errors associated with the job creation request are saved.
JobConfiguration jobConfiguration
Contains the configuration information of a job, such as the file format used to save data in Amazon S3.
Boolean adaptiveIngestion
If set to true, ingest new data into IoT SiteWise storage. Measurements with notifications, metrics and transforms are computed. If set to false, historical data is ingested into IoT SiteWise as is.
Boolean deleteFilesAfterImport
If set to true, your data files is deleted from S3, after ingestion into IoT SiteWise storage.
String jobId
The ID of the job.
String jobName
The unique name that helps identify the job request.
String jobStatus
The status of the bulk import job can be one of following values:
PENDING – IoT SiteWise is waiting for the current bulk import job to finish.
CANCELLED – The bulk import job has been canceled.
RUNNING – IoT SiteWise is processing your request to import your data from Amazon S3.
COMPLETED – IoT SiteWise successfully completed your request to import data from Amazon S3.
FAILED – IoT SiteWise couldn't process your request to import data from Amazon S3. You can use logs
saved in the specified error report location in Amazon S3 to troubleshoot issues.
COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import data from Amazon S3 with
errors. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.
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 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 IoT SiteWise resources in the 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 IoT SiteWise resources in the IoT SiteWise User Guide.
String portalName
A friendly name for the portal.
String portalDescription
A description for the portal.
String portalContactEmail
The Amazon Web Services 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 IoT SiteWise resources on your behalf. For more information, see Using service roles for IoT SiteWise Monitor in the 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 IoT SiteWise resources in the 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 IAM Identity Center to authenticate users and manage user permissions. Before
you can create a portal that uses IAM Identity Center, you must enable IAM Identity Center. For more information,
see Enabling IAM
Identity Center in the IoT SiteWise User Guide. This option is only available in Amazon Web Services
Regions other than the China Regions.
IAM – The portal uses Identity and Access Management to authenticate users and manage user
permissions.
You can't change this value after you create a portal.
Default: SSO
String notificationSenderEmail
The email address that sends alarm notifications.
If you use the IoT Events managed Lambda function to manage your emails, you must verify the sender email address in Amazon SES.
Alarms alarms
Contains the configuration information of an alarm created in an 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. For more information, see Monitoring with alarms in the IoT SiteWise Application Guide.
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 IoT SiteWise Monitor portal. You can use this URL to access portals that use IAM Identity Center for authentication. For portals that use IAM for authentication, you must use the 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 IAM Identity Center application ID, if the portal uses IAM Identity Center.
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 IoT SiteWise resources in the IoT SiteWise User Guide.
String s3ResourceArn
The ARN of the Amazon S3 object. For more information about how to find the ARN for an Amazon S3 object, see Amazon S3 resources in the Amazon Simple Storage Service User Guide.
String roleArn
The ARN of the Identity and Access Management role that allows IoT SiteWise to send data to Amazon S3.
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.
String scalarValue
Indicates if the data point is a scalar value such as integer, string, double, or Boolean.
List<E> arrayValue
Indicates if the data point is an array.
Row rowValue
Indicates if the data point is a row.
Boolean nullValue
Indicates if the data point is null.
String assetModelId
The ID of the asset model, in UUID format.
String assetModelCompositeModelId
The ID of a composite model 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
String assetModelId
The ID of the asset model to delete. This can be either the actual ID in UUID format, or else
externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the 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.
AssetModelStatus assetModelStatus
The status of the asset model, which contains a state (DELETING after successfully calling this
operation) and any error message.
String assetId
The ID of the asset to delete. This can be either the actual ID in UUID format, or else externalId:
followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the 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.
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 alias
The alias that identifies the time series.
String assetId
The ID of the asset in which the asset property was created. This can be either the actual ID in UUID format, or
else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
String propertyId
The ID of the asset property. This can be either the actual ID in UUID format, or else externalId:
followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the 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 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 (IAM Identity Center user, IAM Identity Center group, or IAM user) to which this access policy applies.
Resource accessPolicyResource
The 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 actionId
The ID of the action.
String actionId
The ID of the action.
TargetResource targetResource
The resource the action will be taken on.
String actionDefinitionId
The ID of the action definition.
ActionPayload actionPayload
The JSON payload of the action.
Date executionTime
The time the action was executed.
String assetId
The ID of the asset. This can be either the actual ID in UUID format, or else externalId: followed
by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
String assetCompositeModelId
The ID of a composite model on this asset. This can be either the actual ID in UUID format, or else
externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
String assetId
The ID of the asset, in UUID format. This ID uniquely identifies the asset within IoT SiteWise and can be used with other IoT SiteWise APIs.
String assetCompositeModelId
The ID of a composite model on this asset.
String assetCompositeModelExternalId
An external ID to assign to the asset model.
If the composite model is a component-based composite model, or one nested inside a component model, you can only
set the external ID using UpdateAssetModelCompositeModel and specifying the derived ID of the model
or property from the created model it's a part of.
List<E> assetCompositeModelPath
The path to the composite model listing the parent composite models.
String assetCompositeModelName
The unique, friendly name for the composite model.
String assetCompositeModelDescription
A description for the composite model.
String assetCompositeModelType
The composite model type. Valid values are AWS/ALARM, CUSTOM, or
AWS/L4E_ANOMALY.
List<E> assetCompositeModelProperties
The property definitions of the composite model that was used to create the asset.
List<E> assetCompositeModelSummaries
The list of composite model summaries.
List<E> actionDefinitions
The available actions for a composite model on this asset.
String assetModelId
The ID of the asset model. This can be either the actual ID in UUID format, or else externalId:
followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
String assetModelCompositeModelId
The ID of a composite model on this asset model. This can be either the actual ID in UUID format, or else
externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
String assetModelId
The ID of the asset model, in UUID format.
String assetModelCompositeModelId
The ID of a composite model on this asset model.
String assetModelCompositeModelExternalId
The external ID of a composite model on this asset model.
List<E> assetModelCompositeModelPath
The path to the composite model listing the parent composite models.
String assetModelCompositeModelName
The unique, friendly name for the composite model.
String assetModelCompositeModelDescription
The description for the composite model.
String assetModelCompositeModelType
The composite model type. Valid values are AWS/ALARM, CUSTOM, or
AWS/L4E_ANOMALY.
List<E> assetModelCompositeModelProperties
The property definitions of the composite model.
CompositionDetails compositionDetails
Metadata for the composition relationship established by using composedAssetModelId in
CreateAssetModelCompositeModel . For instance, an array detailing the path of the composition
relationship for this composite model.
List<E> assetModelCompositeModelSummaries
The list of composite model summaries for the composite model.
List<E> actionDefinitions
The available actions for a composite model on this asset model.
String assetModelId
The ID of the asset model. This can be either the actual ID in UUID format, or else externalId:
followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
Boolean excludeProperties
Whether or not to exclude asset model properties from the response.
String assetModelId
The ID of the asset model, in UUID format.
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 built-in composite models for the asset model, such as those with those of type
AWS/ALARMS.
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 assetModelType
The type of asset model.
ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.
COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
List<E> assetModelCompositeModelSummaries
The list of the immediate child custom composite model summaries for the asset model.
String assetModelExternalId
The external ID of the asset model, if any.
String assetId
The ID of the asset. This can be either the actual ID in UUID format, or else externalId: followed
by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
String propertyId
The ID of the asset property. This can be either the actual ID in UUID format, or else externalId:
followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
String assetId
The ID of the asset, in UUID format.
String assetName
The name of the asset.
String assetModelId
The ID of the asset model, in UUID format.
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 model that declares this asset property, if this asset property exists in a composite model.
String assetExternalId
The external ID of the asset. For more information, see Using external IDs in the IoT SiteWise User Guide.
String assetId
The ID of the asset. This can be either the actual ID in UUID format, or else externalId: followed
by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
Boolean excludeProperties
Whether or not to exclude asset properties from the response.
String assetId
The ID of the asset, in UUID format.
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 assetDescription
A description for the asset.
List<E> assetCompositeModelSummaries
The list of the immediate child custom composite model summaries for the asset.
String assetExternalId
The external ID of the asset, if any.
String jobId
The ID of the job.
String jobId
The ID of the job.
String jobName
The unique name that helps identify the job request.
String jobStatus
The status of the bulk import job can be one of following values:
PENDING – IoT SiteWise is waiting for the current bulk import job to finish.
CANCELLED – The bulk import job has been canceled.
RUNNING – IoT SiteWise is processing your request to import your data from Amazon S3.
COMPLETED – IoT SiteWise successfully completed your request to import data from Amazon S3.
FAILED – IoT SiteWise couldn't process your request to import data from Amazon S3. You can use logs
saved in the specified error report location in Amazon S3 to troubleshoot issues.
COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import data from Amazon S3 with
errors. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.
String jobRoleArn
The ARN of the IAM role that allows IoT SiteWise to read Amazon S3 data.
List<E> files
The files in the specified Amazon S3 bucket that contain your data.
ErrorReportLocation errorReportLocation
The Amazon S3 destination where errors associated with the job creation request are saved.
JobConfiguration jobConfiguration
Contains the configuration information of a job, such as the file format used to save data in Amazon S3.
Date jobCreationDate
The date the job was created, in Unix epoch TIME.
Date jobLastUpdateDate
The date the job was last updated, in Unix epoch time.
Boolean adaptiveIngestion
If set to true, ingest new data into IoT SiteWise storage. Measurements with notifications, metrics and transforms are computed. If set to false, historical data is ingested into IoT SiteWise as is.
Boolean deleteFilesAfterImport
If set to true, your data files is deleted from S3, after ingestion into IoT SiteWise storage.
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 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 key used for 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 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 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 IAM Identity Center application generated client ID (used with IAM Identity Center API operations). IoT
SiteWise includes portalClientId for only portals that use IAM Identity Center to authenticate
users.
String portalStartUrl
The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that use IAM Identity Center for authentication. For portals that use IAM for authentication, you must use the IoT SiteWise console to get a URL that you can use to access the portal.
String portalContactEmail
The Amazon Web Services 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 IoT SiteWise resources on your behalf. For more information, see Using service roles for IoT SiteWise Monitor in the IoT SiteWise User Guide.
String portalAuthMode
The service to use to authenticate users to the portal.
String notificationSenderEmail
The email address that sends alarm notifications.
Alarms alarms
Contains the configuration information of an alarm created in an IoT SiteWise Monitor 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 storageType
The storage tier that you specified for your data. The storageType parameter can be one of the
following values:
SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot tier. The hot tier is a
service-managed database.
MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and the hot tier. The cold
tier is a customer-managed Amazon S3 bucket.
MultiLayerStorage multiLayerStorage
Contains information about the storage destination.
String disassociatedDataStorage
Contains the storage configuration for time series (data streams) that aren't associated with asset properties.
The disassociatedDataStorage can be one of the following values:
ENABLED – IoT SiteWise accepts time series that aren't associated with asset properties.
After the disassociatedDataStorage is enabled, you can't disable it.
DISABLED – IoT SiteWise doesn't accept time series (data streams) that aren't associated with asset
properties.
For more information, see Data streams in the IoT SiteWise User Guide.
RetentionPeriod retentionPeriod
The number of days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.
ConfigurationStatus configurationStatus
Date lastUpdateDate
The date the storage configuration was last updated, in Unix epoch time.
String warmTier
A service managed storage tier optimized for analytical queries. It stores periodically uploaded, buffered and historical data ingested with the CreaeBulkImportJob API.
WarmTierRetentionPeriod warmTierRetentionPeriod
Set this period to specify how long your data is stored in the warm tier before it is deleted. You can set this only if cold tier is enabled.
String alias
The alias that identifies the time series.
String assetId
The ID of the asset in which the asset property was created. This can be either the actual ID in UUID format, or
else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
String propertyId
The ID of the asset property. This can be either the actual ID in UUID format, or else externalId:
followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
String assetId
The ID of the asset in which the asset property was created.
String propertyId
The ID of the asset property, in UUID format.
String alias
The alias that identifies the time series.
String timeSeriesId
The ID of the time series.
String dataType
The data type of the time series.
If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the
structure for this time series.
String dataTypeSpec
The data type of the structure for this time series. This parameter is required for time series that have the
STRUCT data type.
The options for this parameter depend on the type of the composite model in which you created the asset property
that is associated with your time series. Use AWS/ALARM_STATE for alarm state in alarm composite
models.
Date timeSeriesCreationDate
The date that the time series was created, in Unix epoch time.
Date timeSeriesLastUpdateDate
The date that the time series was last updated, in Unix epoch time.
String timeSeriesArn
The ARN of the time series, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId}
String assetId
The ID of the parent asset from which to disassociate the child asset. This can be either the actual ID in UUID
format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing
objects with external IDs in the IoT SiteWise User Guide.
String hierarchyId
The ID of a hierarchy in the parent asset's model. (This can be either the actual ID in UUID format, or else
externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.) 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 IoT SiteWise User Guide.
String childAssetId
The ID of the child asset to disassociate. This can be either the actual ID in UUID format, or else
externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the 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 alias
The alias that identifies the time series.
String assetId
The ID of the asset in which the asset property was created. This can be either the actual ID in UUID format, or
else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
String propertyId
The ID of the asset property. This can be either the actual ID in UUID format, or else externalId:
followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the 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 bucket
The name of the Amazon S3 bucket to which errors associated with the bulk import job are sent.
String prefix
Amazon S3 uses the prefix as a folder name to organize data in the bucket. Each Amazon S3 object has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/). For more information, see Organizing objects using prefixes in the Amazon Simple Storage Service User Guide.
TargetResource targetResource
The resource the action will be taken on.
String actionDefinitionId
The ID of the action definition.
ActionPayload actionPayload
The JSON payload of the action.
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 actionId
The ID of the action.
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 bucket
The name of the Amazon S3 bucket from which data is imported.
String key
The key of the Amazon S3 object that contains your data. Each object has a key that is a unique identifier. Each object has exactly one key.
String versionId
The version ID to identify a specific version of the Amazon S3 object that contains your data.
String state
The forwarding state for the given property.
String capabilityNamespace
The namespace of the capability configuration. For example, if you configure OPC-UA sources from the 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 IoT Greengrass.
GreengrassV2 greengrassV2
A gateway that runs on IoT Greengrass V2.
String gatewayId
The ID of the gateway device.
String gatewayName
The name of the asset.
GatewayPlatform gatewayPlatform
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, in UUID format.
String propertyId
The ID of the asset property, in UUID format.
String propertyAlias
The 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 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 return for each paginated request. A result set is returned in the two cases, whichever occurs first.
The size of the result set is equal to 1 MB.
The number of data points in the result set is equal to the value of maxResults. The maximum value
of maxResults is 2500.
String assetId
The ID of the asset, in UUID format.
String propertyId
The ID of the asset property, in UUID format.
String propertyAlias
The 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 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 return for each paginated request. A result set is returned in the two cases, whichever occurs first.
The size of the result set is equal to 4 MB.
The number of data points in the result set is equal to the value of maxResults. The maximum value
of maxResults is 20000.
String assetId
The ID of the asset, in UUID format.
String propertyId
The ID of the asset property, in UUID format.
String propertyAlias
The 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 IoT SiteWise User Guide.
AssetPropertyValue propertyValue
The current asset property value.
String assetId
The ID of the asset, in UUID format.
String propertyId
The ID of the asset property, in UUID format.
String propertyAlias
The 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 IoT SiteWise User Guide.
Long startTimeInSeconds
The exclusive start of the range from which to interpolate data, expressed in seconds in Unix epoch time.
Integer startTimeOffsetInNanos
The nanosecond offset converted from startTimeInSeconds.
Long endTimeInSeconds
The inclusive end of the range from which to interpolate data, expressed in seconds in Unix epoch time.
Integer endTimeOffsetInNanos
The nanosecond offset converted from endTimeInSeconds.
String quality
The quality of the asset property value. You can use this parameter as a filter to choose only the asset property values that have a specific quality.
Long intervalInSeconds
The time interval in seconds over which to interpolate data. Each interval starts when the previous one ends.
String nextToken
The token to be used for the next set of paginated results.
Integer maxResults
The maximum number of results to return for each paginated request. If not specified, the default value is 10.
String type
The interpolation type.
Valid values: LINEAR_INTERPOLATION | LOCF_INTERPOLATION
LINEAR_INTERPOLATION – Estimates missing data using linear interpolation.
For example, you can use this operation to return the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days. If the interpolation starts July 1, 2021, at 9 AM, IoT SiteWise returns the first interpolated value on July 2, 2021, at 9 AM, the second interpolated value on July 3, 2021, at 9 AM, and so on.
LOCF_INTERPOLATION – Estimates missing data using last observation carried forward interpolation
If no data point is found for an interval, IoT SiteWise returns the last observed data point for the previous interval and carries forward this interpolated value until a new data point is found.
For example, you can get the state of an on-off valve every 24 hours over a duration of 7 days. If the interpolation starts July 1, 2021, at 9 AM, IoT SiteWise returns the last observed data point between July 1, 2021, at 9 AM and July 2, 2021, at 9 AM as the first interpolated value. If a data point isn't found after 9 AM on July 2, 2021, IoT SiteWise uses the same interpolated value for the rest of the days.
Long intervalWindowInSeconds
The query interval for the window, in seconds. IoT SiteWise computes each interpolated value by using data points from the timestamp of each interval, minus the window to the timestamp of each interval plus the window. If not specified, the window ranges between the start time minus the interval and the end time plus the interval.
If you specify a value for the intervalWindowInSeconds parameter, the value for the
type parameter must be LINEAR_INTERPOLATION.
If a data point isn't found during the specified query window, IoT SiteWise won't return an interpolated value for the interval. This indicates that there's a gap in the ingested data points.
For example, you can get the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days. If the interpolation starts on July 1, 2021, at 9 AM with a window of 2 hours, IoT SiteWise uses the data points from 7 AM (9 AM minus 2 hours) to 11 AM (9 AM plus 2 hours) on July 2, 2021 to compute the first interpolated value. Next, IoT SiteWise uses the data points from 7 AM (9 AM minus 2 hours) to 11 AM (9 AM plus 2 hours) on July 3, 2021 to compute the second interpolated value, and so on.
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 IoT Greengrass API Reference.
String coreDeviceThingName
The name of the IoT thing for your IoT Greengrass V2 core device.
String id
The IAM Identity Center ID of the group.
UserIdentity user
An IAM Identity Center user identity.
GroupIdentity group
An IAM Identity Center 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.
TimeInNanos timestamp
Variant value
FileFormat fileFormat
The file format of the data in S3.
String id
The ID of the job.
String name
The unique name that helps identify the job request.
String status
The status of the bulk import job can be one of following values:
PENDING – IoT SiteWise is waiting for the current bulk import job to finish.
CANCELLED – The bulk import job has been canceled.
RUNNING – IoT SiteWise is processing your request to import your data from Amazon S3.
COMPLETED – IoT SiteWise successfully completed your request to import data from Amazon S3.
FAILED – IoT SiteWise couldn't process your request to import data from Amazon S3. You can use logs
saved in the specified error report location in Amazon S3 to troubleshoot issues.
COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import data from Amazon S3 with
errors. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.
String identityType
The type of identity (IAM Identity Center user, IAM Identity Center 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 return for each paginated request.
Default: 50
String targetResourceType
The type of resource.
String targetResourceId
The ID of the target resource.
String nextToken
The token to be used for the next set of paginated results.
Integer maxResults
The maximum number of results to return for each paginated request.
String assetModelId
The ID of the asset model. This can be either the actual ID in UUID format, or else externalId:
followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
String nextToken
The token to be used for the next set of paginated results.
Integer maxResults
The maximum number of results to return for each paginated request.
Default: 50
String assetModelId
The ID of the asset model. This can be either the actual ID in UUID format, or else externalId:
followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
String nextToken
The token to be used for the next set of paginated results.
Integer maxResults
The maximum number of results to return for each paginated request. If not specified, the default value is 50.
String filter
Filters the requested list of asset model properties. You can choose one of the following options:
ALL – The list includes all asset model properties for a given asset model ID.
BASE – The list includes only base asset model properties for a given asset model ID.
Default: BASE
String nextToken
The token to be used for the next set of paginated results.
Integer maxResults
The maximum number of results to return for each paginated request.
Default: 50
List<E> assetModelTypes
The type of asset model.
ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.
COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
String assetId
The ID of the asset. This can be either the actual ID in UUID format, or else externalId: followed
by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
String nextToken
The token to be used for the next set of paginated results.
Integer maxResults
The maximum number of results to return for each paginated request. If not specified, the default value is 50.
String filter
Filters the requested list of asset properties. You can choose one of the following options:
ALL – The list includes all asset properties for a given asset model ID.
BASE – The list includes only base asset properties for a given asset model ID.
Default: BASE
String assetId
The ID of the asset. This can be either the actual ID in UUID format, or else externalId: followed
by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
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 return for each paginated request.
String nextToken
The token to be used for the next set of paginated results.
Integer maxResults
The maximum number of results to return for each 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. This can be either the actual ID in UUID format, or else
externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
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. This can be either the actual ID in UUID format, or else externalId:
followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
String hierarchyId
The ID of the hierarchy by which child assets are associated to the asset. (This can be either the actual ID in
UUID format, or else externalId: followed by the external ID, if it has one. For more information,
see
Referencing objects with external IDs in the IoT SiteWise User Guide.) 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 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 return for each paginated request.
Default: 50
String assetModelId
The ID of the asset model. This can be either the actual ID in UUID format, or else externalId:
followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
String nextToken
The token to be used for the next set of paginated results.
Integer maxResults
The maximum number of results to return for each 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 IoT SiteWise resources in the IoT SiteWise User Guide.
String nextToken
The token to be used for the next set of paginated results.
Integer maxResults
The maximum number of results to return for each paginated request.
String assetId
The ID of the asset in which the asset property was created. This can be either the actual ID in UUID format, or
else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
String aliasPrefix
The alias prefix of the time series.
String timeSeriesType
The type of the time series. The time series type can be one of the following values:
ASSOCIATED – The time series is associated with an asset property.
DISASSOCIATED – The time series isn't associated with any asset property.
String level
The IoT SiteWise logging verbosity level.
MeasurementProcessingConfig processingConfig
The processing configuration for the given measurement property. You can configure measurements to be kept at the edge or forwarded to the Amazon Web Services Cloud. By default, measurements are forwarded to the cloud.
ForwardingConfig forwardingConfig
The forwarding configuration for the given measurement property.
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 IoT SiteWise User Guide.
List<E> variables
The list of variables used in the expression.
MetricWindow window
The window (time interval) over which IoT SiteWise computes the metric's aggregation expression. IoT SiteWise
computes one data point per window.
MetricProcessingConfig processingConfig
The processing configuration for the given metric property. You can configure metrics to be computed at the edge or in the Amazon Web Services Cloud. By default, metrics are forwarded to the cloud.
String computeLocation
The compute location for the given metric property.
TumblingWindow tumbling
The tumbling time interval window.
CustomerManagedS3Storage customerManagedS3Storage
Contains information about a customer managed Amazon S3 bucket.
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 IoT SiteWise Monitor portal. You can use this URL to access portals that use IAM Identity Center for authentication. For portals that use IAM for authentication, you must use the 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 IoT SiteWise resources on your behalf. For more information, see Using service roles for IoT SiteWise Monitor in the 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 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 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.
List<E> path
The structured path to the property from the root of the asset.
String externalId
The external ID of the asset property. For more information, see Using external IDs in the IoT SiteWise User Guide.
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 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 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 KMS key used for 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.
String storageType
The storage tier that you specified for your data. The storageType parameter can be one of the
following values:
SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot tier. The hot tier is a
service-managed database.
MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and the hot tier. The cold
tier is a customer-managed Amazon S3 bucket.
MultiLayerStorage multiLayerStorage
Identifies a storage destination. If you specified MULTI_LAYER_STORAGE for the storage type, you
must specify a MultiLayerStorage object.
String disassociatedDataStorage
Contains the storage configuration for time series (data streams) that aren't associated with asset properties.
The disassociatedDataStorage can be one of the following values:
ENABLED – IoT SiteWise accepts time series that aren't associated with asset properties.
After the disassociatedDataStorage is enabled, you can't disable it.
DISABLED – IoT SiteWise doesn't accept time series (data streams) that aren't associated with asset
properties.
For more information, see Data streams in the IoT SiteWise User Guide.
RetentionPeriod retentionPeriod
String warmTier
A service managed storage tier optimized for analytical queries. It stores periodically uploaded, buffered and historical data ingested with the CreaeBulkImportJob API.
WarmTierRetentionPeriod warmTierRetentionPeriod
Set this period to specify how long your data is stored in the warm tier before it is deleted. You can set this only if cold tier is enabled.
String storageType
The storage tier that you specified for your data. The storageType parameter can be one of the
following values:
SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot tier. The hot tier is a
service-managed database.
MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and the hot tier. The cold
tier is a customer-managed Amazon S3 bucket.
MultiLayerStorage multiLayerStorage
Contains information about the storage destination.
String disassociatedDataStorage
Contains the storage configuration for time series (data streams) that aren't associated with asset properties.
The disassociatedDataStorage can be one of the following values:
ENABLED – IoT SiteWise accepts time series that aren't associated with asset properties.
After the disassociatedDataStorage is enabled, you can't disable it.
DISABLED – IoT SiteWise doesn't accept time series (data streams) that aren't associated with asset
properties.
For more information, see Data streams in the IoT SiteWise User Guide.
RetentionPeriod retentionPeriod
ConfigurationStatus configurationStatus
String warmTier
A service managed storage tier optimized for analytical queries. It stores periodically uploaded, buffered and historical data ingested with the CreaeBulkImportJob API.
WarmTierRetentionPeriod warmTierRetentionPeriod
Set this period to specify how long your data is stored in the warm tier before it is deleted. You can set this only if cold tier is enabled.
PortalResource portal
A portal resource.
ProjectResource project
A project resource.
Integer numberOfDays
The number of days that your data is kept.
If you specified a value for this parameter, the unlimited parameter must be false.
Boolean unlimited
If true, your data is kept indefinitely.
If configured to true, you must not specify a value for the numberOfDays parameter.
String assetId
The ID of the asset, in UUID format.
String assetId
The ID of the asset in which the asset property was created.
String propertyId
The ID of the asset property, in UUID format.
String alias
The alias that identifies the time series.
String timeSeriesId
The ID of the time series.
String dataType
The data type of the time series.
If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the
structure for this time series.
String dataTypeSpec
The data type of the structure for this time series. This parameter is required for time series that have the
STRUCT data type.
The options for this parameter depend on the type of the composite model in which you created the asset property
that is associated with your time series. Use AWS/ALARM_STATE for alarm state in alarm composite
models.
Date timeSeriesCreationDate
The date that the time series was created, in Unix epoch time.
Date timeSeriesLastUpdateDate
The date that the time series was last updated, in Unix epoch time.
String timeSeriesArn
The ARN of the time series, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId}
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 IoT SiteWise User Guide.
List<E> variables
The list of variables used in the expression.
TransformProcessingConfig processingConfig
The processing configuration for the given transform property. You can configure transforms to be kept at the edge or forwarded to the Amazon Web Services Cloud. You can also configure transforms to be computed at the edge or in the cloud.
String computeLocation
The compute location for the given transform property.
ForwardingConfig forwardingConfig
String interval
The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.
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 IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. IoT SiteWise places the computed data point at the end of the interval.
String offset
The offset for the tumbling window. The offset parameter accepts the following:
The offset time.
For example, if you specify 18h for offset and 1d for
interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The ISO 8601 format.
For example, if you specify PT18H for offset and 1d for
interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The 24-hour clock.
For example, if you specify 00:03:00 for offset, 5m for
interval, and you create the metric at 2 PM (UTC), you get the first aggregation result at 2:03 PM
(UTC). You get the second aggregation result at 2:08 PM (UTC).
The offset time zone.
For example, if you specify 2021-07-23T18:00-08 for offset and 1d for
interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.
If you create the metric after 6 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.
String accessPolicyId
The ID of the access policy.
Identity accessPolicyIdentity
The identity for this access policy. Choose an IAM Identity Center user, an IAM Identity Center group, or an IAM user.
Resource accessPolicyResource
The 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, in UUID format.
String assetModelCompositeModelId
The ID of a composite model on this asset model.
String assetModelCompositeModelExternalId
An external ID to assign to the asset model. You can only set the external ID of the asset model if it wasn't set when it was created, or you're setting it to the exact same thing as when it was created.
String assetModelCompositeModelDescription
A description for the composite model.
String assetModelCompositeModelName
A unique, friendly name for the composite 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.
List<E> assetModelCompositeModelProperties
The property definitions of the composite model. For more information, see <LINK>.
You can specify up to 200 properties per composite model. For more information, see Quotas in the IoT SiteWise User Guide.
List<E> assetModelCompositeModelPath
The path to the composite model listing the parent composite models.
AssetModelStatus assetModelStatus
String assetModelId
The ID of the asset model to update. This can be either the actual ID in UUID format, or else
externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the 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 updated property definitions of the asset model. For more information, see Asset properties in the IoT SiteWise User Guide.
You can specify up to 200 properties per asset model. For more information, see Quotas in the 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 IoT SiteWise User Guide.
You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the IoT SiteWise User Guide.
List<E> assetModelCompositeModels
The composite models that are part of this asset model. It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model.
When creating custom composite models, you need to use CreateAssetModelCompositeModel. For more information, see <LINK>.
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 assetModelExternalId
An external ID to assign to the asset model. The asset model must not already have an external ID. The external ID must be unique within your Amazon Web Services account. For more information, see Using external IDs in the IoT SiteWise User Guide.
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. This can be either the actual ID in UUID format, or else
externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
String propertyId
The ID of the asset property to be updated. This can be either the actual ID in UUID format, or else
externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
String propertyAlias
The 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 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, IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see Interacting with other services in the 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 propertyUnit
The unit of measure (such as Newtons or RPM) of the asset property. If you don't specify a value for this
parameter, the service uses the value of the assetModelProperty in the asset model.
String assetId
The ID of the asset to update. This can be either the actual ID in UUID format, or else externalId:
followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
String assetName
A 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.
String assetDescription
A description for the asset.
String assetExternalId
An external ID to assign to the asset. The asset must not already have an external ID. The external ID must be unique within your Amazon Web Services account. For more information, see Using external IDs in the IoT SiteWise User Guide.
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 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 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 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 Amazon Web Services administrator's contact email address.
Image portalLogoImage
String roleArn
The ARN of a service role that allows the portal's users to access your IoT SiteWise resources on your behalf. For more information, see Using service roles for IoT SiteWise Monitor in the 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 notificationSenderEmail
The email address that sends alarm notifications.
Alarms alarms
Contains the configuration information of an alarm created in an 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. For more information, see Monitoring with alarms in the IoT SiteWise Application Guide.
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 IAM Identity Center 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. If the property has an external ID, you can specify externalId: followed by the
external ID. For more information, see Using external
IDs in the IoT SiteWise User Guide.
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. If the hierarchy has an external ID, you can specify externalId: followed by the external ID.
For more information, see Using external
IDs in the IoT SiteWise User Guide.
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 IoT SiteWise User Guide.
List<E> propertyPath
The path of the property.
String stringValue
Asset property data of type string (sequence of characters).
Integer integerValue
Asset property data of type integer (number that's greater than or equal to zero).
Double doubleValue
Asset property data of type double (floating point number).
Boolean booleanValue
Asset property data of type Boolean (true or false).
Copyright © 2024. All rights reserved.