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

************
list_servers
************



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

  

  Returns a list of all the servers.

  

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


  **Request Syntax**
  ::

    response = client.list_servers(
        filterValue='string',
        groupIdFilter=[
            {
                'name': 'ExternalId'|'ExternalSourceType',
                'value': 'string'
            },
        ],
        maxResults=123,
        nextToken='string',
        serverCriteria='NOT_DEFINED'|'OS_NAME'|'STRATEGY'|'DESTINATION'|'SERVER_ID'|'ANALYSIS_STATUS'|'ERROR_CATEGORY',
        sort='ASC'|'DESC'
    )
    
  :type filterValue: string
  :param filterValue: 

    Specifies the filter value, which is based on the type of server criteria. For example, if ``serverCriteria`` is ``OS_NAME``, and the ``filterValue`` is equal to ``WindowsServer``, then ``ListServers`` returns all of the servers matching the OS name ``WindowsServer``.

    

  
  :type groupIdFilter: list
  :param groupIdFilter: 

    Specifies the group ID to filter on.

    

  
    - *(dict) --* 

      The object containing information about distinct imports or groups for Strategy Recommendations.

      

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

        The key of the specific import group.

        

      
      - **value** *(string) --* 

        The value of the specific import group.

        

      
    

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

    

  
  :type serverCriteria: string
  :param serverCriteria: 

    Criteria for filtering servers.

    

  
  :type sort: string
  :param sort: 

    Specifies whether to sort by ascending ( ``ASC``) or descending ( ``DESC``) order.

    

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

    
    ::

      {
          'nextToken': 'string',
          'serverInfos': [
              {
                  'antipatternReportS3Object': {
                      's3Bucket': 'string',
                      's3key': 'string'
                  },
                  'antipatternReportStatus': 'FAILED'|'IN_PROGRESS'|'SUCCESS',
                  'antipatternReportStatusMessage': 'string',
                  'applicationComponentStrategySummary': [
                      {
                          'count': 123,
                          'strategy': 'Rehost'|'Retirement'|'Refactor'|'Replatform'|'Retain'|'Relocate'|'Repurchase'
                      },
                  ],
                  'dataCollectionStatus': 'dataCollectionTaskToBeScheduled'|'dataCollectionTaskScheduled'|'dataCollectionTaskStarted'|'dataCollectionTaskStopped'|'dataCollectionTaskSuccess'|'dataCollectionTaskFailed'|'dataCollectionTaskPartialSuccess',
                  'id': 'string',
                  'lastAnalyzedTimestamp': datetime(2015, 1, 1),
                  'listAntipatternSeveritySummary': [
                      {
                          'count': 123,
                          'severity': 'HIGH'|'MEDIUM'|'LOW'
                      },
                  ],
                  'name': 'string',
                  'recommendationSet': {
                      'strategy': 'Rehost'|'Retirement'|'Refactor'|'Replatform'|'Retain'|'Relocate'|'Repurchase',
                      'targetDestination': 'None specified'|'AWS Elastic BeanStalk'|'AWS Fargate'|'Amazon Elastic Cloud Compute (EC2)'|'Amazon Elastic Container Service (ECS)'|'Amazon Elastic Kubernetes Service (EKS)'|'Aurora MySQL'|'Aurora PostgreSQL'|'Amazon Relational Database Service on MySQL'|'Amazon Relational Database Service on PostgreSQL'|'Amazon DocumentDB'|'Amazon DynamoDB'|'Amazon Relational Database Service'|'Babelfish for Aurora PostgreSQL',
                      'transformationTool': {
                          'description': 'string',
                          'name': 'App2Container'|'Porting Assistant For .NET'|'End of Support Migration'|'Windows Web Application Migration Assistant'|'Application Migration Service'|'Strategy Recommendation Support'|'In Place Operating System Upgrade'|'Schema Conversion Tool'|'Database Migration Service'|'Native SQL Server Backup/Restore',
                          'tranformationToolInstallationLink': 'string'
                      }
                  },
                  'serverError': {
                      'serverErrorCategory': 'CONNECTIVITY_ERROR'|'CREDENTIAL_ERROR'|'PERMISSION_ERROR'|'ARCHITECTURE_ERROR'|'OTHER_ERROR'
                  },
                  'serverType': 'string',
                  'statusMessage': 'string',
                  'systemInfo': {
                      'cpuArchitecture': 'string',
                      'fileSystemType': 'string',
                      'networkInfoList': [
                          {
                              'interfaceName': 'string',
                              'ipAddress': 'string',
                              'macAddress': 'string',
                              'netMask': 'string'
                          },
                      ],
                      'osInfo': {
                          'type': 'LINUX'|'WINDOWS',
                          'version': 'string'
                      }
                  }
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

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

        
      

      - **serverInfos** *(list) --* 

        The list of servers with detailed information about each server.

        
        

        - *(dict) --* 

          Detailed information about a server.

          
          

          - **antipatternReportS3Object** *(dict) --* 

            The S3 bucket name and Amazon S3 key name for anti-pattern report.

            
            

            - **s3Bucket** *(string) --* 

              The S3 bucket name.

              
            

            - **s3key** *(string) --* 

              The Amazon S3 key name.

              
        
          

          - **antipatternReportStatus** *(string) --* 

            The status of the anti-pattern report generation.

            
          

          - **antipatternReportStatusMessage** *(string) --* 

            A message about the status of the anti-pattern report generation.

            
          

          - **applicationComponentStrategySummary** *(list) --* 

            A list of strategy summaries.

            
            

            - *(dict) --* 

              Object containing the summary of the strategy recommendations.

              
              

              - **count** *(integer) --* 

                The count of recommendations per strategy.

                
              

              - **strategy** *(string) --* 

                The name of recommended strategy.

                
          
        
          

          - **dataCollectionStatus** *(string) --* 

            The status of assessment for the server.

            
          

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

            The server ID.

            
          

          - **lastAnalyzedTimestamp** *(datetime) --* 

            The timestamp of when the server was assessed.

            
          

          - **listAntipatternSeveritySummary** *(list) --* 

            A list of anti-pattern severity summaries.

            
            

            - *(dict) --* 

              Contains the summary of anti-patterns and their severity.

              
              

              - **count** *(integer) --* 

                Contains the count of anti-patterns.

                
              

              - **severity** *(string) --* 

                Contains the severity of anti-patterns.

                
          
        
          

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

            The name of the server.

            
          

          - **recommendationSet** *(dict) --* 

            A set of recommendations.

            
            

            - **strategy** *(string) --* 

              The recommended strategy.

              
            

            - **targetDestination** *(string) --* 

              The recommended target destination.

              
            

            - **transformationTool** *(dict) --* 

              The target destination for the recommendation set.

              
              

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

                Description of the tool.

                
              

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

                Name of the tool.

                
              

              - **tranformationToolInstallationLink** *(string) --* 

                URL for installing the tool.

                
          
        
          

          - **serverError** *(dict) --* 

            The error in server analysis.

            
            

            - **serverErrorCategory** *(string) --* 

              The error category of server analysis.

              
        
          

          - **serverType** *(string) --* 

            The type of server.

            
          

          - **statusMessage** *(string) --* 

            A message about the status of data collection, which contains detailed descriptions of any error messages.

            
          

          - **systemInfo** *(dict) --* 

            System information about the server.

            
            

            - **cpuArchitecture** *(string) --* 

              CPU architecture type for the server.

              
            

            - **fileSystemType** *(string) --* 

              File system type for the server.

              
            

            - **networkInfoList** *(list) --* 

              Networking information related to a server.

              
              

              - *(dict) --* 

                Information about the server's network for which the assessment was run.

                
                

                - **interfaceName** *(string) --* 

                  Information about the name of the interface of the server for which the assessment was run.

                  
                

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

                  Information about the IP address of the server for which the assessment was run.

                  
                

                - **macAddress** *(string) --* 

                  Information about the MAC address of the server for which the assessment was run.

                  
                

                - **netMask** *(string) --* 

                  Information about the subnet mask of the server for which the assessment was run.

                  
            
          
            

            - **osInfo** *(dict) --* 

              Operating system corresponding to a server.

              
              

              - **type** *(string) --* 

                Information about the type of operating system.

                
              

              - **version** *(string) --* 

                Information about the version of operating system.

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

  