DirectoryService / Client / restore_from_snapshot

restore_from_snapshot#

DirectoryService.Client.restore_from_snapshot(**kwargs)#

Restores a directory using an existing directory snapshot.

When you restore a directory from a snapshot, any changes made to the directory after the snapshot date are overwritten.

This action returns as soon as the restore operation is initiated. You can monitor the progress of the restore operation by calling the DescribeDirectories operation with the directory identifier. When the DirectoryDescription.Stage value changes to Active, the restore operation is complete.

Request Syntax

response = client.restore_from_snapshot(
    SnapshotId='string'
)

Parameters:

SnapshotId (string) –

[REQUIRED]

The identifier of the snapshot to restore from.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

(dict) –

Contains the results of the RestoreFromSnapshot operation.

Exceptions

DirectoryService.Client.exceptions.EntityDoesNotExistException
DirectoryService.Client.exceptions.InvalidParameterException
DirectoryService.Client.exceptions.ClientException
DirectoryService.Client.exceptions.ServiceException