IoTSiteWise / Paginator / ListComputationModelDataBindingUsages

ListComputationModelDataBindingUsages

class IoTSiteWise.Paginator.ListComputationModelDataBindingUsages

paginator = client.get_paginator('list_computation_model_data_binding_usages')

paginate(**kwargs)

Creates an iterator that will paginate through responses from IoTSiteWise.Client.list_computation_model_data_binding_usages().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    dataBindingValueFilter={
        'asset': {
            'assetId': 'string'
        },
        'assetModel': {
            'assetModelId': 'string'
        },
        'assetProperty': {
            'assetId': 'string',
            'propertyId': 'string'
        },
        'assetModelProperty': {
            'assetModelId': 'string',
            'propertyId': 'string'
        }
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• dataBindingValueFilter (dict) –

  [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.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

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) –

    A token to resume pagination.