IoTSiteWise / Client / list_interface_relationships

list_interface_relationships

IoTSiteWise.Client.list_interface_relationships(**kwargs)

Retrieves a paginated list of asset models that have a specific interface asset model applied to them.

See also: AWS API Documentation

Request Syntax

response = client.list_interface_relationships(
    interfaceAssetModelId='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • interfaceAssetModelId (string) –

    [REQUIRED]

    The ID of the interface asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID.

  • nextToken (string) – The token to be used for the next set of paginated results.

  • maxResults (integer) – The maximum number of results to return for each paginated request. Default: 50

Return type:

dict

Returns:

Response Syntax

{
    'interfaceRelationshipSummaries': [
        {
            'id': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • interfaceRelationshipSummaries (list) –

      A list that summarizes each interface relationship.

      • (dict) –

        Contains summary information about an interface relationship, which defines how an interface is applied to an asset model. This summary provides the essential identifiers needed to retrieve detailed information about the relationship.

        • id (string) –

          The ID of the asset model that has the interface applied to it.

    • nextToken (string) –

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

Exceptions