AWS SDK Version 2 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.

.NET Framework 3.5
 
Contains all the parameters that can be set when making a this request with the TransferUtility method.

Inheritance Hierarchy

System.Object
  Amazon.S3.Transfer.BaseDownloadRequest
    Amazon.S3.Transfer.TransferUtilityDownloadRequest

Namespace: Amazon.S3.Transfer
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C#
public class TransferUtilityDownloadRequest : BaseDownloadRequest

The TransferUtilityDownloadRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property BucketName System.String Gets or sets the name of the bucket.
Public Property FilePath System.String Get or sets the file path location of where the downloaded Amazon S3 object will be written to.
Public Property Key System.String Gets or sets the key under which the Amazon S3 object is stored.
Public Property ModifiedSinceDate System.DateTime Gets or sets the ModifiedSinceDate property.
Public Property ServerSideEncryptionCustomerMethod Amazon.S3.ServerSideEncryptionCustomerMethod The Server-side encryption algorithm to be used with the customer provided key.
Public Property ServerSideEncryptionCustomerProvidedKey System.String The base64-encoded encryption key for Amazon S3 to use to decrypt the object

Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only thing you do is manage the encryption keys you provide.

When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies the encryption key you provided matches, and then decrypts the object before returning the object data to you.

Important: Amazon S3 does not store the encryption key you provide.

Public Property ServerSideEncryptionCustomerProvidedKeyMD5 System.String The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set.
Public Property UnmodifiedSinceDate System.DateTime Gets or sets the UnmodifiedSinceDate property.
Public Property VersionId System.String Gets or sets the version ID of the Amazon S3 object.

Events

NameDescription
Event WriteObjectProgressEvent The event for WriteObjectProgressEvent notifications. All subscribers will be notified when a new progress event is raised.

The WriteObjectProgressEvent is fired as data is downloaded from S3. The delegates attached to the event will be passed information detailing how much data has been downloaded as well as how much will be downloaded.

Version Information

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

.NET for Windows Store apps:
Supported in: Windows 8.1, Windows 8

.NET for Windows Phone:
Supported in: Windows Phone 8.1, Windows Phone 8