AWS IoT SiteWise

{'computationModelVersion': 'string'}

Retrieves information about a computation model.

See also: AWS API Documentation

Request Syntax

client.describe_computation_model(
    computationModelId='string',
    computationModelVersion='string'
)

type computationModelId:

string

param computationModelId:

[REQUIRED]

The ID of the computation model.

type computationModelVersion:

string

param computationModelVersion:

The version 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.