AWS SDK for .NET Documentation
UploadPartRequest Class
AmazonAmazon.S3.ModelUploadPartRequest Did this page help you?   Yes   No    Tell us about it...
The parameters to request upload of a part in a multipart upload operation.
Declaration Syntax
C#
public class UploadPartRequest : S3Request
Members
All MembersConstructorsMethodsPropertiesEvents



IconMemberDescription
UploadPartRequest()()()()
Initializes a new instance of the UploadPartRequest class

AddHeader(String, String)
Adds the header to the collection of headers for the request.
(Inherited from S3Request.)
AddHeaders(NameValueCollection)
Adds all of the specified key/value pairs into the request headers collection.
(Inherited from S3Request.)
BucketName
The name of the bucket containing the object to receive the part.

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
FilePath
Full path and name of a file from which the content for the part is retrieved.

FilePosition
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.

GenerateMD5Digest
If set true, an MD5 digest is automatically computed for the part.

GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
InputStream
Input stream for the request; content for the request will be read from the stream.
(Inherited from S3Request.)
Key
The key of the object.

MD5Digest
An MD5 digest for the part.

PartNumber
The identifier of the part to be uploaded.

PartSize
The size of the part to be uploaded.

ReadWriteTimeout
Overrides the default HttpWebRequest ReadWriteTimeout value.
(Inherited from S3Request.)
ServerSideEncryptionCustomerMethod
The Server-side encryption algorithm to be used with the customer provided key.

ServerSideEncryptionCustomerProvidedKey
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.


Timeout
Overrides the default HttpWebRequest timeout value.
(Inherited from S3Request.)
ToString()()()() (Inherited from S3Request.)
UploadId
The upload id for the multipart upload in progress.

UploadPartProgressEvent
The event for Put Object progress notifications. All subscribers will be notified when a new progress event is raised.

WithBucketName(String) Obsolete.
Sets the name of the bucket containing the object to receive the part.

WithFilePath(String) Obsolete.
Sets the full path and name of a file from which the content for the part is retrieved.

WithFilePosition(Int64) Obsolete.
Sets the 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.

WithGenerateChecksum(Boolean) Obsolete.
If set true, an MD5 digest is automatically computed for the part.

WithInputStream(Stream) Obsolete.
Sets an input stream for the request; content for the request will be read from the stream.
(Inherited from S3Request.)
WithKey(String) Obsolete.
Sets the key of the object.

WithMD5Digest(String) Obsolete.
Sets an MD5 digest for the part.

WithPartNumber(Int32) Obsolete.
Sets the identifier of the part to be uploaded.

WithPartSize(Int64) Obsolete.
Sets the size of the part to be uploaded.

WithReadWriteTimeout(Int32) Obsolete.
Custom ReadWriteTimeout property (in milliseconds).

WithSubscriber(EventHandler<(Of <<'(UploadPartProgressArgs>)>>)) Obsolete.
The "handler" will be notified every time a put object progress event is raised.

WithTimeout(Int32) Obsolete.
Custom Timeout property (in milliseconds).

WithUploadId(String) Obsolete.
Sets the upload id for the multipart upload in progress.

Remarks

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.

Examples

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.

CopyMultipart 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<PartETag>
    {
        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);
Inheritance Hierarchy
Object
S3Request
 UploadPartRequest

Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)