Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListWaves

Retrieves all waves or multiple waves by ID.

Request Syntax


POST /ListWaves HTTP/1.1
Content-type: application/json

{
   "accountID": "string",
   "filters": { 
      "isArchived": boolean,
      "waveIDs": [ "string" ]
   },
   "maxResults": number,
   "nextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

accountID

Request account ID.

Type: String

Length Constraints: Fixed length of 12.

Pattern: [0-9]{12,}

Required: No

filters

Waves list filters.

Type: ListWavesRequestFilters object

Required: No

maxResults

Maximum results to return when listing waves.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

Required: No

nextToken

Request next token.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "arn": "string",
         "creationDateTime": "string",
         "description": "string",
         "isArchived": boolean,
         "lastModifiedDateTime": "string",
         "name": "string",
         "tags": { 
            "string" : "string" 
         },
         "waveAggregatedStatus": { 
            "healthStatus": "string",
            "lastUpdateDateTime": "string",
            "progressStatus": "string",
            "replicationStartedDateTime": "string",
            "totalApplications": number
         },
         "waveID": "string"
      }
   ],
   "nextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

items

Waves list.

Type: Array of Wave objects

nextToken

Response next token.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Errors

For information about the errors that are common to all actions, see Common Errors.

UninitializedAccountException

Uninitialized account exception.

HTTP Status Code: 400