list_application_instances

Panorama.Client.list_application_instances(**kwargs)

Returns a list of application instances.

See also: AWS API Documentation

Request Syntax

response = client.list_application_instances(
    DeviceId='string',
    MaxResults=123,
    NextToken='string',
    StatusFilter='DEPLOYMENT_SUCCEEDED'|'DEPLOYMENT_ERROR'|'REMOVAL_SUCCEEDED'|'REMOVAL_FAILED'|'PROCESSING_DEPLOYMENT'|'PROCESSING_REMOVAL'|'DEPLOYMENT_FAILED'
)

Parameters

• DeviceId (string) -- The application instances' device ID.
• MaxResults (integer) -- The maximum number of application 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.
• StatusFilter (string) -- Only include instances with a specific status.

Return type

dict

Returns

Response Syntax

{
    'ApplicationInstances': [
        {
            'ApplicationInstanceId': 'string',
            'Arn': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'DefaultRuntimeContextDevice': 'string',
            'DefaultRuntimeContextDeviceName': 'string',
            'Description': 'string',
            'HealthStatus': 'RUNNING'|'ERROR'|'NOT_AVAILABLE',
            'Name': 'string',
            'RuntimeContextStates': [
                {
                    'DesiredState': 'RUNNING'|'STOPPED'|'REMOVED',
                    'DeviceReportedStatus': 'STOPPING'|'STOPPED'|'STOP_ERROR'|'REMOVAL_FAILED'|'REMOVAL_IN_PROGRESS'|'STARTING'|'RUNNING'|'INSTALL_ERROR'|'LAUNCHED'|'LAUNCH_ERROR'|'INSTALL_IN_PROGRESS',
                    'DeviceReportedTime': datetime(2015, 1, 1),
                    'RuntimeContextName': 'string'
                },
            ],
            'Status': 'DEPLOYMENT_PENDING'|'DEPLOYMENT_REQUESTED'|'DEPLOYMENT_IN_PROGRESS'|'DEPLOYMENT_ERROR'|'DEPLOYMENT_SUCCEEDED'|'REMOVAL_PENDING'|'REMOVAL_REQUESTED'|'REMOVAL_IN_PROGRESS'|'REMOVAL_FAILED'|'REMOVAL_SUCCEEDED'|'DEPLOYMENT_FAILED',
            'StatusDescription': 'string',
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • ApplicationInstances (list) --

    A list of application instances.

    • (dict) --

      An application instance on a device.

      • ApplicationInstanceId (string) --

        The application instance's ID.

      • Arn (string) --

        The application instance's ARN.

      • CreatedTime (datetime) --

        When the application instance was created.

      • DefaultRuntimeContextDevice (string) --

        The device's ID.

      • DefaultRuntimeContextDeviceName (string) --

        The device's name.

      • Description (string) --

        The application instance's description.

      • HealthStatus (string) --

        The application instance's health status.

      • Name (string) --

        The application instance's name.

      • RuntimeContextStates (list) --

        The application's state.

        • (dict) --

          An application instance's state.

          • DesiredState (string) --

            The application's desired state.

          • DeviceReportedStatus (string) --

            The application's reported status.

          • DeviceReportedTime (datetime) --

            When the device reported the application's state.

          • RuntimeContextName (string) --

            The device's name.

      • Status (string) --

        The application instance's status.

      • StatusDescription (string) --

        The application instance's status description.

      • Tags (dict) --

        The application instance's tags.

        • (string) --
          • (string) --

  • NextToken (string) --

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

Exceptions

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