awswrangler.s3.download

awswrangler.s3.download(path: str, local_file: str | Any, version_id: str | None = None, use_threads: bool | int = True, boto3_session: Session | None = None, s3_additional_kwargs: dict[str, Any] | None = None) → None

Download file from a received S3 path to local file.

Note

In case of use_threads=True the number of threads that will be spawned will be gotten from os.cpu_count().

Parameters:

  • path (str) – S3 path (e.g. s3://bucket/key0).

  • local_file (str | Any) – A file-like object in binary mode or a path to local file (e.g. ./local/path/to/key0).

  • version_id (str | None) – Version id of the object.

  • use_threads (bool | int) – True to enable concurrent requests, False to disable multiple threads. If enabled os.cpu_count() will be used as the max number of threads. If integer is provided, specified number is used.

  • boto3_session (Session | None) – Boto3 Session. The default boto3 session will be used if boto3_session receive None.

  • s3_additional_kwargs (dict[str, Any] | None) – Forward to botocore requests, only “SSECustomerAlgorithm”, “SSECustomerKey” and “RequestPayer” arguments will be considered.

Return type:

None

Returns:

None

Examples

Downloading a file using a path to local file

>>> import awswrangler as wr
>>> wr.s3.download(path='s3://bucket/key', local_file='./key')

Downloading a file using a file-like object

>>> import awswrangler as wr
>>> with open(file='./key', mode='wb') as local_f:
>>>     wr.s3.download(path='s3://bucket/key', local_file=local_f)