create_dev_environment¶

create_dev_environment(**kwargs)¶

Creates a Dev Environment in Amazon CodeCatalyst, a cloud-based development Dev Environment that you can use to quickly work on the code stored in the source repositories of your project. By default, a Dev Environment is configured to have a 2 core processor, 4GB of RAM, and 16GB of persistent storage.

See also: AWS API Documentation

Request Syntax

response = client.create_dev_environment(
    spaceName='string',
    projectName='string',
    repositories=[
        {
            'repositoryName': 'string',
            'branchName': 'string'
        },
    ],
    clientToken='string',
    alias='string',
    ides=[
        {
            'runtime': 'string',
            'name': 'string'
        },
    ],
    instanceType='dev.standard1.small'|'dev.standard1.medium'|'dev.standard1.large'|'dev.standard1.xlarge',
    inactivityTimeoutMinutes=123,
    persistentStorage={
        'sizeInGiB': 123
    }
)

Parameters

spaceName (string) --
[REQUIRED]

The name of the space.
projectName (string) --
[REQUIRED]

The name of the project in the space.
repositories (list) --
The source repository that contains the branch to clone into the Dev Environment.
- (dict) --
  Information about a repository that will be cloned to a Dev Environment.
  - repositoryName (string) -- [REQUIRED]
    The name of the source repository.
  - branchName (string) --
    The name of the branch in a source repository.
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.
alias (string) -- The user-defined alias for a Dev Environment.
ides (list) --
Information about the integrated development environment (IDE) configured for a Dev Environment.

Note

An IDE is required to create a Dev Environment. For Dev Environment creation, this field contains configuration information and must be provided.
- (dict) --
  Information about the configuration of an integrated development environment (IDE) for a Dev Environment.
  - runtime (string) --
    A link to the IDE runtime image.
  - name (string) --
    The name of the IDE.
instanceType (string) --
[REQUIRED]

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.
persistentStorage (dict) --
[REQUIRED]

Information about the amount of storage allocated to the Dev Environment. By default, a Dev Environment is configured to have 16GB of persistent storage.

Note

Valid values for persistent storage are based on memory sizes in 16GB increments. Valid values are 16, 32, and 64.
- sizeInGiB (integer) -- [REQUIRED]
  The size of the persistent storage in gigabytes (specifically GiB).
  
  Note
  
  Valid values for storage are based on memory sizes in 16GB increments. Valid values are 16, 32, and 64.

Return type

dict

Returns

Response Syntax

{
    'spaceName': 'string',
    'projectName': 'string',
    'id': '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.

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

Table Of Contents

create_dev_environment¶