AppIntegrationsService / Client / get_application

get_application

AppIntegrationsService.Client.get_application(**kwargs)

Get an Application resource.

See also: AWS API Documentation

Request Syntax

response = client.get_application(
    Arn='string'
)
Parameters:

Arn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the Application.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'Id': 'string',
    'Name': 'string',
    'Namespace': 'string',
    'Description': 'string',
    'ApplicationSourceConfig': {
        'ExternalUrlConfig': {
            'AccessUrl': 'string',
            'ApprovedOrigins': [
                'string',
            ]
        }
    },
    'Subscriptions': [
        {
            'Event': 'string',
            'Description': 'string'
        },
    ],
    'Publications': [
        {
            'Event': 'string',
            'Schema': 'string',
            'Description': 'string'
        },
    ],
    'CreatedTime': datetime(2015, 1, 1),
    'LastModifiedTime': datetime(2015, 1, 1),
    'Tags': {
        'string': 'string'
    },
    'Permissions': [
        'string',
    ],
    'IsService': True|False,
    'InitializationTimeout': 123,
    'ApplicationConfig': {
        'ContactHandling': {
            'Scope': 'CROSS_CONTACTS'|'PER_CONTACT'
        }
    },
    'IframeConfig': {
        'Allow': [
            'string',
        ],
        'Sandbox': [
            'string',
        ]
    }
}

Response Structure

  • (dict) –

    • Arn (string) –

      The Amazon Resource Name (ARN) of the Application.

    • Id (string) –

      A unique identifier for the Application.

    • Name (string) –

      The name of the application.

    • Namespace (string) –

      The namespace of the application.

    • Description (string) –

      The description of the application.

    • ApplicationSourceConfig (dict) –

      The configuration for where the application should be loaded from.

      • ExternalUrlConfig (dict) –

        The external URL source for the application.

        • AccessUrl (string) –

          The URL to access the application.

        • ApprovedOrigins (list) –

          Additional URLs to allow list if different than the access URL.

          • (string) –

    • Subscriptions (list) –

      The events that the application subscribes.

      • (dict) –

        The configuration of an event that the application subscribes.

        • Event (string) –

          The name of the subscription.

        • Description (string) –

          The description of the subscription.

    • Publications (list) –

      The events that the application publishes.

      • (dict) –

        The configuration of an event that the application publishes.

        • Event (string) –

          The name of the publication.

        • Schema (string) –

          The JSON schema of the publication event.

        • Description (string) –

          The description of the publication.

    • CreatedTime (datetime) –

      The created time of the Application.

    • LastModifiedTime (datetime) –

      The last modified time of the Application.

    • Tags (dict) –

      The tags used to organize, track, or control access for this resource. For example, { “tags”: {“key1”:”value1”, “key2”:”value2”} }.

      • (string) –

        • (string) –

    • Permissions (list) –

      The configuration of events or requests that the application has access to.

      • (string) –

        The permission of an event or request that the application has access to.

    • IsService (boolean) –

      Indicates whether the application is a service.

    • InitializationTimeout (integer) –

      The maximum time in milliseconds allowed to establish a connection with the workspace.

    • ApplicationConfig (dict) –

      The configuration settings for the application.

      • ContactHandling (dict) –

        The contact handling configuration for the application.

        • Scope (string) –

          Indicates whether the application refreshes for each contact or refreshes only with each new browser session.

    • IframeConfig (dict) –

      The iframe configuration for the application.

      • Allow (list) –

        The list of features that are allowed in the iframe.

        • (string) –

          A permission for the iframe.

      • Sandbox (list) –

        The list of sandbox attributes for the iframe.

        • (string) –

          A permission for the iframe.

Exceptions