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.

Writes the content of the ResponseStream a file indicated by the filePath argument.

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 BeginWriteResponseStreamToFile and EndWriteResponseStreamToFile.

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

Syntax

C#
public Task WriteResponseStreamToFileAsync(
         String filePath,
         Boolean append,
         CancellationToken cancellationToken
)

Parameters

filePath
Type: System.String

The location where to write the ResponseStream

append
Type: System.Boolean

Whether or not to append to the file if it exists

cancellationToken
Type: System.Threading.CancellationToken

Cancellation token which can be used to cancel this operation.

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