asset_model_interface_relationships

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

Overview

Name	asset_model_interface_relationships
Type	Resource
Id	aws.iotsitewise.asset_model_interface_relationships

Fields

The following fields are returned by SELECT queries:

describe_asset_model_interface_relationship

Name	Datatype	Description
asset_model_id	string	The ID of the 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>)
hierarchy_mappings	array	A list of hierarchy mappings between the interface asset model and the asset model where the interface is applied.
interface_asset_model_id	string	The ID of the interface 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>)
property_mappings	array	A list of property mappings between the interface asset model and the asset model where the interface is applied.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_asset_model_interface_relationship	select	asset_model_id, interface_asset_model_id, region		Retrieves information about an interface relationship between an asset model and an interface asset model.
put_asset_model_interface_relationship	replace	asset_model_id, interface_asset_model_id, region, propertyMappingConfiguration		Creates or updates an interface relationship between an asset model and an interface asset model. This operation applies an interface to an asset model.
delete_asset_model_interface_relationship	delete	asset_model_id, interface_asset_model_id, region	clientToken	Deletes an interface relationship between an asset model and an interface asset 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.
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)
clientToken	string	A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

SELECT examples

describe_asset_model_interface_relationship

Retrieves information about an interface relationship between an asset model and an interface asset model.

SELECT
asset_model_id,
hierarchy_mappings,
interface_asset_model_id,
property_mappings
FROM aws.iotsitewise.asset_model_interface_relationships
WHERE asset_model_id = '{{ asset_model_id }}' -- required
AND interface_asset_model_id = '{{ interface_asset_model_id }}' -- required
AND region = '{{ region }}' -- required
;

REPLACE examples

put_asset_model_interface_relationship

Creates or updates an interface relationship between an asset model and an interface asset model. This operation applies an interface to an asset model.

REPLACE aws.iotsitewise.asset_model_interface_relationships
SET 
propertyMappingConfiguration = '{{ propertyMappingConfiguration }}',
clientToken = '{{ clientToken }}'
WHERE 
asset_model_id = '{{ asset_model_id }}' --required
AND interface_asset_model_id = '{{ interface_asset_model_id }}' --required
AND region = '{{ region }}' --required
AND propertyMappingConfiguration = '{{ propertyMappingConfiguration }}' --required
RETURNING
asset_model_arn,
asset_model_id,
asset_model_status,
interface_asset_model_id;

DELETE examples

delete_asset_model_interface_relationship

Deletes an interface relationship between an asset model and an interface asset model.

DELETE FROM aws.iotsitewise.asset_model_interface_relationships
WHERE asset_model_id = '{{ asset_model_id }}' --required
AND interface_asset_model_id = '{{ interface_asset_model_id }}' --required
AND region = '{{ region }}' --required
AND clientToken = '{{ clientToken }}'
;