:doc:`EVS <../../evs>` / Paginator / ListEnvironments

****************
ListEnvironments
****************



.. py:class:: EVS.Paginator.ListEnvironments

  ::

    
    paginator = client.get_paginator('list_environments')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`EVS.Client.list_environments`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/ListEnvironments>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          state=[
              'CREATING'|'CREATED'|'DELETING'|'DELETED'|'CREATE_FAILED',
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type state: list
    :param state: 

      The state of an environment. Used to filter response results to return only environments with the specified ``environmentState``.

      

    
      - *(string) --* 

      
  
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

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

      
      ::

        {
            'environmentSummaries': [
                {
                    'environmentId': 'string',
                    'environmentName': 'string',
                    'vcfVersion': 'VCF-5.2.1'|'VCF-5.2.2',
                    'environmentStatus': 'PASSED'|'FAILED'|'UNKNOWN',
                    'environmentState': 'CREATING'|'CREATED'|'DELETING'|'DELETED'|'CREATE_FAILED',
                    'createdAt': datetime(2015, 1, 1),
                    'modifiedAt': datetime(2015, 1, 1),
                    'environmentArn': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **environmentSummaries** *(list) --* 

          A list of environments with summarized environment details.

          
          

          - *(dict) --* 

            A list of environments with summarized environment details.

            
            

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

              A unique ID for the environment.

              
            

            - **environmentName** *(string) --* 

              The name of the environment.

              
            

            - **vcfVersion** *(string) --* 

              The VCF version of the environment.

              
            

            - **environmentStatus** *(string) --* 

              Reports impaired functionality that stems from issues internal to the environment, such as impaired reachability.

              
            

            - **environmentState** *(string) --* 

              The state of an environment.

              
            

            - **createdAt** *(datetime) --* 

              The date and time that the environment was created.

              
            

            - **modifiedAt** *(datetime) --* 

              The date and time that the environment was modified.

              
            

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

              The Amazon Resource Name (ARN) that is associated with the environment.

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    