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

************************************
modify_workspace_creation_properties
************************************



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

  

  Modify the default properties used to create WorkSpaces.

  

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


  **Request Syntax**
  ::

    response = client.modify_workspace_creation_properties(
        ResourceId='string',
        WorkspaceCreationProperties={
            'EnableInternetAccess': True|False,
            'DefaultOu': 'string',
            'CustomSecurityGroupId': 'string',
            'UserEnabledAsLocalAdministrator': True|False,
            'EnableMaintenanceMode': True|False,
            'InstanceIamRoleArn': 'string'
        }
    )
    
  :type ResourceId: string
  :param ResourceId: **[REQUIRED]** 

    The identifier of the directory.

    

  
  :type WorkspaceCreationProperties: dict
  :param WorkspaceCreationProperties: **[REQUIRED]** 

    The default properties for creating WorkSpaces.

    

  
    - **EnableInternetAccess** *(boolean) --* 

      Indicates whether internet access is enabled for your WorkSpaces.

      

    
    - **DefaultOu** *(string) --* 

      The default organizational unit (OU) for your WorkSpaces directories. This string must be the full Lightweight Directory Access Protocol (LDAP) distinguished name for the target domain and OU. It must be in the form ``"OU=value,DC=value,DC=value"``, where *value* is any string of characters, and the number of domain components (DCs) is two or more. For example, ``OU=WorkSpaces_machines,DC=machines,DC=example,DC=com``.

       

      .. warning::

         

        
        * To avoid errors, certain characters in the distinguished name must be escaped. For more information, see `Distinguished Names <https://docs.microsoft.com/previous-versions/windows/desktop/ldap/distinguished-names>`__ in the Microsoft documentation.
         
        * The API doesn't validate whether the OU exists.
        

        

      

    
    - **CustomSecurityGroupId** *(string) --* 

      The identifier of your custom security group.

      

    
    - **UserEnabledAsLocalAdministrator** *(boolean) --* 

      Indicates whether users are local administrators of their WorkSpaces.

      

    
    - **EnableMaintenanceMode** *(boolean) --* 

      Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see `WorkSpace Maintenance <https://docs.aws.amazon.com/workspaces/latest/adminguide/workspace-maintenance.html>`__.

      

    
    - **InstanceIamRoleArn** *(string) --* 

      Indicates the IAM role ARN of the instance.

      

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

    
    ::

      {}
      
    **Response Structure**

    

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

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

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

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

  