CodeCatalyst / Client / update_dev_environment

update_dev_environment#

CodeCatalyst.Client.update_dev_environment(**kwargs)#

Changes one or more values for a Dev Environment. Updating certain values of the Dev Environment will cause a restart.

See also: AWS API Documentation

Request Syntax

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

  • alias (string) – The user-specified alias for the Dev Environment. Changing this value will not cause a restart.

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

    Note

    Changing this value will cause a restart of the Dev Environment if it is running.

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

    Note

    Changing this value will cause a restart of the Dev Environment if it is running.

  • clientToken (string) – A user-specified idempotency token. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries return the result from the original successful request and have no additional effect.

Return type:

dict

Returns:

Response Syntax

{
    'id': 'string',
    'spaceName': 'string',
    'projectName': 'string',
    'alias': 'string',
    'ides': [
        {
            'runtime': 'string',
            'name': 'string'
        },
    ],
    'instanceType': 'dev.standard1.small'|'dev.standard1.medium'|'dev.standard1.large'|'dev.standard1.xlarge',
    'inactivityTimeoutMinutes': 123,
    'clientToken': 'string'
}

Response Structure

  • (dict) –

    • id (string) –

      The system-generated unique ID of the Dev Environment.

    • spaceName (string) –

      The name of the space.

    • projectName (string) –

      The name of the project in the space.

    • alias (string) –

      The user-specified alias for the Dev Environment.

    • ides (list) –

      Information about the integrated development environment (IDE) configured for the 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.

    • clientToken (string) –

      A user-specified idempotency token. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries return the result from the original successful request and have no additional effect.

Exceptions