ListApplicationsCommand

Suggest an Edit

Gets a list of Fleet Hub for IoT Device Management web applications for the current account.

Example Syntax

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

import { IoTFleetHubClient, ListApplicationsCommand } from "@aws-sdk/client-iotfleethub"; // ES Modules import
// const { IoTFleetHubClient, ListApplicationsCommand } = require("@aws-sdk/client-iotfleethub"); // CommonJS import
const client = new IoTFleetHubClient(config);
const input = { // ListApplicationsRequest
  nextToken: "STRING_VALUE",
};
const command = new ListApplicationsCommand(input);
const response = await client.send(command);
// { // ListApplicationsResponse
//   applicationSummaries: [ // ApplicationSummaries
//     { // ApplicationSummary
//       applicationId: "STRING_VALUE", // required
//       applicationName: "STRING_VALUE", // required
//       applicationDescription: "STRING_VALUE",
//       applicationUrl: "STRING_VALUE", // required
//       applicationCreationDate: Number("long"),
//       applicationLastUpdateDate: Number("long"),
//       applicationState: "CREATING" || "DELETING" || "ACTIVE" || "CREATE_FAILED" || "DELETE_FAILED",
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

ListApplicationsCommand Input

See ListApplicationsCommandInput for more details

Parameter
Type
Description
nextToken
string | undefined

A token used to get the next set of results.

ListApplicationsCommand Output

See ListApplicationsCommandOutput for details

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

An array of objects that provide summaries of information about the web applications in the list.

nextToken
string | undefined

A token used to get the next set of results.

Throws

Name
Fault
Details
InternalFailureException
server

An unexpected error has occurred.

InvalidRequestException
client

The request is not valid.

ThrottlingException
client

The rate exceeds the limit.

IoTFleetHubServiceException
Base exception class for all service exceptions from IoTFleetHub service.