:doc:`WorkSpaces <../../workspaces>` / Client / modify_workspace_properties

***************************
modify_workspace_properties
***************************



.. py:method:: WorkSpaces.Client.modify_workspace_properties(**kwargs)

  

  Modifies the specified WorkSpace properties. For important information about how to modify the size of the root and user volumes, see `Modify a WorkSpace <https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html>`__.

   

  .. note::

    

    The ``MANUAL`` running mode value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see `Amazon WorkSpaces Core <http://aws.amazon.com/workspaces/core/>`__.

    

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyWorkspaceProperties>`_  


  **Request Syntax**
  ::

    response = client.modify_workspace_properties(
        WorkspaceId='string',
        WorkspaceProperties={
            'RunningMode': 'AUTO_STOP'|'ALWAYS_ON'|'MANUAL',
            'RunningModeAutoStopTimeoutInMinutes': 123,
            'RootVolumeSizeGib': 123,
            'UserVolumeSizeGib': 123,
            'ComputeTypeName': 'VALUE'|'STANDARD'|'PERFORMANCE'|'POWER'|'GRAPHICS'|'POWERPRO'|'GENERALPURPOSE_4XLARGE'|'GENERALPURPOSE_8XLARGE'|'GRAPHICSPRO'|'GRAPHICS_G4DN'|'GRAPHICSPRO_G4DN'|'GRAPHICS_G6_XLARGE'|'GRAPHICS_G6_2XLARGE'|'GRAPHICS_G6_4XLARGE'|'GRAPHICS_G6_8XLARGE'|'GRAPHICS_G6_16XLARGE'|'GRAPHICS_GR6_4XLARGE'|'GRAPHICS_GR6_8XLARGE'|'GRAPHICS_G6F_LARGE'|'GRAPHICS_G6F_XLARGE'|'GRAPHICS_G6F_2XLARGE'|'GRAPHICS_G6F_4XLARGE'|'GRAPHICS_GR6F_4XLARGE',
            'Protocols': [
                'PCOIP'|'WSP',
            ],
            'OperatingSystemName': 'AMAZON_LINUX_2'|'UBUNTU_18_04'|'UBUNTU_20_04'|'UBUNTU_22_04'|'UNKNOWN'|'WINDOWS_10'|'WINDOWS_11'|'WINDOWS_7'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'WINDOWS_SERVER_2022'|'RHEL_8'|'ROCKY_8',
            'GlobalAccelerator': {
                'Mode': 'ENABLED_AUTO'|'DISABLED'|'INHERITED',
                'PreferredProtocol': 'TCP'|'NONE'|'INHERITED'
            }
        },
        DataReplication='NO_REPLICATION'|'PRIMARY_AS_SOURCE'
    )
    
  :type WorkspaceId: string
  :param WorkspaceId: **[REQUIRED]** 

    The identifier of the WorkSpace.

    

  
  :type WorkspaceProperties: dict
  :param WorkspaceProperties: 

    The properties of the WorkSpace.

    

  
    - **RunningMode** *(string) --* 

      The running mode. For more information, see `Manage the WorkSpace Running Mode <https://docs.aws.amazon.com/workspaces/latest/adminguide/running-mode.html>`__.

       

      .. note::

        

        The ``MANUAL`` value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see `Amazon WorkSpaces Core <http://aws.amazon.com/workspaces/core/>`__.

        

       

      Review your running mode to ensure you are using one that is optimal for your needs and budget. For more information on switching running modes, see `Can I switch between hourly and monthly billing? <http://aws.amazon.com/workspaces-family/workspaces/faqs/#:~:text=Can%20I%20switch%20between%20hourly%20and%20monthly%20billing%20on%20WorkSpaces%20Personal%3F>`__

      

    
    - **RunningModeAutoStopTimeoutInMinutes** *(integer) --* 

      The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.

      

    
    - **RootVolumeSizeGib** *(integer) --* 

      The size of the root volume. For important information about how to modify the size of the root and user volumes, see `Modify a WorkSpace <https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html>`__.

      

    
    - **UserVolumeSizeGib** *(integer) --* 

      The size of the user storage. For important information about how to modify the size of the root and user volumes, see `Modify a WorkSpace <https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html>`__.

      

    
    - **ComputeTypeName** *(string) --* 

      The compute type. For more information, see `Amazon WorkSpaces Bundles <http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles>`__.

      

    
    - **Protocols** *(list) --* 

      The protocol. For more information, see `Protocols for Amazon WorkSpaces <https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-protocols.html>`__.

       

      .. note::

        

        
        * Only available for WorkSpaces created with PCoIP bundles.
         
        * The ``Protocols`` property is case sensitive. Ensure you use ``PCOIP`` or ``DCV`` (formerly WSP).
         
        * Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).
        

        

      

    
      - *(string) --* 

      
  
    - **OperatingSystemName** *(string) --* 

      The name of the operating system.

      

    
    - **GlobalAccelerator** *(dict) --* 

      Indicates the Global Accelerator properties.

      

    
      - **Mode** *(string) --* **[REQUIRED]** 

        Indicates if Global Accelerator for WorkSpaces is enabled, disabled, or the same mode as the associated directory.

        

      
      - **PreferredProtocol** *(string) --* 

        Indicates the preferred protocol for Global Accelerator.

        

      
    
  
  :type DataReplication: string
  :param DataReplication: 

    Indicates the data replication status.

    

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

    
    ::

      {}
      
    **Response Structure**

    

    - *(dict) --* 
  
  **Exceptions**
  
  *   :py:class:`WorkSpaces.Client.exceptions.InvalidParameterValuesException`

  
  *   :py:class:`WorkSpaces.Client.exceptions.InvalidResourceStateException`

  
  *   :py:class:`WorkSpaces.Client.exceptions.OperationInProgressException`

  
  *   :py:class:`WorkSpaces.Client.exceptions.UnsupportedWorkspaceConfigurationException`

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

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

  
  *   :py:class:`WorkSpaces.Client.exceptions.ResourceUnavailableException`

  