mgn / Client / list_waves

list_waves¶

mgn.Client.list_waves(**kwargs)¶

Retrieves all waves or multiple waves by ID.

Request Syntax

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

Parameters:

filters (dict) –
Waves list filters.
- waveIDs (list) –
  
  Filter waves list by wave ID.
  - (string) –
- isArchived (boolean) –
  
  Filter waves list by archival status.
maxResults (integer) – Maximum results to return when listing waves.
nextToken (string) – Request next token.
accountID (string) – Request account ID.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            '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'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- items (list) –
  
  Waves list.
  - (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) –
- nextToken (string) –
  
  Response next token.

Exceptions

mgn.Client.exceptions.UninitializedAccountException