GetObjectRequest Class | AWS SDK for .NET V3 (original) (raw)

Name Type Description
Public Property BucketName System.String Gets and sets the property BucketName. The bucket name containing the object. Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format _bucket-base-name_--_zone-id_--x-s3 (for example, _amzn-s3-demo-bucket_--_usw2-az1_--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.Object Lambda access points - When you use this action with an Object Lambda access point, you must direct requests to the Object Lambda access point hostname. The Object Lambda access point hostname takes the form _AccessPointName_-AccountId.s3-object-lambda.Region.amazonaws.com. Object Lambda access points are not supported by directory buckets.S3 on Outposts - When you use this action with 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 you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.
Public Property ByteRange Amazon.S3.Model.ByteRange Downloads the specified range bytes of an object. For more information about the HTTP Range header, see https://www.rfc-editor.org/rfc/rfc9110.html#name-range. Amazon S3 doesn't support retrieving multiple ranges of data per GET request.
Public Property ChecksumMode Amazon.S3.ChecksumMode Gets and sets the property ChecksumMode. To retrieve the checksum, this mode must be enabled.General purpose buckets - In addition, if you enable checksum mode and the object is uploaded with a checksum and encrypted with an Key Management Service (KMS) key, you must have permission to use the kms:Decrypt action to retrieve the checksum.
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 NotModified (304) signal is returned.
Public Property ExpectedBucketOwner System.String Gets and sets the property ExpectedBucketOwner. The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code403 Forbidden (access denied).
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 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. This functionality is not supported for directory buckets.
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. This functionality is not supported for directory buckets.
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. This functionality is not supported for directory buckets.
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. This functionality is not supported for directory buckets.