AWS SDK Version 4 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 the S3Directory property and returns response metadata. Uses enhanced multipart download with concurrent part downloads for improved performance.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.7.2 or higher.

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

Syntax

C# 
public virtual Task<TransferUtilityDownloadDirectoryResponse> DownloadDirectoryWithResponseAsync(
         TransferUtilityDownloadDirectoryRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.S3.Transfer.TransferUtilityDownloadDirectoryRequest

Contains all the parameters required to download objects from Amazon S3 into a local directory.

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<TransferUtilityDownloadDirectoryResponse>
The task object representing the asynchronous operation with download response metadata.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer