s3_download_file: Download a file from S3 and store it at a specified file...

In paws.storage: 'Amazon Web Services' Storage Services

Download a file from S3 and store it at a specified file location

Description

Download a file from S3 and store it at a specified file location.

Usage

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

Arguments

Bucket	[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 with 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. When using this API 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 operation using S3 on Outposts through the AWS 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 Simple Storage Service Developer Guide.
Key	[required] Key of the object to get.
Filename	[required] A local file location where the downloaded object will be saved.
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).
Range	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.
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 (for example, 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 S3 does not store the encryption key. 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	Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests
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 will fail with an HTTP ⁠403 (Access Denied)⁠ error.

Details

This is a wrapper function for get_object that will write the downloaded object to the file location specified.

Request syntax

svc$download_file(
  Bucket = "string",
  Key = "string",
  Filename = "string"
)

Examples

## Not run: 
# The following example retrieves an object from an S3 bucket. The request
# specifies the range header to retrieve a specific byte range. The text file
# is saved in a local output folder.
svc$download_file(
  Bucket = "examplebucket",
  Key = "SampleFile.txt",
  Range = "bytes=0-9",
  Filename = "./output/SampleFile.txt"
)

# The following example retrieves an object from an S3 bucket. The object is
# stored in the current directory as "HappyFace.jpg".
svc$download_file(
  Bucket = "examplebucket",
  Key = "HappyFace.jpg",
  Filename = "HappyFace.jpg"
)

## End(Not run)

paws.storage documentation built on Sept. 12, 2024, 6:16 a.m.