Menu
AWS Directory Service
API Reference

CreateSnapshot

Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud.

Note

You cannot take snapshots of AD Connector directories.

Request Syntax

{
   "DirectoryId": "string",
   "Name": "string"
}

Request Parameters

The request accepts the following data in JSON format.

DirectoryId

The identifier of the directory of which to take a snapshot.

Type: String

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

Required: Yes

Name

The descriptive name to apply to the snapshot.

Type: String

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

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

Required: No

Response Syntax

{
   "SnapshotId": "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.

SnapshotId

The identifier of the snapshot that was created.

Type: String

Pattern: ^s-[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

EntityDoesNotExistException

The specified entity 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 AWS 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

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: 58 X-Amz-Target: DirectoryService_20150416.CreateSnapshot X-Amz-Date: 20161213T233356Z 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=8789d87320d00e26fec4d745a34b3c5d898e4e89bf96b5f9c744ca612bed3d6d { "DirectoryId":"d-926example", "Name":"ad.example.com" }

Example Response

Copy
HTTP/1.1 200 OK x-amzn-RequestId: 9eedb7ba-c18c-11e6-a099-03078e35561b Content-Type: application/x-amz-json-1.1 Content-Length: 29 Date: Tue, 13 Dec 2016 23:33:58 GMT { "SnapshotId":"s-9267f8d3f0" }

See Also

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