properties

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

Overview

Name	properties
Type	Resource
Id	aws.iottwinmaker.properties

Fields

The following fields are returned by SELECT queries:

list_properties

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_properties	select	workspace_id, region		This API lists the properties of a component.

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
region	string	AWS region (default: us-east-1)
workspace_id	string	The workspace ID.

SELECT examples

list_properties

This API lists the properties of a component.

SELECT
next_token,
property_summaries
FROM aws.iottwinmaker.properties
WHERE workspace_id = '{{ workspace_id }}' -- required
AND region = '{{ region }}' -- required
;