class Aws::S3::Types::GetObjectRequest
@note When making an API call, you may pass GetObjectRequest
data as a hash: { bucket: "BucketName", # required if_match: "IfMatch", if_modified_since: Time.now, if_none_match: "IfNoneMatch", if_unmodified_since: Time.now, key: "ObjectKey", # required range: "Range", response_cache_control: "ResponseCacheControl", response_content_disposition: "ResponseContentDisposition", response_content_encoding: "ResponseContentEncoding", response_content_language: "ResponseContentLanguage", response_content_type: "ResponseContentType", response_expires: Time.now, version_id: "ObjectVersionId", sse_customer_algorithm: "SSECustomerAlgorithm", sse_customer_key: "SSECustomerKey", sse_customer_key_md5: "SSECustomerKeyMD5", request_payer: "requester", # accepts requester part_number: 1, expected_bucket_owner: "AccountId", }
@!attribute [rw] bucket
The bucket name containing the object. When using this action 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 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][1] in the *Amazon S3 User Guide*. When using this action 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 action using S3 on Outposts through the Amazon Web Services 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][2] in the *Amazon S3 User Guide*. [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html @return [String]
@!attribute [rw] if_match
Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed). @return [String]
@!attribute [rw] if_modified_since
Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified). @return [Time]
@!attribute [rw] if_none_match
Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified). @return [String]
@!attribute [rw] if_unmodified_since
Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed). @return [Time]
@!attribute [rw] key
Key of the object to get. @return [String]
@!attribute [rw] range
Downloads the specified range bytes of an object. For more information about the HTTP Range header, see [https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35][1]. <note markdown="1"> Amazon S3 doesn't support retrieving multiple ranges of data per `GET` request. </note> [1]: https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35 @return [String]
@!attribute [rw] response_cache_control
Sets the `Cache-Control` header of the response. @return [String]
@!attribute [rw] response_content_disposition
Sets the `Content-Disposition` header of the response @return [String]
@!attribute [rw] response_content_encoding
Sets the `Content-Encoding` header of the response. @return [String]
@!attribute [rw] response_content_language
Sets the `Content-Language` header of the response. @return [String]
@!attribute [rw] response_content_type
Sets the `Content-Type` header of the response. @return [String]
@!attribute [rw] response_expires
Sets the `Expires` header of the response. @return [Time]
@!attribute [rw] version_id
VersionId used to reference a specific version of the object. @return [String]
@!attribute [rw] sse_customer_algorithm
Specifies the algorithm to use to when decrypting the object (for example, AES256). @return [String]
@!attribute [rw] sse_customer_key
Specifies the customer-provided encryption key for Amazon S3 used to encrypt the data. This value is used to decrypt the object when recovering it and must match the one used when storing the data. The key must be appropriate for use with the algorithm specified in the `x-amz-server-side-encryption-customer-algorithm` header. @return [String]
@!attribute [rw] sse_customer_key_md5
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error. @return [String]
@!attribute [rw] request_payer
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see [Downloading Objects in Requestor Pays Buckets][1] in the *Amazon S3 User Guide*. [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html @return [String]
@!attribute [rw] part_number
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. @return [Integer]
@!attribute [rw] expected_bucket_owner
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. @return [String]
@see docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectRequest AWS API Documentation
Constants
- SENSITIVE