MigrationHubStrategyRecommendations / Paginator / ListCollectors

ListCollectors#

class MigrationHubStrategyRecommendations.Paginator.ListCollectors#

paginator = client.get_paginator('list_collectors')

paginate(**kwargs)#

Creates an iterator that will paginate through responses from MigrationHubStrategyRecommendations.Client.list_collectors().

Request Syntax

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

Parameters:

PaginationConfig (dict) –

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.

Return type:

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) –
  
  A token to resume pagination.