Skip to content

UpdateDevEnvironmentRequest

Source code in docs_src/capo_codecatalyst/types/update_dev_environment_request.py
class UpdateDevEnvironmentRequest(TypedDict, closed=True):
    space_name: "capo_codecatalyst.types.name_string.NameString"
    """<p>The name of the space.</p>"""
    project_name: "capo_codecatalyst.types.name_string.NameString"
    """<p>The name of the project in the space.</p>"""
    id: "capo_codecatalyst.types.uuid.Uuid"
    """<p>The system-generated unique ID of the Dev Environment. </p>"""
    alias: NotRequired["str"]
    """<p>The user-specified alias for the Dev Environment. Changing this value will not cause a restart.</p>"""
    ides: NotRequired[
        "capo_codecatalyst.types.ide_configuration_list.IdeConfigurationList"
    ]
    """<p>Information about the integrated development environment (IDE) configured for a Dev Environment.</p>"""
    instance_type: NotRequired["capo_codecatalyst.types.instance_type.InstanceType"]
    """<p>The Amazon EC2 instace type to use for the Dev Environment. </p> <note> <p>Changing this value will cause a restart of the Dev Environment if it is running.</p> </note>"""
    inactivity_timeout_minutes: (
        "capo_codecatalyst.types.inactivity_timeout_minutes.InactivityTimeoutMinutes"
    )
    """<p>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.</p> <note> <p>Changing this value will cause a restart of the Dev Environment if it is running.</p> </note>"""
    client_token: NotRequired["capo_codecatalyst.types.client_token.ClientToken"]
    """<p>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.</p>"""

alias instance-attribute

alias: NotRequired[str]

The user-specified alias for the Dev Environment. Changing this value will not cause a restart.

client_token instance-attribute

client_token: NotRequired[ClientToken]

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.

id instance-attribute

id: Uuid

The system-generated unique ID of the Dev Environment.

ides instance-attribute

ides: NotRequired[IdeConfigurationList]

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

inactivity_timeout_minutes instance-attribute

inactivity_timeout_minutes: InactivityTimeoutMinutes

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.

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

instance_type instance-attribute

instance_type: NotRequired[InstanceType]

The Amazon EC2 instace type to use for the Dev Environment.

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

project_name instance-attribute

project_name: NameString

The name of the project in the space.

space_name instance-attribute

space_name: NameString

The name of the space.