Panorama / Client / describe_application_instance

describe_application_instance

Panorama.Client.describe_application_instance(**kwargs)

Returns information about an application instance on a device.

See also: AWS API Documentation

Request Syntax

response = client.describe_application_instance(
    ApplicationInstanceId='string'
)

Parameters:

ApplicationInstanceId (string) –

[REQUIRED]

The application instance’s ID.

Return type:

dict

Returns:

Response Syntax

{
    'ApplicationInstanceId': 'string',
    'ApplicationInstanceIdToReplace': 'string',
    'Arn': 'string',
    'CreatedTime': datetime(2015, 1, 1),
    'DefaultRuntimeContextDevice': 'string',
    'DefaultRuntimeContextDeviceName': 'string',
    'Description': 'string',
    'HealthStatus': 'RUNNING'|'ERROR'|'NOT_AVAILABLE',
    'LastUpdatedTime': datetime(2015, 1, 1),
    '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'
        },
    ],
    'RuntimeRoleArn': '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'
    }
}

Response Structure

• (dict) –

  • ApplicationInstanceId (string) –

    The application instance’s ID.

  • ApplicationInstanceIdToReplace (string) –

    The ID of the application instance that this instance replaced.

  • 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 bane.

  • Description (string) –

    The application instance’s description.

  • HealthStatus (string) –

    The application instance’s health status.

  • LastUpdatedTime (datetime) –

    The application instance was updated.

  • Name (string) –

    The application instance’s name.

  • RuntimeContextStates (list) –

    The application instance’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.

  • RuntimeRoleArn (string) –

    The application instance’s runtime role ARN.

  • Status (string) –

    The application instance’s status.

  • StatusDescription (string) –

    The application instance’s status description.

  • Tags (dict) –

    The application instance’s tags.

    • (string) –

      • (string) –

Exceptions

• Panorama.Client.exceptions.ConflictException

• Panorama.Client.exceptions.ValidationException

• Panorama.Client.exceptions.AccessDeniedException

• Panorama.Client.exceptions.ResourceNotFoundException

• Panorama.Client.exceptions.InternalServerException