Struct aws_sdk_s3::operation::get_object::GetObjectInput
source · #[non_exhaustive]pub struct GetObjectInput {Show 21 fields
pub bucket: Option<String>,
pub if_match: Option<String>,
pub if_modified_since: Option<DateTime>,
pub if_none_match: Option<String>,
pub if_unmodified_since: Option<DateTime>,
pub key: Option<String>,
pub range: Option<String>,
pub response_cache_control: Option<String>,
pub response_content_disposition: Option<String>,
pub response_content_encoding: Option<String>,
pub response_content_language: Option<String>,
pub response_content_type: Option<String>,
pub response_expires: Option<DateTime>,
pub version_id: Option<String>,
pub sse_customer_algorithm: Option<String>,
pub sse_customer_key: Option<String>,
pub sse_customer_key_md5: Option<String>,
pub request_payer: Option<RequestPayer>,
pub part_number: Option<i32>,
pub expected_bucket_owner: Option<String>,
pub checksum_mode: Option<ChecksumMode>,
}
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.bucket: Option<String>
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-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3
(for example, DOC-EXAMPLE-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, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. 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.
Access points and Object Lambda access points are not supported by directory buckets.
S3 on Outposts - When you use 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.
if_match: Option<String>
Return the object only if its entity tag (ETag) is the same as the one specified in this header; otherwise, return a 412 Precondition Failed
error.
If both of the If-Match
and If-Unmodified-Since
headers are present in the request as follows: If-Match
condition evaluates to true
, and; If-Unmodified-Since
condition evaluates to false
; then, S3 returns 200 OK
and the data requested.
For more information about conditional requests, see RFC 7232.
if_modified_since: Option<DateTime>
Return the object only if it has been modified since the specified time; otherwise, return a 304 Not Modified
error.
If both of the If-None-Match
and If-Modified-Since
headers are present in the request as follows: If-None-Match
condition evaluates to false
, and; If-Modified-Since
condition evaluates to true
; then, S3 returns 304 Not Modified
status code.
For more information about conditional requests, see RFC 7232.
if_none_match: Option<String>
Return the object only if its entity tag (ETag) is different from the one specified in this header; otherwise, return a 304 Not Modified
error.
If both of the If-None-Match
and If-Modified-Since
headers are present in the request as follows: If-None-Match
condition evaluates to false
, and; If-Modified-Since
condition evaluates to true
; then, S3 returns 304 Not Modified
HTTP status code.
For more information about conditional requests, see RFC 7232.
if_unmodified_since: Option<DateTime>
Return the object only if it has not been modified since the specified time; otherwise, return a 412 Precondition Failed
error.
If both of the If-Match
and If-Unmodified-Since
headers are present in the request as follows: If-Match
condition evaluates to true
, and; If-Unmodified-Since
condition evaluates to false
; then, S3 returns 200 OK
and the data requested.
For more information about conditional requests, see RFC 7232.
key: Option<String>
Key of the object to get.
range: Option<String>
Downloads the specified byte range 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.
response_cache_control: Option<String>
Sets the Cache-Control
header of the response.
response_content_disposition: Option<String>
Sets the Content-Disposition
header of the response.
response_content_encoding: Option<String>
Sets the Content-Encoding
header of the response.
response_content_language: Option<String>
Sets the Content-Language
header of the response.
response_content_type: Option<String>
Sets the Content-Type
header of the response.
response_expires: Option<DateTime>
Sets the Expires
header of the response.
version_id: Option<String>
Version ID used to reference a specific version of the object.
By default, the GetObject
operation returns the current version of an object. To return a different version, use the versionId
subresource.
-
If you include a
versionId
in your request header, you must have thes3:GetObjectVersion
permission to access a specific version of an object. Thes3:GetObject
permission is not required in this scenario. -
If you request the current version of an object without a specific
versionId
in the request header, only thes3:GetObject
permission is required. Thes3:GetObjectVersion
permission is not required in this scenario. -
Directory buckets - S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the
null
value of the version ID is supported by directory buckets. You can only specifynull
to theversionId
query parameter in the request.
For more information about versioning, see PutBucketVersioning.
sse_customer_algorithm: Option<String>
Specifies the algorithm to use when decrypting the object (for example, AES256
).
If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers:
-
x-amz-server-side-encryption-customer-algorithm
-
x-amz-server-side-encryption-customer-key
-
x-amz-server-side-encryption-customer-key-MD5
For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide.
This functionality is not supported for directory buckets.
sse_customer_key: Option<String>
Specifies the customer-provided encryption key that you originally provided for Amazon S3 to encrypt the data before storing it. 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.
If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers:
-
x-amz-server-side-encryption-customer-algorithm
-
x-amz-server-side-encryption-customer-key
-
x-amz-server-side-encryption-customer-key-MD5
For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide.
This functionality is not supported for directory buckets.
sse_customer_key_md5: Option<String>
Specifies the 128-bit MD5 digest of the customer-provided 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.
If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers:
-
x-amz-server-side-encryption-customer-algorithm
-
x-amz-server-side-encryption-customer-key
-
x-amz-server-side-encryption-customer-key-MD5
For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide.
This functionality is not supported for directory buckets.
request_payer: Option<RequestPayer>
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.
This functionality is not supported for directory buckets.
part_number: Option<i32>
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.
expected_bucket_owner: Option<String>
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 code 403 Forbidden
(access denied).
checksum_mode: Option<ChecksumMode>
To retrieve the checksum, this mode must be enabled.
Implementations§
source§impl GetObjectInput
impl GetObjectInput
sourcepub fn bucket(&self) -> Option<&str>
pub fn bucket(&self) -> Option<&str>
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-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3
(for example, DOC-EXAMPLE-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, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. 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.
Access points and Object Lambda access points are not supported by directory buckets.
S3 on Outposts - When you use 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.
sourcepub fn if_match(&self) -> Option<&str>
pub fn if_match(&self) -> Option<&str>
Return the object only if its entity tag (ETag) is the same as the one specified in this header; otherwise, return a 412 Precondition Failed
error.
If both of the If-Match
and If-Unmodified-Since
headers are present in the request as follows: If-Match
condition evaluates to true
, and; If-Unmodified-Since
condition evaluates to false
; then, S3 returns 200 OK
and the data requested.
For more information about conditional requests, see RFC 7232.
sourcepub fn if_modified_since(&self) -> Option<&DateTime>
pub fn if_modified_since(&self) -> Option<&DateTime>
Return the object only if it has been modified since the specified time; otherwise, return a 304 Not Modified
error.
If both of the If-None-Match
and If-Modified-Since
headers are present in the request as follows: If-None-Match
condition evaluates to false
, and; If-Modified-Since
condition evaluates to true
; then, S3 returns 304 Not Modified
status code.
For more information about conditional requests, see RFC 7232.
sourcepub fn if_none_match(&self) -> Option<&str>
pub fn if_none_match(&self) -> Option<&str>
Return the object only if its entity tag (ETag) is different from the one specified in this header; otherwise, return a 304 Not Modified
error.
If both of the If-None-Match
and If-Modified-Since
headers are present in the request as follows: If-None-Match
condition evaluates to false
, and; If-Modified-Since
condition evaluates to true
; then, S3 returns 304 Not Modified
HTTP status code.
For more information about conditional requests, see RFC 7232.
sourcepub fn if_unmodified_since(&self) -> Option<&DateTime>
pub fn if_unmodified_since(&self) -> Option<&DateTime>
Return the object only if it has not been modified since the specified time; otherwise, return a 412 Precondition Failed
error.
If both of the If-Match
and If-Unmodified-Since
headers are present in the request as follows: If-Match
condition evaluates to true
, and; If-Unmodified-Since
condition evaluates to false
; then, S3 returns 200 OK
and the data requested.
For more information about conditional requests, see RFC 7232.
sourcepub fn range(&self) -> Option<&str>
pub fn range(&self) -> Option<&str>
Downloads the specified byte range 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.
sourcepub fn response_cache_control(&self) -> Option<&str>
pub fn response_cache_control(&self) -> Option<&str>
Sets the Cache-Control
header of the response.
sourcepub fn response_content_disposition(&self) -> Option<&str>
pub fn response_content_disposition(&self) -> Option<&str>
Sets the Content-Disposition
header of the response.
sourcepub fn response_content_encoding(&self) -> Option<&str>
pub fn response_content_encoding(&self) -> Option<&str>
Sets the Content-Encoding
header of the response.
sourcepub fn response_content_language(&self) -> Option<&str>
pub fn response_content_language(&self) -> Option<&str>
Sets the Content-Language
header of the response.
sourcepub fn response_content_type(&self) -> Option<&str>
pub fn response_content_type(&self) -> Option<&str>
Sets the Content-Type
header of the response.
sourcepub fn response_expires(&self) -> Option<&DateTime>
pub fn response_expires(&self) -> Option<&DateTime>
Sets the Expires
header of the response.
sourcepub fn version_id(&self) -> Option<&str>
pub fn version_id(&self) -> Option<&str>
Version ID used to reference a specific version of the object.
By default, the GetObject
operation returns the current version of an object. To return a different version, use the versionId
subresource.
-
If you include a
versionId
in your request header, you must have thes3:GetObjectVersion
permission to access a specific version of an object. Thes3:GetObject
permission is not required in this scenario. -
If you request the current version of an object without a specific
versionId
in the request header, only thes3:GetObject
permission is required. Thes3:GetObjectVersion
permission is not required in this scenario. -
Directory buckets - S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the
null
value of the version ID is supported by directory buckets. You can only specifynull
to theversionId
query parameter in the request.
For more information about versioning, see PutBucketVersioning.
sourcepub fn sse_customer_algorithm(&self) -> Option<&str>
pub fn sse_customer_algorithm(&self) -> Option<&str>
Specifies the algorithm to use when decrypting the object (for example, AES256
).
If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers:
-
x-amz-server-side-encryption-customer-algorithm
-
x-amz-server-side-encryption-customer-key
-
x-amz-server-side-encryption-customer-key-MD5
For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide.
This functionality is not supported for directory buckets.
sourcepub fn sse_customer_key(&self) -> Option<&str>
pub fn sse_customer_key(&self) -> Option<&str>
Specifies the customer-provided encryption key that you originally provided for Amazon S3 to encrypt the data before storing it. 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.
If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers:
-
x-amz-server-side-encryption-customer-algorithm
-
x-amz-server-side-encryption-customer-key
-
x-amz-server-side-encryption-customer-key-MD5
For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide.
This functionality is not supported for directory buckets.
sourcepub fn sse_customer_key_md5(&self) -> Option<&str>
pub fn sse_customer_key_md5(&self) -> Option<&str>
Specifies the 128-bit MD5 digest of the customer-provided 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.
If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers:
-
x-amz-server-side-encryption-customer-algorithm
-
x-amz-server-side-encryption-customer-key
-
x-amz-server-side-encryption-customer-key-MD5
For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide.
This functionality is not supported for directory buckets.
sourcepub fn request_payer(&self) -> Option<&RequestPayer>
pub fn request_payer(&self) -> Option<&RequestPayer>
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.
This functionality is not supported for directory buckets.
sourcepub fn part_number(&self) -> Option<i32>
pub fn part_number(&self) -> Option<i32>
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.
sourcepub fn expected_bucket_owner(&self) -> Option<&str>
pub fn expected_bucket_owner(&self) -> Option<&str>
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 code 403 Forbidden
(access denied).
sourcepub fn checksum_mode(&self) -> Option<&ChecksumMode>
pub fn checksum_mode(&self) -> Option<&ChecksumMode>
To retrieve the checksum, this mode must be enabled.
source§impl GetObjectInput
impl GetObjectInput
sourcepub fn builder() -> GetObjectInputBuilder
pub fn builder() -> GetObjectInputBuilder
Creates a new builder-style object to manufacture GetObjectInput
.
Trait Implementations§
source§impl Clone for GetObjectInput
impl Clone for GetObjectInput
source§fn clone(&self) -> GetObjectInput
fn clone(&self) -> GetObjectInput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for GetObjectInput
impl Debug for GetObjectInput
source§impl PartialEq for GetObjectInput
impl PartialEq for GetObjectInput
impl StructuralPartialEq for GetObjectInput
Auto Trait Implementations§
impl Freeze for GetObjectInput
impl RefUnwindSafe for GetObjectInput
impl Send for GetObjectInput
impl Sync for GetObjectInput
impl Unpin for GetObjectInput
impl UnwindSafe for GetObjectInput
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)