:doc:`AppConfig <../../appconfig>` / Paginator / ListEnvironments

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



.. py:class:: AppConfig.Paginator.ListEnvironments

  ::

    
    paginator = client.get_paginator('list_environments')

  
  

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

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

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ListEnvironments>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          ApplicationId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type ApplicationId: string
    :param ApplicationId: **[REQUIRED]** 

      The application ID.

      

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

      
      ::

        {
            'Items': [
                {
                    'ApplicationId': 'string',
                    'Id': 'string',
                    'Name': 'string',
                    'Description': 'string',
                    'State': 'READY_FOR_DEPLOYMENT'|'DEPLOYING'|'ROLLING_BACK'|'ROLLED_BACK'|'REVERTED',
                    'Monitors': [
                        {
                            'AlarmArn': 'string',
                            'AlarmRoleArn': 'string'
                        },
                    ]
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **Items** *(list) --* 

          The elements from this collection.

          
          

          - *(dict) --* 
            

            - **ApplicationId** *(string) --* 

              The application ID.

              
            

            - **Id** *(string) --* 

              The environment ID.

              
            

            - **Name** *(string) --* 

              The name of the environment.

              
            

            - **Description** *(string) --* 

              The description of the environment.

              
            

            - **State** *(string) --* 

              The state of the environment. An environment can be in one of the following states: ``READY_FOR_DEPLOYMENT``, ``DEPLOYING``, ``ROLLING_BACK``, or ``ROLLED_BACK``

              
            

            - **Monitors** *(list) --* 

              Amazon CloudWatch alarms monitored during the deployment.

              
              

              - *(dict) --* 

                Amazon CloudWatch alarms to monitor during the deployment process.

                
                

                - **AlarmArn** *(string) --* 

                  Amazon Resource Name (ARN) of the Amazon CloudWatch alarm.

                  
                

                - **AlarmRoleArn** *(string) --* 

                  ARN of an Identity and Access Management (IAM) role for AppConfig to monitor ``AlarmArn``.

                  
            
          
        
      
    