interface_relationships

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

Overview

Name	interface_relationships
Type	Resource
Id	aws.iotsitewise.interface_relationships

Fields

The following fields are returned by SELECT queries:

list_interface_relationships

Name	Datatype	Description
id	string	The ID of the asset model that has the interface applied to it. (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_interface_relationships	select	interface_asset_model_id, region	nextToken, maxResults	Retrieves a paginated list of asset models that have a specific interface asset model applied to them.

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
interface_asset_model_id	string	The ID of the interface asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID.
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_interface_relationships

Retrieves a paginated list of asset models that have a specific interface asset model applied to them.

SELECT
id
FROM aws.iotsitewise.interface_relationships
WHERE interface_asset_model_id = '{{ interface_asset_model_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;