ListApplicationInstancesCommand

Suggest an Edit

Returns a list of application instances.

Example Syntax

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

import { PanoramaClient, ListApplicationInstancesCommand } from "@aws-sdk/client-panorama"; // ES Modules import
// const { PanoramaClient, ListApplicationInstancesCommand } = require("@aws-sdk/client-panorama"); // CommonJS import
const client = new PanoramaClient(config);
const input = { // ListApplicationInstancesRequest
  DeviceId: "STRING_VALUE",
  StatusFilter: "STRING_VALUE",
  MaxResults: Number("int"),
  NextToken: "STRING_VALUE",
};
const command = new ListApplicationInstancesCommand(input);
const response = await client.send(command);
// { // ListApplicationInstancesResponse
//   ApplicationInstances: [ // ApplicationInstances
//     { // ApplicationInstance
//       Name: "STRING_VALUE",
//       ApplicationInstanceId: "STRING_VALUE",
//       DefaultRuntimeContextDevice: "STRING_VALUE",
//       DefaultRuntimeContextDeviceName: "STRING_VALUE",
//       Description: "STRING_VALUE",
//       Status: "STRING_VALUE",
//       HealthStatus: "STRING_VALUE",
//       StatusDescription: "STRING_VALUE",
//       CreatedTime: new Date("TIMESTAMP"),
//       Arn: "STRING_VALUE",
//       Tags: { // TagMap
//         "<keys>": "STRING_VALUE",
//       },
//       RuntimeContextStates: [ // ReportedRuntimeContextStates
//         { // ReportedRuntimeContextState
//           DesiredState: "STRING_VALUE", // required
//           RuntimeContextName: "STRING_VALUE", // required
//           DeviceReportedStatus: "STRING_VALUE", // required
//           DeviceReportedTime: new Date("TIMESTAMP"), // required
//         },
//       ],
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

ListApplicationInstancesCommand Input

See ListApplicationInstancesCommandInput for more details

Parameter
Type
Description
DeviceId
string | undefined

The application instances' device ID.

MaxResults
number | undefined

The maximum number of application instances to return in one page of results.

NextToken
string | undefined

Specify the pagination token from a previous request to retrieve the next page of results.

StatusFilter
StatusFilter | undefined

Only include instances with a specific status.

ListApplicationInstancesCommand Output

See ListApplicationInstancesCommandOutput for details

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

A list of application instances.

NextToken
string | undefined

A pagination token that's included if more results are available.

Throws

Name
Fault
Details
AccessDeniedException
client

The requestor does not have permission to access the target action or resource.

InternalServerException
server

An internal error occurred.

PanoramaServiceException
Base exception class for all service exceptions from Panorama service.