Class GetObjectRequest
Container for the parameters to the GetObject operation.
Retrieves objects from Amazon S3.
public class GetObjectRequest : AmazonWebServiceRequest- Inheritance
-
GetObjectRequest
Constructors
GetObjectRequest()
public GetObjectRequest()Properties
BucketName
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 string BucketName { get; set; }Property Value
ByteRange
Downloads the specified range bytes of an object.
public ByteRange ByteRange { get; set; }Property Value
EtagToMatch
ETag to be matched as a pre-condition for returning the object, otherwise a PreconditionFailed signal is returned.
public string EtagToMatch { get; set; }Property Value
EtagToNotMatch
ETag that should not be matched as a pre-condition for returning the object, otherwise a PreconditionFailed signal is returned.
public string EtagToNotMatch { get; set; }Property Value
ExpectedBucketOwner
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 string ExpectedBucketOwner { get; set; }Property Value
Key
Gets and sets the Key property. This is the user defined key that identifies the object in the bucket.
public string Key { get; set; }Property Value
Remarks
This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." is interpreted as use parent directory. For further information view the documentation for the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri
ModifiedSinceDate
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.[Obsolete("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.", false)]
public DateTime ModifiedSinceDate { get; set; }Property Value
ModifiedSinceDateUtc
Returns the object only if it has been modified since the specified time, otherwise returns a PreconditionFailed.
public DateTime ModifiedSinceDateUtc { get; set; }Property Value
PartNumber
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 int? PartNumber { get; set; }Property Value
- int?
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 RequestPayer RequestPayer { get; set; }Property Value
ResponseExpires
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.[Obsolete("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.", false)]
public DateTime ResponseExpires { get; set; }Property Value
ResponseExpiresUtc
Sets the Expires header of the response.
public DateTime ResponseExpiresUtc { get; set; }Property Value
ResponseHeaderOverrides
A set of response headers that should be returned with the object.
public ResponseHeaderOverrides ResponseHeaderOverrides { get; set; }Property Value
ServerSideEncryptionCustomerMethod
The Server-side encryption algorithm to be used with the customer provided key.
public ServerSideEncryptionCustomerMethod ServerSideEncryptionCustomerMethod { get; set; }Property Value
ServerSideEncryptionCustomerProvidedKey
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 string ServerSideEncryptionCustomerProvidedKey { get; set; }Property Value
ServerSideEncryptionCustomerProvidedKeyMD5
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 string ServerSideEncryptionCustomerProvidedKeyMD5 { get; set; }Property Value
UnmodifiedSinceDate
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.[Obsolete("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.", false)]
public DateTime UnmodifiedSinceDate { get; set; }Property Value
UnmodifiedSinceDateUtc
Returns the object only if it has not been modified since the specified time, otherwise returns a PreconditionFailed.
public DateTime UnmodifiedSinceDateUtc { get; set; }Property Value
VersionId
VersionId used to reference a specific version of the object.
public string VersionId { get; set; }