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.

Container for the parameters to the PutObject operation.

Adds an object to a bucket.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.S3.Model.PutWithACLRequest
      Amazon.S3.Model.PutObjectRequest

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

Syntax

C#
public class PutObjectRequest : PutWithACLRequest
         IAmazonWebServiceRequest

The PutObjectRequest type exposes the following members

Constructors

NameDescription
Public Method PutObjectRequest()

Properties

NameTypeDescription
Public Property AutoCloseStream System.Boolean

If this value is set to true then the stream used with this request will be closed when all the content is read from the stream. Default: true.

Public Property AutoResetStreamPosition System.Boolean

If this value is set to true then the stream will be seeked back to the start before being read for upload. Default: true.

Public Property BucketName System.String

The name of the bucket to contain the object.

Public Property CannedACL Amazon.S3.S3CannedACL

A canned access control list (CACL) to apply to the object. Please refer to Amazon.S3.S3CannedACL for information on S3 Canned ACLs.

Public Property ContentBody System.String

Text content to be uploaded. Use this property if you want to upload plaintext to S3. The content type will be set to 'text/plain'.

Public Property ContentType System.String

This is a convenience property for Headers.ContentType.

Public Property FilePath System.String

The full path and name to a file to be uploaded. If this is set the request will upload the specified file to S3.

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.Model.PutWithACLRequest.
Public Property Headers Amazon.S3.Model.HeadersCollection

The collection of headers for the request.

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 and sets Key property. This key is used to identify the object in S3.

Public Property MD5Digest System.String

An MD5 digest for the content.

Public Property Metadata Amazon.S3.Model.MetadataCollection

The collection of meta data for the request.

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 ServerSideEncryptionKeyManagementServiceKeyId System.String

The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. If a key id is not specified, the default key will be used for encryption and decryption.

Public Property ServerSideEncryptionMethod Amazon.S3.ServerSideEncryptionMethod

The Server-side encryption algorithm used when storing this object in S3.

Public Property StorageClass Amazon.S3.S3StorageClass

The type of storage to use for the object. Defaults to 'STANDARD'.

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 TagSet System.Collections.Generic.List<Amazon.S3.Model.Tag>

The tag-set for the object. The tag-set must be encoded as URL Query parameters.

Public Property Timeout System.Nullable<System.TimeSpan>

Overrides the default request timeout value.

Public Property WebsiteRedirectLocation System.String

If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.

Examples

This following examples show multiple ways of creating an object.

This example shows how to put an object, with its content being passed along as a string.

PutObject sample 1


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

// Create a PutObject request
PutObjectRequest request = new PutObjectRequest
{
    BucketName = "SampleBucket",
    Key = "Item1",
    ContentBody = "This is sample content..."
};

// Put object
PutObjectResponse response = client.PutObject(request);

                

This example shows how to put an object, setting its content to be a file.

PutObject sample 2


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

// Create a PutObject request
PutObjectRequest request = new PutObjectRequest
{
    BucketName = "SampleBucket",
    Key = "Item1",
    FilePath = "contents.txt"
};

// Put object
PutObjectResponse response = client.PutObject(request);

                

This example shows how to put an object using a stream.

PutObject sample 3


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

// Create a PutObject request
PutObjectRequest request = new PutObjectRequest
{
    BucketName = "SampleBucket",
    Key = "Item1",
};
using (FileStream stream = new FileStream("contents.txt", FileMode.Open))
{
    request.InputStream = stream;

    // Put object
    PutObjectResponse response = client.PutObject(request);
}

                

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

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