mgn / Client / archive_wave

archive_wave¶

mgn.Client.archive_wave(**kwargs)¶

Archive wave.

Request Syntax

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

Parameters:

waveID (string) –
[REQUIRED]

Wave ID.
accountID (string) – Account ID.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –
- waveID (string) –
  
  Wave ID.
- arn (string) –
  
  Wave ARN.
- name (string) –
  
  Wave name.
- description (string) –
  
  Wave description.
- isArchived (boolean) –
  
  Wave archival status.
- waveAggregatedStatus (dict) –
  
  Wave aggregated status.
  - lastUpdateDateTime (string) –
    
    Wave aggregated status last update dateTime.
  - replicationStartedDateTime (string) –
    
    DateTime marking when the first source server in the wave started replication.
  - healthStatus (string) –
    
    Wave aggregated status health status.
  - progressStatus (string) –
    
    Wave aggregated status progress status.
  - totalApplications (integer) –
    
    Wave aggregated status total applications amount.
- creationDateTime (string) –
  
  Wave creation dateTime.
- lastModifiedDateTime (string) –
  
  Wave last modified dateTime.
- tags (dict) –
  
  Wave tags.
  - (string) –
    - (string) –

Exceptions

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