:doc:`WorkSpacesThinClient <../../workspaces-thin-client>` / Paginator / ListEnvironments

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



.. py:class:: WorkSpacesThinClient.Paginator.ListEnvironments

  ::

    
    paginator = client.get_paginator('list_environments')

  
  

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

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

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/workspaces-thin-client-2023-08-22/ListEnvironments>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': '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**

      
      ::

        {
            'environments': [
                {
                    'id': 'string',
                    'name': 'string',
                    'desktopArn': 'string',
                    'desktopEndpoint': 'string',
                    'desktopType': 'workspaces'|'appstream'|'workspaces-web',
                    'activationCode': 'string',
                    'softwareSetUpdateSchedule': 'USE_MAINTENANCE_WINDOW'|'APPLY_IMMEDIATELY',
                    'maintenanceWindow': {
                        'type': 'SYSTEM'|'CUSTOM',
                        'startTimeHour': 123,
                        'startTimeMinute': 123,
                        'endTimeHour': 123,
                        'endTimeMinute': 123,
                        'daysOfTheWeek': [
                            'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY',
                        ],
                        'applyTimeOf': 'UTC'|'DEVICE'
                    },
                    'softwareSetUpdateMode': 'USE_LATEST'|'USE_DESIRED',
                    'desiredSoftwareSetId': 'string',
                    'pendingSoftwareSetId': 'string',
                    'createdAt': datetime(2015, 1, 1),
                    'updatedAt': datetime(2015, 1, 1),
                    'arn': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

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

          Describes environments.

          
          

          - *(dict) --* 

            Describes an environment.

            
            

            - **id** *(string) --* 

              The ID of the environment.

              
            

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

              The name of the environment.

              
            

            - **desktopArn** *(string) --* 

              The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Secure Browser, or AppStream 2.0.

              
            

            - **desktopEndpoint** *(string) --* 

              The URL for the identity provider login (only for environments that use AppStream 2.0).

              
            

            - **desktopType** *(string) --* 

              The type of streaming desktop for the environment.

              
            

            - **activationCode** *(string) --* 

              The activation code to register a device to the environment.

              
            

            - **softwareSetUpdateSchedule** *(string) --* 

              An option to define if software updates should be applied within a maintenance window.

              
            

            - **maintenanceWindow** *(dict) --* 

              A specification for a time window to apply software updates.

              
              

              - **type** *(string) --* 

                An option to select the default or custom maintenance window.

                
              

              - **startTimeHour** *(integer) --* 

                The hour for the maintenance window start ( ``00``- ``23``).

                
              

              - **startTimeMinute** *(integer) --* 

                The minutes past the hour for the maintenance window start ( ``00``- ``59``).

                
              

              - **endTimeHour** *(integer) --* 

                The hour for the maintenance window end ( ``00``- ``23``).

                
              

              - **endTimeMinute** *(integer) --* 

                The minutes for the maintenance window end ( ``00``- ``59``).

                
              

              - **daysOfTheWeek** *(list) --* 

                The days of the week during which the maintenance window is open.

                
                

                - *(string) --* 
            
              

              - **applyTimeOf** *(string) --* 

                The option to set the maintenance window during the device local time or Universal Coordinated Time (UTC).

                
          
            

            - **softwareSetUpdateMode** *(string) --* 

              An option to define which software updates to apply.

              
            

            - **desiredSoftwareSetId** *(string) --* 

              The ID of the software set to apply.

              
            

            - **pendingSoftwareSetId** *(string) --* 

              The ID of the software set that is pending to be installed.

              
            

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

              The timestamp of when the environment was created.

              
            

            - **updatedAt** *(datetime) --* 

              The timestamp of when the device was updated.

              
            

            - **arn** *(string) --* 

              The Amazon Resource Name (ARN) of the environment.

              
        
      
        

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

          A token to resume pagination.

          
    