AWS SDK Version 2 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.

.NET Framework 3.5
Returns information about the GetObject response and response metadata.

Inheritance Hierarchy


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


public class GetObjectResponse : StreamResponse

The GetObjectResponse type exposes the following members


Public Method GetObjectResponse()


Public Property AcceptRanges System.String
Public Property BucketName System.String Gets and sets the BucketName property.
Public Property ContentLength System.Int64 Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property DeleteMarker System.String Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.
Public Property ETag System.String An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL
Public Property Expiration Amazon.S3.Model.Expiration Gets and sets the Expiration property. Specifies the expiration date for the object and the rule governing the expiration. Is null if expiration is not applicable.
Public Property Expires System.DateTime The date and time at which the object is no longer cacheable.
Public Property Headers Amazon.S3.Model.HeadersCollection The collection of headers for the request.
Public Property HttpStatusCode System.Net.HttpStatusCode Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property Key System.String Gets and sets the Key property.
Public Property LastModified System.DateTime Last modified date of the object
Public Property Metadata Amazon.S3.Model.MetadataCollection The collection of meta data for the request.
Public Property MissingMeta System.Int32 This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.
Public Property ReplicationStatus Amazon.S3.ReplicationStatus The status of the replication job associated with this source object.
Public Property ResponseMetadata Amazon.Runtime.ResponseMetadata Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property ResponseStream System.IO.Stream An open stream read from to get the data from S3. In order to use this stream without leaking the underlying resource, please wrap access to the stream within a using block.
Public Property RestoreExpiration System.Nullable<System.DateTime> Gets and sets the RestoreExpiration property. RestoreExpiration will be set for objects that have been restored from Amazon Glacier. It indiciates for those objects how long the restored object will exist.
Public Property RestoreInProgress System.Boolean Gets and sets the RestoreInProgress Will be true when the object is in the process of being restored from Amazon Glacier.
Public Property ServerSideEncryptionCustomerMethod Amazon.S3.ServerSideEncryptionCustomerMethod The Server-side encryption algorithm to be used with the customer provided key.
Public Property ServerSideEncryptionKeyManagementServiceKeyId System.String The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object.
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 class of storage used to store the object.
Public Property VersionId System.String Version of the object.
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.


Public Method Dispose() Disposes of all managed and unmanaged resources.
Public Method WriteResponseStreamToFile(string) Writes the content of the ResponseStream a file indicated by the filePath argument.
Public Method WriteResponseStreamToFile(string, bool) Writes the content of the ResponseStream a file indicated by the filePath argument.


Event WriteObjectProgressEvent The event for Write Object progress notifications. All subscribers will be notified when a new progress event is raised.


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