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 the content from Amazon S3 and writes it to the specified file.

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.S3.Transfer
Assembly: AWSSDK.S3.dll
Version: 3.x.y.z

Syntax

C#
public virtual Task DownloadAsync(
         String filePath,
         String bucketName,
         String key,
         CancellationToken cancellationToken
)
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.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value
Type: Task
The task object representing the asynchronous operation.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5