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.

The parameters to request upload of a part in a multipart upload operation.

Inheritance Hierarchy


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


public class UploadPartRequest : AmazonWebServiceRequest

The UploadPartRequest type exposes the following members


Public Method UploadPartRequest()


Public Property BucketName System.String

The name of the bucket containing the object to receive the part.

Public Property FilePath System.String

Full path and name of a file from which the content for the part is retrieved.

For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt".

Public Property FilePosition System.Int64

Position in the file specified by FilePath from which to retrieve the content of the part. This field is required when a file path is specified. It is ignored when using the InputStream property.

Public Property InputStream System.IO.Stream

Input stream for the request; content for the request will be read from the stream.

Public Property IsLastPart System.Boolean

Caller needs to set this to true when uploading the last part. This property only needs to be set when using the AmazonS3EncryptionClient.

Public Property Key System.String

The key of the object.

Public Property MD5Digest System.String

An MD5 digest for the part.

Public Property PartNumber System.Int32

Part number of part being uploaded.

Public Property PartSize System.Int64

The size of the part to be uploaded.

Public Property ReadWriteTimeout System.Nullable<System.TimeSpan>

Overrides the default ReadWriteTimeout value.

Public Property RequestPayer Amazon.S3.RequestPayer

Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests.

Public Property ServerSideEncryptionCustomerMethod Amazon.S3.ServerSideEncryptionCustomerMethod

The Server-side encryption algorithm to be used with the customer provided key.

Public Property ServerSideEncryptionCustomerProvidedKey System.String

The base64-encoded encryption key for Amazon S3 to use to encrypt the object

Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only thing you do is manage the encryption keys you provide.

When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies the encryption key you provided matches, and then decrypts the object before returning the object data to you.

Important: Amazon S3 does not store the encryption key you provide.

Public Property ServerSideEncryptionCustomerProvidedKeyMD5 System.String

The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set.

Public Property StreamTransferProgress System.EventHandler<Amazon.Runtime.StreamTransferProgressArgs>

Attach a callback that will be called as data is being sent to the AWS Service.

Public Property Timeout System.Nullable<System.TimeSpan>

Overrides the default request timeout value.

Public Property UploadId System.String

Upload ID identifying the multipart upload whose part is being uploaded.

Public Property UseChunkEncoding System.Boolean

If this value is set to true then a chunked encoding upload will be used for the request. Default: true.


This example shows how to upload 13MB of data using mutlipart upload.
The data is contained in a stream and the upload is done in 3 parts: 5MB, 5MB, then the remainder.

Multipart Upload Sample

int MB = (int)Math.Pow(2, 20);

// Create a client
AmazonS3Client client = new AmazonS3Client();

// Define input stream
Stream inputStream = Create13MBDataStream();

// Initiate multipart upload
InitiateMultipartUploadRequest initRequest = new InitiateMultipartUploadRequest
    BucketName = "SampleBucket",
    Key = "Item1"
InitiateMultipartUploadResponse initResponse = client.InitiateMultipartUpload(initRequest);

// Upload part 1
UploadPartRequest uploadRequest = new UploadPartRequest
    BucketName = "SampleBucket",
    Key = "Item1",
    UploadId = initResponse.UploadId,
    PartNumber = 1,
    PartSize = 5 * MB,
    InputStream = inputStream
UploadPartResponse up1Response = client.UploadPart(uploadRequest);

// Upload part 2
uploadRequest = new UploadPartRequest
    BucketName = "SampleBucket",
    Key = "Item1",
    UploadId = initResponse.UploadId,
    PartNumber = 2,
    PartSize = 5 * MB,
    InputStream = inputStream
UploadPartResponse up2Response = client.UploadPart(uploadRequest);

// Upload part 3
uploadRequest = new UploadPartRequest
    BucketName = "SampleBucket",
    Key = "Item1",
    UploadId = initResponse.UploadId,
    PartNumber = 3,
    InputStream = inputStream
UploadPartResponse up3Response = client.UploadPart(uploadRequest);

// List parts for current upload
ListPartsRequest listPartRequest = new ListPartsRequest
    BucketName = "SampleBucket",
    Key = "Item1",
    UploadId = initResponse.UploadId
ListPartsResponse listPartResponse = client.ListParts(listPartRequest);
Debug.Assert(listPartResponse.Parts.Count == 3);

// Complete the multipart upload
CompleteMultipartUploadRequest compRequest = new CompleteMultipartUploadRequest
    BucketName = "SampleBucket",
    Key = "Item1",
    UploadId = initResponse.UploadId,
    PartETags = new List
        new PartETag { ETag = up1Response.ETag, PartNumber = 1 },
        new PartETag { ETag = up2Response.ETag, PartNumber = 2 },
        new PartETag { ETag = up3Response.ETag, PartNumber = 3 }
CompleteMultipartUploadResponse compResponse = client.CompleteMultipartUpload(compRequest);



If PartSize is not specified then the rest of the content from the file or stream will be sent to Amazon S3.

You must set either the FilePath or InputStream. If FilePath is set then the FilePosition property must be set.

Version Information

.NET Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

Supported Versions: 4.6 and above
Supported Platforms: Android, iOS, Standalone