ListDevEnvironments¶

class CodeCatalyst.Paginator.ListDevEnvironments¶

paginator = client.get_paginator('list_dev_environments')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from CodeCatalyst.Client.list_dev_environments().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    spaceName='string',
    projectName='string',
    filters=[
        {
            'key': 'string',
            'values': [
                'string',
            ],
            'comparisonOperator': 'string'
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

spaceName (string) --
[REQUIRED]

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

The name of the project in the space.
filters (list) --
Information about filters to apply to narrow the results returned in the list.
- (dict) --
  - key (string) -- [REQUIRED]
  - values (list) -- [REQUIRED]
    - (string) --
  - comparisonOperator (string) --
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

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
            }
        },
    ],
    '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.
- NextToken (string) --
  
  A token to resume pagination.

Table Of Contents

ListDevEnvironments¶