:doc:`CodeCatalyst <../../codecatalyst>` / Client / list_dev_environments

*********************
list_dev_environments
*********************



.. py:method:: CodeCatalyst.Client.list_dev_environments(**kwargs)

  

  Retrieves a list of Dev Environments in a project.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/codecatalyst-2022-09-28/ListDevEnvironments>`_  


  **Request Syntax**
  ::

    response = 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 <https://www.rfc-editor.org/rfc/rfc3339#section-5.6>`__.

            
          

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

        
  
  **Exceptions**
  
  *   :py:class:`CodeCatalyst.Client.exceptions.ThrottlingException`

  
  *   :py:class:`CodeCatalyst.Client.exceptions.ConflictException`

  
  *   :py:class:`CodeCatalyst.Client.exceptions.ValidationException`

  
  *   :py:class:`CodeCatalyst.Client.exceptions.ServiceQuotaExceededException`

  
  *   :py:class:`CodeCatalyst.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`CodeCatalyst.Client.exceptions.AccessDeniedException`

  