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.

Container for the parameters to the UploadArchive operation. This operation adds an archive to a vault. This is a synchronous operation, and for a successful upload, your data is durably persisted. Amazon Glacier returns the archive ID in the x-amz-archive-id header of the response.

You must use the archive ID to access your data in Amazon Glacier. After you upload an archive, you should save the archive ID returned so that you can retrieve or delete the archive later. Besides saving the archive ID, you can also index it and give it a friendly name to allow for better searching. You can also use the optional archive description field to specify how the archive is referred to in an external index of archives, such as you might create in Amazon DynamoDB. You can also get the vault inventory to obtain a list of archive IDs in a vault. For more information, see InitiateJob.

You must provide a SHA256 tree hash of the data you are uploading. For information about computing a SHA256 tree hash, see Computing Checksums.

You can optionally specify an archive description of up to 1,024 printable ASCII characters. You can get the archive description when you either retrieve the archive or get the vault inventory. For more information, see InitiateJob. Amazon Glacier does not interpret the description in any way. An archive description does not need to be unique. You cannot use the description to retrieve or sort the archive list.

Archives are immutable. After you upload an archive, you cannot edit the archive or its description.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

For conceptual information and underlying REST API, go to Uploading an Archive in Amazon Glacier and Upload Archive in the Amazon Glacier Developer Guide.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Glacier.AmazonGlacierRequest
      Amazon.Glacier.Model.UploadArchiveRequest

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

Syntax

C#
public class UploadArchiveRequest : AmazonGlacierRequest
         IAmazonWebServiceRequest

The UploadArchiveRequest type exposes the following members

Constructors

NameDescription
Public Method UploadArchiveRequest()

Empty constructor used to set properties independently even when a simple constructor is available

Public Method UploadArchiveRequest(string, string, string, Stream)

Instantiates UploadArchiveRequest with the parameterized properties

Public Method UploadArchiveRequest(string, string, string, string, Stream)

Instantiates UploadArchiveRequest with the parameterized properties

Properties

NameTypeDescription
Public Property AccountId System.String

Gets and sets the property AccountId.

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

Public Property ArchiveDescription System.String

Gets and sets the property ArchiveDescription.

The optional description of the archive you are uploading.

Public Property Body System.IO.Stream

Gets and sets the property Body.

The data to upload.

Public Property Checksum System.String

Gets and sets the property Checksum.

The SHA256 tree hash of the data being uploaded.

Public Property StreamTransferProgress System.EventHandler<Amazon.Runtime.StreamTransferProgressArgs>

Attach a callback that will be called as data is being sent to the AWS Service.

Public Property VaultName System.String

Gets and sets the property VaultName.

The name of the vault.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms