Struct aws_sdk_s3::client::fluent_builders::GetObject [−][src]
pub struct GetObject<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }
Expand description
Fluent builder constructing a request to GetObject
.
Retrieves objects from Amazon S3. To use GET
, you must have READ
access to the object. If you grant READ
access to the anonymous user, you can
return the object without using an authorization header.
An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer
file system. You can, however, create a logical hierarchy by using object key names that
imply a folder structure. For example, instead of naming an object sample.jpg
,
you can name it photos/2006/February/sample.jpg
.
To get an object from such a logical hierarchy, specify the full key name for the object
in the GET
operation. For a virtual hosted-style request example, if you have
the object photos/2006/February/sample.jpg
, specify the resource as
/photos/2006/February/sample.jpg
. For a path-style request example, if you
have the object photos/2006/February/sample.jpg
in the bucket named
examplebucket
, specify the resource as
/examplebucket/photos/2006/February/sample.jpg
. For more information about
request types, see HTTP Host Header Bucket Specification.
To distribute large files to many people, you can save bandwidth costs by using BitTorrent. For more information, see Amazon S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl.
If the object you are retrieving is stored in the S3 Glacier or
S3 Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive or
S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve the object you must first restore a
copy using RestoreObject. Otherwise, this action returns an
InvalidObjectStateError
error. For information about restoring archived
objects, see Restoring Archived
Objects.
Encryption request headers, like x-amz-server-side-encryption
, should not
be sent for GET requests if your object uses server-side encryption with KMS keys (SSE-KMS)
or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your
object does use these types of keys, you’ll get an HTTP 400 BadRequest 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).
Assuming you have the relevant permission to read object tags, the response also returns the
x-amz-tagging-count
header that provides the count of number of tags
associated with the object. You can use GetObjectTagging to retrieve
the tag set associated with an object.
Permissions
You need the relevant read object (or version) permission for this operation. For more
information, see Specifying Permissions
in a Policy. If the object you request does not exist, the error Amazon S3 returns
depends on whether you also have the s3:ListBucket
permission.
-
If you have the
s3:ListBucket
permission on the bucket, Amazon S3 will return an HTTP status code 404 ("no such key") error. -
If you don’t have the
s3:ListBucket
permission, Amazon S3 will return an HTTP status code 403 ("access denied") error.
Versioning
By default, the GET action returns the current version of an object. To return a
different version, use the versionId
subresource.
-
You need the
s3:GetObjectVersion
permission to access a specific version of an object. -
If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes
x-amz-delete-marker: true
in the response.
For more information about versioning, see PutBucketVersioning.
Overriding Response Header Values
There are times when you want to override certain response header values in a GET response. For example, you might override the Content-Disposition response header value in your GET request.
You can override values for a set of response headers using the following query
parameters. These response header values are sent only on a successful request, that is,
when status code 200 OK is returned. The set of headers you can override using these
parameters is a subset of the headers that Amazon S3 accepts when you create an object. The
response headers that you can override for the GET response are Content-Type
,
Content-Language
, Expires
, Cache-Control
,
Content-Disposition
, and Content-Encoding
. To override these
header values in the GET response, you use the following request parameters.
You must sign the request, either using an Authorization header or a presigned URL, when using these parameters. They cannot be used with an unsigned (anonymous) request.
-
response-content-type
-
response-content-language
-
response-expires
-
response-cache-control
-
response-content-disposition
-
response-content-encoding
Additional Considerations about Request Headers
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.
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 response code.
For more information about conditional requests, see RFC 7232.
The following operations are related to GetObject
:
Implementations
impl<C, M, R> GetObject<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
impl<C, M, R> GetObject<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
pub async fn send(self) -> Result<GetObjectOutput, SdkError<GetObjectError>> where
R::Policy: SmithyRetryPolicy<GetObjectInputOperationOutputAlias, GetObjectOutput, GetObjectError, GetObjectInputOperationRetryAlias>,
pub async fn send(self) -> Result<GetObjectOutput, SdkError<GetObjectError>> where
R::Policy: SmithyRetryPolicy<GetObjectInputOperationOutputAlias, GetObjectOutput, GetObjectError, GetObjectInputOperationRetryAlias>,
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
pub async fn presigned(
self,
presigning_config: PresigningConfig
) -> Result<PresignedRequest, SdkError<GetObjectError>>
pub async fn presigned(
self,
presigning_config: PresigningConfig
) -> Result<PresignedRequest, SdkError<GetObjectError>>
Creates a presigned request for this operation.
The presigning_config
provides additional presigning-specific config values, such as the
amount of time the request should be valid for after creation.
Presigned requests can be given to other users or applications to access a resource or perform an operation without having access to the AWS security credentials.
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 in the Amazon S3 User Guide.
When using an Object Lambda access point the hostname takes the form AccessPointName-AccountId.s3-object-lambda.Region.amazonaws.com.
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 in the Amazon S3 User Guide.
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 in the Amazon S3 User Guide.
When using an Object Lambda access point the hostname takes the form AccessPointName-AccountId.s3-object-lambda.Region.amazonaws.com.
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 in the Amazon S3 User Guide.
Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).
Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).
Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).
Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).
Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).
Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).
Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).
Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).
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.
Amazon S3 doesn't support retrieving multiple ranges of data per GET
request.
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.
Amazon S3 doesn't support retrieving multiple ranges of data per GET
request.
Sets the Cache-Control
header of the response.
Sets the Cache-Control
header of the response.
Sets the Content-Disposition
header of the response
Sets the Content-Disposition
header of the response
Sets the Content-Encoding
header of the response.
Sets the Content-Encoding
header of the response.
Sets the Content-Language
header of the response.
Sets the Content-Language
header of the response.
Sets the Content-Type
header of the response.
Sets the Content-Type
header of the response.
Sets the Expires
header of the response.
Sets the Expires
header of the response.
VersionId used to reference a specific version of the object.
VersionId used to reference a specific version of the object.
Specifies the algorithm to use to when decrypting the object (for example, AES256).
Specifies the algorithm to use to when decrypting the object (for example, AES256).
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.
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.
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.
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.
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 in the Amazon S3 User Guide.
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 in the Amazon S3 User Guide.
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.
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.
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.
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.
Trait Implementations
Auto Trait Implementations
impl<C = DynConnector, M = AwsMiddleware, R = Standard> !RefUnwindSafe for GetObject<C, M, R>
impl<C = DynConnector, M = AwsMiddleware, R = Standard> !UnwindSafe for GetObject<C, M, R>
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more