UpdateDirectorySetup - Amazon Directory Service
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

UpdateDirectorySetup

Updates the directory for a particular update type.

Request Syntax

{ "CreateSnapshotBeforeUpdate": boolean, "DirectoryId": "string", "OSUpdateSettings": { "OSVersion": "string" }, "UpdateType": "string" }

Request Parameters

The request accepts the following data in JSON format.

CreateSnapshotBeforeUpdate

The boolean that specifies if a snapshot for the directory needs to be taken before updating the directory.

Type: Boolean

Required: No

DirectoryId

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

Type: String

Pattern: ^d-[0-9a-f]{10}$

Required: Yes

OSUpdateSettings

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

Type: OSUpdateSettings object

Required: No

UpdateType

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

Type: String

Valid Values: OS

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Client authentication is not available in this region at this time.

HTTP Status Code: 400

ClientException

A client exception has occurred.

HTTP Status Code: 400

DirectoryDoesNotExistException

The specified directory does not exist in the system.

HTTP Status Code: 400

DirectoryInDesiredStateException

The directory is already updated to desired update type settings.

HTTP Status Code: 400

DirectoryUnavailableException

The specified directory is unavailable or could not be found.

HTTP Status Code: 400

InvalidParameterException

One or more parameters are not valid.

HTTP Status Code: 400

ServiceException

An exception has occurred in Amazon Directory Service.

HTTP Status Code: 500

SnapshotLimitExceededException

The maximum number of manual snapshots for the directory has been reached. You can use the GetSnapshotLimits operation to determine the snapshot limits for a directory.

HTTP Status Code: 400

UnsupportedOperationException

The operation is not supported.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: