CodeCatalyst / Client / start_dev_environment_session

start_dev_environment_session#

CodeCatalyst.Client.start_dev_environment_session(**kwargs)#

Starts a session for a specified Dev Environment.

See also: AWS API Documentation

Request Syntax

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

  • spaceName (string) –

    [REQUIRED]

    The name of the space.

  • projectName (string) –

    [REQUIRED]

    The name of the project in the space.

  • id (string) –

    [REQUIRED]

    The system-generated unique ID of the Dev Environment.

  • sessionConfiguration (dict) –

    [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) –

Return type:

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