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.

Downloads an archive from Amazon Glacier from the specified vault for the current user's account. Saves the archive to the specified file.

This method creates an Amazon SNS topic, and an Amazon SQS queue that is subscribed to that topic. It then initiates the archive retrieval job and polls the queue for the archive to be available. This polling takes about 4 hours. Once the archive is available, download will begin.

Additional options can be set using the UploadDirectoryOptions object. For example, you can set the FilesTransferProgress property to a delegate to track progress.

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 BeginDownload and EndDownload.

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

Syntax

C#
public Task DownloadAsync(
         String vaultName,
         String archiveId,
         String filePath,
         DownloadOptions options
)

Parameters

vaultName
Type: System.String

The name of the vault to download the archive from.

archiveId
Type: System.String

The unique ID of the archive to download.

filePath
Type: System.String

The file path to save the archive at.

options
Type: Amazon.Glacier.Transfer.DownloadOptions

Additional options that can be used for the download.

Return Value


Type: Task

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer