s3_upload_algorithm

Algorithm for uploading documents to an AWS S3 bucket.

Classes

S3UploadAlgorithm

class S3UploadAlgorithm(    datastructure: DataStructure,    s3_bucket: Optional[str] = None,    aws_region: Optional[str] = None,    aws_profile: str = 'default',    **kwargs: Any,):

Algorithm for uploading files to S3.

Arguments

• datastructure: The data structure to use for the algorithm.
• s3_bucket: AWS S3 Bucket name to upload files into.
• aws_region: AWS region in which the bucket resides.
• aws_profile: Name of AWS profile with which to generate the pre-signed POST.

Ancestors

• BaseNonModelAlgorithmFactory
• BaseAlgorithmFactory
• abc.ABC
• bitfount.federated.roles._RolesMixIn
• bitfount.types._BaseSerializableObjectMixIn
• typing.Generic

Variables

• static fields_dict : ClassVar[dict[str, marshmallow.fields.Field]]

Methods

---

modeller

def modeller(    self, **kwargs: Any,) ‑> bitfount.federated.algorithms.s3_upload_algorithm._ModellerSide:

Inherited from:

BaseNonModelAlgorithmFactory.modeller :

Modeller-side of the algorithm.

worker

def worker(    self, **kwargs: Any,) ‑> bitfount.federated.algorithms.s3_upload_algorithm._WorkerSide:

Inherited from:

BaseNonModelAlgorithmFactory.worker :

Worker-side of the algorithm.

---