---
title: "POST /ListWaves"
method: POST
path: "/ListWaves"
---

# POST /ListWaves

`POST /ListWaves`

Retrieves all waves or multiple waves by ID.

## Query parameters

- `maxResults` string
- `nextToken` string

## Request body

- object
  - `filters` object — Waves list filters.
    - `isArchived` boolean — Filter waves list by archival status.
    - `waveIDs` WaveID[] — Filter waves list by wave ID.
  - `maxResults` integer — Maximum results to return when listing waves.
  - `nextToken` string — Request next token.

## Response `200`

Success

- ListWavesResponse
  - `items` Wave[] — Waves list.
    - `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` object — Wave tags.
    - `waveAggregatedStatus` object — Wave aggregated status.
      - `healthStatus` 'HEALTHY' | 'LAGGING' | 'ERROR' — Wave aggregated status health status.
      - `lastUpdateDateTime` string — Wave aggregated status last update dateTime.
      - `progressStatus` 'NOT_STARTED' | 'IN_PROGRESS' | 'COMPLETED' — 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.

## Other responses

- `480` — UninitializedAccountException

---

[API](https://skmtc.net/aws/apis/mgn.md) · [All operations](https://skmtc.net/aws/apis/mgn/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/mgn/versions/71048ba96dc1/schema)