# wmill.s3_types API documentation

# wmill.s3_types

View Source

     1from typing import Optional
     2
     3
     4class S3Object(dict):
     5    s3: str
     6    storage: Optional[str]
     7    presigned: Optional[str]
     8
     9    def __getattr__(self, attr):
    10        return self[attr]
    11
    12
    13class S3FsClientKwargs(dict):
    14    region_name: str
    15
    16    def __getattr__(self, attr):
    17        return self[attr]
    18
    19
    20class S3FsArgs(dict):
    21    endpoint_url: str
    22    key: str
    23    secret: str
    24    use_ssl: bool
    25    cache_regions: bool
    26    client_kwargs: S3FsClientKwargs
    27
    28    def __getattr__(self, attr):
    29        return self[attr]
    30
    31
    32class StorageOptions(dict):
    33    aws_endpoint_url: str
    34    aws_access_key_id: str
    35    aws_secret_access_key: str
    36    aws_region: str
    37    aws_allow_http: str
    38
    39    def __getattr__(self, attr):
    40        return self[attr]
    41
    42
    43class PolarsConnectionSettings(dict):
    44    s3fs_args: S3FsArgs
    45    storage_options: StorageOptions
    46
    47    def __getattr__(self, attr):
    48        return self[attr]
    49
    50
    51class Boto3ConnectionSettings(dict):
    52    endpoint_url: str
    53    region_name: str
    54    use_ssl: bool
    55    aws_access_key_id: str
    56    aws_secret_access_key: str
    57
    58    def __getattr__(self, attr):
    59        return self[attr]
    60
    61
    62class DuckDbConnectionSettings(dict):
    63    connection_settings_str: str
    64
    65    def __getattr__(self, attr):
    66        return self[attr]

class S3Object(builtins.dict): View Source

     5class S3Object(dict):
     6    s3: str
     7    storage: Optional[str]
     8    presigned: Optional[str]
     9
    10    def __getattr__(self, attr):
    11        return self[attr]

s3: str
storage: Optional[str]
presigned: Optional[str]
class S3FsClientKwargs(builtins.dict): View Source

    14class S3FsClientKwargs(dict):
    15    region_name: str
    16
    17    def __getattr__(self, attr):
    18        return self[attr]

region_name: str
class S3FsArgs(builtins.dict): View Source

    21class S3FsArgs(dict):
    22    endpoint_url: str
    23    key: str
    24    secret: str
    25    use_ssl: bool
    26    cache_regions: bool
    27    client_kwargs: S3FsClientKwargs
    28
    29    def __getattr__(self, attr):
    30        return self[attr]

endpoint_url: str
key: str
secret: str
use_ssl: bool
cache_regions: bool
client_kwargs: S3FsClientKwargs
class StorageOptions(builtins.dict): View Source

    33class StorageOptions(dict):
    34    aws_endpoint_url: str
    35    aws_access_key_id: str
    36    aws_secret_access_key: str
    37    aws_region: str
    38    aws_allow_http: str
    39
    40    def __getattr__(self, attr):
    41        return self[attr]

aws_endpoint_url: str
aws_access_key_id: str
aws_secret_access_key: str
aws_region: str
aws_allow_http: str
class PolarsConnectionSettings(builtins.dict): View Source

    44class PolarsConnectionSettings(dict):
    45    s3fs_args: S3FsArgs
    46    storage_options: StorageOptions
    47
    48    def __getattr__(self, attr):
    49        return self[attr]

s3fs_args: S3FsArgs
storage_options: StorageOptions
class Boto3ConnectionSettings(builtins.dict): View Source

    52class Boto3ConnectionSettings(dict):
    53    endpoint_url: str
    54    region_name: str
    55    use_ssl: bool
    56    aws_access_key_id: str
    57    aws_secret_access_key: str
    58
    59    def __getattr__(self, attr):
    60        return self[attr]

endpoint_url: str
region_name: str
use_ssl: bool
aws_access_key_id: str
aws_secret_access_key: str
class DuckDbConnectionSettings(builtins.dict): View Source

    63class DuckDbConnectionSettings(dict):
    64    connection_settings_str: str
    65
    66    def __getattr__(self, attr):
    67        return self[attr]

connection_settings_str: str