IoTSiteWise / Paginator / ListCompositionRelationships


class IoTSiteWise.Paginator.ListCompositionRelationships#
paginator = client.get_paginator('list_composition_relationships')

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • assetModelId (string) –


    The ID of the asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

  • 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:



Response Syntax

    'compositionRelationshipSummaries': [
            'assetModelId': 'string',
            'assetModelCompositeModelId': 'string',
            'assetModelCompositeModelType': 'string'
    'NextToken': 'string'

Response Structure

  • (dict) –

    • compositionRelationshipSummaries (list) –

      A list that summarizes each composition relationship.

      • (dict) –

        Contains a summary of the components of the composite model.

        • assetModelId (string) –

          The ID of the asset model, in UUID format.

        • assetModelCompositeModelId (string) –

          The ID of a composite model on this asset model.

        • assetModelCompositeModelType (string) –

          The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.

    • NextToken (string) –

      A token to resume pagination.