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.

Contains all the parameters that can be set when making a this request with the TransferUtility method.

Inheritance Hierarchy

System.Object
  Amazon.S3.Transfer.BaseUploadRequest
    Amazon.S3.Transfer.TransferUtilityUploadRequest

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

Syntax

C#
public class TransferUtilityUploadRequest : BaseUploadRequest

The TransferUtilityUploadRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property AutoCloseStream System.Boolean

Gets or sets whether or not the stream used with this request is automatically closed when all of the content is read from the stream.

Public Property AutoResetStreamPosition System.Boolean

If this value is set to true then the stream's position will be reset to the start before being read for upload. Default: true.

Public Property BucketKeyEnabled System.Nullable<System.Boolean> Inherited from Amazon.S3.Transfer.BaseUploadRequest.
Public Property BucketName System.String Inherited from Amazon.S3.Transfer.BaseUploadRequest.
Public Property CannedACL Amazon.S3.S3CannedACL Inherited from Amazon.S3.Transfer.BaseUploadRequest.
Public Property ChecksumAlgorithm Amazon.S3.ChecksumAlgorithm Inherited from Amazon.S3.Transfer.BaseUploadRequest.
Public Property ChecksumCRC32 System.String

Gets and sets the property ChecksumCRC32.

This specifies the Base64 encoded, 32-bit CRC-32C checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

Public Property ChecksumCRC32C System.String

Gets and sets the property ChecksumCRC32C.

This specifies the Base64 encoded, 32-bit CRC-32C checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

Public Property ChecksumCRC64NVME System.String

Gets and sets the property ChecksumCRC64NVME.

This specifies the Base64 encoded, 64-bit CRC-64NVME checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

Public Property ChecksumSHA1 System.String

Gets and sets the property ChecksumSHA1.

This specifies the Base64 encoded, 160-bit SHA-1 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

Public Property ChecksumSHA256 System.String

Gets and sets the property ChecksumSHA256.

This specifies the Base64 encoded, 256-bit SHA-256 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

Public Property ContentType System.String Inherited from Amazon.S3.Transfer.BaseUploadRequest.
Public Property DisableDefaultChecksumValidation System.Nullable<System.Boolean> Inherited from Amazon.S3.Transfer.BaseUploadRequest.
Public Property DisablePayloadSigning System.Nullable<System.Boolean> Inherited from Amazon.S3.Transfer.BaseUploadRequest.
Public Property ExpectedBucketOwner System.String Inherited from Amazon.S3.Transfer.BaseUploadRequest.
Public Property FilePath System.String

Gets or sets the file path where the Amazon S3 object will be uploaded from.

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

Public Property Grants System.Collections.Generic.List<Amazon.S3.Model.S3Grant> Inherited from Amazon.S3.Transfer.BaseUploadRequest.
Public Property Headers Amazon.S3.Model.HeadersCollection Inherited from Amazon.S3.Transfer.BaseUploadRequest.
Public Property IfMatch System.String

Gets and sets the property IfMatch used when CompleteMultipartUploadRequest is called to complete the multipart upload.

Uploads the object only if the ETag (entity tag) value provided during the WRITE operation matches the ETag of the object in S3. If the ETag values do not match, the operation returns a 412 Precondition Failed error.

If a conflicting operation occurs during the upload S3 returns a 409 ConditionalRequestConflict response. On a 409 failure you should fetch the object's ETag and retry the upload.

Expects the ETag value as a string.

For more information about conditional requests, see RFC 7232, or Conditional requests in the Amazon S3 User Guide.

Public Property IfNoneMatch System.String

Gets and sets the property IfNoneMatch used when CompleteMultipartUploadRequest is called to complete the multipart upload.

Uploads the object only if the object key name does not already exist in the bucket specified. Otherwise, Amazon S3 returns a 412 Precondition Failed error.

If a conflicting operation occurs during the upload S3 returns a 409 ConditionalRequestConflict response. On a 409 failure you should re-initiate the multipart upload with CreateMultipartUpload and re-upload each part.

Expects the '*' (asterisk) character.

For more information about conditional requests, see RFC 7232, or Conditional requests in the Amazon S3 User Guide.

Public Property InputStream System.IO.Stream

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

Public Property Key System.String

Gets or sets the key under which the Amazon S3 object is to be stored.

Public Property Metadata Amazon.S3.Model.MetadataCollection Inherited from Amazon.S3.Transfer.BaseUploadRequest.
Public Property MpuObjectSize System.Int64

Gets and sets the property MpuObjectSize.

The expected total object size of the multipart upload request. If there's a mismatch between the specified object size value and the actual object size value, it results in an HTTP 400 InvalidRequest error.

Public Property ObjectLockLegalHoldStatus Amazon.S3.ObjectLockLegalHoldStatus Inherited from Amazon.S3.Transfer.BaseUploadRequest.
Public Property ObjectLockMode Amazon.S3.ObjectLockMode Inherited from Amazon.S3.Transfer.BaseUploadRequest.
Public Property ObjectLockRetainUntilDate System.Nullable<System.DateTime> Inherited from Amazon.S3.Transfer.BaseUploadRequest.
Public Property PartSize System.Int64

Gets or sets the part size of the upload in bytes. The uploaded file will be divided into parts the size specified and uploaded to Amazon S3 individually.

Public Property RequestPayer Amazon.S3.RequestPayer Inherited from Amazon.S3.Transfer.BaseUploadRequest.
Public Property ServerSideEncryptionCustomerMethod Amazon.S3.ServerSideEncryptionCustomerMethod Inherited from Amazon.S3.Transfer.BaseUploadRequest.
Public Property ServerSideEncryptionCustomerProvidedKey System.String Inherited from Amazon.S3.Transfer.BaseUploadRequest.
Public Property ServerSideEncryptionCustomerProvidedKeyMD5 System.String Inherited from Amazon.S3.Transfer.BaseUploadRequest.
Public Property ServerSideEncryptionKeyManagementServiceKeyId System.String Inherited from Amazon.S3.Transfer.BaseUploadRequest.
Public Property ServerSideEncryptionMethod Amazon.S3.ServerSideEncryptionMethod Inherited from Amazon.S3.Transfer.BaseUploadRequest.
Public Property SSEKMSEncryptionContext System.String Inherited from Amazon.S3.Transfer.BaseUploadRequest.
Public Property StorageClass Amazon.S3.S3StorageClass Inherited from Amazon.S3.Transfer.BaseUploadRequest.
Public Property TagSet System.Collections.Generic.List<Amazon.S3.Model.Tag> Inherited from Amazon.S3.Transfer.BaseUploadRequest.
Public Property WebsiteRedirectLocation System.String Inherited from Amazon.S3.Transfer.BaseUploadRequest.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.7.2 or higher.

NameDescription
Public Method RemoveCannedACL() Inherited from Amazon.S3.Transfer.BaseUploadRequest.
Public Method WithAutoCloseStream(bool)

Sets whether or not the stream used with this request is automatically closed when all of the content is read from the stream and returns this object instance, enabling additional method calls to be chained together.

Events

NameDescription
Event UploadProgressEvent

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