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

s3_get_object

R Documentation

Retrieves an object from Amazon S3

Description

Retrieves an object from Amazon S3.

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. 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.
`IfMatch`	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.
`IfModifiedSince`	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.
`IfNoneMatch`	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.
`IfUnmodifiedSince`	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`	[required] Key of the object to get.
`Range`	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.
`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`	Version ID used to reference a specific version of the object. By default, the `get_object` 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 the `s3:GetObjectVersion` permission to access a specific version of an object. The `s3: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 the `s3:GetObject` permission is required. The `s3: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 specify `null` to the `versionId` query parameter in the request. For more information about versioning, see `put_bucket_versioning`.
`SSECustomerAlgorithm`	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.
`SSECustomerKey`	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.
`SSECustomerKeyMD5`	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.
`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 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).
`ChecksumMode`	To retrieve the checksum, this mode must be enabled. In addition, if you enable checksum mode and the object is uploaded with a checksum and encrypted with an Key Management Service (KMS) key, you must have permission to use the `kms:Decrypt` action to retrieve the checksum.