:doc:`SimSpaceWeaver <../../simspaceweaver>` / Client / start_app

*********
start_app
*********



.. py:method:: SimSpaceWeaver.Client.start_app(**kwargs)

  

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

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/simspaceweaver-2022-10-28/StartApp>`_  


  **Request Syntax**
  ::

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

    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.

  
  :type Description: string
  :param Description: 

    The description of the app.

    

  
  :type Domain: string
  :param Domain: **[REQUIRED]** 

    The name of the domain of the app.

    

  
  :type LaunchOverrides: dict
  :param LaunchOverrides: 

    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) --* 

      
  
  
  :type Name: string
  :param Name: **[REQUIRED]** 

    The name of the app.

    

  
  :type Simulation: string
  :param Simulation: **[REQUIRED]** 

    The name of the simulation of the app.

    

  
  
  :rtype: 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**
  
  *   :py:class:`SimSpaceWeaver.Client.exceptions.InternalServerException`

  
  *   :py:class:`SimSpaceWeaver.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`SimSpaceWeaver.Client.exceptions.ValidationException`

  
  *   :py:class:`SimSpaceWeaver.Client.exceptions.ServiceQuotaExceededException`

  
  *   :py:class:`SimSpaceWeaver.Client.exceptions.ConflictException`

  