ListApplicationsCommand

Suggest an Edit

Retrieves all applications or multiple applications by ID.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { MgnClient, ListApplicationsCommand } from "@aws-sdk/client-mgn"; // ES Modules import
// const { MgnClient, ListApplicationsCommand } = require("@aws-sdk/client-mgn"); // CommonJS import
const client = new MgnClient(config);
const input = { // ListApplicationsRequest
  filters: { // ListApplicationsRequestFilters
    applicationIDs: [ // ApplicationIDsFilter
      "STRING_VALUE",
    ],
    isArchived: true || false,
    waveIDs: [ // WaveIDsFilter
      "STRING_VALUE",
    ],
  },
  maxResults: Number("int"),
  nextToken: "STRING_VALUE",
  accountID: "STRING_VALUE",
};
const command = new ListApplicationsCommand(input);
const response = await client.send(command);
// { // ListApplicationsResponse
//   items: [ // ApplicationsList
//     { // Application
//       applicationID: "STRING_VALUE",
//       arn: "STRING_VALUE",
//       name: "STRING_VALUE",
//       description: "STRING_VALUE",
//       isArchived: true || false,
//       applicationAggregatedStatus: { // ApplicationAggregatedStatus
//         lastUpdateDateTime: "STRING_VALUE",
//         healthStatus: "STRING_VALUE",
//         progressStatus: "STRING_VALUE",
//         totalSourceServers: Number("long"),
//       },
//       creationDateTime: "STRING_VALUE",
//       lastModifiedDateTime: "STRING_VALUE",
//       tags: { // TagsMap
//         "<keys>": "STRING_VALUE",
//       },
//       waveID: "STRING_VALUE",
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

ListApplicationsCommand Input

See ListApplicationsCommandInput for more details

Parameter
Type
Description
accountID
string | undefined

Applications list Account ID.

filters
ListApplicationsRequestFilters | undefined

Applications list filters.

maxResults
number | undefined

Maximum results to return when listing applications.

nextToken
string | undefined

Request next token.

ListApplicationsCommand Output

See ListApplicationsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
items
Application[] | undefined

Applications list.

nextToken
string | undefined

Response next token.

Throws

Name
Fault
Details
UninitializedAccountException
client

Uninitialized account exception.

MgnServiceException
Base exception class for all service exceptions from Mgn service.