AWS API Changes

2025/07/28 - AWS IoT SiteWise - 10 new3 updated api methods

Changes Add support for native anomaly detection in IoT SiteWise using new Computation Model APIs

ListComputationModelDataBindingUsages (new)

Link ¶

Lists all data binding usages for computation models. This allows to identify where specific data bindings are being utilized across the computation models. This track dependencies between data sources and computation models.

See also: AWS API Documentation

Request Syntax

client.list_computation_model_data_binding_usages(
    dataBindingValueFilter={
        'asset': {
            'assetId': 'string'
        },
        'assetModel': {
            'assetModelId': 'string'
        },
        'assetProperty': {
            'assetId': 'string',
            'propertyId': 'string'
        },
        'assetModelProperty': {
            'assetModelId': 'string',
            'propertyId': 'string'
        }
    },
    nextToken='string',
    maxResults=123
)

type dataBindingValueFilter:

dict

param dataBindingValueFilter:

[REQUIRED]

A filter used to limit the returned data binding usages based on specific data binding values. You can filter by asset, asset model, asset property, or asset model property to find all computation models using these specific data sources.

asset (dict) --

Filter criteria for matching data bindings based on a specific asset. Used to list all data bindings referencing a particular asset or its properties.
- assetId (string) -- [REQUIRED]
  
  The ID of the asset to filter data bindings by. Only data bindings referencing this specific asset are matched.
assetModel (dict) --

Filter criteria for matching data bindings based on a specific asset model. Used to list all data bindings referencing a particular asset model or its properties.
- assetModelId (string) -- [REQUIRED]
  
  The ID of the asset model to filter data bindings by. Only data bindings referemncing this specific asset model are matched.
assetProperty (dict) --

Filter criteria for matching data bindings based on a specific asset property. Used to list all data bindings referencing a particular property of an asset.
- assetId (string) -- [REQUIRED]
  
  The ID of the asset containing the property to filter by. This identifies the specific asset instance containing the property of interest.
- propertyId (string) -- [REQUIRED]
  
  The ID of the property within the asset to filter by. Only data bindings referencing this specific property of the specified asset are matched.
assetModelProperty (dict) --

Filter criteria for matching data bindings based on a specific asset model property. Used to list all data bindings referencing a particular property of an asset model.
- assetModelId (string) -- [REQUIRED]
  
  The ID of the asset model containing the filter property. This identifies the specific asset model that contains the property of interest.
- propertyId (string) -- [REQUIRED]
  
  The ID of the property within the asset model to filter by. Only data bindings referencing this specific property of the specified asset model are matched.

type nextToken:

string

param nextToken:

The token used for the next set of paginated results.

type maxResults:

integer

param maxResults:

The maximum number of results returned for each paginated request.

rtype:

dict

returns:

Response Syntax

