list_application_instance_node_instances

Panorama.Client.list_application_instance_node_instances(**kwargs)

Returns a list of application node instances.

See also: AWS API Documentation

Request Syntax

response = client.list_application_instance_node_instances(
    ApplicationInstanceId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • ApplicationInstanceId (string) --

    [REQUIRED]

    The node instances' application instance ID.

  • MaxResults (integer) -- The maximum number of node instances to return in one page of results.
  • NextToken (string) -- Specify the pagination token from a previous request to retrieve the next page of results.
Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'NodeInstances': [
        {
            'CurrentStatus': 'RUNNING'|'ERROR'|'NOT_AVAILABLE'|'PAUSED',
            'NodeId': 'string',
            'NodeInstanceId': 'string',
            'NodeName': 'string',
            'PackageName': 'string',
            'PackagePatchVersion': 'string',
            'PackageVersion': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

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

    • NodeInstances (list) --

      A list of node instances.

      • (dict) --

        A node instance.

        • CurrentStatus (string) --

          The instance's current status.

        • NodeId (string) --

          The node's ID.

        • NodeInstanceId (string) --

          The instance's ID.

        • NodeName (string) --

          The instance's name.

        • PackageName (string) --

          The instance's package name.

        • PackagePatchVersion (string) --

          The instance's package patch version.

        • PackageVersion (string) --

          The instance's package version.

Exceptions

  • Panorama.Client.exceptions.AccessDeniedException
  • Panorama.Client.exceptions.InternalServerException