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

ListComputationModelDataBindingUsages

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.

Request Syntax


POST /computation-models/data-binding-usages HTTP/1.1
Content-type: application/json

{
   "dataBindingValueFilter": { 
      "asset": { 
         "assetId": "string"
      },
      "assetModel": { 
         "assetModelId": "string"
      },
      "assetModelProperty": { 
         "assetModelId": "string",
         "propertyId": "string"
      },
      "assetProperty": { 
         "assetId": "string",
         "propertyId": "string"
      }
   },
   "maxResults": number,
   "nextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

dataBindingValueFilter

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.

Type: DataBindingValueFilter object

Required: Yes

maxResults

The maximum number of results returned for each paginated request.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 250.

Required: No

nextToken

The token used for the next set of paginated results.

Type: String

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

Pattern: [A-Za-z0-9+/=]+

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "dataBindingUsageSummaries": [ 
      { 
         "computationModelIds": [ "string" ],
         "matchedDataBinding": { 
            "value": { 
               "assetModelProperty": { 
                  "assetModelId": "string",
                  "propertyId": "string"
               },
               "assetProperty": { 
                  "assetId": "string",
                  "propertyId": "string"
               }
            }
         }
      }
   ],
   "nextToken": "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.

dataBindingUsageSummaries

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.

Type: Array of ComputationModelDataBindingUsageSummary objects

nextToken

The token for the next set of paginated results, or null if there are no additional results.

Type: String

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

Pattern: [A-Za-z0-9+/=]+

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

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