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
 
 
Initiates the asynchronous execution of the Download operation. Amazon.S3.Transfer.TransferUtility.Download

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

Syntax

C# 
public IAsyncResult BeginDownload(
         String filePath,
         String bucketName,
         String key,
         AsyncCallback callback,
         Object state
)

Parameters

filePath
Type: System.String

The file path where the content from Amazon S3 will be written to.

bucketName
Type: System.String

The name of the bucket containing the Amazon S3 object to download.

key
Type: System.String

The key under which the Amazon S3 object is stored.

callback
Type: System.AsyncCallback

An AsyncCallback delegate that is invoked when the operation completes.

state
Type: System.Object

A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.

Return Value
Type: System.IAsyncResult
An IAsyncResult that can be used to poll, or wait for results, or both. This values is also needed when invoking EndDownload.

Exceptions

ExceptionCondition
System.ArgumentNullException
System.Net.WebException
AmazonS3Exception

Version Information

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