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.

Download an object in S3 to a file path.

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 BeginDownloadToFilePath and EndDownloadToFilePath.

Namespace: Amazon.Runtime.SharedInterfaces
Assembly: AWSSDK.Core.dll
Version: 3.x.y.z

Syntax

C# 
public abstract Task DownloadToFilePathAsync(
         String bucketName,
         String objectKey,
         String filepath,
         IDictionary<String, Object> additionalProperties,
         CancellationToken cancellationToken
)

Parameters

bucketName
Type: System.String

objectKey
Type: System.String

filepath
Type: System.String

additionalProperties
Type: System.Collections.Generic.IDictionary<System.String, System.Object>

cancellationToken
Type: System.Threading.CancellationToken

Return Value


Type: Task

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5