mgn / Client / list_applications

list_applications#

mgn.Client.list_applications(**kwargs)#

Retrieves all applications or multiple applications by ID.

See also: AWS API Documentation

Request Syntax

response = client.list_applications(
    accountID='string',
    filters={
        'applicationIDs': [
            'string',
        ],
        'isArchived': True|False,
        'waveIDs': [
            'string',
        ]
    },
    maxResults=123,
    nextToken='string'
)
Parameters:

  • accountID (string) – Applications list Account ID.

  • filters (dict) –

    Applications list filters.

    • applicationIDs (list) –

      Filter applications list by application ID.

      • (string) –

    • isArchived (boolean) –

      Filter applications list by archival status.

    • waveIDs (list) –

      Filter applications list by wave ID.

      • (string) –

  • maxResults (integer) – Maximum results to return when listing applications.

  • nextToken (string) – Request next token.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'applicationAggregatedStatus': {
                'healthStatus': 'HEALTHY'|'LAGGING'|'ERROR',
                'lastUpdateDateTime': 'string',
                'progressStatus': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED',
                'totalSourceServers': 123
            },
            'applicationID': 'string',
            'arn': 'string',
            'creationDateTime': 'string',
            'description': 'string',
            'isArchived': True|False,
            'lastModifiedDateTime': 'string',
            'name': 'string',
            'tags': {
                'string': 'string'
            },
            'waveID': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • items (list) –

      Applications list.

      • (dict) –

        • applicationAggregatedStatus (dict) –

          Application aggregated status.

          • healthStatus (string) –

            Application aggregated status health status.

          • lastUpdateDateTime (string) –

            Application aggregated status last update dateTime.

          • progressStatus (string) –

            Application aggregated status progress status.

          • totalSourceServers (integer) –

            Application aggregated status total source servers amount.

        • applicationID (string) –

          Application ID.

        • arn (string) –

          Application ARN.

        • creationDateTime (string) –

          Application creation dateTime.

        • description (string) –

          Application description.

        • isArchived (boolean) –

          Application archival status.

        • lastModifiedDateTime (string) –

          Application last modified dateTime.

        • name (string) –

          Application name.

        • tags (dict) –

          Application tags.

          • (string) –

            • (string) –

        • waveID (string) –

          Application wave ID.

    • nextToken (string) –

      Response next token.

Exceptions