Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeComputationModel

Retrieves information about a computation model.

Request Syntax


GET /computation-models/computationModelId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

computationModelId

The ID of the computation model.

Length Constraints: Fixed length of 36.

Pattern: ^(?!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}$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "actionDefinitions": [ 
      { 
         "actionDefinitionId": "string",
         "actionName": "string",
         "actionType": "string"
      }
   ],
   "computationModelArn": "string",
   "computationModelConfiguration": { 
      "anomalyDetection": { 
         "inputProperties": "string",
         "resultProperty": "string"
      }
   },
   "computationModelCreationDate": number,
   "computationModelDataBinding": { 
      "string" : { 
         "assetModelProperty": { 
            "assetModelId": "string",
            "propertyId": "string"
         },
         "assetProperty": { 
            "assetId": "string",
            "propertyId": "string"
         },
         "list": [ 
            "ComputationModelDataBindingValue"
         ]
      }
   },
   "computationModelDescription": "string",
   "computationModelId": "string",
   "computationModelLastUpdateDate": number,
   "computationModelName": "string",
   "computationModelStatus": { 
      "error": { 
         "code": "string",
         "details": [ 
            { 
               "code": "string",
               "message": "string"
            }
         ],
         "message": "string"
      },
      "state": "string"
   },
   "computationModelVersion": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

actionDefinitions

The available actions for this computation model.

Type: Array of ActionDefinition objects

computationModelArn

The ARN of the computation model, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:computation-model/${ComputationModelId}

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: ^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$

computationModelConfiguration

The configuration for the computation model.

Type: ComputationModelConfiguration object

computationModelCreationDate

The model creation date, in Unix epoch time.

Type: Timestamp

computationModelDataBinding

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

Type: String to ComputationModelDataBindingValue object map

Key Length Constraints: Minimum length of 1. Maximum length of 64.

Key Pattern: ^[a-z][a-z0-9_]*$

computationModelDescription

The description of the computation model.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^[a-zA-Z0-9 _\-#$*!@]+$

computationModelId

The ID of the computation model.

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^(?!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}$

computationModelLastUpdateDate

The date the model was last updated, in Unix epoch time.

Type: Timestamp

computationModelName

The name of the computation model.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^[a-zA-Z0-9 _\-#$*!@]+$

computationModelStatus

The current status of the asset model, which contains a state and an error message if any.

Type: ComputationModelStatus object

computationModelVersion

The version of the computation model.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 10.

Pattern: ^(0|([1-9]{1}\d*))$

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalFailureException

AWS IoT SiteWise can't process your request right now. Try again later.

HTTP Status Code: 500

InvalidRequestException

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

HTTP Status Code: 400

ResourceNotFoundException

The requested resource can't be found.

HTTP Status Code: 404

ThrottlingException

Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the AWS IoT SiteWise User Guide.

HTTP Status Code: 429