DirectoryService / Client / update_directory_setup

update_directory_setup#

DirectoryService.Client.update_directory_setup(**kwargs)#

Updates the directory for a particular update type.

See also: AWS API Documentation

Request Syntax

response = client.update_directory_setup(
    DirectoryId='string',
    UpdateType='OS',
    OSUpdateSettings={
        'OSVersion': 'SERVER_2012'|'SERVER_2019'
    },
    CreateSnapshotBeforeUpdate=True|False
)
Parameters:

  • DirectoryId (string) –

    [REQUIRED]

    The identifier of the directory on which you want to perform the update.

  • UpdateType (string) –

    [REQUIRED]

    The type of update that needs to be performed on the directory. For example, OS.

  • OSUpdateSettings (dict) –

    The settings for the OS update that needs to be performed on the directory.

    • OSVersion (string) –

      OS version that the directory needs to be updated to.

  • CreateSnapshotBeforeUpdate (boolean) – The boolean that specifies if a snapshot for the directory needs to be taken before updating the directory.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • DirectoryService.Client.exceptions.UnsupportedOperationException

  • DirectoryService.Client.exceptions.DirectoryInDesiredStateException

  • DirectoryService.Client.exceptions.DirectoryUnavailableException

  • DirectoryService.Client.exceptions.SnapshotLimitExceededException

  • DirectoryService.Client.exceptions.InvalidParameterException

  • DirectoryService.Client.exceptions.DirectoryDoesNotExistException

  • DirectoryService.Client.exceptions.AccessDeniedException

  • DirectoryService.Client.exceptions.ClientException

  • DirectoryService.Client.exceptions.ServiceException