mgn / Paginator / ListNetworkMigrationDefinitions

ListNetworkMigrationDefinitions

class mgn.Paginator.ListNetworkMigrationDefinitions
paginator = client.get_paginator('list_network_migration_definitions')
paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    filters={
        'networkMigrationDefinitionIDs': [
            'string',
        ]
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • filters (dict) –

    Filters to apply when listing network migration definitions.

    • networkMigrationDefinitionIDs (list) –

      A list of definition 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': [
        {
            'networkMigrationDefinitionID': 'string',
            'name': 'string',
            'sourceEnvironment': 'NSX'|'VSPHERE'|'FORTIGATE_FIREWALL'|'PALO_ALTO_FIREWALL'|'CISCO_ACI'|'LOGICAL_MODEL'|'MODELIZE_IT',
            'arn': 'string',
            'tags': {
                'string': 'string'
            },
            'scopeTags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • items (list) –

      A list of network migration definition summaries.

      • (dict) –

        A summary of a network migration definition.

        • networkMigrationDefinitionID (string) –

          The unique identifier of the network migration definition.

        • name (string) –

          The name of the network migration definition.

        • sourceEnvironment (string) –

          The source environment configuration.

        • arn (string) –

          The Amazon Resource Name (ARN) of the network migration definition.

        • tags (dict) –

          Tags assigned to the network migration definition.

          • (string) –

            • (string) –

        • scopeTags (dict) –

          Scope tags for the network migration definition.

          • (string) –

            • (string) –

    • NextToken (string) –

      A token to resume pagination.