s3_get_object: Retrieves objects from Amazon S3
In paws.storage: 'Amazon Web Services' Storage Services

s3_get_object

R Documentation

Retrieves objects from Amazon S3

Description

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.

See https://www.paws-r-sdk.com/docs/s3_get_object/ for full documentation.

Usage

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

Arguments

`Bucket`	[required] 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 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.
`IfMatch`	Return the object only if its entity tag (ETag) is the same as the one specified; otherwise, return a 412 (precondition failed) error.
`IfModifiedSince`	Return the object only if it has been modified since the specified time; otherwise, return a 304 (not modified) error.
`IfNoneMatch`	Return the object only if its entity tag (ETag) is different from the one specified; otherwise, return a 304 (not modified) error.
`IfUnmodifiedSince`	Return the object only if it has not been modified since the specified time; otherwise, return a 412 (precondition failed) error.
`Key`	[required] Key of the object to get.
`Range`	Downloads the specified range bytes 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.
`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 decrypting the object (for example, AES256).
`SSECustomerKey`	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.
`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 that 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.
`ExpectedBucketOwner`	The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code `⁠403 Forbidden⁠` (access denied).
`ChecksumMode`	To retrieve the checksum, this mode must be enabled.