UpdateDirectorySetup - AWS Directory Service
Request SyntaxRequest ParametersResponse ElementsErrorsSee Also

UpdateDirectorySetup

Updates directory configuration for the specified update type.

Request Syntax

{
   "CreateSnapshotBeforeUpdate": boolean,
   "DirectoryId": "string",
   "DirectorySizeUpdateSettings": { 
      "DirectorySize": "string"
   },
   "NetworkUpdateSettings": { 
      "CustomerDnsIpsV6": [ "string" ],
      "NetworkType": "string"
   },
   "OSUpdateSettings": { 
      "OSVersion": "string"
   },
   "UpdateType": "string"
}

Request Parameters

The request accepts the following data in JSON format.

CreateSnapshotBeforeUpdate

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

Type: Boolean

Required: No

DirectoryId

The identifier of the directory to update.

Type: String

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

Required: Yes

DirectorySizeUpdateSettings

Directory size configuration to apply during the update operation.

Type: DirectorySizeUpdateSettings object

Required: No

NetworkUpdateSettings

Network configuration to apply during the directory update operation.

Type: NetworkUpdateSettings object

Required: No

OSUpdateSettings

Operating system configuration to apply during the directory update operation.

Type: OSUpdateSettings object

Required: No

UpdateType

The type of update to perform on the directory.

Type: String

Valid Values: OS | NETWORK | SIZE

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

You do not have sufficient access to perform this action.

Message

The descriptive message for the exception.

RequestId

The AWS request identifier.

HTTP Status Code: 400

ClientException

A client exception has occurred.

Message

The descriptive message for the exception.

RequestId

The AWS request identifier.

HTTP Status Code: 400

DirectoryDoesNotExistException

The specified directory does not exist in the system.

Message

The descriptive message for the exception.

RequestId

The AWS request identifier.

HTTP Status Code: 400

DirectoryInDesiredStateException

The directory is already updated to desired update type settings.

Message

The descriptive message for the exception.

RequestId

The AWS request identifier.

HTTP Status Code: 400

DirectoryUnavailableException

The specified directory is unavailable.

Message

The descriptive message for the exception.

RequestId

The AWS request identifier.

HTTP Status Code: 400

InvalidParameterException

One or more parameters are not valid.

Message

The descriptive message for the exception.

RequestId

The AWS request identifier.

HTTP Status Code: 400

ServiceException

An exception has occurred in AWS Directory Service.

Message

The descriptive message for the exception.

RequestId

The AWS request identifier.

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.

Message

The descriptive message for the exception.

RequestId

The AWS request identifier.

HTTP Status Code: 400

UnsupportedOperationException

The operation is not supported.

Message

The descriptive message for the exception.

RequestId

The AWS request identifier.

HTTP Status Code: 400

See Also

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