:doc:`CodeCatalyst <../../codecatalyst>` / Client / start_dev_environment_session

*****************************
start_dev_environment_session
*****************************



.. py:method:: CodeCatalyst.Client.start_dev_environment_session(**kwargs)

  

  Starts a session for a specified Dev Environment.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/codecatalyst-2022-09-28/StartDevEnvironmentSession>`_  


  **Request Syntax**
  ::

    response = client.start_dev_environment_session(
        spaceName='string',
        projectName='string',
        id='string',
        sessionConfiguration={
            'sessionType': 'SSM'|'SSH',
            'executeCommandSessionConfiguration': {
                'command': 'string',
                'arguments': [
                    'string',
                ]
            }
        }
    )
    
  :type spaceName: string
  :param spaceName: **[REQUIRED]** 

    The name of the space.

    

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

    The name of the project in the space.

    

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

    The system-generated unique ID of the Dev Environment.

    

  
  :type sessionConfiguration: dict
  :param sessionConfiguration: **[REQUIRED]** 

    Information about the configuration of a Dev Environment session.

    

  
    - **sessionType** *(string) --* **[REQUIRED]** 

      The type of the session.

      

    
    - **executeCommandSessionConfiguration** *(dict) --* 

      Information about optional commands that will be run on the Dev Environment when the SSH session begins.

      

    
      - **command** *(string) --* **[REQUIRED]** 

        The command used at the beginning of the SSH session to a Dev Environment.

        

      
      - **arguments** *(list) --* 

        An array of arguments containing arguments and members.

        

      
        - *(string) --* 

        
    
    
  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'accessDetails': {
              'streamUrl': 'string',
              'tokenValue': 'string'
          },
          'sessionId': 'string',
          'spaceName': 'string',
          'projectName': 'string',
          'id': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **accessDetails** *(dict) --* 

        Information about connection details for a Dev Environment.

        
        

        - **streamUrl** *(string) --* 

          The URL used to send commands to and from the Dev Environment.

          
        

        - **tokenValue** *(string) --* 

          An encrypted token value that contains session and caller information used to authenticate the connection.

          
    
      

      - **sessionId** *(string) --* 

        The system-generated unique ID of the Dev Environment session.

        
      

      - **spaceName** *(string) --* 

        The name of the space.

        
      

      - **projectName** *(string) --* 

        The name of the project in the space.

        
      

      - **id** *(string) --* 

        The system-generated unique ID of the Dev Environment.

        
  
  **Exceptions**
  
  *   :py:class:`CodeCatalyst.Client.exceptions.ThrottlingException`

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

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

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

  
  *   :py:class:`CodeCatalyst.Client.exceptions.ResourceNotFoundException`

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

  