mgn / Client / list_network_migration_definitions

list_network_migration_definitions

mgn.Client.list_network_migration_definitions(**kwargs)

Lists all network migration definitions in the account, with optional filtering.

See also: AWS API Documentation

Request Syntax

response = client.list_network_migration_definitions(
    filters={
        'networkMigrationDefinitionIDs': [
            'string',
        ]
    },
    nextToken='string',
    maxResults=123
)
Parameters:
  • filters (dict) –

    Filters to apply when listing network migration definitions.

    • networkMigrationDefinitionIDs (list) –

      A list of definition IDs to filter by.

      • (string) –

  • nextToken (string) – The token for the next page of results.

  • maxResults (integer) – The maximum number of results to return in a single call.

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) –

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions

  • mgn.Client.exceptions.AccessDeniedException