:doc:`IoTFleetWise <../../iotfleetwise>` / Paginator / ListStateTemplates

******************
ListStateTemplates
******************



.. py:class:: IoTFleetWise.Paginator.ListStateTemplates

  ::

    
    paginator = client.get_paginator('list_state_templates')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`IoTFleetWise.Client.list_state_templates`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iotfleetwise-2021-06-17/ListStateTemplates>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          listResponseScope='METADATA_ONLY',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type listResponseScope: string
    :param listResponseScope: 

      When you set the ``listResponseScope`` parameter to ``METADATA_ONLY``, the list response includes: state template ID, Amazon Resource Name (ARN), creation time, and last modification time.

      

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

      
      ::

        {
            'summaries': [
                {
                    'name': 'string',
                    'arn': 'string',
                    'signalCatalogArn': 'string',
                    'description': 'string',
                    'creationTime': datetime(2015, 1, 1),
                    'lastModificationTime': datetime(2015, 1, 1),
                    'id': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **summaries** *(list) --* 

          A list of information about each state template.

          
          

          - *(dict) --* 

            Information about a state template.

             

            .. warning::

               

              Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see `Amazon Web Services Region and feature availability <https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html>`__ in the *Amazon Web Services IoT FleetWise Developer Guide*.

              

            
            

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

              The name of the state template.

              
            

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

              The Amazon Resource Name (ARN) of the state template.

              
            

            - **signalCatalogArn** *(string) --* 

              The Amazon Resource Name (ARN) of the signal catalog associated with the state template.

              
            

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

              A brief description of the state template.

              
            

            - **creationTime** *(datetime) --* 

              The time the state template was created, in seconds since epoch (January 1, 1970 at midnight UTC time).

              
            

            - **lastModificationTime** *(datetime) --* 

              The time the state template was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time).

              
            

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

              The unique ID of the state template.

              
        
      
        

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

          A token to resume pagination.

          
    