AWS API Changes

2023/11/16 - Amazon CodeCatalyst - 3 updated api methods

Changes This release includes updates to the Dev Environment APIs to include an optional vpcConnectionName parameter that supports using Dev Environments with Amazon VPC.

CreateDevEnvironment (updated)

Link ¶
Changes (both)

{'vpcConnectionName': 'string'}

Creates a Dev Environment in Amazon CodeCatalyst, a cloud-based development environment that you can use to quickly work on the code stored in the source repositories of your project.

Note

When created in the Amazon CodeCatalyst console, by default a Dev Environment is configured to have a 2 core processor, 4GB of RAM, and 16GB of persistent storage. None of these defaults apply to a Dev Environment created programmatically.

See also: AWS API Documentation

Request Syntax

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
    },
    vpcConnectionName='string'
)

type spaceName

string

param spaceName

[REQUIRED]

The name of the space.

type projectName

string

param projectName

[REQUIRED]

The name of the project in the space.

type repositories

list

param repositories

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.

type clientToken

string

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

type alias

string

param alias

The user-defined alias for a Dev Environment.

type ides

list

param ides

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.
  
  Note
  
  This parameter is not required for VSCode .
- name (string) --
  
  The name of the IDE. Valid values include Cloud9 , IntelliJ , PyCharm , GoLand , and VSCode .

type instanceType

string

param instanceType

[REQUIRED]

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

type inactivityTimeoutMinutes

integer

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

type persistentStorage

dict

param persistentStorage

[REQUIRED]

Information about the amount of storage allocated to the Dev Environment.

Note

By default, a Dev Environment is configured to have 16GB of persistent storage when created from the Amazon CodeCatalyst console, but there is no default when programmatically creating a Dev Environment. 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.

type vpcConnectionName

string

param vpcConnectionName

The name of the connection to use connect to a Amazon VPC.

rtype

dict

returns

Response Syntax

