IoTSiteWise / Paginator / ListInterfaceRelationships

ListInterfaceRelationships¶

class IoTSiteWise.Paginator.ListInterfaceRelationships¶

paginator = client.get_paginator('list_interface_relationships')

paginate(**kwargs)¶

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

Request Syntax

response_iterator = paginator.paginate(
    interfaceAssetModelId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

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

{
    '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) –
  
  A token to resume pagination.