start_app

SimSpaceWeaver.Client.start_app(**kwargs)

Starts a custom app with the configuration specified in the simulation schema.

See also: AWS API Documentation

Request Syntax

response = client.start_app(
    ClientToken='string',
    Description='string',
    Domain='string',
    LaunchOverrides={
        'LaunchCommands': [
            'string',
        ]
    },
    Name='string',
    Simulation='string'
)

Parameters

• ClientToken (string) --

  A value that you provide to ensure that repeated calls to this API operation using the same parameters complete only once. A ClientToken is also known as an idempotency token . A ClientToken expires after 24 hours.

  This field is autopopulated if not provided.

• Description (string) -- The description of the app.
• Domain (string) --

  [REQUIRED]

  The name of the domain of the app.

• LaunchOverrides (dict) --

  Options that apply when the app starts. These optiAons 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) --

  [REQUIRED]

  The name of the app.

• Simulation (string) --

  [REQUIRED]

  The name of the simulation of the app.

Return type

dict

Returns

Response Syntax

{
    'Domain': 'string',
    'Name': 'string',
    'Simulation': 'string'
}

Response Structure

• (dict) --

  • Domain (string) --

    The name of the domain of the app.

  • Name (string) --

    The name of the app.

  • Simulation (string) --

    The name of the simulation of the app.

Exceptions

• SimSpaceWeaver.Client.exceptions.InternalServerException
• SimSpaceWeaver.Client.exceptions.AccessDeniedException
• SimSpaceWeaver.Client.exceptions.ValidationException
• SimSpaceWeaver.Client.exceptions.ServiceQuotaExceededException
• SimSpaceWeaver.Client.exceptions.ConflictException