paws.storage (version 0.1.4)

s3_get_object: Retrieves objects from Amazon S3

Description

Retrieves objects from Amazon S3.

Usage

s3_get_object(Bucket, IfMatch, IfModifiedSince, IfNoneMatch,
  IfUnmodifiedSince, Key, Range, ResponseCacheControl,
  ResponseContentDisposition, ResponseContentEncoding,
  ResponseContentLanguage, ResponseContentType, ResponseExpires,
  VersionId, SSECustomerAlgorithm, SSECustomerKey, SSECustomerKeyMD5,
  RequestPayer, PartNumber)

Arguments

Bucket

[required]

IfMatch

Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).

IfModifiedSince

Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).

IfNoneMatch

Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).

IfUnmodifiedSince

Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).

Key

[required]

Range

Downloads the specified range bytes of an object. For more information about the HTTP Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html\#sec14.35.

ResponseCacheControl

Sets the Cache-Control header of the response.

ResponseContentDisposition

Sets the Content-Disposition header of the response

ResponseContentEncoding

Sets the Content-Encoding header of the response.

ResponseContentLanguage

Sets the Content-Language header of the response.

ResponseContentType

Sets the Content-Type header of the response.

ResponseExpires

Sets the Expires header of the response.

VersionId

VersionId used to reference a specific version of the object.

SSECustomerAlgorithm

Specifies the algorithm to use to when encrypting the object (e.g., AES256).

SSECustomerKey

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 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.

SSECustomerKeyMD5

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 the encryption key was transmitted without error.

RequestPayer

PartNumber

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.

Request syntax

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
)

Examples

# NOT RUN {
# The following example retrieves an object for an S3 bucket.
# }
# NOT RUN {
svc$get_object(
  Bucket = "examplebucket",
  Key = "HappyFace.jpg"
)
# }
# NOT RUN {
# The following example retrieves an object for an S3 bucket. The request
# specifies the range header to retrieve a specific byte range.
# }
# NOT RUN {
svc$get_object(
  Bucket = "examplebucket",
  Key = "SampleFile.txt",
  Range = "bytes=0-9"
)
# }
# NOT RUN {
# }