CodeCatalyst / Client / start_dev_environment

start_dev_environment#

CodeCatalyst.Client.start_dev_environment(**kwargs)#

Starts a specified Dev Environment and puts it into an active state.

See also: AWS API Documentation

Request Syntax

response = client.start_dev_environment(
    spaceName='string',
    projectName='string',
    id='string',
    ides=[
        {
            'runtime': 'string',
            'name': 'string'
        },
    ],
    instanceType='dev.standard1.small'|'dev.standard1.medium'|'dev.standard1.large'|'dev.standard1.xlarge',
    inactivityTimeoutMinutes=123
)
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.

  • ides (list) –

    Information about the integrated development environment (IDE) configured for a Dev Environment.

    • (dict) –

      Information about the configuration of an integrated development environment (IDE) for a Dev Environment.

      • runtime (string) –

        A link to the IDE runtime image.

        Note

        This parameter is not required for VSCode .

      • name (string) –

        The name of the IDE. Valid values include Cloud9 , IntelliJ , PyCharm , GoLand , and VSCode .

  • instanceType (string) – The Amazon EC2 instace type to use for the Dev Environment.

  • inactivityTimeoutMinutes (integer) – The amount of time the Dev Environment will run without any activity detected before stopping, in minutes. Only whole integers are allowed. Dev Environments consume compute minutes when running.

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

  • CodeCatalyst.Client.exceptions.ThrottlingException

  • CodeCatalyst.Client.exceptions.ConflictException

  • CodeCatalyst.Client.exceptions.ValidationException

  • CodeCatalyst.Client.exceptions.ServiceQuotaExceededException

  • CodeCatalyst.Client.exceptions.ResourceNotFoundException

  • CodeCatalyst.Client.exceptions.AccessDeniedException