S3Bucket class is a wrapper around boto3 S3 client to provide a simplified interface to upload and download files to and from an S3 bucket.
:raises Exception: description :return: description :rtype: type
Attributes
access_key_id: strbucket_name: strendpoint: strmessage_dispatcher: MessageDispatcherregion: strsecret_access_key: strFunctions
Parameters:
| Name | Type | Default value | Description |
|---|---|---|---|
| endpoint | str | Url of the s3 endpoint | |
| region | str | Region of the s3 bucket | |
| access_key_id | str | Access key id | |
| secret_access_key | str | Secret access key | |
| bucket_name | str | Name of the s3 bucket | |
| message_dispatcher | MessageDispatcher | A message dispatcher can be provided (from a task for example) to notify the progress of the upload/download , optional |
Parameters:
| Name | Type | Default value | Description |
|---|---|---|---|
| object_key | str | ||
| local_file_path | str |
Return type:
str |
Parameters:
| Name | Type | Default value | Description |
|---|---|---|---|
| file_path | str | ||
| object_key | str |