PutObjectRequest Class

.NET Framework 4.5
 
 
 
Did this page help you?  Yes  No   Tell us about it...
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.dll
Version: 2.0.0.3

Syntax

C#
public class PutObjectRequest : PutWithACLRequest
         IRequestEvents

The PutObjectRequest type exposes the following members

Constructors

  Name Description
Public Method PutObjectRequest()

Properties

  Name Description
Public Property AutoCloseStream 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 BucketName The name of the bucket to contain the object.
Public Property CannedACL A canned access control list (CACL) to apply to the object. Please refer to for information on S3 Canned ACLs.
Public Property ContentBody 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 This is a convenience property for Headers.ContentType.
Public Property FilePath

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 Gets the access control lists (ACLs) for this request. Please refer to for information on S3 Grants.
Public Property Headers The collection of headers for the request.
Public Property InputStream Input stream for the request; content for the request will be read from the stream.
Public Property Key
Public Property MD5Digest An MD5 digest for the content.
Public Property MetaData The collection of meta data for the request.
Public Property ServerSideEncryptionMethod The Server-side encryption algorithm used when storing this object in S3.
Public Property StorageClass The type of storage to use for the object. Defaults to 'STANDARD'.
Public Property StreamTransferProgress Attach a callback that will be called as data is being sent to the AWS Service.
Public Property WebsiteRedirectLocation 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 Framework:
Supported in: 4.5, 4.0, 3.5

.NET for Windows Store apps:
Supported in: Windows 8

.NET for Windows Phone:
Supported in: Window Phone 8