Using the Amazon SDK for .NET with Amazon S3 Glacier - Amazon S3 Glacier
Using the Low-Level APIUsing the High-Level APIRunning .NET ExamplesSetting the Endpoint
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This page is only for existing customers of the S3 Glacier service using Vaults and the original REST API from 2012.

If you're looking for archival storage solutions we suggest using the S3 Glacier storage classes in Amazon S3, S3 Glacier Instant Retrieval, S3 Glacier Flexible Retrieval, and S3 Glacier Deep Archive. To learn more about these storage options, see S3 Glacier storage classes and Long-term data storage using S3 Glacier storage classes in the Amazon S3 User Guide. These storage classes use the Amazon S3 API, are available in all regions, and can be managed within the Amazon S3 console. They offer features like Storage Cost Analysis, Storage Lens, advanced optional encryption features, and more.

Using the Amazon SDK for .NET with Amazon S3 Glacier

The Amazon SDK for .NET API is available in AWSSDK.dll. For information about downloading the Amazon SDK for .NET, go to Sample Code Libraries. As described in Using the Amazon SDKs with Amazon S3 Glacier, the Amazon SDK for .NET provides both the high-level and low-level APIs.

Note

The low-level API and high-level API provide thread-safe clients for accessing S3 Glacier. As a best practice, your applications should create one client and reuse the client between threads.

Using the Low-Level API

The low-level AmazonGlacierClient class provides all the methods that map to the underlying REST operations of Amazon S3 Glacier (S3 Glacier) ( API Reference for Amazon S3 Glacier). When calling any of these methods, you must create a corresponding request object and provide a response object in which the method can return a S3 Glacier response to the operation.

For example, the AmazonGlacierClient class provides the CreateVault method to create a vault. This method maps to the underlying Create Vault REST operation (see Create Vault (PUT vault)). To use this method, you must create instances of the CreateVaultRequest and CreateVaultResponse classes to provide request information and receive a S3 Glacier response as shown in the following C# code snippet:

AmazonGlacierClient client;
client = new AmazonGlacierClient(Amazon.RegionEndpoint.USEast1); 

CreateVaultRequest request = new CreateVaultRequest()
{
  AccountId = "-",
  VaultName = "*** Provide vault name ***"
};

CreateVaultResponse response = client.CreateVault(request);

All the low-level samples in the guide use this pattern.

Note

The preceding code segment specifies AccountId when creating the request. However, when using the Amazon SDK for .NET, the AccountId in the request is optional, and therefore all the low-level examples in this guide don't set this value. The AccountId is the Amazon Web Services account ID. This value must match the Amazon Web Services account ID associated with the credentials used to sign the request. You can specify either the Amazon Web Services account ID or optionally a '-', in which case S3 Glacier uses the Amazon Web Services account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it. When using Amazon SDK for .NET, if you don't provide the account ID, the library sets the account ID to '-'.

Using the High-Level API

To further simplify your application development, the Amazon SDK for .NET provides the ArchiveTransferManager class that implements a higher-level abstraction for some of the methods in the low-level API. It provides useful methods, such as Upload and Download, for the archive operations.

For example, the following C# code snippet uses the Upload high-level method to upload an archive. 

string vaultName = "examplevault";
string archiveToUpload = "c:\folder\exampleArchive.zip";

var manager = new ArchiveTransferManager(Amazon.RegionEndpoint.USEast1);
string archiveId = manager.Upload(vaultName, "archive description", archiveToUpload).ArchiveId;

Note that any operations you perform apply to the Amazon Region you specified when creating the ArchiveTransferManager object. All the high-level examples in this guide use this pattern.

Note

The high-level ArchiveTransferManager class still needs the low-level AmazonGlacierClient client, which you can pass either explicitly or the ArchiveTransferManager creates the client.

Running Code Examples

The easiest way to get started with the .NET code examples is to install the Amazon SDK for .NET. For more information, go to Amazon SDK for .NET.

The following procedure outlines steps for you to test the code examples provided in this guide.

General Process of Creating .NET Code Examples (Using Visual Studio)

1

Create a credentials profile for your Amazon credentials as described in the Amazon SDK for .NET topic Configuring Amazon Credentials.

2

Create a new Visual Studio project using the Amazon Empty Project template.

3

Replace the code in the project file, Program.cs, with the code in the section you are reading.

4

Run the code. Verify that the object is created using the Amazon Web Services Management Console. For more information about Amazon Web Services Management Console, go to http://www.amazonaws.cn/console/.

Setting the Endpoint

By default, the Amazon SDK for .NET sets the endpoint to the US West (Oregon) Region (https://glacier.us-west-2.amazonaws.com.cn). You can set the endpoint to other Amazon Regions as shown in the following C# snippets.

The following snippet shows how to set the endpoint to the US West (Oregon) Region (us-west-2) in the low-level API.

AmazonGlacierClient client = new AmazonGlacierClient(Amazon.RegionEndpoint.USWest2);

The following snippet shows how to set the endpoint to the US West (Oregon) Region in the high-level API.

var manager = new ArchiveTransferManager(Amazon.RegionEndpoint.USWest2);

For a current list of supported Amazon Regions and endpoints, see Accessing Amazon S3 Glacier.