components

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

Overview

Name	components
Type	Resource
Id	aws.iottwinmaker.components

Fields

The following fields are returned by SELECT queries:

list_components

Name	Datatype	Description
component_summaries	array	A list of objects that contain information about the components.
next_token	string	The string that specifies the next page of component results. (pattern: <code>.*</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_components	select	workspace_id, entity_id, region		This API lists the components of an entity.

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
entity_id	string	The ID for the entity whose metadata (component/properties) is returned by the operation.
region	string	AWS region (default: us-east-1)
workspace_id	string	The workspace ID.

SELECT examples

list_components

This API lists the components of an entity.

SELECT
component_summaries,
next_token
FROM aws.iottwinmaker.components
WHERE workspace_id = '{{ workspace_id }}' -- required
AND entity_id = '{{ entity_id }}' -- required
AND region = '{{ region }}' -- required
;