archive_wave

mgn.Client.archive_wave(**kwargs)

Archive wave.

See also: AWS API Documentation

Request Syntax

response = client.archive_wave(
    waveID='string'
)

Parameters

waveID (string) --

[REQUIRED]

Wave ID.

Return type

dict

Returns

Response Syntax

{
    'arn': 'string',
    'creationDateTime': 'string',
    'description': 'string',
    'isArchived': True|False,
    'lastModifiedDateTime': 'string',
    'name': 'string',
    'tags': {
        'string': 'string'
    },
    'waveAggregatedStatus': {
        'healthStatus': 'HEALTHY'|'LAGGING'|'ERROR',
        'lastUpdateDateTime': 'string',
        'progressStatus': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED',
        'replicationStartedDateTime': 'string',
        'totalApplications': 123
    },
    'waveID': 'string'
}

Response Structure

• (dict) --
  • arn (string) --

    Wave ARN.

  • creationDateTime (string) --

    Wave creation dateTime.

  • description (string) --

    Wave description.

  • isArchived (boolean) --

    Wave archival status.

  • lastModifiedDateTime (string) --

    Wave last modified dateTime.

  • name (string) --

    Wave name.

  • tags (dict) --

    Wave tags.

    • (string) --
      • (string) --
  • waveAggregatedStatus (dict) --

    Wave aggregated status.

    • healthStatus (string) --

      Wave aggregated status health status.

    • lastUpdateDateTime (string) --

      Wave aggregated status last update dateTime.

    • progressStatus (string) --

      Wave aggregated status progress status.

    • replicationStartedDateTime (string) --

      DateTime marking when the first source server in the wave started replication.

    • totalApplications (integer) --

      Wave aggregated status total applications amount.

  • waveID (string) --

    Wave ID.

Exceptions

• mgn.Client.exceptions.UninitializedAccountException
• mgn.Client.exceptions.ResourceNotFoundException
• mgn.Client.exceptions.ServiceQuotaExceededException
• mgn.Client.exceptions.ConflictException