:doc:`MainframeModernization <../../m2>` / Client / list_environments

*****************
list_environments
*****************



.. py:method:: MainframeModernization.Client.list_environments(**kwargs)

  

  Lists the runtime environments.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/ListEnvironments>`_  


  **Request Syntax**
  ::

    response = client.list_environments(
        engineType='microfocus'|'bluage',
        maxResults=123,
        names=[
            'string',
        ],
        nextToken='string'
    )
    
  :type engineType: string
  :param engineType: 

    The engine type for the runtime environment.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of runtime environments to return.

    

  
  :type names: list
  :param names: 

    The names of the runtime environments. Must be unique within the account.

    

  
    - *(string) --* 

    

  :type nextToken: string
  :param nextToken: 

    A pagination token to control the number of runtime environments displayed in the list.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'environments': [
              {
                  'creationTime': datetime(2015, 1, 1),
                  'engineType': 'microfocus'|'bluage',
                  'engineVersion': 'string',
                  'environmentArn': 'string',
                  'environmentId': 'string',
                  'instanceType': 'string',
                  'name': 'string',
                  'networkType': 'ipv4'|'dual',
                  'status': 'Creating'|'Available'|'Updating'|'Deleting'|'Failed'|'UnHealthy'
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **environments** *(list) --* 

        Returns a list of summary details for all the runtime environments in your account.

        
        

        - *(dict) --* 

          Contains a subset of the possible runtime environment attributes. Used in the environment list.

          
          

          - **creationTime** *(datetime) --* 

            The timestamp when the runtime environment was created.

            
          

          - **engineType** *(string) --* 

            The target platform for the runtime environment.

            
          

          - **engineVersion** *(string) --* 

            The version of the runtime engine.

            
          

          - **environmentArn** *(string) --* 

            The Amazon Resource Name (ARN) of a particular runtime environment.

            
          

          - **environmentId** *(string) --* 

            The unique identifier of a particular runtime environment.

            
          

          - **instanceType** *(string) --* 

            The instance type of the runtime environment.

            
          

          - **name** *(string) --* 

            The name of the runtime environment.

            
          

          - **networkType** *(string) --* 

            The network type supported by the runtime environment.

            
          

          - **status** *(string) --* 

            The status of the runtime environment

            
      
    
      

      - **nextToken** *(string) --* 

        A pagination token that's returned when the response doesn't contain all the runtime environments.

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

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

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

  
  *   :py:class:`MainframeModernization.Client.exceptions.InternalServerException`

  