{
    'dataBindingUsageSummaries': [
        {
            'computationModelIds': [
                'string',
            ],
            'matchedDataBinding': {
                'value': {
                    'assetModelProperty': {
                        'assetModelId': 'string',
                        'propertyId': 'string'
                    },
                    'assetProperty': {
                        'assetId': 'string',
                        'propertyId': 'string'
                    }
                }
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- dataBindingUsageSummaries (list) --
  
  A list of summaries describing the data binding usages across computation models. Each summary includes the computation model IDs and the matched data binding details.
  - (dict) --
    
    A summary of how a specific data binding is used across computation models. This tracks dependencies between data sources and computation models, allowing you to understand the impact of changes to data sources.
    - computationModelIds (list) --
      
      The list of computation model IDs that use this data binding. This allows identification of all computation models affected by changes to the referenced data source.
      - (string) --
    - matchedDataBinding (dict) --
      
      The data binding matched by the filter criteria. Contains details about specific data binding values used by the computation models.
      - value (dict) --
        
        The value of the matched data binding.
        
        assetModelProperty (dict) --
        
        Contains information about an assetModelProperty binding value.
        
        assetModelId (string) --
        
        The ID of the asset model, in UUID format.
        
        propertyId (string) --
        
        The ID of the asset model property used in data binding value.
        
        assetProperty (dict) --
        
        The asset property value used in the data binding.
        
        assetId (string) --
        
        The ID of the asset containing the property. This identifies the specific asset instance's property value used in the computation model.
        
        propertyId (string) --
        
        The ID of the property within the asset. This identifies the specific property's value used in the computation model.
- nextToken (string) --
  
  The token for the next set of paginated results, or null if there are no additional results.

DescribeExecution (new)

Link ¶

Retrieves information about the execution.

See also: AWS API Documentation

Request Syntax

client.describe_execution(
    executionId='string'
)

type executionId:

string

param executionId:

[REQUIRED]

The ID of the execution.

rtype:

dict

returns:

Response Syntax

{
    'executionId': 'string',
    'actionType': 'string',
    'targetResource': {
        'assetId': 'string',
        'computationModelId': 'string'
    },
    'targetResourceVersion': 'string',
    'resolveTo': {
        'assetId': 'string'
    },
    'executionStartTime': datetime(2015, 1, 1),
    'executionEndTime': datetime(2015, 1, 1),
    'executionStatus': {
        'state': 'RUNNING'|'COMPLETED'|'FAILED'
    },
    'executionResult': {
        'string': 'string'
    },
    'executionDetails': {
        'string': 'string'
    },
    'executionEntityVersion': 'string'
}

Response Structure

(dict) --
- executionId (string) --
  
  The ID of the execution.
- actionType (string) --
  
  The type of action exectued.
- targetResource (dict) --
  
  The resource the action will be taken on.
  - assetId (string) --
    
    The ID of the asset, in UUID format.
  - computationModelId (string) --
    
    The ID of the computation model.
- targetResourceVersion (string) --
  
  The version of the target resource.
- resolveTo (dict) --
  
  The detailed resource this execution resolves to.
  - assetId (string) --
    
    The ID of the asset that the resource resolves to.
- executionStartTime (datetime) --
  
  The time the process started.
- executionEndTime (datetime) --
  
  The time the process ended.
- executionStatus (dict) --
  
  The status of the execution process.
  - state (string) --
    
    The current state of the computation model.
- executionResult (dict) --
  
  The result of the execution.
  - (string) --
    - (string) --
- executionDetails (dict) --
  
  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.
  - (string) --
    - (string) --
- executionEntityVersion (string) --
  
  Entity version used for the execution.

ListExecutions (new)

Link ¶

Retrieves a paginated list of summaries of all executions.

See also: AWS API Documentation

Request Syntax

client.list_executions(
    targetResourceType='ASSET'|'COMPUTATION_MODEL',
    targetResourceId='string',
    resolveToResourceType='ASSET',
    resolveToResourceId='string',
    nextToken='string',
    maxResults=123,
    actionType='string'
)

type targetResourceType:

string

param targetResourceType:

[REQUIRED]

The type of the target resource.

type targetResourceId:

string

param targetResourceId:

[REQUIRED]

The ID of the target resource.

type resolveToResourceType:

string

param resolveToResourceType:

The type of the resolved resource.

type resolveToResourceId:

string

param resolveToResourceId:

The ID of the resolved resource.

type nextToken:

string

param nextToken:

The token used for the next set of paginated results.

type maxResults:

integer

param maxResults:

The maximum number of results returned for each paginated request.

type actionType:

string

param actionType:

The type of action exectued.

rtype:

dict

returns:

Response Syntax

{
    'executionSummaries': [
        {
            'executionId': 'string',
            'actionType': 'string',
            'targetResource': {
                'assetId': 'string',
                'computationModelId': 'string'
            },
            'targetResourceVersion': 'string',
            'resolveTo': {
                'assetId': 'string'
            },
            'executionStartTime': datetime(2015, 1, 1),
            'executionEndTime': datetime(2015, 1, 1),
            'executionStatus': {
                'state': 'RUNNING'|'COMPLETED'|'FAILED'
            },
            'executionEntityVersion': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- executionSummaries (list) --
  
  Contains the list of execution summaries of the computation models.
  - (dict) --
    
    Contains the execution summary of the computation model.
    - executionId (string) --
      
      The ID of the execution.
    - actionType (string) --
      
      The type of action exectued.
    - targetResource (dict) --
      
      The resource the action will be taken on.
      - assetId (string) --
        
        The ID of the asset, in UUID format.
      - computationModelId (string) --
        
        The ID of the computation model.
    - targetResourceVersion (string) --
      
      The version of the target resource.
    - resolveTo (dict) --
      
      The detailed resource this execution resolves to.
      - assetId (string) --
        
        The ID of the asset that the resource resolves to.
    - executionStartTime (datetime) --
      
      The time the process started.
    - executionEndTime (datetime) --
      
      The time the process ended.
    - executionStatus (dict) --
      
      The status of the execution process.
      - state (string) --
        
        The current state of the computation model.
    - executionEntityVersion (string) --
      
      The execution entity version associated with the summary.
- nextToken (string) --
  
  The token for the next set of results, or null if there are no additional results.

DescribeComputationModel (new)

Link ¶

Retrieves information about a computation model.

See also: AWS API Documentation

Request Syntax

client.describe_computation_model(
    computationModelId='string'
)

type computationModelId:

string

param computationModelId:

[REQUIRED]

The ID of the computation model.

rtype:

dict

returns:

Response Syntax

{
    'computationModelId': 'string',
    'computationModelArn': 'string',
    'computationModelName': 'string',
    'computationModelDescription': 'string',
    'computationModelConfiguration': {
        'anomalyDetection': {
            'inputProperties': 'string',
            'resultProperty': 'string'
        }
    },
    'computationModelDataBinding': {
        'string': {
            'assetModelProperty': {
                'assetModelId': 'string',
                'propertyId': 'string'
            },
            'assetProperty': {
                'assetId': 'string',
                'propertyId': 'string'
            },
            'list': [
                {'... recursive ...'},
            ]
        }
    },
    'computationModelCreationDate': datetime(2015, 1, 1),
    'computationModelLastUpdateDate': datetime(2015, 1, 1),
    'computationModelStatus': {
        'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
        'error': {
            'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
            'message': 'string',
            'details': [
                {
                    'code': 'INCOMPATIBLE_COMPUTE_LOCATION'|'INCOMPATIBLE_FORWARDING_CONFIGURATION',
                    'message': 'string'
                },
            ]
        }
    },
    'computationModelVersion': 'string',
    'actionDefinitions': [
        {
            'actionDefinitionId': 'string',
            'actionName': 'string',
            'actionType': 'string'
        },
    ]
}

Response Structure

(dict) --
- computationModelId (string) --
  
  The ID of the computation model.
- computationModelArn (string) --
  
  The ARN of the computation model, which has the following format.
  
  arn:${Partition}:iotsitewise:${Region}:${Account}:computation-model/${ComputationModelId}
- computationModelName (string) --
  
  The name of the computation model.
- computationModelDescription (string) --
  
  The description of the computation model.
- computationModelConfiguration (dict) --
  
  The configuration for the computation model.
  - anomalyDetection (dict) --
    
    The configuration for the anomaly detection type of computation model.
    - inputProperties (string) --
      
      Define the variable name associated with input properties, with the following format ${VariableName}.
    - resultProperty (string) --
      
      Define the variable name associated with the result property, and the following format ${VariableName}.
- computationModelDataBinding (dict) --
  
  The data binding for the computation model. Key is a variable name defined in configuration. Value is a ComputationModelDataBindingValue referenced by the variable.
  - (string) --
    - (dict) --
      
      Contains computation model data binding value information, which can be one of assetModelProperty, list.
      - assetModelProperty (dict) --
        
        Specifies an asset model property data binding value.
        
        assetModelId (string) --
        
        The ID of the asset model, in UUID format.
        
        propertyId (string) --
        
        The ID of the asset model property used in data binding value.
      - assetProperty (dict) --
        
        The asset property value used for computation model data binding.
        
        assetId (string) --
        
        The ID of the asset containing the property. This identifies the specific asset instance's property value used in the computation model.
        
        propertyId (string) --
        
        The ID of the property within the asset. This identifies the specific property's value used in the computation model.
      - list (list) --
        
        Specifies a list of data binding value.
        
        (dict) --
        
        Contains computation model data binding value information, which can be one of assetModelProperty, list.
- computationModelCreationDate (datetime) --
  
  The model creation date, in Unix epoch time.
- computationModelLastUpdateDate (datetime) --
  
  The date the model was last updated, in Unix epoch time.
- computationModelStatus (dict) --
  
  The current status of the asset model, which contains a state and an error message if any.
  - state (string) --
    
    The current state of the computation model.
  - error (dict) --
    
    Contains the details of an IoT SiteWise error.
    - code (string) --
      
      The error code.
    - message (string) --
      
      The error message.
    - details (list) --
      
      A list of detailed errors.
      - (dict) --
        
        Contains detailed error information.
        
        code (string) --
        
        The error code.
        
        message (string) --
        
        The error message.
- computationModelVersion (string) --
  
  The version of the computation model.
- actionDefinitions (list) --
  
  The available actions for this computation model.
  - (dict) --
    
    Contains a definition for an action.
    - actionDefinitionId (string) --
      
      The ID of the action definition.
    - actionName (string) --
      
      The name of the action definition.
    - actionType (string) --
      
      The type of the action definition.

DescribeComputationModelExecutionSummary (new)

Link ¶

Retrieves information about the execution summary of a computation model.

See also: AWS API Documentation

Request Syntax

client.describe_computation_model_execution_summary(
    computationModelId='string',
    resolveToResourceType='ASSET',
    resolveToResourceId='string'
)

type computationModelId:

string

param computationModelId:

[REQUIRED]

The ID of the computation model.

type resolveToResourceType:

string

param resolveToResourceType:

The type of the resolved resource.

type resolveToResourceId:

string

param resolveToResourceId:

The ID of the resolved resource.

rtype:

dict

returns:

Response Syntax

{
    'computationModelId': 'string',
    'resolveTo': {
        'assetId': 'string'
    },
    'computationModelExecutionSummary': {
        'string': 'string'
    }
}

Response Structure

(dict) --
- computationModelId (string) --
  
  The ID of the computation model.
- resolveTo (dict) --
  
  The detailed resource this execution summary resolves to.
  - assetId (string) --
    
    The ID of the asset that the resource resolves to.
- computationModelExecutionSummary (dict) --
  
  Contains the execution summary of the computation model.
  - (string) --
    - (string) --

ListComputationModels (new)

Link ¶

Retrieves a paginated list of summaries of all computation models.

See also: AWS API Documentation

Request Syntax

client.list_computation_models(
    computationModelType='ANOMALY_DETECTION',
    nextToken='string',
    maxResults=123
)

type computationModelType:

string

param computationModelType:

The type of computation model. If a computationModelType is not provided, all types of computation models are returned.

type nextToken:

string

param nextToken:

The token to be used for the next set of paginated results.

type maxResults:

integer

param maxResults:

The maximum number of results to return for each paginated request.

rtype:

dict

returns:

Response Syntax

{
    'computationModelSummaries': [
        {
            'id': 'string',
            'arn': 'string',
            'name': 'string',
            'description': 'string',
            'type': 'ANOMALY_DETECTION',
            'creationDate': datetime(2015, 1, 1),
            'lastUpdateDate': datetime(2015, 1, 1),
            'status': {
                'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
                'error': {
                    'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
                    'message': 'string',
                    'details': [
                        {
                            'code': 'INCOMPATIBLE_COMPUTE_LOCATION'|'INCOMPATIBLE_FORWARDING_CONFIGURATION',
                            'message': 'string'
                        },
                    ]
                }
            },
            'version': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- computationModelSummaries (list) --
  
  A list summarizing each computation model.
  - (dict) --
    
    Contains a summary of a computation model.
    - id (string) --
      
      The ID of the computation model.
    - arn (string) --
      
      The ARN of the computation model, which has the following format.
      
      arn:${Partition}:iotsitewise:${Region}:${Account}:computation-model/${ComputationModelId}
    - name (string) --
      
      The name of the computation model.
    - description (string) --
      
      The description of the computation model.
    - type (string) --
      
      The type of the computation model.
    - creationDate (datetime) --
      
      The model creation date, in Unix epoch time.
    - lastUpdateDate (datetime) --
      
      The time the model was last updated, in Unix epoch time.
    - status (dict) --
      
      The current status of the computation model.
      - state (string) --
        
        The current state of the computation model.
      - error (dict) --
        
        Contains the details of an IoT SiteWise error.
        
        code (string) --
        
        The error code.
        
        message (string) --
        
        The error message.
        
        details (list) --
        
        A list of detailed errors.
        
        (dict) --
        
        Contains detailed error information.
        
        code (string) --
        
        The error code.
        
        message (string) --
        
        The error message.
    - version (string) --
      
      The version of the computation model.
- nextToken (string) --
  
  The token for the next set of results, or null if there are no additional results.

UpdateComputationModel (new)

Link ¶

Updates the computation model.

See also: AWS API Documentation

Request Syntax

client.update_computation_model(
    computationModelId='string',
    computationModelName='string',
    computationModelDescription='string',
    computationModelConfiguration={
        'anomalyDetection': {
            'inputProperties': 'string',
            'resultProperty': 'string'
        }
    },
    computationModelDataBinding={
        'string': {
            'assetModelProperty': {
                'assetModelId': 'string',
                'propertyId': 'string'
            },
            'assetProperty': {
                'assetId': 'string',
                'propertyId': 'string'
            },
            'list': [
                {'... recursive ...'},
            ]
        }
    },
    clientToken='string'
)

type computationModelId:

string

param computationModelId:

[REQUIRED]

The ID of the computation model.

type computationModelName:

string

param computationModelName:

[REQUIRED]

The name of the computation model.

type computationModelDescription:

string

param computationModelDescription:

The description of the computation model.

type computationModelConfiguration:

dict

param computationModelConfiguration:

[REQUIRED]

The configuration for the computation model.

anomalyDetection (dict) --

The configuration for the anomaly detection type of computation model.
- inputProperties (string) -- [REQUIRED]
  
  Define the variable name associated with input properties, with the following format ${VariableName}.
- resultProperty (string) -- [REQUIRED]
  
  Define the variable name associated with the result property, and the following format ${VariableName}.

type computationModelDataBinding:

dict

param computationModelDataBinding:

[REQUIRED]

The data binding for the computation model. Key is a variable name defined in configuration. Value is a ComputationModelDataBindingValue referenced by the variable.

(string) --
- (dict) --
  
  Contains computation model data binding value information, which can be one of assetModelProperty, list.
  - assetModelProperty (dict) --
    
    Specifies an asset model property data binding value.
    - assetModelId (string) -- [REQUIRED]
      
      The ID of the asset model, in UUID format.
    - propertyId (string) -- [REQUIRED]
      
      The ID of the asset model property used in data binding value.
  - assetProperty (dict) --
    
    The asset property value used for computation model data binding.
    - assetId (string) -- [REQUIRED]
      
      The ID of the asset containing the property. This identifies the specific asset instance's property value used in the computation model.
    - propertyId (string) -- [REQUIRED]
      
      The ID of the property within the asset. This identifies the specific property's value used in the computation model.
  - list (list) --
    
    Specifies a list of data binding value.
    - (dict) --
      
      Contains computation model data binding value information, which can be one of assetModelProperty, list.

type clientToken:

string

param clientToken:

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.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'computationModelStatus': {
        'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
        'error': {
            'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
            'message': 'string',
            'details': [
                {
                    'code': 'INCOMPATIBLE_COMPUTE_LOCATION'|'INCOMPATIBLE_FORWARDING_CONFIGURATION',
                    'message': 'string'
                },
            ]
        }
    }
}

Response Structure

(dict) --
- computationModelStatus (dict) --
  
  The status of the computation model. It contains a state (UPDATING after successfully calling this operation) and an error message if any.
  - state (string) --
    
    The current state of the computation model.
  - error (dict) --
    
    Contains the details of an IoT SiteWise error.
    - code (string) --
      
      The error code.
    - message (string) --
      
      The error message.
    - details (list) --
      
      A list of detailed errors.
      - (dict) --
        
        Contains detailed error information.
        
        code (string) --
        
        The error code.
        
        message (string) --
        
        The error message.

ListComputationModelResolveToResources (new)

Link ¶

Lists all distinct resources that are resolved from the executed actions of the computation model.

See also: AWS API Documentation

Request Syntax

client.list_computation_model_resolve_to_resources(
    computationModelId='string',
    nextToken='string',
    maxResults=123
)

type computationModelId:

string

param computationModelId:

[REQUIRED]

The ID of the computation model for which to list resolved resources.

type nextToken:

string

param nextToken:

The token used for the next set of paginated results.

type maxResults:

integer

param maxResults:

The maximum number of results returned for each paginated request.

rtype:

dict

returns:

Response Syntax

{
    'computationModelResolveToResourceSummaries': [
        {
            'resolveTo': {
                'assetId': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- computationModelResolveToResourceSummaries (list) --
  
  A list of summaries describing the distinct resources that this computation model resolves to when actions were executed.
  - (dict) --
    
    A summary of the resource that a computation model resolves to.
    - resolveTo (dict) --
      
      The detailed resource this execution summary resolves to.
      - assetId (string) --
        
        The ID of the asset that the resource resolves to.
- nextToken (string) --
  
  The token for the next set of paginated results, or null if there are no additional results.

DeleteComputationModel (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.delete_computation_model(
    computationModelId='string',
    clientToken='string'
)

type computationModelId:

string

param computationModelId:

[REQUIRED]

The ID of the computation model.

type clientToken:

string

param clientToken:

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.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'computationModelStatus': {
        'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
        'error': {
            'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
            'message': 'string',
            'details': [
                {
                    'code': 'INCOMPATIBLE_COMPUTE_LOCATION'|'INCOMPATIBLE_FORWARDING_CONFIGURATION',
                    'message': 'string'
                },
            ]
        }
    }
}

Response Structure

(dict) --
- computationModelStatus (dict) --
  
  The status of the computation model. It contains a state (DELETING after successfully calling this operation) and any error messages.
  - state (string) --
    
    The current state of the computation model.
  - error (dict) --
    
    Contains the details of an IoT SiteWise error.
    - code (string) --
      
      The error code.
    - message (string) --
      
      The error message.
    - details (list) --
      
      A list of detailed errors.
      - (dict) --
        
        Contains detailed error information.
        
        code (string) --
        
        The error code.
        
        message (string) --
        
        The error message.

CreateComputationModel (new)

Link ¶

Create a computation model with a configuration and data binding.

See also: AWS API Documentation

Request Syntax

client.create_computation_model(
    computationModelName='string',
    computationModelDescription='string',
    computationModelConfiguration={
        'anomalyDetection': {
            'inputProperties': 'string',
            'resultProperty': 'string'
        }
    },
    computationModelDataBinding={
        'string': {
            'assetModelProperty': {
                'assetModelId': 'string',
                'propertyId': 'string'
            },
            'assetProperty': {
                'assetId': 'string',
                'propertyId': 'string'
            },
            'list': [
                {'... recursive ...'},
            ]
        }
    },
    clientToken='string',
    tags={
        'string': 'string'
    }
)

type computationModelName:

string

param computationModelName:

[REQUIRED]

The name of the computation model.

type computationModelDescription:

string

param computationModelDescription:

The description of the computation model.

type computationModelConfiguration:

dict

param computationModelConfiguration:

[REQUIRED]

The configuration for the computation model.

anomalyDetection (dict) --

The configuration for the anomaly detection type of computation model.
- inputProperties (string) -- [REQUIRED]
  
  Define the variable name associated with input properties, with the following format ${VariableName}.
- resultProperty (string) -- [REQUIRED]
  
  Define the variable name associated with the result property, and the following format ${VariableName}.

type computationModelDataBinding:

dict

param computationModelDataBinding:

[REQUIRED]

The data binding for the computation model. Key is a variable name defined in configuration. Value is a ComputationModelDataBindingValue referenced by the variable.

(string) --
- (dict) --
  
  Contains computation model data binding value information, which can be one of assetModelProperty, list.
  - assetModelProperty (dict) --
    
    Specifies an asset model property data binding value.
    - assetModelId (string) -- [REQUIRED]
      
      The ID of the asset model, in UUID format.
    - propertyId (string) -- [REQUIRED]
      
      The ID of the asset model property used in data binding value.
  - assetProperty (dict) --
    
    The asset property value used for computation model data binding.
    - assetId (string) -- [REQUIRED]
      
      The ID of the asset containing the property. This identifies the specific asset instance's property value used in the computation model.
    - propertyId (string) -- [REQUIRED]
      
      The ID of the property within the asset. This identifies the specific property's value used in the computation model.
  - list (list) --
    
    Specifies a list of data binding value.
    - (dict) --
      
      Contains computation model data binding value information, which can be one of assetModelProperty, list.

type clientToken:

string

param clientToken:

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.

This field is autopopulated if not provided.

type tags:

dict

param tags:

A list of key-value pairs that contain metadata for the asset. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.

(string) --
- (string) --

rtype:

dict

returns:

Response Syntax

{
    'computationModelId': 'string',
    'computationModelArn': 'string',
    'computationModelStatus': {
        'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
        'error': {
            'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
            'message': 'string',
            'details': [
                {
                    'code': 'INCOMPATIBLE_COMPUTE_LOCATION'|'INCOMPATIBLE_FORWARDING_CONFIGURATION',
                    'message': 'string'
                },
            ]
        }
    }
}

Response Structure

(dict) --
- computationModelId (string) --
  
  The ID of the computation model.
- computationModelArn (string) --
  
  The ARN of the computation model, which has the following format.
  
  arn:${Partition}:iotsitewise:${Region}:${Account}:computation-model/${ComputationModelId}
- computationModelStatus (dict) --
  
  The status of the computation model, containing a state (CREATING after successfully calling this operation) and any error messages.
  - state (string) --
    
    The current state of the computation model.
  - error (dict) --
    
    Contains the details of an IoT SiteWise error.
    - code (string) --
      
      The error code.
    - message (string) --
      
      The error message.
    - details (list) --
      
      A list of detailed errors.
      - (dict) --
        
        Contains detailed error information.
        
        code (string) --
        
        The error code.
        
        message (string) --
        
        The error message.

DescribeAction (updated)

Link ¶
Changes (response)

{'resolveTo': {'assetId': 'string'},
 'targetResource': {'computationModelId': 'string'}}

Retrieves information about an action.

See also: AWS API Documentation

Request Syntax

client.describe_action(
    actionId='string'
)

type actionId:

string

param actionId:

[REQUIRED]

The ID of the action.

rtype:

dict

returns:

Response Syntax

{
    'actionId': 'string',
    'targetResource': {
        'assetId': 'string',
        'computationModelId': 'string'
    },
    'actionDefinitionId': 'string',
    'actionPayload': {
        'stringValue': 'string'
    },
    'executionTime': datetime(2015, 1, 1),
    'resolveTo': {
        'assetId': 'string'
    }
}

Response Structure

(dict) --
- actionId (string) --
  
  The ID of the action.
- targetResource (dict) --
  
  The resource the action will be taken on.
  - assetId (string) --
    
    The ID of the asset, in UUID format.
  - computationModelId (string) --
    
    The ID of the computation model.
- actionDefinitionId (string) --
  
  The ID of the action definition.
- actionPayload (dict) --
  
  The JSON payload of the action.
  - stringValue (string) --
    
    The payload of the action in a JSON string.
- executionTime (datetime) --
  
  The time the action was executed.
- resolveTo (dict) --
  
  The detailed resource this action resolves to.
  - assetId (string) --
    
    The ID of the asset that the resource resolves to.

ExecuteAction (updated)

Link ¶
Changes (request)

{'resolveTo': {'assetId': 'string'},
 'targetResource': {'computationModelId': 'string'}}

Executes an action on a target resource.

See also: AWS API Documentation

Request Syntax

client.execute_action(
    targetResource={
        'assetId': 'string',
        'computationModelId': 'string'
    },
    actionDefinitionId='string',
    actionPayload={
        'stringValue': 'string'
    },
    clientToken='string',
    resolveTo={
        'assetId': 'string'
    }
)

type targetResource:

dict

param targetResource:

[REQUIRED]

The resource the action will be taken on.

assetId (string) --

The ID of the asset, in UUID format.
computationModelId (string) --

The ID of the computation model.

type actionDefinitionId:

string

param actionDefinitionId:

[REQUIRED]

The ID of the action definition.

type actionPayload:

dict

param actionPayload:

[REQUIRED]

The JSON payload of the action.

stringValue (string) -- [REQUIRED]

The payload of the action in a JSON string.

type clientToken:

string

param clientToken:

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.

type resolveTo:

dict

param resolveTo:

The detailed resource this action resolves to.

assetId (string) -- [REQUIRED]

The ID of the asset that the resource resolves to.

rtype:

dict

returns:

Response Syntax

{
    'actionId': 'string'
}

Response Structure

(dict) --
- actionId (string) --
  
  The ID of the action.

ListActions (updated)

Link ¶
Changes (request, response)
Request

{'resolveToResourceId': 'string',
 'resolveToResourceType': 'ASSET',
 'targetResourceType': {'COMPUTATION_MODEL'}}

Response

{'actionSummaries': {'resolveTo': {'assetId': 'string'},
                     'targetResource': {'computationModelId': 'string'}}}

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

See also: AWS API Documentation

Request Syntax

client.list_actions(
    targetResourceType='ASSET'|'COMPUTATION_MODEL',
    targetResourceId='string',
    nextToken='string',
    maxResults=123,
    resolveToResourceType='ASSET',
    resolveToResourceId='string'
)

type targetResourceType:

string

param targetResourceType:

[REQUIRED]

The type of resource.

type targetResourceId:

string

param targetResourceId:

[REQUIRED]

The ID of the target resource.

type nextToken:

string

param nextToken:

The token to be used for the next set of paginated results.

type maxResults:

integer

param maxResults:

The maximum number of results to return for each paginated request.

type resolveToResourceType:

string

param resolveToResourceType:

The type of the resolved resource.

type resolveToResourceId:

string

param resolveToResourceId:

The ID of the resolved resource.

rtype:

dict

returns:

Response Syntax

{
    'actionSummaries': [
        {
            'actionId': 'string',
            'actionDefinitionId': 'string',
            'targetResource': {
                'assetId': 'string',
                'computationModelId': 'string'
            },
            'resolveTo': {
                'assetId': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- actionSummaries (list) --
  
  A list that summarizes the actions associated with the specified asset.
  - (dict) --
    
    Contains the summary of the actions.
    - actionId (string) --
      
      The ID of the action.
    - actionDefinitionId (string) --
      
      The ID of the action definition.
    - targetResource (dict) --
      
      The resource the action will be taken on.
      - assetId (string) --
        
        The ID of the asset, in UUID format.
      - computationModelId (string) --
        
        The ID of the computation model.
    - resolveTo (dict) --
      
      The detailed resource this action resolves to.
      - assetId (string) --
        
        The ID of the asset that the resource resolves to.
- nextToken (string) --
  
  The token for the next set of results, or null if there are no additional results.