asset_composite_models

Creates, updates, deletes, gets or lists an asset_composite_models resource.

Overview

Name	asset_composite_models
Type	Resource
Id	aws.iotsitewise.asset_composite_models

Fields

The following fields are returned by SELECT queries:

describe_asset_composite_model

Name	Datatype	Description
action_definitions	array	The available actions for a composite model on this asset.
asset_composite_model_description	string	A description for the composite model. (pattern: <code>[^\u0000-\u001F\u007F]+</code>)
asset_composite_model_external_id	string	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. (pattern: <code>[a-zA-Z0-9_][a-zA-Z_-0-9.:]*[a-zA-Z0-9_]+</code>)
asset_composite_model_id	string	The ID of a composite model on this asset. (pattern: <code>^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$</code>)
asset_composite_model_name	string	The unique, friendly name for the composite model. (pattern: <code>[^\u0000-\u001F\u007F]+</code>)
asset_composite_model_path	array	The path to the composite model listing the parent composite models.
asset_composite_model_properties	array	The property definitions of the composite model that was used to create the asset.
asset_composite_model_summaries	array	The list of composite model summaries.
asset_composite_model_type	string	The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY. (pattern: <code>[^\u0000-\u001F\u007F]+</code>)
asset_id	string	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. (pattern: <code>^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_asset_composite_model	select	asset_id, asset_composite_model_id, region		Retrieves information about an asset composite model (also known as an asset component). An AssetCompositeModel is an instance of an AssetModelCompositeModel. If you want to see information about the model this is based on, call DescribeAssetModelCompositeModel.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
asset_composite_model_id	string	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.
asset_id	string	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.
region	string	AWS region (default: us-east-1)

SELECT examples

describe_asset_composite_model

Retrieves information about an asset composite model (also known as an asset component). An AssetCompositeModel is an instance of an AssetModelCompositeModel. If you want to see information about the model this is based on, call DescribeAssetModelCompositeModel.

SELECT
action_definitions,
asset_composite_model_description,
asset_composite_model_external_id,
asset_composite_model_id,
asset_composite_model_name,
asset_composite_model_path,
asset_composite_model_properties,
asset_composite_model_summaries,
asset_composite_model_type,
asset_id
FROM aws.iotsitewise.asset_composite_models
WHERE asset_id = '{{ asset_id }}' -- required
AND asset_composite_model_id = '{{ asset_composite_model_id }}' -- required
AND region = '{{ region }}' -- required
;