GetObjectRequest Class | AWS SDK for .NET V2

Container for the parameters to the GetObject operation.

Retrieves objects from Amazon S3.

Inheritance Hierarchy

System.Object
Amazon.Runtime.AmazonWebServiceRequest
Amazon.S3.Model.GetObjectRequest

Namespace: Amazon.S3.Model
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

public class GetObjectRequest : AmazonWebServiceRequest
         IRequestEvents

The GetObjectRequest type exposes the following members

Constructors

	Name	Description
	GetObjectRequest()

Properties

Name	Type	Description
BucketName	System.String	The name of the bucket containing the object.
ByteRange	Amazon.S3.Model.ByteRange	Downloads the specified range bytes of an object.
EtagToMatch	System.String	ETag to be matched as a pre-condition for returning the object, otherwise a PreconditionFailed signal is returned.
EtagToNotMatch	System.String	ETag that should not be matched as a pre-condition for returning the object, otherwise a PreconditionFailed signal is returned.
Key	System.String
ModifiedSinceDate	System.DateTime	Returns the object only if it has been modified since the specified time, otherwise returns a PreconditionFailed.
ResponseExpires	System.DateTime	Sets the Expires header of the response.
ResponseHeaderOverrides	Amazon.S3.Model.ResponseHeaderOverrides	A set of response headers that should be returned with the object.
ServerSideEncryptionCustomerMethod	Amazon.S3.ServerSideEncryptionCustomerMethod	The Server-side encryption algorithm to be used with the customer provided key.
ServerSideEncryptionCustomerProvidedKey	System.String	The base64-encoded encryption key for Amazon S3 to use to decrypt 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.
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.
UnmodifiedSinceDate	System.DateTime	Returns the object only if it has not been modified since the specified time, otherwise returns a PreconditionFailed.
VersionId	System.String	VersionId used to reference a specific version of the object.

Examples

This example shows how to get an object.

GetObject sample


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

// Create a GetObject request
GetObjectRequest request = new GetObjectRequest
{
    BucketName = "SampleBucket",
    Key = "Item1"
};

// Issue request and remember to dispose of the response
using (GetObjectResponse response = client.GetObject(request))
{
    using (StreamReader reader = new StreamReader(response.ResponseStream))
    {
        string contents = reader.ReadToEnd();
        Console.WriteLine("Object - " + response.Key);
        Console.WriteLine(" Version Id - " + response.VersionId);
        Console.WriteLine(" Contents - " + contents);
    }
}

Version Information

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

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

.NET for Windows Phone:
Supported in: Windows Phone 8.1, Windows Phone 8