ListApplicationInstanceNodeInstancesCommand

Suggest an Edit

Returns a list of application node instances.

Example Syntax

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

import { PanoramaClient, ListApplicationInstanceNodeInstancesCommand } from "@aws-sdk/client-panorama"; // ES Modules import
// const { PanoramaClient, ListApplicationInstanceNodeInstancesCommand } = require("@aws-sdk/client-panorama"); // CommonJS import
const client = new PanoramaClient(config);
const input = { // ListApplicationInstanceNodeInstancesRequest
  ApplicationInstanceId: "STRING_VALUE", // required
  MaxResults: Number("int"),
  NextToken: "STRING_VALUE",
};
const command = new ListApplicationInstanceNodeInstancesCommand(input);
const response = await client.send(command);
// { // ListApplicationInstanceNodeInstancesResponse
//   NodeInstances: [ // NodeInstances
//     { // NodeInstance
//       NodeInstanceId: "STRING_VALUE", // required
//       NodeId: "STRING_VALUE",
//       PackageName: "STRING_VALUE",
//       PackageVersion: "STRING_VALUE",
//       PackagePatchVersion: "STRING_VALUE",
//       NodeName: "STRING_VALUE",
//       CurrentStatus: "STRING_VALUE", // required
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

ListApplicationInstanceNodeInstancesCommand Input

See ListApplicationInstanceNodeInstancesCommandInput for more details

Parameter
Type
Description
ApplicationInstanceId
Required
string | undefined

The node instances' application instance ID.

MaxResults
number | undefined

The maximum number of node 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.

ListApplicationInstanceNodeInstancesCommand Output

See ListApplicationInstanceNodeInstancesCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
NextToken
string | undefined

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

NodeInstances
NodeInstance[] | undefined

A list of node instances.

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.