:doc:`DirectoryService <../../ds>` / Client / update_directory_setup

**********************
update_directory_setup
**********************



.. py:method:: DirectoryService.Client.update_directory_setup(**kwargs)

  

  Updates directory configuration for the specified update type.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/UpdateDirectorySetup>`_  


  **Request Syntax**
  ::

    response = client.update_directory_setup(
        DirectoryId='string',
        UpdateType='OS'|'NETWORK'|'SIZE',
        OSUpdateSettings={
            'OSVersion': 'SERVER_2012'|'SERVER_2019'
        },
        DirectorySizeUpdateSettings={
            'DirectorySize': 'Small'|'Large'
        },
        NetworkUpdateSettings={
            'NetworkType': 'Dual-stack'|'IPv4'|'IPv6',
            'CustomerDnsIpsV6': [
                'string',
            ]
        },
        CreateSnapshotBeforeUpdate=True|False
    )
    
  :type DirectoryId: string
  :param DirectoryId: **[REQUIRED]** 

    The identifier of the directory to update.

    

  
  :type UpdateType: string
  :param UpdateType: **[REQUIRED]** 

    The type of update to perform on the directory.

    

  
  :type OSUpdateSettings: dict
  :param OSUpdateSettings: 

    Operating system configuration to apply during the directory update operation.

    

  
    - **OSVersion** *(string) --* 

      OS version that the directory needs to be updated to.

      

    
  
  :type DirectorySizeUpdateSettings: dict
  :param DirectorySizeUpdateSettings: 

    Directory size configuration to apply during the update operation.

    

  
    - **DirectorySize** *(string) --* 

      The target directory size for the update operation.

      

    
  
  :type NetworkUpdateSettings: dict
  :param NetworkUpdateSettings: 

    Network configuration to apply during the directory update operation.

    

  
    - **NetworkType** *(string) --* 

      The target network type for the directory update.

      

    
    - **CustomerDnsIpsV6** *(list) --* 

      IPv6 addresses of DNS servers or domain controllers in the self-managed directory. Required only when updating an AD Connector directory.

      

    
      - *(string) --* 

      
  
  
  :type CreateSnapshotBeforeUpdate: boolean
  :param CreateSnapshotBeforeUpdate: 

    Specifies whether to create a directory snapshot before performing the update.

    

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

    
    ::

      {}
      
    **Response Structure**

    

    - *(dict) --* 
  
  **Exceptions**
  
  *   :py:class:`DirectoryService.Client.exceptions.UnsupportedOperationException`

  
  *   :py:class:`DirectoryService.Client.exceptions.DirectoryInDesiredStateException`

  
  *   :py:class:`DirectoryService.Client.exceptions.DirectoryUnavailableException`

  
  *   :py:class:`DirectoryService.Client.exceptions.SnapshotLimitExceededException`

  
  *   :py:class:`DirectoryService.Client.exceptions.InvalidParameterException`

  
  *   :py:class:`DirectoryService.Client.exceptions.DirectoryDoesNotExistException`

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

  
  *   :py:class:`DirectoryService.Client.exceptions.ClientException`

  
  *   :py:class:`DirectoryService.Client.exceptions.ServiceException`

  