composition_relationships

Creates, updates, deletes, gets or lists a composition_relationships resource.

Overview

Name	composition_relationships
Type	Resource
Id	aws.iotsitewise.composition_relationships

Fields

The following fields are returned by SELECT queries:

list_composition_relationships

Name	Datatype	Description
asset_model_composite_model_id	string	The ID of a composite model on this asset model. (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_model_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_model_id	string	The ID of the asset model, in UUID format. (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
list_composition_relationships	select	asset_model_id, region	nextToken, maxResults	Retrieves a paginated list of composition relationships for an asset model of type COMPONENT_MODEL.

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_model_id	string	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.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to return for each paginated request. Default: 50
nextToken	string	The token to be used for the next set of paginated results.

SELECT examples

list_composition_relationships

Retrieves a paginated list of composition relationships for an asset model of type COMPONENT_MODEL.

SELECT
asset_model_composite_model_id,
asset_model_composite_model_type,
asset_model_id
FROM aws.iotsitewise.composition_relationships
WHERE asset_model_id = '{{ asset_model_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;