[ aws . panorama ]

list-nodes

Description

Returns a list of nodes.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-nodes
[--category <value>]
[--owner-account <value>]
[--package-name <value>]
[--package-version <value>]
[--patch-version <value>]
[--next-token <value>]
[--max-results <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--category (string)

Search for nodes by category.

Possible values:

  • BUSINESS_LOGIC

  • ML_MODEL

  • MEDIA_SOURCE

  • MEDIA_SINK

--owner-account (string)

Search for nodes by the account ID of the nodes’ owner.

--package-name (string)

Search for nodes by name.

--package-version (string)

Search for nodes by version.

--patch-version (string)

Search for nodes by patch version.

--next-token (string)

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

--max-results (integer)

The maximum number of nodes to return in one page of results.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

Nodes -> (list)

A list of nodes.

(structure)

An application node that represents a camera stream, a model, code, or output.

NodeId -> (string)

The node’s ID.

Name -> (string)

The node’s name.

Category -> (string)

The node’s category.

OwnerAccount -> (string)

The account ID of the node’s owner.

PackageName -> (string)

The node’s package name.

PackageId -> (string)

The node’s package ID.

PackageArn -> (string)

The node’s ARN.

PackageVersion -> (string)

The node’s package version.

PatchVersion -> (string)

The node’s patch version.

Description -> (string)

The node’s description.

CreatedTime -> (timestamp)

When the node was created.

NextToken -> (string)

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