Panorama / Client / list_nodes

list_nodes

Panorama.Client.list_nodes(**kwargs)

Returns a list of nodes.

See also: AWS API Documentation

Request Syntax

response = client.list_nodes(
    Category='BUSINESS_LOGIC'|'ML_MODEL'|'MEDIA_SOURCE'|'MEDIA_SINK',
    MaxResults=123,
    NextToken='string',
    OwnerAccount='string',
    PackageName='string',
    PackageVersion='string',
    PatchVersion='string'
)

Parameters:

• Category (string) – Search for nodes by category.

• MaxResults (integer) – The maximum number of nodes to return in one page of results.

• NextToken (string) – Specify the pagination token from a previous request to retrieve the next page of results.

• OwnerAccount (string) – Search for nodes by the account ID of the nodes’ owner.

• PackageName (string) – Search for nodes by name.

• PackageVersion (string) – Search for nodes by version.

• PatchVersion (string) – Search for nodes by patch version.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'Nodes': [
        {
            'Category': 'BUSINESS_LOGIC'|'ML_MODEL'|'MEDIA_SOURCE'|'MEDIA_SINK',
            'CreatedTime': datetime(2015, 1, 1),
            'Description': 'string',
            'Name': 'string',
            'NodeId': 'string',
            'OwnerAccount': 'string',
            'PackageArn': 'string',
            'PackageId': 'string',
            'PackageName': 'string',
            'PackageVersion': 'string',
            'PatchVersion': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • NextToken (string) –

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

  • Nodes (list) –

    A list of nodes.

    • (dict) –

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

      • Category (string) –

        The node’s category.

      • CreatedTime (datetime) –

        When the node was created.

      • Description (string) –

        The node’s description.

      • Name (string) –

        The node’s name.

      • NodeId (string) –

        The node’s ID.

      • OwnerAccount (string) –

        The account ID of the node’s owner.

      • PackageArn (string) –

        The node’s ARN.

      • PackageId (string) –

        The node’s package ID.

      • PackageName (string) –

        The node’s package name.

      • PackageVersion (string) –

        The node’s package version.

      • PatchVersion (string) –

        The node’s patch version.

Exceptions

• Panorama.Client.exceptions.ConflictException

• Panorama.Client.exceptions.ValidationException

• Panorama.Client.exceptions.InternalServerException