:doc:`GroundStation <../../groundstation>` / Paginator / ListConfigs

***********
ListConfigs
***********



.. py:class:: GroundStation.Paginator.ListConfigs

  ::

    
    paginator = client.get_paginator('list_configs')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`GroundStation.Client.list_configs`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ListConfigs>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :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**

      
      ::

        {
            'configList': [
                {
                    'configId': 'string',
                    'configType': 'antenna-downlink'|'antenna-downlink-demod-decode'|'tracking'|'dataflow-endpoint'|'antenna-uplink'|'uplink-echo'|'s3-recording'|'telemetry-sink',
                    'configArn': 'string',
                    'name': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **configList** *(list) --* 

          List of ``Config`` items.

          
          

          - *(dict) --* 

            An item in a list of ``Config`` objects.

            
            

            - **configId** *(string) --* 

              UUID of a ``Config``.

              
            

            - **configType** *(string) --* 

              Type of a ``Config``.

              
            

            - **configArn** *(string) --* 

              ARN of a ``Config``.

              
            

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

              Name of a ``Config``.

              
        
      
        

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

          A token to resume pagination.

          
    