:doc:`IoTSiteWise <../../iotsitewise>` / Paginator / ListAssetProperties

*******************
ListAssetProperties
*******************



.. py:class:: IoTSiteWise.Paginator.ListAssetProperties

  ::

    
    paginator = client.get_paginator('list_asset_properties')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`IoTSiteWise.Client.list_asset_properties`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListAssetProperties>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          assetId='string',
          filter='ALL'|'BASE',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type assetId: string
    :param assetId: **[REQUIRED]** 

      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 <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references>`__ in the *IoT SiteWise User Guide*.

      

    
    :type filter: string
    :param filter: 

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

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'assetPropertySummaries': [
                {
                    'id': 'string',
                    'externalId': 'string',
                    'alias': 'string',
                    'unit': 'string',
                    'notification': {
                        'topic': 'string',
                        'state': 'ENABLED'|'DISABLED'
                    },
                    'assetCompositeModelId': 'string',
                    'path': [
                        {
                            'id': 'string',
                            'name': '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.

              
            

            - **externalId** *(string) --* 

              The external ID of the property. For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`__ in the *IoT SiteWise User Guide*.

              
            

            - **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 <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html>`__ 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 <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html>`__ 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.

                  
            
          
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    