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

************************
ListAssetModelProperties
************************



.. py:class:: IoTSiteWise.Paginator.ListAssetModelProperties

  ::

    
    paginator = client.get_paginator('list_asset_model_properties')

  
  

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

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

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


    **Request Syntax**
    ::

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

      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 <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 model properties. You can choose one of the following options:

       

      
      * ``ALL`` – The list includes all asset model properties for a given asset model ID.
       
      * ``BASE`` – The list includes only base asset model properties for a given asset model ID.
      

       

      Default: ``BASE``

      

    
    :type assetModelVersion: string
    :param assetModelVersion: 

      The version alias that specifies the latest or active version of the asset model. The details are returned in the response. The default value is ``LATEST``. See `Asset model versions <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html>`__ in the *IoT SiteWise User Guide*.

      

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

      
      ::

        {
            'assetModelPropertySummaries': [
                {
                    'id': 'string',
                    'externalId': 'string',
                    'name': 'string',
                    'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT',
                    'dataTypeSpec': 'string',
                    'unit': 'string',
                    'type': {
                        'attribute': {
                            'defaultValue': 'string'
                        },
                        'measurement': {
                            'processingConfig': {
                                'forwardingConfig': {
                                    'state': 'DISABLED'|'ENABLED'
                                }
                            }
                        },
                        'transform': {
                            'expression': 'string',
                            'variables': [
                                {
                                    'name': 'string',
                                    'value': {
                                        'propertyId': 'string',
                                        'hierarchyId': 'string',
                                        'propertyPath': [
                                            {
                                                'id': 'string',
                                                'name': 'string'
                                            },
                                        ]
                                    }
                                },
                            ],
                            'processingConfig': {
                                'computeLocation': 'EDGE'|'CLOUD',
                                'forwardingConfig': {
                                    'state': 'DISABLED'|'ENABLED'
                                }
                            }
                        },
                        'metric': {
                            'expression': 'string',
                            'variables': [
                                {
                                    'name': 'string',
                                    'value': {
                                        'propertyId': 'string',
                                        'hierarchyId': 'string',
                                        'propertyPath': [
                                            {
                                                'id': 'string',
                                                'name': 'string'
                                            },
                                        ]
                                    }
                                },
                            ],
                            'window': {
                                'tumbling': {
                                    'interval': 'string',
                                    'offset': 'string'
                                }
                            },
                            'processingConfig': {
                                'computeLocation': 'EDGE'|'CLOUD'
                            }
                        }
                    },
                    'assetModelCompositeModelId': 'string',
                    'path': [
                        {
                            'id': 'string',
                            'name': 'string'
                        },
                    ],
                    'interfaceSummaries': [
                        {
                            'interfaceAssetModelId': 'string',
                            'interfaceAssetModelPropertyId': 'string'
                        },
                    ]
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **assetModelPropertySummaries** *(list) --* 

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

          
          

          - *(dict) --* 

            Contains a summary of a property associated with a model. This includes information about which interfaces the property belongs to, if any.

            
            

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

              
            

            - **name** *(string) --* 

              The name of the property.

              
            

            - **dataType** *(string) --* 

              The data type of the property.

              
            

            - **dataTypeSpec** *(string) --* 

              The data type of the structure for this property. This parameter exists on properties that have the ``STRUCT`` data type.

              
            

            - **unit** *(string) --* 

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

              
            

            - **type** *(dict) --* 

              Contains a property type, which can be one of ``attribute``, ``measurement``, ``metric``, or ``transform``.

              
              

              - **attribute** *(dict) --* 

                Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an `IIoT <https://en.wikipedia.org/wiki/Internet_of_things#Industrial_applications>`__ wind turbine.

                
                

                - **defaultValue** *(string) --* 

                  The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see `Updating attribute values <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-attribute-values.html>`__ in the *IoT SiteWise User Guide*.

                  
            
              

              - **measurement** *(dict) --* 

                Specifies an asset measurement property. A measurement represents a device's raw sensor data stream, such as timestamped temperature values or timestamped power values.

                
                

                - **processingConfig** *(dict) --* 

                  The processing configuration for the given measurement property. You can configure measurements to be kept at the edge or forwarded to the Amazon Web Services Cloud. By default, measurements are forwarded to the cloud.

                  
                  

                  - **forwardingConfig** *(dict) --* 

                    The forwarding configuration for the given measurement property.

                    
                    

                    - **state** *(string) --* 

                      The forwarding state for the given property.

                      
                
              
            
              

              - **transform** *(dict) --* 

                Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.

                
                

                - **expression** *(string) --* 

                  The mathematical expression that defines the transformation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.

                   

                  For more information, see `Quotas <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html>`__ in the *IoT SiteWise User Guide*.

                  
                

                - **variables** *(list) --* 

                  The list of variables used in the expression.

                  
                  

                  - *(dict) --* 

                    Contains expression variable information.

                    
                    

                    - **name** *(string) --* 

                      The friendly name of the variable to be used in the expression.

                      
                    

                    - **value** *(dict) --* 

                      The variable that identifies an asset property from which to use values.

                      
                      

                      - **propertyId** *(string) --* 

                        The ID of the property to use as the variable. You can use the property ``name`` if it's from the same asset model. If the property has an external ID, you can specify ``externalId:`` followed by the external ID. 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*.

                        
                      

                      - **hierarchyId** *(string) --* 

                        The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID. If the hierarchy has an external ID, you can specify ``externalId:`` followed by the external ID. 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*.

                         

                        You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same ``propertyId``. For example, you might have separately grouped assets that come from the same asset model. For more information, see `Asset hierarchies <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html>`__ in the *IoT SiteWise User Guide*.

                        
                      

                      - **propertyPath** *(list) --* 

                        The path of the property.

                        
                        

                        - *(dict) --* 

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

                          
                          

                          - **id** *(string) --* 

                            The ID of the path segment.

                            
                          

                          - **name** *(string) --* 

                            The name of the path segment.

                            
                      
                    
                  
                
              
                

                - **processingConfig** *(dict) --* 

                  The processing configuration for the given transform property. You can configure transforms to be kept at the edge or forwarded to the Amazon Web Services Cloud. You can also configure transforms to be computed at the edge or in the cloud.

                  
                  

                  - **computeLocation** *(string) --* 

                    The compute location for the given transform property.

                    
                  

                  - **forwardingConfig** *(dict) --* 

                    The forwarding configuration for a given property.

                    
                    

                    - **state** *(string) --* 

                      The forwarding state for the given property.

                      
                
              
            
              

              - **metric** *(dict) --* 

                Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.

                
                

                - **expression** *(string) --* 

                  The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.

                   

                  For more information, see `Quotas <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html>`__ in the *IoT SiteWise User Guide*.

                  
                

                - **variables** *(list) --* 

                  The list of variables used in the expression.

                  
                  

                  - *(dict) --* 

                    Contains expression variable information.

                    
                    

                    - **name** *(string) --* 

                      The friendly name of the variable to be used in the expression.

                      
                    

                    - **value** *(dict) --* 

                      The variable that identifies an asset property from which to use values.

                      
                      

                      - **propertyId** *(string) --* 

                        The ID of the property to use as the variable. You can use the property ``name`` if it's from the same asset model. If the property has an external ID, you can specify ``externalId:`` followed by the external ID. 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*.

                        
                      

                      - **hierarchyId** *(string) --* 

                        The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID. If the hierarchy has an external ID, you can specify ``externalId:`` followed by the external ID. 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*.

                         

                        You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same ``propertyId``. For example, you might have separately grouped assets that come from the same asset model. For more information, see `Asset hierarchies <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html>`__ in the *IoT SiteWise User Guide*.

                        
                      

                      - **propertyPath** *(list) --* 

                        The path of the property.

                        
                        

                        - *(dict) --* 

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

                          
                          

                          - **id** *(string) --* 

                            The ID of the path segment.

                            
                          

                          - **name** *(string) --* 

                            The name of the path segment.

                            
                      
                    
                  
                
              
                

                - **window** *(dict) --* 

                  The window (time interval) over which IoT SiteWise computes the metric's aggregation expression. IoT SiteWise computes one data point per ``window``.

                  
                  

                  - **tumbling** *(dict) --* 

                    The tumbling time interval window.

                    
                    

                    - **interval** *(string) --* 

                      The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.

                       

                      IoT SiteWise computes the ``1w`` interval the end of Sunday at midnight each week (UTC), the ``1d`` interval at the end of each day at midnight (UTC), the ``1h`` interval at the end of each hour, and so on.

                       

                      When IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. IoT SiteWise places the computed data point at the end of the interval.

                      
                    

                    - **offset** *(string) --* 

                      The offset for the tumbling window. The ``offset`` parameter accepts the following:

                       

                      
                      * The offset time. For example, if you specify ``18h`` for ``offset`` and ``1d`` for ``interval``, IoT SiteWise aggregates data in one of the following ways: 

                        
                        * If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
                         
                        * If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
                        

                      
                       
                      * The ISO 8601 format. For example, if you specify ``PT18H`` for ``offset`` and ``1d`` for ``interval``, IoT SiteWise aggregates data in one of the following ways: 

                        
                        * If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
                         
                        * If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
                        

                      
                       
                      * The 24-hour clock. For example, if you specify ``00:03:00`` for ``offset``, ``5m`` for ``interval``, and you create the metric at 2 PM (UTC), you get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result at 2:08 PM (UTC).
                       
                      * The offset time zone. For example, if you specify ``2021-07-23T18:00-08`` for ``offset`` and ``1d`` for ``interval``, IoT SiteWise aggregates data in one of the following ways: 

                        
                        * If you create the metric before or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.
                         
                        * If you create the metric after 6 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.
                        

                      
                      

                      
                
              
                

                - **processingConfig** *(dict) --* 

                  The processing configuration for the given metric property. You can configure metrics to be computed at the edge or in the Amazon Web Services Cloud. By default, metrics are forwarded to the cloud.

                  
                  

                  - **computeLocation** *(string) --* 

                    The compute location for the given metric property.

                    
              
            
          
            

            - **assetModelCompositeModelId** *(string) --* 

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

              
            

            - **path** *(list) --* 

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

              
              

              - *(dict) --* 

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

                
                

                - **id** *(string) --* 

                  The ID of the path segment.

                  
                

                - **name** *(string) --* 

                  The name of the path segment.

                  
            
          
            

            - **interfaceSummaries** *(list) --* 

              A list of interface summaries that describe which interfaces this property belongs to, including the interface asset model ID and the corresponding property ID in the interface.

              
              

              - *(dict) --* 

                Contains summary information about an interface that a property belongs to.

                
                

                - **interfaceAssetModelId** *(string) --* 

                  The ID of the interface asset model that contains this property.

                  
                

                - **interfaceAssetModelPropertyId** *(string) --* 

                  The ID of the property in the interface asset model that corresponds to this property.

                  
            
          
        
      
        

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

          A token to resume pagination.

          
    