Este producto no es compatible con el
sitio Datadog seleccionado. (
).
aws_iotsitewise_asset_model
account_id
Type: STRING
asset_model_arn
Type: STRING
Provider name: assetModelArn
Description: The ARN of the asset model, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}
asset_model_composite_model_summaries
Type: UNORDERED_LIST_STRUCT
Provider name: assetModelCompositeModelSummaries
Description: The list of the immediate child custom composite model summaries for the asset model.
description
Type: STRING
Provider name: description
Description: The description of the composite model that this summary describes..
external_id
Type: STRING
Provider name: externalId
Description: The external ID of a composite model on this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
id
Type: STRING
Provider name: id
Description: The ID of the composite model that this summary describes..
name
Type: STRING
Provider name: name
Description: The name of the composite model that this summary describes..
path
Type: UNORDERED_LIST_STRUCT
Provider name: path
Description: The path that includes all the pieces that make up the composite model.
id
Type: STRING
Provider name: id
Description: The ID of the path segment.
name
Type: STRING
Provider name: name
Description: The name of the path segment.
type
Type: STRING
Provider name: type
Description: The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.
asset_model_composite_models
Type: UNORDERED_LIST_STRUCT
Provider name: assetModelCompositeModels
Description: The list of built-in composite models for the asset model, such as those with those of type AWS/ALARMS.
description
Type: STRING
Provider name: description
Description: The description of the composite model.
external_id
Type: STRING
Provider name: externalId
Description: The external ID of the asset model composite model. For more information, see Using external IDs in the IoT SiteWise User Guide.
id
Type: STRING
Provider name: id
Description: The ID of the asset model composite model.
name
Type: STRING
Provider name: name
Description: The name of the composite model.
properties
Type: UNORDERED_LIST_STRUCT
Provider name: properties
Description: The asset property definitions for this composite model.
data_type
Type: STRING
Provider name: dataType
Description: The data type of the asset model property. If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this property.
data_type_spec
Type: STRING
Provider name: dataTypeSpec
Description: The data type of the structure for this property. This parameter exists on properties that have the STRUCT data type.
external_id
Type: STRING
Provider name: externalId
Description: 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.
id
Type: STRING
Provider name: id
Description: 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.
name
Type: STRING
Provider name: name
Description: The name of the asset model property.
path
Type: UNORDERED_LIST_STRUCT
Provider name: path
Description: The structured path to the property from the root of the asset model.
id
Type: STRING
Provider name: id
Description: The ID of the path segment.
name
Type: STRING
Provider name: name
Description: The name of the path segment.
type
Type: STRUCT
Provider name: type
Description: The property type (see PropertyType).
attribute
Type: STRUCT
Provider name: attribute
Description: Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine.
default_value
Type: STRING
Provider name: defaultValue
Description: 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.
measurement
Type: STRUCT
Provider name: measurement
Description: Specifies an asset measurement property. A measurement represents a device’s raw sensor data stream, such as timestamped temperature values or timestamped power values.
processing_config
Type: STRUCT
Provider name: processingConfig
Description: 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.
forwarding_config
Type: STRUCT
Provider name: forwardingConfig
Description: The forwarding configuration for the given measurement property.
state
Type: STRING
Provider name: state
Description: The forwarding state for the given property.
metric
Type: STRUCT
Provider name: metric
Description: 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.
expression
Type: STRING
Provider name: expression
Description: 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.
processing_config
Type: STRUCT
Provider name: processingConfig
Description: 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.
compute_location
Type: STRING
Provider name: computeLocation
Description: The compute location for the given metric property.
variables
Type: UNORDERED_LIST_STRUCT
Provider name: variables
Description: The list of variables used in the expression.
name
Type: STRING
Provider name: name
Description: The friendly name of the variable to be used in the expression.
value
Type: STRUCT
Provider name: value
Description: The variable that identifies an asset property from which to use values.
hierarchy_id
Type: STRING
Provider name: hierarchyId
Description: 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.
property_id
Type: STRING
Provider name: propertyId
Description: 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.
property_path
Type: UNORDERED_LIST_STRUCT
Provider name: propertyPath
Description: The path of the property.
id
Type: STRING
Provider name: id
Description: The ID of the path segment.
name
Type: STRING
Provider name: name
Description: The name of the path segment.
window
Type: STRUCT
Provider name: window
Description: The window (time interval) over which IoT SiteWise computes the metric’s aggregation expression. IoT SiteWise computes one data point per window.
tumbling
Type: STRUCT
Provider name: tumbling
Description: The tumbling time interval window.
interval
Type: STRING
Provider name: interval
Description: 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.
offset
Type: STRING
Provider name: offset
Description: 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.
transform
Type: STRUCT
Provider name: transform
Description: 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.
expression
Type: STRING
Provider name: expression
Description: 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.
processing_config
Type: STRUCT
Provider name: processingConfig
Description: 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.
compute_location
Type: STRING
Provider name: computeLocation
Description: The compute location for the given transform property.
forwarding_config
Type: STRUCT
Provider name: forwardingConfig
state
Type: STRING
Provider name: state
Description: The forwarding state for the given property.
variables
Type: UNORDERED_LIST_STRUCT
Provider name: variables
Description: The list of variables used in the expression.
name
Type: STRING
Provider name: name
Description: The friendly name of the variable to be used in the expression.
value
Type: STRUCT
Provider name: value
Description: The variable that identifies an asset property from which to use values.
hierarchy_id
Type: STRING
Provider name: hierarchyId
Description: 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.
property_id
Type: STRING
Provider name: propertyId
Description: 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.
property_path
Type: UNORDERED_LIST_STRUCT
Provider name: propertyPath
Description: The path of the property.
id
Type: STRING
Provider name: id
Description: The ID of the path segment.
name
Type: STRING
Provider name: name
Description: The name of the path segment.
unit
Type: STRING
Provider name: unit
Description: The unit of the asset model property, such as Newtons or RPM.
type
Type: STRING
Provider name: type
Description: The type of the composite model. For alarm composite models, this type is AWS/ALARM.
asset_model_creation_date
Type: TIMESTAMP
Provider name: assetModelCreationDate
Description: The date the asset model was created, in Unix epoch time.
asset_model_description
Type: STRING
Provider name: assetModelDescription
Description: The asset model’s description.
asset_model_external_id
Type: STRING
Provider name: assetModelExternalId
Description: The external ID of the asset model, if any.
asset_model_hierarchies
Type: UNORDERED_LIST_STRUCT
Provider name: assetModelHierarchies
Description: 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.
child_asset_model_id
Type: STRING
Provider name: childAssetModelId
Description: 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.
external_id
Type: STRING
Provider name: externalId
Description: 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.
id
Type: STRING
Provider name: id
Description: 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.
name
Type: STRING
Provider name: name
Description: The name of the asset model hierarchy that you specify by using the CreateAssetModel or UpdateAssetModel API operation.
asset_model_id
Type: STRING
Provider name: assetModelId
Description: The ID of the asset model, in UUID format.
asset_model_last_update_date
Type: TIMESTAMP
Provider name: assetModelLastUpdateDate
Description: The date the asset model was last updated, in Unix epoch time.
asset_model_name
Type: STRING
Provider name: assetModelName
Description: The name of the asset model.
asset_model_properties
Type: UNORDERED_LIST_STRUCT
Provider name: assetModelProperties
Description: 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.
data_type
Type: STRING
Provider name: dataType
Description: The data type of the asset model property. If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this property.
data_type_spec
Type: STRING
Provider name: dataTypeSpec
Description: The data type of the structure for this property. This parameter exists on properties that have the STRUCT data type.
external_id
Type: STRING
Provider name: externalId
Description: 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.
id
Type: STRING
Provider name: id
Description: 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.
name
Type: STRING
Provider name: name
Description: The name of the asset model property.
path
Type: UNORDERED_LIST_STRUCT
Provider name: path
Description: The structured path to the property from the root of the asset model.
id
Type: STRING
Provider name: id
Description: The ID of the path segment.
name
Type: STRING
Provider name: name
Description: The name of the path segment.
type
Type: STRUCT
Provider name: type
Description: The property type (see PropertyType).
attribute
Type: STRUCT
Provider name: attribute
Description: Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine.
default_value
Type: STRING
Provider name: defaultValue
Description: 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.
measurement
Type: STRUCT
Provider name: measurement
Description: Specifies an asset measurement property. A measurement represents a device’s raw sensor data stream, such as timestamped temperature values or timestamped power values.
processing_config
Type: STRUCT
Provider name: processingConfig
Description: 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.
forwarding_config
Type: STRUCT
Provider name: forwardingConfig
Description: The forwarding configuration for the given measurement property.
state
Type: STRING
Provider name: state
Description: The forwarding state for the given property.
metric
Type: STRUCT
Provider name: metric
Description: 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.
expression
Type: STRING
Provider name: expression
Description: 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.
processing_config
Type: STRUCT
Provider name: processingConfig
Description: 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.
compute_location
Type: STRING
Provider name: computeLocation
Description: The compute location for the given metric property.
variables
Type: UNORDERED_LIST_STRUCT
Provider name: variables
Description: The list of variables used in the expression.
name
Type: STRING
Provider name: name
Description: The friendly name of the variable to be used in the expression.
value
Type: STRUCT
Provider name: value
Description: The variable that identifies an asset property from which to use values.
hierarchy_id
Type: STRING
Provider name: hierarchyId
Description: 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.
property_id
Type: STRING
Provider name: propertyId
Description: 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.
property_path
Type: UNORDERED_LIST_STRUCT
Provider name: propertyPath
Description: The path of the property.
id
Type: STRING
Provider name: id
Description: The ID of the path segment.
name
Type: STRING
Provider name: name
Description: The name of the path segment.
window
Type: STRUCT
Provider name: window
Description: The window (time interval) over which IoT SiteWise computes the metric’s aggregation expression. IoT SiteWise computes one data point per window.
tumbling
Type: STRUCT
Provider name: tumbling
Description: The tumbling time interval window.
interval
Type: STRING
Provider name: interval
Description: 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.
offset
Type: STRING
Provider name: offset
Description: 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.
transform
Type: STRUCT
Provider name: transform
Description: 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.
expression
Type: STRING
Provider name: expression
Description: 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.
processing_config
Type: STRUCT
Provider name: processingConfig
Description: 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.
compute_location
Type: STRING
Provider name: computeLocation
Description: The compute location for the given transform property.
forwarding_config
Type: STRUCT
Provider name: forwardingConfig
state
Type: STRING
Provider name: state
Description: The forwarding state for the given property.
variables
Type: UNORDERED_LIST_STRUCT
Provider name: variables
Description: The list of variables used in the expression.
name
Type: STRING
Provider name: name
Description: The friendly name of the variable to be used in the expression.
value
Type: STRUCT
Provider name: value
Description: The variable that identifies an asset property from which to use values.
hierarchy_id
Type: STRING
Provider name: hierarchyId
Description: 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.
property_id
Type: STRING
Provider name: propertyId
Description: 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.
property_path
Type: UNORDERED_LIST_STRUCT
Provider name: propertyPath
Description: The path of the property.
id
Type: STRING
Provider name: id
Description: The ID of the path segment.
name
Type: STRING
Provider name: name
Description: The name of the path segment.
unit
Type: STRING
Provider name: unit
Description: The unit of the asset model property, such as Newtons or RPM.
asset_model_status
Type: STRUCT
Provider name: assetModelStatus
Description: The current status of the asset model, which contains a state and any error message.
error
Type: STRUCT
Provider name: error
Description: Contains associated error information, if any.
code
Type: STRING
Provider name: code
Description: The error code.
details
Type: UNORDERED_LIST_STRUCT
Provider name: details
Description: A list of detailed errors.
code
Type: STRING
Provider name: code
Description: The error code.
message
Type: STRING
Provider name: message
Description: The error message.
message
Type: STRING
Provider name: message
Description: The error message.
state
Type: STRING
Provider name: state
Description: The current state of the asset model.
asset_model_type
Type: STRING
Provider name: assetModelType
Description: 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.
asset_model_version
Type: STRING
Provider name: assetModelVersion
Description: The version of the asset model. See Asset model versions in the IoT SiteWise User Guide.
e_tag
Type: STRING
Provider name: eTag
Description: The entity tag (ETag) is a hash of the retrieved version of the asset model. It’s used to make concurrent updates safely to the resource. See Optimistic locking for asset model writes in the IoT SiteWise User Guide. See Optimistic locking for asset model writes in the IoT SiteWise User Guide.
Type: UNORDERED_LIST_STRING
