mgn / Paginator / ListNetworkMigrationAnalyses

ListNetworkMigrationAnalyses¶

class mgn.Paginator.ListNetworkMigrationAnalyses¶

paginator = client.get_paginator('list_network_migration_analyses')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from mgn.Client.list_network_migration_analyses().

Request Syntax

response_iterator = paginator.paginate(
    networkMigrationExecutionID='string',
    networkMigrationDefinitionID='string',
    filters={
        'jobIDs': [
            'string',
        ]
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

networkMigrationExecutionID (string) –
[REQUIRED]

The unique identifier of the network migration execution to list analyses for.
networkMigrationDefinitionID (string) –
[REQUIRED]

The unique identifier of the network migration definition.
filters (dict) –
Filters to apply when listing analysis jobs.
- jobIDs (list) –
  
  A list of job IDs to filter by.
  - (string) –
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

{
    'items': [
        {
            'jobID': 'string',
            'networkMigrationExecutionID': 'string',
            'networkMigrationDefinitionID': 'string',
            'createdAt': datetime(2015, 1, 1),
            'endedAt': datetime(2015, 1, 1),
            'status': 'PENDING'|'STARTED'|'SUCCEEDED'|'FAILED',
            'statusDetails': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- items (list) –
  
  A list of network migration analysis job details.
  - (dict) –
    
    Details about a network migration analysis job.
    - jobID (string) –
      
      The unique identifier of the analysis job.
    - networkMigrationExecutionID (string) –
      
      The unique identifier of the network migration execution.
    - networkMigrationDefinitionID (string) –
      
      The unique identifier of the network migration definition.
    - createdAt (datetime) –
      
      The timestamp when the job was created.
    - endedAt (datetime) –
      
      The timestamp when the job completed or failed.
    - status (string) –
      
      The current status of the analysis job.
    - statusDetails (string) –
      
      Detailed status information about the job.
- NextToken (string) –
  
  A token to resume pagination.