SimSpaceWeaver / Client / describe_app

describe_app#

SimSpaceWeaver.Client.describe_app(**kwargs)#

Returns the state of the given custom app.

See also: AWS API Documentation

Request Syntax

response = client.describe_app(
    App='string',
    Domain='string',
    Simulation='string'
)
Parameters:

  • App (string) –

    [REQUIRED]

    The name of the app.

  • Domain (string) –

    [REQUIRED]

    The name of the domain of the app.

  • Simulation (string) –

    [REQUIRED]

    The name of the simulation of the app.

Return type:

dict

Returns:

Response Syntax

{
    'Description': 'string',
    'Domain': 'string',
    'EndpointInfo': {
        'Address': 'string',
        'IngressPortMappings': [
            {
                'Actual': 123,
                'Declared': 123
            },
        ]
    },
    'LaunchOverrides': {
        'LaunchCommands': [
            'string',
        ]
    },
    'Name': 'string',
    'Simulation': 'string',
    'Status': 'STARTING'|'STARTED'|'STOPPING'|'STOPPED'|'ERROR'|'UNKNOWN',
    'TargetStatus': 'UNKNOWN'|'STARTED'|'STOPPED'
}

Response Structure

  • (dict) –

    • Description (string) –

      The description of the app.

    • Domain (string) –

      The name of the domain of the app.

    • EndpointInfo (dict) –

      Information about the network endpoint for the custom app. You can use the endpoint to connect to the custom app.

      • Address (string) –

        The IP address of the app. SimSpace Weaver dynamically assigns this IP address when the app starts.

      • IngressPortMappings (list) –

        The inbound TCP/UDP port numbers of the app. The combination of an IP address and a port number form a network endpoint.

        • (dict) –

          A collection of TCP/UDP ports for a custom or service app.

          • Actual (integer) –

            The TCP/UDP port number of the running app. SimSpace Weaver dynamically assigns this port number when the app starts. SimSpace Weaver maps the Declared port to the Actual port. Clients connect to the app using the app’s IP address and the Actual port number.

          • Declared (integer) –

            The TCP/UDP port number of the app, declared in the simulation schema. SimSpace Weaver maps the Declared port to the Actual port. The source code for the app should bind to the Declared port.

    • LaunchOverrides (dict) –

      Options that apply when the app starts. These options override default behavior.

      • LaunchCommands (list) –

        App launch commands and command line parameters that override the launch command configured in the simulation schema.

        • (string) –

    • Name (string) –

      The name of the app.

    • Simulation (string) –

      The name of the simulation of the app.

    • Status (string) –

      The current lifecycle state of the custom app.

    • TargetStatus (string) –

      The desired lifecycle state of the custom app.

Exceptions