property_values

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

Overview

Name	property_values
Type	Resource
Id	aws.iottwinmaker.property_values

Fields

The following fields are returned by SELECT queries:

get_property_value

Name	Datatype	Description
next_token	string	The string that specifies the next page of results. (pattern: <code>.*</code>)
property_values	object	An object that maps strings to the properties and latest property values in the response. Each string in the mapping must be unique to this object.
tabular_property_values	array	A table of property values.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_property_value	select	workspace_id, region		Gets the property values for a component, component type, entity, or workspace. You must specify a value for either componentName, componentTypeId, entityId, or workspaceId.
batch_put_property_values	exec	workspace_id, region, entries		Sets values for multiple time series properties.

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 ID of the workspace that contains the properties to set.

SELECT examples

get_property_value

Gets the property values for a component, component type, entity, or workspace. You must specify a value for either componentName, componentTypeId, entityId, or workspaceId.

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

Lifecycle Methods

batch_put_property_values

Sets values for multiple time series properties.

EXEC aws.iottwinmaker.property_values.batch_put_property_values 
@workspace_id='{{ workspace_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"entries": "{{ entries }}"
}'
;