mgn / Client / list_waves

list_waves

mgn.Client.list_waves(**kwargs)

Retrieves all waves or multiple waves by ID.

See also: AWS API Documentation

Request Syntax

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

Parameters:

• accountID (string) – Request account ID.

• filters (dict) –

  Waves list filters.

  • isArchived (boolean) –

    Filter waves list by archival status.

  • waveIDs (list) –

    Filter waves list by wave ID.

    • (string) –

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

• nextToken (string) – Request next token.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  • items (list) –

    Waves list.

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

  • nextToken (string) –

    Response next token.

Exceptions

• mgn.Client.exceptions.UninitializedAccountException