Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

GetSnapshotLimits

Obtains the manual snapshot limits for a directory.

Request Syntax


{
   "DirectoryId": "string"
}

Request Parameters

The request accepts the following data in JSON format.

DirectoryId

Contains the identifier of the directory to obtain the limits for.

Type: String

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

Required: Yes

Response Syntax


{
   "SnapshotLimits": { 
      "ManualSnapshotsCurrentCount": number,
      "ManualSnapshotsLimit": number,
      "ManualSnapshotsLimitReached": boolean
   }
}

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.

SnapshotLimits

A SnapshotLimits object that contains the manual snapshot limits for the specified directory.

Type: SnapshotLimits object

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

ServiceException

An exception has occurred in Amazon Directory Service.

HTTP Status Code: 500

Examples

The following examples are formatted for legibility.

Example Request

This example illustrates one usage of GetSnapshotLimits.


POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 31
X-Amz-Target: DirectoryService_20150416.GetSnapshotLimits
X-Amz-Date: 20161214T224507Z
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/20161214/us-west-2/ds/aws4_request, 
 SignedHeaders=content-type;host;x-amz-date;x-amz-target, 
 Signature=f9ba790cf905e14fa97fd1ed6a961c72d83a23f3e54ab126d8e4a30ec14d3cdb

 {
   "DirectoryId": "d-926example"
 }

Example Response

This example illustrates one usage of GetSnapshotLimits.


HTTP/1.1 200 OK
x-amzn-RequestId: f7895979-c24e-11e6-a0ba-6bb2a89ebc49
Content-Type: application/x-amz-json-1.1
Content-Length: 113
Date: Wed, 14 Dec 2016 22:45:09 GMT

{
   "SnapshotLimits":{
      "ManualSnapshotsCurrentCount":1,
      "ManualSnapshotsLimit":5,
      "ManualSnapshotsLimitReached":false
   }
}