executions

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

Overview

Name	executions
Type	Resource
Id	aws.iotsitewise.executions

Fields

The following fields are returned by SELECT queries:

list_executions

Name	Datatype	Description
action_type	string	The type of action exectued. (pattern: <code>[^\u0000-\u001F\u007F]+</code>)
execution_end_time	string (date-time)	The time the process ended.
execution_entity_version	string	The execution entity version associated with the summary. (pattern: <code>^(0|([1-9]{1}\d*))$</code>)
execution_id	string	The ID of the execution. (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>)
execution_start_time	string (date-time)	The time the process started.
execution_status	object	The status of the execution process.
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.
target_resource_version	string	The version of the target resource. (pattern: <code>^(0|([1-9]{1}\d*))$</code>)

describe_execution

Name	Datatype	Description
action_type	string	The type of action exectued. (pattern: <code>[^\u0000-\u001F\u007F]+</code>)
execution_details	object	Provides detailed information about the execution of your anomaly detection models. This includes model metrics and training timestamps for both training and inference actions. The training action (Amazon Web Services/ANOMALY_DETECTION_TRAINING), includes performance metrics that help you compare different versions of your anomaly detection models. These metrics provide insights into the model's performance during the training process. The inference action (Amazon Web Services/ANOMALY_DETECTION_INFERENCE), includes information about the results of executing your anomaly detection models. This helps you understand the output of your models and assess their performance.
execution_end_time	string (date-time)	The time the process ended.
execution_entity_version	string	Entity version used for the execution. (pattern: <code>^(0|([1-9]{1}\d*))$</code>)
execution_id	string	The ID of the execution. (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>)
execution_result	object	The result of the execution.
execution_start_time	string (date-time)	The time the process started.
execution_status	object	The status of the execution process.
resolve_to	object	The detailed resource this execution resolves to.
target_resource	object	The resource the action will be taken on. This can include asset-based resources and computation model resources.
target_resource_version	string	The version of the target resource. (pattern: <code>^(0|([1-9]{1}\d*))$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_executions	select	targetResourceType, targetResourceId, region	resolveToResourceType, resolveToResourceId, nextToken, maxResults, actionType	Retrieves a paginated list of summaries of all executions.
describe_execution	select	execution_id, region		Retrieves information about the execution.

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
execution_id	string	The ID of the execution.
region	string	AWS region (default: us-east-1)
targetResourceId	string	The ID of the target resource.
targetResourceType	string	The type of the target resource.
actionType	string	The type of action exectued.
maxResults	integer	The maximum number of results returned for each paginated request.
nextToken	string	The token 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_executions

Retrieves a paginated list of summaries of all executions.

SELECT
action_type,
execution_end_time,
execution_entity_version,
execution_id,
execution_start_time,
execution_status,
resolve_to,
target_resource,
target_resource_version
FROM aws.iotsitewise.executions
WHERE targetResourceType = '{{ targetResourceType }}' -- required
AND targetResourceId = '{{ targetResourceId }}' -- required
AND region = '{{ region }}' -- required
AND resolveToResourceType = '{{ resolveToResourceType }}'
AND resolveToResourceId = '{{ resolveToResourceId }}'
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
AND actionType = '{{ actionType }}'
;

describe_execution

Retrieves information about the execution.

SELECT
action_type,
execution_details,
execution_end_time,
execution_entity_version,
execution_id,
execution_result,
execution_start_time,
execution_status,
resolve_to,
target_resource,
target_resource_version
FROM aws.iotsitewise.executions
WHERE execution_id = '{{ execution_id }}' -- required
AND region = '{{ region }}' -- required
;