mgn / Client / archive_application

archive_application

mgn.Client.archive_application(**kwargs)

Archive application.

See also: AWS API Documentation

Request Syntax

response = client.archive_application(
    accountID='string',
    applicationID='string'
)

Parameters:

• accountID (string) – Account ID.

• applicationID (string) –

  [REQUIRED]

  Application ID.

Return type:

dict

Returns:

Response Syntax

{
    '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'
}

Response Structure

• (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.

Exceptions

• mgn.Client.exceptions.UninitializedAccountException

• mgn.Client.exceptions.ResourceNotFoundException

• mgn.Client.exceptions.ServiceQuotaExceededException

• mgn.Client.exceptions.ConflictException