CreateDirectory - Amazon Cloud Directory


Creates a Directory by copying the published schema into the directory. A directory cannot be created without a schema.

You can also quickly create a directory using a managed schema, called the QuickStartSchema. For more information, see Managed Schema in the Amazon Cloud Directory Developer Guide.

Request Syntax

PUT /amazonclouddirectory/2017-01-11/directory/create HTTP/1.1 x-amz-data-partition: SchemaArn Content-type: application/json { "Name": "string" }

URI Request Parameters

The request uses the following URI parameters.


The Amazon Resource Name (ARN) of the published schema that will be copied into the data Directory. For more information, see Arn Examples.

Required: Yes

Request Body

The request accepts the following data in JSON format.


The name of the Directory. Should be unique per account, per region.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9._-]*$

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "AppliedSchemaArn": "string", "DirectoryArn": "string", "Name": "string", "ObjectIdentifier": "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.


The ARN of the published schema in the Directory. Once a published schema is copied into the directory, it has its own ARN, which is referred to applied schema ARN. For more information, see Arn Examples.

Type: String


The ARN that is associated with the Directory. For more information, see Arn Examples.

Type: String


The name of the Directory.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9._-]*$


The root object node of the created directory.

Type: String


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


Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.

HTTP Status Code: 403


Indicates that a Directory could not be created due to a naming conflict. Choose a different name and try again.

HTTP Status Code: 400


Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.

HTTP Status Code: 500


Indicates that the provided ARN value is not valid.

HTTP Status Code: 400


Indicates that limits are exceeded. See Limits for more information.

HTTP Status Code: 400


The specified resource could not be found.

HTTP Status Code: 404


Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

HTTP Status Code: 409


Indicates that your request is malformed in some manner. See the exception message.

HTTP Status Code: 400


The following examples are formatted for legibility.

Example Request

This example illustrates one usage of CreateDirectory.

PUT /amazonclouddirectory/2017-01-11/directory/create HTTP/1.1 Host: Accept-Encoding: identity Content-Length: 22 Authorization: AWS4-HMAC-SHA256 Credential=AKIAI7E3BYXS3example/20170922/us-west-2/clouddirectory/aws4_request, SignedHeaders=host;x-amz-data-partition;x-amz-date, Signature=f347d3f8d6ceccbfd47738ab11fe0194b5efd329b4e0431f7221ee80c672fd9a x-amz-data-partition: arn:aws:clouddirectory:us-west-2:45132example:schema/published/person/1 X-Amz-Date: 20170922T220642Z User-Agent: aws-cli/1.11.150 Python/2.7.9 Windows/8 botocore/1.7.8 { "Name": "ExampleCD" }

Example Response

This example illustrates one usage of CreateDirectory.

HTTP/1.1 200 OK x-amzn-RequestId: f6f0b320-a3e4-11e7-b86b-239c40918c06 Date: Thu, 22 Sep 2017 00:35:44 GMT x-amzn-RequestId: f6f0b320-a3e4-11e7-b86b-239c40918c06 Content-Type: application/json Content-Length: 521 { "AppliedSchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AfMr4qym1kZTvwqOafAYfqI/schema/person/1", "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AfMr4qym1kZTvwqOafAYfqI", "Name": "ExampleCD", "ObjectIdentifier": "AQHzK-KsptZGU78KjmnwGH6i-4guCM3uQFOTA9_NjeHDrg" }

See Also

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