Panorama / Client / describe_application_instance_details

describe_application_instance_details#

Panorama.Client.describe_application_instance_details(**kwargs)#

Returns information about an application instance’s configuration manifest.

See also: AWS API Documentation

Request Syntax

response = client.describe_application_instance_details(
    ApplicationInstanceId='string'
)
Parameters:

ApplicationInstanceId (string) –

[REQUIRED]

The application instance’s ID.

Return type:

dict

Returns:

Response Syntax

{
    'ApplicationInstanceId': 'string',
    'ApplicationInstanceIdToReplace': 'string',
    'CreatedTime': datetime(2015, 1, 1),
    'DefaultRuntimeContextDevice': 'string',
    'Description': 'string',
    'ManifestOverridesPayload': {
        'PayloadData': 'string'
    },
    'ManifestPayload': {
        'PayloadData': 'string'
    },
    'Name': 'string'
}

Response Structure

  • (dict) –

    • ApplicationInstanceId (string) –

      The application instance’s ID.

    • ApplicationInstanceIdToReplace (string) –

      The ID of the application instance that this instance replaced.

    • CreatedTime (datetime) –

      When the application instance was created.

    • DefaultRuntimeContextDevice (string) –

      The application instance’s default runtime context device.

    • Description (string) –

      The application instance’s description.

    • ManifestOverridesPayload (dict) –

      Parameter overrides for the configuration manifest.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: PayloadData. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      
      • PayloadData (string) –

        The overrides document.

    • ManifestPayload (dict) –

      The application instance’s configuration manifest.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: PayloadData. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      
      • PayloadData (string) –

        The application manifest.

    • Name (string) –

      The application instance’s name.

Exceptions

  • Panorama.Client.exceptions.ConflictException

  • Panorama.Client.exceptions.ValidationException

  • Panorama.Client.exceptions.AccessDeniedException

  • Panorama.Client.exceptions.ResourceNotFoundException

  • Panorama.Client.exceptions.InternalServerException