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.
s3_get_object(Bucket, IfMatch, IfModifiedSince, IfNoneMatch,
IfUnmodifiedSince, Key, Range, ResponseCacheControl,
ResponseContentDisposition, ResponseContentEncoding,
ResponseContentLanguage, ResponseContentType, ResponseExpires,
VersionId, SSECustomerAlgorithm, SSECustomerKey, SSECustomerKeyMD5,
RequestPayer, PartNumber)[required] 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 using 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.
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 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).
[required] Key of the object to get.
Downloads the specified range bytes of an object. For more information about the HTTP Range header, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html\#sec14.35.
Sets the Cache-Control header of the response.
Sets the Content-Disposition header of the response
Sets the Content-Encoding header of the response.
Sets the Content-Language header of the response.
Sets the Content-Type header of the response.
Sets the Expires header of the response.
VersionId used to reference a specific version of the object.
Specifies the algorithm to use to when encrypting the object (for example, AES256).
Specifies the customer-provided encryption key for Amazon S3 to use in
encrypting data. This value is used to store the object and then it is
discarded; Amazon S3 does not store the encryption key. The key must be
appropriate for use with the algorithm specified in the
x-amz-server-side<U+00E2><U+20AC><U+2039>-encryption<U+00E2><U+20AC><U+2039>-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.
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.
svc$get_object(
Bucket = "string",
IfMatch = "string",
IfModifiedSince = as.POSIXct(
"2015-01-01"
),
IfNoneMatch = "string",
IfUnmodifiedSince = as.POSIXct(
"2015-01-01"
),
Key = "string",
Range = "string",
ResponseCacheControl = "string",
ResponseContentDisposition = "string",
ResponseContentEncoding = "string",
ResponseContentLanguage = "string",
ResponseContentType = "string",
ResponseExpires = as.POSIXct(
"2015-01-01"
),
VersionId = "string",
SSECustomerAlgorithm = "string",
SSECustomerKey = raw,
SSECustomerKeyMD5 = "string",
RequestPayer = "requester",
PartNumber = 123
)
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 GLACIER or
DEEP\_ARCHIVE storage classes, before you can retrieve the object you
must first restore a copy using . Otherwise, this operation 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 CMKs stored in AWS KMS (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<U+00E2><U+20AC><U+2039>-encryption<U+00E2><U+20AC><U+2039>-customer-algorithm
x-amz-server-side<U+00E2><U+20AC><U+2039>-encryption<U+00E2><U+20AC><U+2039>-customer-key
x-amz-server-side<U+00E2><U+20AC><U+2039>-encryption<U+00E2><U+20AC><U+2039>-customer-key-MD5
For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys).
Assuming you have permission to read object tags (permission for the
s3:GetObjectVersionTagging action), 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 s3:GetObject 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 operation returns the current version of an object.
To return a different version, use the versionId subresource.
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:
ListBuckets
GetObjectAcl
# NOT RUN {
# The following example retrieves an object for an S3 bucket. The request
# specifies the range header to retrieve a specific byte range.
svc$get_object(
Bucket = "examplebucket",
Key = "SampleFile.txt",
Range = "bytes=0-9"
)
# The following example retrieves an object for an S3 bucket.
svc$get_object(
Bucket = "examplebucket",
Key = "HappyFace.jpg"
)
# }
# NOT RUN {
# }
Run the code above in your browser using DataLab