:doc:`WorkSpacesThinClient <../../workspaces-thin-client>` / Client / get_environment

***************
get_environment
***************



.. py:method:: WorkSpacesThinClient.Client.get_environment(**kwargs)

  

  Returns information for an environment.

  

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


  **Request Syntax**
  ::

    response = client.get_environment(
        id='string'
    )
    
  :type id: string
  :param id: **[REQUIRED]** 

    The ID of the environment for which to return information.

    

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

    
    ::

      {
          'environment': {
              'id': 'string',
              'name': 'string',
              'desktopArn': 'string',
              'desktopEndpoint': 'string',
              'desktopType': 'workspaces'|'appstream'|'workspaces-web',
              'activationCode': 'string',
              'registeredDevicesCount': 123,
              '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',
              'pendingSoftwareSetVersion': 'string',
              'softwareSetComplianceStatus': 'NO_REGISTERED_DEVICES'|'COMPLIANT'|'NOT_COMPLIANT',
              'createdAt': datetime(2015, 1, 1),
              'updatedAt': datetime(2015, 1, 1),
              'arn': 'string',
              'kmsKeyArn': 'string',
              'deviceCreationTags': {
                  'string': 'string'
              }
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

          
        

        - **registeredDevicesCount** *(integer) --* 

          The number of devices registered 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.

          
        

        - **pendingSoftwareSetVersion** *(string) --* 

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

          
        

        - **softwareSetComplianceStatus** *(string) --* 

          Describes if the software currently installed on all devices in the environment is a supported version.

          
        

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

          
        

        - **kmsKeyArn** *(string) --* 

          The Amazon Resource Name (ARN) of the Key Management Service key used to encrypt the environment.

          
        

        - **deviceCreationTags** *(dict) --* 

          The tag keys and optional values for the newly created devices for this environment.

          
          

          - *(string) --* 
            

            - *(string) --* 
      
    
    
  
  **Exceptions**
  
  *   :py:class:`WorkSpacesThinClient.Client.exceptions.ValidationException`

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

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

  
  *   :py:class:`WorkSpacesThinClient.Client.exceptions.ThrottlingException`

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

  