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 objects in Amazon S3 that have a key that starts with the value specified by s3Directory.

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 BeginDownloadDirectory and EndDownloadDirectory.

Namespace: Amazon.S3.Transfer
Assembly: AWSSDK.S3.dll
Version: 3.x.y.z

Syntax

C# 
public virtual Task DownloadDirectoryAsync(
         String bucketName,
         String s3Directory,
         String localDirectory,
         CancellationToken cancellationToken
)

Parameters

bucketName
Type: System.String

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

s3Directory
Type: System.String

The directory in Amazon S3 to download.

localDirectory
Type: System.String

The local directory to download the objects to.

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:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer