awswrangler.s3.upload

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

Upload file from a local file to received S3 path.

Note

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

Parameters:

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

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

• 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) – The default boto3 session will be used if boto3_session receive None.

• pyarrow_additional_kwargs – Forward to botocore requests, only “SSECustomerAlgorithm” and “SSECustomerKey” arguments will be considered.

Return type:

None

Returns:

None

Examples

Uploading a file using a path to local file

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

Uploading a file using a file-like object

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