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 GetObject operation.

Retrieves objects from Amazon S3.

Inheritance Hierarchy

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

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

Syntax

C#
public class GetObjectRequest : AmazonWebServiceRequest
         IAmazonWebServiceRequest

The GetObjectRequest type exposes the following members

Constructors

NameDescription
Public Method GetObjectRequest()

Properties

NameTypeDescription
Public Property BucketName System.String

The bucket name containing the object.

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

Public Property ByteRange Amazon.S3.Model.ByteRange

Downloads the specified range bytes of an object.

Public Property EtagToMatch System.String

ETag to be matched as a pre-condition for returning the object, otherwise a PreconditionFailed signal is returned.

Public Property EtagToNotMatch System.String

ETag that should not be matched as a pre-condition for returning the object, otherwise a PreconditionFailed signal is returned.

Public Property ExpectedBucketOwner System.String

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Public Property Key System.String

Gets and sets the Key property. This is the user defined key that identifies the object in the bucket.

Public Property ModifiedSinceDate System.DateTime

This property is deprecated. Setting this property results in non-UTC DateTimes not being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, the latest assignment to either one of the two property is reflected in the value of both. ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime to it results in the wrong timestamp being passed to the service.

Returns the object only if it has been modified since the specified time, otherwise returns a PreconditionFailed.

Public Property ModifiedSinceDateUtc System.DateTime

Returns the object only if it has been modified since the specified time, otherwise returns a PreconditionFailed.

Public Property PartNumber System.Nullable<System.Int32>

Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' GET request for the part specified. Useful for downloading just a part of an object.

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 ResponseExpires System.DateTime

This property is deprecated. Setting this property results in non-UTC DateTimes not being marshalled correctly. Use ResponseExpiresUtc instead. Setting either ResponseExpires or ResponseExpiresUtc results in both ResponseExpires and ResponseExpiresUtc being assigned, the latest assignment to either one of the two property is reflected in the value of both. ResponseExpires is provided for backwards compatibility only and assigning a non-Utc DateTime to it results in the wrong timestamp being passed to the service.

Sets the Expires header of the response.

Public Property ResponseExpiresUtc System.DateTime

Sets the Expires header of the response.

Public Property ResponseHeaderOverrides Amazon.S3.Model.ResponseHeaderOverrides

A set of response headers that should be returned with the object.

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 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.

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 UnmodifiedSinceDate System.DateTime

This property is deprecated. Setting this property results in non-UTC DateTimes not being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, the latest assignment to either one of the two property is reflected in the value of both. UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime to it results in the wrong timestamp being passed to the service.

Returns the object only if it has not been modified since the specified time, otherwise returns a PreconditionFailed.

Public Property UnmodifiedSinceDateUtc System.DateTime

Returns the object only if it has not been modified since the specified time, otherwise returns a PreconditionFailed.

Public Property 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);
    }
}

                

This example shows how to get an object and write it to a local file.

GetObject WriteResponseStreamToFile 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))
{
    // Save object to local file
    response.WriteResponseStreamToFile("Item1.txt");
}

                

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0, 1.3

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