:doc:`MigrationHubStrategyRecommendations <../../migrationhubstrategy>` / Client / list_collectors

***************
list_collectors
***************



.. py:method:: MigrationHubStrategyRecommendations.Client.list_collectors(**kwargs)

  

  Retrieves a list of all the installed collectors.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/migrationhubstrategy-2020-02-19/ListCollectors>`_  


  **Request Syntax**
  ::

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

    The maximum number of items to include in the response. The maximum value is 100.

    

  
  :type nextToken: string
  :param nextToken: 

    The token from a previous call that you use to retrieve the next set of results. For example, if a previous call to this action returned 100 items, but you set ``maxResults`` to 10. You'll receive a set of 10 results along with a token. You then use the returned token to retrieve the next set of 10.

    

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

    
    ::

      {
          'Collectors': [
              {
                  'collectorHealth': 'COLLECTOR_HEALTHY'|'COLLECTOR_UNHEALTHY',
                  'collectorId': 'string',
                  'collectorVersion': 'string',
                  'configurationSummary': {
                      'ipAddressBasedRemoteInfoList': [
                          {
                              'authType': 'NTLM'|'SSH'|'CERT',
                              'ipAddressConfigurationTimeStamp': 'string',
                              'osType': 'LINUX'|'WINDOWS'
                          },
                      ],
                      'pipelineInfoList': [
                          {
                              'pipelineConfigurationTimeStamp': 'string',
                              'pipelineType': 'AZURE_DEVOPS'
                          },
                      ],
                      'remoteSourceCodeAnalysisServerInfo': {
                          'remoteSourceCodeAnalysisServerConfigurationTimestamp': 'string'
                      },
                      'vcenterBasedRemoteInfoList': [
                          {
                              'osType': 'LINUX'|'WINDOWS',
                              'vcenterConfigurationTimeStamp': 'string'
                          },
                      ],
                      'versionControlInfoList': [
                          {
                              'versionControlConfigurationTimeStamp': 'string',
                              'versionControlType': 'GITHUB'|'GITHUB_ENTERPRISE'|'AZURE_DEVOPS_GIT'
                          },
                      ]
                  },
                  'hostName': 'string',
                  'ipAddress': 'string',
                  'lastActivityTimeStamp': 'string',
                  'registeredTimeStamp': 'string'
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Collectors** *(list) --* 

        The list of all the installed collectors.

        
        

        - *(dict) --* 

          Process data collector that runs in the environment that you specify.

          
          

          - **collectorHealth** *(string) --* 

            Indicates the health of a collector.

            
          

          - **collectorId** *(string) --* 

            The ID of the collector.

            
          

          - **collectorVersion** *(string) --* 

            Current version of the collector that is running in the environment that you specify.

            
          

          - **configurationSummary** *(dict) --* 

            Summary of the collector configuration.

            
            

            - **ipAddressBasedRemoteInfoList** *(list) --* 

              IP address based configurations.

              
              

              - *(dict) --* 

                IP address based configurations.

                
                

                - **authType** *(string) --* 

                  The type of authorization.

                  
                

                - **ipAddressConfigurationTimeStamp** *(string) --* 

                  The time stamp of the configuration.

                  
                

                - **osType** *(string) --* 

                  The type of the operating system.

                  
            
          
            

            - **pipelineInfoList** *(list) --* 

              The list of pipeline info configurations.

              
              

              - *(dict) --* 

                Detailed information of the pipeline.

                
                

                - **pipelineConfigurationTimeStamp** *(string) --* 

                  The time when the pipeline info was configured.

                  
                

                - **pipelineType** *(string) --* 

                  The type of pipeline.

                  
            
          
            

            - **remoteSourceCodeAnalysisServerInfo** *(dict) --* 

              Info about the remote server source code configuration.

              
              

              - **remoteSourceCodeAnalysisServerConfigurationTimestamp** *(string) --* 

                The time when the remote source code server was configured.

                
          
            

            - **vcenterBasedRemoteInfoList** *(list) --* 

              The list of vCenter configurations.

              
              

              - *(dict) --* 

                Details about the server in vCenter.

                
                

                - **osType** *(string) --* 

                  The type of the operating system.

                  
                

                - **vcenterConfigurationTimeStamp** *(string) --* 

                  The time when the remote server based on vCenter was last configured.

                  
            
          
            

            - **versionControlInfoList** *(list) --* 

              The list of the version control configurations.

              
              

              - *(dict) --* 

                Details about the version control configuration.

                
                

                - **versionControlConfigurationTimeStamp** *(string) --* 

                  The time when the version control system was last configured.

                  
                

                - **versionControlType** *(string) --* 

                  The type of version control.

                  
            
          
        
          

          - **hostName** *(string) --* 

            Hostname of the server that is hosting the collector.

            
          

          - **ipAddress** *(string) --* 

            IP address of the server that is hosting the collector.

            
          

          - **lastActivityTimeStamp** *(string) --* 

            Time when the collector last pinged the service.

            
          

          - **registeredTimeStamp** *(string) --* 

            Time when the collector registered with the service.

            
      
    
      

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

        The token you use to retrieve the next set of results, or null if there are no more results.

        
  
  **Exceptions**
  
  *   :py:class:`MigrationHubStrategyRecommendations.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`MigrationHubStrategyRecommendations.Client.exceptions.ThrottlingException`

  
  *   :py:class:`MigrationHubStrategyRecommendations.Client.exceptions.ValidationException`

  
  *   :py:class:`MigrationHubStrategyRecommendations.Client.exceptions.InternalServerException`

  