Menu
AWS Directory Service
API Reference

CreateDirectory

Creates a Simple AD directory.

Before you call CreateDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.

Request Syntax

{
   "Description": "string",
   "Name": "string",
   "Password": "string",
   "ShortName": "string",
   "Size": "string",
   "VpcSettings": { 
      "SubnetIds": [ "string" ],
      "VpcId": "string"
   }
}

Request Parameters

The request accepts the following data in JSON format.

Description

A textual description for the directory.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 128.

Pattern: ^([a-zA-Z0-9_])[\\a-zA-Z0-9_@#%*+=:?./!\s-]*$

Required: No

Name

The fully qualified name for the directory, such as corp.example.com.

Type: String

Pattern: ^([a-zA-Z0-9]+[\\.-])+([a-zA-Z0-9])+$

Required: Yes

Password

The password for the directory administrator. The directory creation process creates a directory administrator account with the username Administrator and this password.

Type: String

Pattern: (?=^.{8,64}$)((?=.*\d)(?=.*[A-Z])(?=.*[a-z])|(?=.*\d)(?=.*[^A-Za-z0-9\s])(?=.*[a-z])|(?=.*[^A-Za-z0-9\s])(?=.*[A-Z])(?=.*[a-z])|(?=.*\d)(?=.*[A-Z])(?=.*[^A-Za-z0-9\s]))^.*

Required: Yes

ShortName

The short name of the directory, such as CORP.

Type: String

Pattern: ^[^\\/:*?\"\<\>|.]+[^\\/:*?\"<>|]*$

Required: No

Size

The size of the directory.

Type: String

Valid Values: Small | Large

Required: Yes

VpcSettings

A DirectoryVpcSettings object that contains additional information for the operation.

Type: DirectoryVpcSettings object

Required: No

Response Syntax

{
   "DirectoryId": "string"
}

Response Elements

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

The following data is returned in JSON format by the service.

DirectoryId

The identifier of the directory that was created.

Type: String

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

Errors

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

ClientException

A client exception has occurred.

HTTP Status Code: 400

DirectoryLimitExceededException

The maximum number of directories in the region has been reached. You can use the GetDirectoryLimits operation to determine your directory limits in the region.

HTTP Status Code: 400

InvalidParameterException

One or more parameters are not valid.

HTTP Status Code: 400

ServiceException

An exception has occurred in AWS Directory Service.

HTTP Status Code: 500

Examples

The following examples are formatted for legibility.

Example Request

Copy
POST / HTTP/1.1 Host: ds.us-west-2.amazonaws.com Accept-Encoding: identity Content-Length: 245 X-Amz-Target: DirectoryService_20150416.CreateDirectory X-Amz-Date: 20161213T222613Z User-Agent: aws-cli/1.11.24 Python/2.7.9 Windows/7 botocore/1.4.81 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAI7E3BYXS3example/20161213/us-west-2/ds/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=e0bf599277231d294b0ebb1c7ad7a68aafdfc49db016adbee32a167954c53d54 { "Description":"Regional directory for example.com", "VpcSettings":{ "SubnetIds":[ "subnet-ba0146de", "subnet-bef46bc8" ], "VpcId":"vpc-45025421" }, "Name":"seattle.example.com", "ShortName":"seattle", "Password":"Str0ngP@ssw0rd", "Size":"Small" }

Example Response

Copy
HTTP/1.1 200 OK x-amzn-RequestId: 298112b6-c183-11e6-9b49-eff49203d13b Content-Type: application/x-amz-json-1.1 Content-Length: 30 Date: Tue, 13 Dec 2016 22:26:17 GMT { "DirectoryId":"d-926example" }

See Also

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