IoTSiteWise / Paginator / ListAssetProperties


class IoTSiteWise.Paginator.ListAssetProperties#
paginator = client.get_paginator('list_asset_properties')

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

See also: AWS API Documentation

Request Syntax

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


    The ID of the asset. 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.

  • filter (string) –

    Filters the requested list of asset properties. You can choose one of the following options:

    • ALL – The list includes all asset properties for a given asset model ID.

    • BASE – The list includes only base asset properties for a given asset model ID.

    Default: BASE

  • 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

    'assetPropertySummaries': [
            'id': 'string',
            'alias': 'string',
            'unit': 'string',
            'notification': {
                'topic': 'string',
                'state': 'ENABLED'|'DISABLED'
            'assetCompositeModelId': 'string',
            'path': [
                    'id': 'string',
                    'name': 'string'
            'externalId': 'string'
    'NextToken': 'string'

Response Structure

  • (dict) –

    • assetPropertySummaries (list) –

      A list that summarizes the properties associated with the specified asset.

      • (dict) –

        Contains a summary of a property associated with an asset.

        • id (string) –

          The ID of the property.

        • alias (string) –

          The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.

        • unit (string) –

          The unit of measure (such as Newtons or RPM) of the asset property.

        • notification (dict) –

          Contains asset property value notification information. When the notification state is enabled, IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see Interacting with other services in the IoT SiteWise User Guide.

          • topic (string) –

            The MQTT topic to which IoT SiteWise publishes property value update notifications.

          • state (string) –

            The current notification state.

        • assetCompositeModelId (string) –

          The ID of the composite model that contains the asset property.

        • path (list) –

          The structured path to the property from the root of the asset.

          • (dict) –

            Represents one level between a property and the root of the asset.

            • id (string) –

              The ID of the path segment.

            • name (string) –

              The name of the path segment.

        • externalId (string) –

          The external ID of the property. For more information, see Using external IDs in the IoT SiteWise User Guide.

    • NextToken (string) –

      A token to resume pagination.