CodeCatalyst / Client / stop_dev_environment

stop_dev_environment#

CodeCatalyst.Client.stop_dev_environment(**kwargs)#

Pauses a specified Dev Environment and places it in a non-running state. Stopped Dev Environments do not consume compute minutes.

See also: AWS API Documentation

Request Syntax

response = client.stop_dev_environment(
    spaceName='string',
    projectName='string',
    id='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.

Return type:

dict

Returns:

Response Syntax

{
    'spaceName': 'string',
    'projectName': 'string',
    'id': 'string',
    'status': 'PENDING'|'RUNNING'|'STARTING'|'STOPPING'|'STOPPED'|'FAILED'|'DELETING'|'DELETED'
}

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.

    • status (string) –

      The status of the Dev Environment.

Exceptions