:doc:`KafkaConnect <../../kafkaconnect>` / Client / list_worker_configurations

**************************
list_worker_configurations
**************************



.. py:method:: KafkaConnect.Client.list_worker_configurations(**kwargs)

  

  Returns a list of all of the worker configurations in this account and Region.

  

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


  **Request Syntax**
  ::

    response = client.list_worker_configurations(
        maxResults=123,
        nextToken='string',
        namePrefix='string'
    )
    
  :type maxResults: integer
  :param maxResults: 

    The maximum number of worker configurations to list in one response.

    

  
  :type nextToken: string
  :param nextToken: 

    If the response of a ListWorkerConfigurations operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.

    

  
  :type namePrefix: string
  :param namePrefix: 

    Lists worker configuration names that start with the specified text string.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'nextToken': 'string',
          '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'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **nextToken** *(string) --* 

        If the response of a ListWorkerConfigurations operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.

        
      

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

            
      
    
  
  **Exceptions**
  
  *   :py:class:`KafkaConnect.Client.exceptions.NotFoundException`

  
  *   :py:class:`KafkaConnect.Client.exceptions.BadRequestException`

  
  *   :py:class:`KafkaConnect.Client.exceptions.ForbiddenException`

  
  *   :py:class:`KafkaConnect.Client.exceptions.ServiceUnavailableException`

  
  *   :py:class:`KafkaConnect.Client.exceptions.TooManyRequestsException`

  
  *   :py:class:`KafkaConnect.Client.exceptions.UnauthorizedException`

  
  *   :py:class:`KafkaConnect.Client.exceptions.InternalServerErrorException`

  