actions

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

Overview

Name	actions
Type	Resource
Id	aws.iotsitewise.actions

Fields

The following fields are returned by SELECT queries:

list_actions

Name	Datatype	Description
action_definition_id	string	The ID of the action definition. (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>)
action_id	string	The ID of the action. (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>)
resolve_to	object	The detailed resource this execution summary resolves to.
target_resource	object	The resource the action will be taken on. This can include asset-based resources and computation model resources.

describe_action

Name	Datatype	Description
action_definition_id	string	The ID of the action definition. (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>)
action_id	string	The ID of the action. (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>)
action_payload	object	The JSON payload of the action.
execution_time	string (date-time)	The time the action was executed.
resolve_to	object	The detailed resource this action resolves to.
target_resource	object	The resource the action will be taken on.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_actions	select	targetResourceType, targetResourceId, region	nextToken, maxResults, resolveToResourceType, resolveToResourceId	Retrieves a paginated list of actions for a specific target resource.
describe_action	select	action_id, region		Retrieves information about an action.

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
action_id	string	The ID of the action.
region	string	AWS region (default: us-east-1)
targetResourceId	string	The ID of the target resource.
targetResourceType	string	The type of resource.
maxResults	integer	The maximum number of results to return for each paginated request.
nextToken	string	The token to be used for the next set of paginated results.
resolveToResourceId	string	The ID of the resolved resource.
resolveToResourceType	string	The type of the resolved resource.

SELECT examples

list_actions

Retrieves a paginated list of actions for a specific target resource.

SELECT
action_definition_id,
action_id,
resolve_to,
target_resource
FROM aws.iotsitewise.actions
WHERE targetResourceType = '{{ targetResourceType }}' -- required
AND targetResourceId = '{{ targetResourceId }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
AND resolveToResourceType = '{{ resolveToResourceType }}'
AND resolveToResourceId = '{{ resolveToResourceId }}'
;

describe_action

Retrieves information about an action.

SELECT
action_definition_id,
action_id,
action_payload,
execution_time,
resolve_to,
target_resource
FROM aws.iotsitewise.actions
WHERE action_id = '{{ action_id }}' -- required
AND region = '{{ region }}' -- required
;