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.

Copies from S3 to the local file system. If the file already exists on the local file system and overwrite is set to false than an ArgumentException is thrown.

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

Syntax

C#
public FileInfo CopyToLocal(
         String destFileName,
         Boolean overwrite
)
Parameters
destFileName
Type: System.String

The path where to copy the file to.

overwrite
Type: System.Boolean

Determines whether the file can be overwritten.

Return Value
Type: FileInfo
FileInfo for the local file where file is copied to.

Exceptions

ExceptionCondition
System.IO.IOException If the file already exists locally and overwrite is set to false.
System.Net.WebException
AmazonS3Exception

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5