AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginRestoreFromSnapshot and EndRestoreFromSnapshot.

Namespace: Amazon.DirectoryService
Assembly: AWSSDK.DirectoryService.dll
Version: 3.x.y.z

Syntax

C#
public abstract Task<RestoreFromSnapshotResponse> RestoreFromSnapshotAsync(
         RestoreFromSnapshotRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.DirectoryService.Model.RestoreFromSnapshotRequest

Container for the necessary parameters to execute the RestoreFromSnapshot service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the RestoreFromSnapshot service method, as returned by DirectoryService.

Exceptions

ExceptionCondition
ClientException A client exception has occurred.
EntityDoesNotExistException The specified entity could not be found.
InvalidParameterException One or more parameters are not valid.
ServiceException An exception has occurred in Directory Service.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also