get_snapshot_limits

DirectoryService.Client.get_snapshot_limits(**kwargs)

Obtains the manual snapshot limits for a directory.

See also: AWS API Documentation

Request Syntax

response = client.get_snapshot_limits(
    DirectoryId='string'
)

Parameters

DirectoryId (string) --

[REQUIRED]

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

Return type

dict

Returns

Response Syntax

{
    'SnapshotLimits': {
        'ManualSnapshotsLimit': 123,
        'ManualSnapshotsCurrentCount': 123,
        'ManualSnapshotsLimitReached': True|False
    }
}

Response Structure

• (dict) --

  Contains the results of the GetSnapshotLimits operation.

  • SnapshotLimits (dict) --

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

    • ManualSnapshotsLimit (integer) --

      The maximum number of manual snapshots allowed.

    • ManualSnapshotsCurrentCount (integer) --

      The current number of manual snapshots of the directory.

    • ManualSnapshotsLimitReached (boolean) --

      Indicates if the manual snapshot limit has been reached.

Exceptions

• DirectoryService.Client.exceptions.EntityDoesNotExistException
• DirectoryService.Client.exceptions.ClientException
• DirectoryService.Client.exceptions.ServiceException