- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
ListNodesCommand
Returns a list of nodes.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { PanoramaClient, ListNodesCommand } from "@aws-sdk/client-panorama"; // ES Modules import
// const { PanoramaClient, ListNodesCommand } = require("@aws-sdk/client-panorama"); // CommonJS import
const client = new PanoramaClient(config);
const input = { // ListNodesRequest
Category: "STRING_VALUE",
OwnerAccount: "STRING_VALUE",
PackageName: "STRING_VALUE",
PackageVersion: "STRING_VALUE",
PatchVersion: "STRING_VALUE",
NextToken: "STRING_VALUE",
MaxResults: Number("int"),
};
const command = new ListNodesCommand(input);
const response = await client.send(command);
// { // ListNodesResponse
// Nodes: [ // NodesList
// { // Node
// NodeId: "STRING_VALUE", // required
// Name: "STRING_VALUE", // required
// Category: "STRING_VALUE", // required
// OwnerAccount: "STRING_VALUE",
// PackageName: "STRING_VALUE", // required
// PackageId: "STRING_VALUE", // required
// PackageArn: "STRING_VALUE",
// PackageVersion: "STRING_VALUE", // required
// PatchVersion: "STRING_VALUE", // required
// Description: "STRING_VALUE",
// CreatedTime: new Date("TIMESTAMP"), // required
// },
// ],
// NextToken: "STRING_VALUE",
// };
ListNodesCommand Input
See ListNodesCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
Category | NodeCategory | undefined | Search for nodes by category. |
MaxResults | number | undefined | The maximum number of nodes 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. |
OwnerAccount | string | undefined | Search for nodes by the account ID of the nodes' owner. |
PackageName | string | undefined | Search for nodes by name. |
PackageVersion | string | undefined | Search for nodes by version. |
PatchVersion | string | undefined | Search for nodes by patch version. |
ListNodesCommand Output
See ListNodesCommandOutput for details
Parameter | Type | Description |
---|
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. |
Nodes | Node[] | undefined | A list of nodes. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
ConflictException | client | The target resource is in use. |
InternalServerException | server | An internal error occurred. |
ValidationException | client | The request contains an invalid parameter value. |
PanoramaServiceException | Base exception class for all service exceptions from Panorama service. |