s3

S3 tools

Functions

args_dict(args_l, kwargs)	This function converts a single in-house S3 configuration to a dictionary containing ready to use key/value parameters.
define_s3_client([endpoint, profile_name, ...])	Define S3 client This function searches for S3 configuration in many places.
in_house_s3_configs()	This function declares in-house S3 configurations for rasterio, pyogrio and cloudpathlib.
s3_args(*args, **kwargs)	This function returns ready to use configurations for rasterio, pyogrio and cloudpathlib.
s3_env(*args, **kwargs)	Create S3 compatible storage environment You need to set endpoint url if you use s3 compatible storage since GDAL/Rasterio does not read endpoint url from config file.
temp_s3([endpoint, profile_name, ...])	Initialize a temporary S3 environment as a context manager You need to set endpoint url if you use s3 compatible storage since GDAL/Rasterio does not read endpoint url from config file.

Module Attributes

AWS_ACCESS_KEY_ID	Environment variable linked to AWS Access Key ID.
AWS_SECRET_ACCESS_KEY	Environment variable linked to AWS Secret Access Key.
AWS_S3_ENDPOINT	Environment variable linked to AWS endpoint.
USE_S3_STORAGE	Environment variable created to use Unistra's S3 bucket.