{
    'spaceName': 'string',
    'projectName': 'string',
    'id': 'string',
    'vpcConnectionName': '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.
- vpcConnectionName (string) --
  
  The name of the connection used to connect to Amazon VPC used when the Dev Environment was created, if any.

GetDevEnvironment (updated)

Link ¶
Changes (response)

{'vpcConnectionName': 'string'}

Returns information about a Dev Environment for a source repository in a project. Dev Environments are specific to the user who creates them.

See also: AWS API Documentation

Request Syntax

client.get_dev_environment(
    spaceName='string',
    projectName='string',
    id='string'
)

type spaceName

string

param spaceName

[REQUIRED]

The name of the space.

type projectName

string

param projectName

[REQUIRED]

The name of the project in the space.

type id

string

param id

[REQUIRED]

The system-generated unique ID of the Dev Environment for which you want to view information. To retrieve a list of Dev Environment IDs, use ListDevEnvironments.

rtype

dict

returns

Response Syntax

{
    'spaceName': 'string',
    'projectName': 'string',
    'id': 'string',
    'lastUpdatedTime': datetime(2015, 1, 1),
    'creatorId': 'string',
    'status': 'PENDING'|'RUNNING'|'STARTING'|'STOPPING'|'STOPPED'|'FAILED'|'DELETING'|'DELETED',
    'statusReason': 'string',
    'repositories': [
        {
            'repositoryName': 'string',
            'branchName': '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
    },
    'vpcConnectionName': '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.
- lastUpdatedTime (datetime) --
  
  The time when the Dev Environment was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.
- creatorId (string) --
  
  The system-generated unique ID of the user who created the Dev Environment.
- status (string) --
  
  The current status of the Dev Environment.
- statusReason (string) --
  
  The reason for the status.
- repositories (list) --
  
  The source repository that contains the branch cloned into the Dev Environment.
  - (dict) --
    
    Information about the source repsitory for a Dev Environment.
    - repositoryName (string) --
      
      The name of the source repository.
    - branchName (string) --
      
      The name of the branch in a source repository cloned into the Dev Environment.
- 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 an integrated development environment (IDE) used in a Dev Environment.
    - runtime (string) --
      
      A link to the IDE runtime image.
    - name (string) --
      
      The name of the IDE.
- 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.
- persistentStorage (dict) --
  
  Information about the amount of storage allocated to the Dev Environment. By default, a Dev Environment is configured to have 16GB of persistent storage.
  - sizeInGiB (integer) --
    
    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.
- vpcConnectionName (string) --
  
  The name of the connection used to connect to Amazon VPC used when the Dev Environment was created, if any.

ListDevEnvironments (updated)

Link ¶
Changes (response)

{'items': {'vpcConnectionName': 'string'}}

Retrieves a list of Dev Environments in a project.

See also: AWS API Documentation

Request Syntax

client.list_dev_environments(
    spaceName='string',
    projectName='string',
    filters=[
        {
            'key': 'string',
            'values': [
                'string',
            ],
            'comparisonOperator': 'string'
        },
    ],
    nextToken='string',
    maxResults=123
)

type spaceName

string

param spaceName

[REQUIRED]

The name of the space.

type projectName

string

param projectName

The name of the project in the space.

type filters

list

param filters

Information about filters to apply to narrow the results returned in the list.

(dict) --

Information about a filter used to limit results of a query.
- key (string) -- [REQUIRED]
  
  A key that can be used to sort results.
- values (list) -- [REQUIRED]
  
  The values of the key.
  - (string) --
- comparisonOperator (string) --
  
  The operator used to compare the fields.

type nextToken

string

param nextToken

A token returned from a call to this API to indicate the next batch of results to return, if any.

type maxResults

integer

param maxResults

The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a NextToken element, which you can use to obtain additional results.

rtype

dict

returns

Response Syntax

{
    'items': [
        {
            'spaceName': 'string',
            'projectName': 'string',
            'id': 'string',
            'lastUpdatedTime': datetime(2015, 1, 1),
            'creatorId': 'string',
            'status': 'PENDING'|'RUNNING'|'STARTING'|'STOPPING'|'STOPPED'|'FAILED'|'DELETING'|'DELETED',
            'statusReason': 'string',
            'repositories': [
                {
                    'repositoryName': 'string',
                    'branchName': '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
            },
            'vpcConnectionName': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- items (list) --
  
  Information about the Dev Environments in a project.
  - (dict) --
    
    Information about a Dev Environment.
    - spaceName (string) --
      
      The name of the space.
    - projectName (string) --
      
      The name of the project in the space.
    - id (string) --
      
      The system-generated unique ID for the Dev Environment.
    - lastUpdatedTime (datetime) --
      
      The time when the Dev Environment was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.
    - creatorId (string) --
      
      The system-generated unique ID of the user who created the Dev Environment.
    - status (string) --
      
      The status of the Dev Environment.
    - statusReason (string) --
      
      The reason for the status.
    - repositories (list) --
      
      Information about the repositories that will be cloned into the Dev Environment. If no rvalue is specified, no repository is cloned.
      - (dict) --
        
        Information about the source repsitory for a Dev Environment.
        
        repositoryName (string) --
        
        The name of the source repository.
        
        branchName (string) --
        
        The name of the branch in a source repository cloned into the Dev Environment.
    - alias (string) --
      
      The user-specified alias for the Dev Environment.
    - ides (list) --
      
      Information about the integrated development environment (IDE) configured for a Dev Environment.
      - (dict) --
        
        Information about an integrated development environment (IDE) used in a Dev Environment.
        
        runtime (string) --
        
        A link to the IDE runtime image.
        
        name (string) --
        
        The name of the IDE.
    - instanceType (string) --
      
      The Amazon EC2 instace type used for the Dev Environment.
    - inactivityTimeoutMinutes (integer) --
      
      The amount of time the Dev Environment will run without any activity detected before stopping, in minutes. Dev Environments consume compute minutes when running.
    - persistentStorage (dict) --
      
      Information about the configuration of persistent storage for the Dev Environment.
      - sizeInGiB (integer) --
        
        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.
    - vpcConnectionName (string) --
      
      The name of the connection used to connect to Amazon VPC used when the Dev Environment was created, if any.
- nextToken (string) --
  
  A token returned from a call to this API to indicate the next batch of results to return, if any.