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

**********
ListAssets
**********



.. py:class:: IoTSiteWise.Paginator.ListAssets

  ::

    
    paginator = client.get_paginator('list_assets')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          assetModelId='string',
          filter='ALL'|'TOP_LEVEL',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type assetModelId: string
    :param assetModelId: 

      The ID of the asset model by which to filter the list of assets. This parameter is required if you choose ``ALL`` for ``filter``. 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: 

      The filter for the requested list of assets. Choose one of the following options:

       

      
      * ``ALL`` – The list includes all assets for a given asset model ID. The ``assetModelId`` parameter is required if you filter by ``ALL``.
       
      * ``TOP_LEVEL`` – The list includes only top-level assets in the asset hierarchy tree.
      

       

      Default: ``ALL``

      

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

      
      ::

        {
            'assetSummaries': [
                {
                    'id': 'string',
                    'externalId': 'string',
                    'arn': 'string',
                    'name': 'string',
                    'assetModelId': 'string',
                    'creationDate': datetime(2015, 1, 1),
                    'lastUpdateDate': datetime(2015, 1, 1),
                    'status': {
                        'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
                        'error': {
                            'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
                            'message': 'string',
                            'details': [
                                {
                                    'code': 'INCOMPATIBLE_COMPUTE_LOCATION'|'INCOMPATIBLE_FORWARDING_CONFIGURATION',
                                    'message': 'string'
                                },
                            ]
                        }
                    },
                    'hierarchies': [
                        {
                            'id': 'string',
                            'externalId': 'string',
                            'name': 'string'
                        },
                    ],
                    'description': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **assetSummaries** *(list) --* 

          A list that summarizes each asset.

          
          

          - *(dict) --* 

            Contains a summary of an asset.

            
            

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

              The ID of the asset, in UUID format.

              
            

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

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

              
            

            - **arn** *(string) --* 

              The `ARN <https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html>`__ of the asset, which has the following format.

               

              ``arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}``

              
            

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

              The name of the asset.

              
            

            - **assetModelId** *(string) --* 

              The ID of the asset model used to create this asset.

              
            

            - **creationDate** *(datetime) --* 

              The date the asset was created, in Unix epoch time.

              
            

            - **lastUpdateDate** *(datetime) --* 

              The date the asset was last updated, in Unix epoch time.

              
            

            - **status** *(dict) --* 

              The current status of the asset.

              
              

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

                The current status of the asset.

                
              

              - **error** *(dict) --* 

                Contains associated error information, if any.

                
                

                - **code** *(string) --* 

                  The error code.

                  
                

                - **message** *(string) --* 

                  The error message.

                  
                

                - **details** *(list) --* 

                  A list of detailed errors.

                  
                  

                  - *(dict) --* 

                    Contains detailed error information.

                    
                    

                    - **code** *(string) --* 

                      The error code.

                      
                    

                    - **message** *(string) --* 

                      The error message.

                      
                
              
            
          
            

            - **hierarchies** *(list) --* 

              A list of asset hierarchies that each contain a ``hierarchyId``. A hierarchy specifies allowed parent/child asset relationships.

              
              

              - *(dict) --* 

                Describes an asset hierarchy that contains a hierarchy's name and ID.

                
                

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

                  The ID of the hierarchy. This ID is a ``hierarchyId``.

                  
                

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

                  The external ID of the hierarchy, if it has one. When you update an asset hierarchy, you may assign an external ID if it doesn't already have one. You can't change the external ID of an asset hierarchy that already has one. 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 hierarchy name provided in the `CreateAssetModel <https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html>`__ or `UpdateAssetModel <https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html>`__ API operation.

                  
            
          
            

            - **description** *(string) --* 

              A description for the asset.

              
        
      
        

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

          A token to resume pagination.

          
    