CodeCatalyst / Client / stop_dev_environment_session

stop_dev_environment_session#

CodeCatalyst.Client.stop_dev_environment_session(**kwargs)#

Stops a session for a specified Dev Environment.

See also: AWS API Documentation

Request Syntax

response = client.stop_dev_environment_session(
    spaceName='string',
    projectName='string',
    id='string',
    sessionId='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. To obtain this ID, use ListDevEnvironments.

  • sessionId (string) –

    [REQUIRED]

    The system-generated unique ID of the Dev Environment session. This ID is returned by StartDevEnvironmentSession.

Return type:

dict

Returns:

Response Syntax

{
    'spaceName': 'string',
    'projectName': 'string',
    'id': 'string',
    'sessionId': 'string'
}

Response Structure

  • (dict) –

    • 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.

    • sessionId (string) –

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

Exceptions