executions

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

Overview

Name	executions
Type	Resource
Id	aws.snow_device_management.executions

Fields

The following fields are returned by SELECT queries:

describe_execution

Name	Datatype	Description
execution_id	string	The ID of the execution.
last_updated_at	string (date-time)	When the status of the execution was last updated.
managed_device_id	string	The ID of the managed device that the task is being executed on.
started_at	string (date-time)	When the execution began.
state	string	The current state of the execution. (QUEUED, IN_PROGRESS, CANCELED, FAILED, SUCCEEDED, REJECTED, TIMED_OUT)
task_id	string	The ID of the task being executed on the device.

list_executions

Name	Datatype	Description
execution_id	string	The ID of the execution.
managed_device_id	string	The ID of the managed device that the task is being executed on.
state	string	The state of the execution. (QUEUED, IN_PROGRESS, CANCELED, FAILED, SUCCEEDED, REJECTED, TIMED_OUT)
task_id	string	The ID of the task.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_execution	select	managed_device_id, task_id, region		Checks the status of a remote task running on one or more target devices.
list_executions	select	taskId, region	maxResults, nextToken, state	Returns the status of tasks for one or more target devices.

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
managed_device_id	string	The ID of the managed device.
region	string	AWS region (default: us-east-1)
taskId	string	The ID of the task.
task_id	string	The ID of the task that the action is describing.
maxResults	integer	The maximum number of tasks to list per page.
nextToken	string	A pagination token to continue to the next page of tasks.
state	string	A structure used to filter the tasks by their current state.

SELECT examples

describe_execution

Checks the status of a remote task running on one or more target devices.

SELECT
execution_id,
last_updated_at,
managed_device_id,
started_at,
state,
task_id
FROM aws.snow_device_management.executions
WHERE managed_device_id = '{{ managed_device_id }}' -- required
AND task_id = '{{ task_id }}' -- required
AND region = '{{ region }}' -- required
;

list_executions

Returns the status of tasks for one or more target devices.

SELECT
execution_id,
managed_device_id,
state,
task_id
FROM aws.snow_device_management.executions
WHERE taskId = '{{ taskId }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND state = '{{ state }}'
;