This product is not supported for your selected Datadog site. ().
This page is not yet available in Spanish. We are working on its translation.
If you have any questions or feedback about our current translation project, feel free to reach out to us!

aws_iotsitewise_asset

account_id

Type: STRING

asset_arn

Type: STRING
Provider name: assetArn
Description: The ARN of the asset, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}

asset_composite_model_summaries

Type: UNORDERED_LIST_STRUCT
Provider name: assetCompositeModelSummaries
Description: The list of the immediate child custom composite model summaries for the asset.

  • description
    Type: STRING
    Provider name: description
    Description: A description of the composite model that this summary describes.
  • external_id
    Type: STRING
    Provider name: externalId
    Description: 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.
  • 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 components of the asset model for the asset.
    • 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 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_composite_models

Type: UNORDERED_LIST_STRUCT
Provider name: assetCompositeModels
Description: The composite models for the asset.

  • 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 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 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 properties that this composite model defines.
    • alias
      Type: STRING
      Provider name: alias
      Description: 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.
    • data_type
      Type: STRING
      Provider name: dataType
      Description: The data type of the asset 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 of the asset property. 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 property.
    • name
      Type: STRING
      Provider name: name
      Description: The name of the property.
    • notification
      Type: STRUCT
      Provider name: notification
      Description: The asset property’s notification topic and state. For more information, see UpdateAssetProperty.
      • state
        Type: STRING
        Provider name: state
        Description: The current notification state.
      • topic
        Type: STRING
        Provider name: topic
        Description: The MQTT topic to which IoT SiteWise publishes property value update notifications.
    • path
      Type: UNORDERED_LIST_STRUCT
      Provider name: path
      Description: The structured path to the property from the root of the asset.
      • 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 (such as Newtons or RPM) of the asset property.
  • type
    Type: STRING
    Provider name: type
    Description: The type of the composite model. For alarm composite models, this type is AWS/ALARM.

asset_creation_date

Type: TIMESTAMP
Provider name: assetCreationDate
Description: The date the asset was created, in Unix epoch time.

asset_description

Type: STRING
Provider name: assetDescription
Description: A description for the asset.

asset_external_id

Type: STRING
Provider name: assetExternalId
Description: The external ID of the asset, if any.

asset_hierarchies

Type: UNORDERED_LIST_STRUCT
Provider name: assetHierarchies
Description: A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed parent/child asset relationships.

  • external_id
    Type: STRING
    Provider name: externalId
    Description: 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.
  • id
    Type: STRING
    Provider name: id
    Description: The ID of the hierarchy. This ID is a hierarchyId.
  • name
    Type: STRING
    Provider name: name
    Description: The hierarchy name provided in the CreateAssetModel or UpdateAssetModel API operation.

asset_id

Type: STRING
Provider name: assetId
Description: The ID of the asset, in UUID format.

asset_last_update_date

Type: TIMESTAMP
Provider name: assetLastUpdateDate
Description: The date the asset was last updated, in Unix epoch time.

asset_model_id

Type: STRING
Provider name: assetModelId
Description: The ID of the asset model that was used to create the asset.

asset_name

Type: STRING
Provider name: assetName
Description: The name of the asset.

asset_properties

Type: UNORDERED_LIST_STRUCT
Provider name: assetProperties
Description: 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.

  • alias
    Type: STRING
    Provider name: alias
    Description: 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.
  • data_type
    Type: STRING
    Provider name: dataType
    Description: The data type of the asset 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 of the asset property. 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 property.
  • name
    Type: STRING
    Provider name: name
    Description: The name of the property.
  • notification
    Type: STRUCT
    Provider name: notification
    Description: The asset property’s notification topic and state. For more information, see UpdateAssetProperty.
    • state
      Type: STRING
      Provider name: state
      Description: The current notification state.
    • topic
      Type: STRING
      Provider name: topic
      Description: The MQTT topic to which IoT SiteWise publishes property value update notifications.
  • path
    Type: UNORDERED_LIST_STRUCT
    Provider name: path
    Description: The structured path to the property from the root of the asset.
    • 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 (such as Newtons or RPM) of the asset property.

asset_status

Type: STRUCT
Provider name: assetStatus
Description: The current status of the asset, 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 status of the asset.

tags

Type: UNORDERED_LIST_STRING