:doc:`KafkaConnect <../../kafkaconnect>` / Paginator / ListWorkerConfigurations

************************
ListWorkerConfigurations
************************



.. py:class:: KafkaConnect.Paginator.ListWorkerConfigurations

  ::

    
    paginator = client.get_paginator('list_worker_configurations')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`KafkaConnect.Client.list_worker_configurations`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/kafkaconnect-2021-09-14/ListWorkerConfigurations>`_    


    **Request Syntax**
    ::

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

      Lists worker configuration names that start with the specified text 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**

      
      ::

        {
            'workerConfigurations': [
                {
                    'creationTime': datetime(2015, 1, 1),
                    'description': 'string',
                    'latestRevision': {
                        'creationTime': datetime(2015, 1, 1),
                        'description': 'string',
                        'revision': 123
                    },
                    'name': 'string',
                    'workerConfigurationArn': 'string',
                    'workerConfigurationState': 'ACTIVE'|'DELETING'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **workerConfigurations** *(list) --* 

          An array of worker configuration descriptions.

          
          

          - *(dict) --* 

            The summary of a worker configuration.

            
            

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

              The time that a worker configuration was created.

              
            

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

              The description of a worker configuration.

              
            

            - **latestRevision** *(dict) --* 

              The latest revision of a worker configuration.

              
              

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

                The time that a worker configuration revision was created.

                
              

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

                The description of a worker configuration revision.

                
              

              - **revision** *(integer) --* 

                The revision of a worker configuration.

                
          
            

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

              The name of the worker configuration.

              
            

            - **workerConfigurationArn** *(string) --* 

              The Amazon Resource Name (ARN) of the worker configuration.

              
            

            - **workerConfigurationState** *(string) --* 

              The state of the worker configuration.

              
        
      
        

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

          A token to resume pagination.

          
    