CodeCatalyst / Client / get_dev_environment

get_dev_environment

CodeCatalyst.Client.get_dev_environment(**kwargs)

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

response = client.get_dev_environment(
    spaceName='string',
    projectName='string',
    id='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 for which you want to view information. To retrieve a list of Dev Environment IDs, use ListDevEnvironments.

Return type:

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
    }
}

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.

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