gws_core

Introduction
Getting Started
Developer guide
Release
Architecture
CLI
Technical documentations
Version

S3Bucket

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: str
Functions
__init__
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
get_object
object_key : str
local_file_path : str
Return type : str
upload_file
file_path : str
object_key : str