computation_models

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

Overview

Name	computation_models
Type	Resource
Id	aws.iotsitewise.computation_models

Fields

The following fields are returned by SELECT queries:

describe_computation_model

Name	Datatype	Description
action_definitions	array	The available actions for this computation model.
computation_model_arn	string	The ARN of the computation model, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:computation-model/${ComputationModelId} (pattern: <code>^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:/_.]+$</code>)
computation_model_configuration	object	The configuration for the computation model.
computation_model_creation_date	string (date-time)	The model creation date, in Unix epoch time.
computation_model_data_binding	object	The data binding for the computation model. Key is a variable name defined in configuration. Value is a ComputationModelDataBindingValue referenced by the variable.
computation_model_description	string	The description of the computation model. (pattern: <code>^[a-zA-Z0-9 _-#$*!@]+$</code>)
computation_model_id	string	The ID of the computation model. (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>)
computation_model_last_update_date	string (date-time)	The date the model was last updated, in Unix epoch time.
computation_model_name	string	The name of the computation model. (pattern: <code>^[a-zA-Z0-9 _-#$*!@.]+$</code>)
computation_model_status	object	The current status of the asset model, which contains a state and an error message if any.
computation_model_version	string	The version of the computation model. (pattern: <code>^(0|([1-9]{1}\d*))$</code>)

list_computation_models

Name	Datatype	Description
id	string	The ID of the computation model. (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>)
name	string	The name of the computation model. (pattern: <code>^[a-zA-Z0-9 _-#$*!@.]+$</code>)
arn	string	The ARN of the computation model, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:computation-model/${ComputationModelId} (pattern: <code>^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:/_.]+$</code>)
creation_date	string (date-time)	The model creation date, in Unix epoch time.
description	string	The description of the computation model. (pattern: <code>^[a-zA-Z0-9 _-#$*!@]+$</code>)
last_update_date	string (date-time)	The time the model was last updated, in Unix epoch time.
status	object	The current status of the computation model.
type_	string	The type of the computation model. (ANOMALY_DETECTION)
version	string	The version of the computation model. (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
describe_computation_model	select	computation_model_id, region	computationModelVersion	Retrieves information about a computation model.
list_computation_models	select	region	computationModelType, nextToken, maxResults	Retrieves a paginated list of summaries of all computation models.
create_computation_model	insert	region, computationModelName, computationModelConfiguration, computationModelDataBinding		Create a computation model with a configuration and data binding.
update_computation_model	update	computation_model_id, region, computationModelName, computationModelConfiguration, computationModelDataBinding		Updates the computation model.
delete_computation_model	delete	computation_model_id, region	clientToken	Deletes a computation model. This action can't be undone.

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
computation_model_id	string	The ID of the computation model.
region	string	AWS region (default: us-east-1)
clientToken	string	A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
computationModelType	string	The type of computation model. If a computationModelType is not provided, all types of computation models are returned.
computationModelVersion	string	The version of the computation model.
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.

SELECT examples

describe_computation_model

Retrieves information about a computation model.

SELECT
action_definitions,
computation_model_arn,
computation_model_configuration,
computation_model_creation_date,
computation_model_data_binding,
computation_model_description,
computation_model_id,
computation_model_last_update_date,
computation_model_name,
computation_model_status,
computation_model_version
FROM aws.iotsitewise.computation_models
WHERE computation_model_id = '{{ computation_model_id }}' -- required
AND region = '{{ region }}' -- required
AND computationModelVersion = '{{ computationModelVersion }}'
;

list_computation_models

Retrieves a paginated list of summaries of all computation models.

SELECT
id,
name,
arn,
creation_date,
description,
last_update_date,
status,
type_,
version
FROM aws.iotsitewise.computation_models
WHERE region = '{{ region }}' -- required
AND computationModelType = '{{ computationModelType }}'
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_computation_model

Create a computation model with a configuration and data binding.

INSERT INTO aws.iotsitewise.computation_models (
computationModelName,
computationModelDescription,
computationModelConfiguration,
computationModelDataBinding,
clientToken,
tags,
region
)
SELECT 
'{{ computationModelName }}' /* required */,
'{{ computationModelDescription }}',
'{{ computationModelConfiguration }}' /* required */,
'{{ computationModelDataBinding }}' /* required */,
'{{ clientToken }}',
'{{ tags }}',
'{{ region }}'
RETURNING
computation_model_arn,
computation_model_id,
computation_model_status
;

Manifest

# Description fields are for documentation purposes
- name: computation_models
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the computation_models resource.
  - name: computationModelName
    value: "{{ computationModelName }}"
  - name: computationModelDescription
    value: "{{ computationModelDescription }}"
  - name: computationModelConfiguration
    description: |
      The configuration for the computation model.
    value:
      anomalyDetection:
        inputProperties: "{{ inputProperties }}"
        resultProperty: "{{ resultProperty }}"
  - name: computationModelDataBinding
    value: "{{ computationModelDataBinding }}"
  - name: clientToken
    value: "{{ clientToken }}"
  - name: tags
    value: "{{ tags }}"

UPDATE examples

update_computation_model

Updates the computation model.

UPDATE aws.iotsitewise.computation_models
SET 
computationModelName = '{{ computationModelName }}',
computationModelDescription = '{{ computationModelDescription }}',
computationModelConfiguration = '{{ computationModelConfiguration }}',
computationModelDataBinding = '{{ computationModelDataBinding }}',
clientToken = '{{ clientToken }}'
WHERE 
computation_model_id = '{{ computation_model_id }}' --required
AND region = '{{ region }}' --required
AND computationModelName = '{{ computationModelName }}' --required
AND computationModelConfiguration = '{{ computationModelConfiguration }}' --required
AND computationModelDataBinding = '{{ computationModelDataBinding }}' --required
RETURNING
computation_model_status;

DELETE examples

delete_computation_model

Deletes a computation model. This action can't be undone.

DELETE FROM aws.iotsitewise.computation_models
WHERE computation_model_id = '{{ computation_model_id }}' --required
AND region = '{{ region }}' --required
AND clientToken = '{{ clientToken }}'
;