DirectoryService / Client / update_directory_setup

update_directory_setup

DirectoryService.Client.update_directory_setup(**kwargs)

Updates directory configuration for the specified update type.

See also: AWS API Documentation

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
)
Parameters:

  • DirectoryId (string) –

    [REQUIRED]

    The identifier of the directory to update.

  • UpdateType (string) –

    [REQUIRED]

    The type of update to perform on the directory.

  • OSUpdateSettings (dict) –

    Operating system configuration to apply during the directory update operation.

    • OSVersion (string) –

      OS version that the directory needs to be updated to.

  • DirectorySizeUpdateSettings (dict) –

    Directory size configuration to apply during the update operation.

    • DirectorySize (string) –

      The target directory size for the update operation.

  • NetworkUpdateSettings (dict) –

    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) –

  • CreateSnapshotBeforeUpdate (boolean) – Specifies whether to create a directory snapshot before performing the update.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions