THE ORIONIS API
Build with clarity.
Explore the building blocks of an async-first Python framework. Every module, class, and method — connected, searchable, and ready to build with.
class documentation
class S3(BaseEntity): (source)
Represent an AWS S3 storage configuration.
| Parameters | |
| driver | The filesystem driver name. Built-in names are "aws" and "s3". |
| key | AWS access key ID. |
| secret | AWS secret access key. |
| region | AWS region where the bucket is located. |
| bucket | The S3 bucket name. |
| url | The URL endpoint for accessing the S3 bucket. |
| endpoint | The AWS S3 endpoint URL. |
| use | Whether to use a path-style endpoint. |
| Returns | |
None | This class does not return a value. |
| Method | __post |
Validate initialization of AWS filesystem entity attributes. |
| Class Variable | bucket |
Undocumented |
| Class Variable | driver |
Undocumented |
| Class Variable | endpoint |
Undocumented |
| Class Variable | key |
Undocumented |
| Class Variable | region |
Undocumented |
| Class Variable | secret |
Undocumented |
| Class Variable | url |
Undocumented |
| Class Variable | use |
Undocumented |
Inherited from BaseEntity:
| Class Method | _cached |
Retrieve field definitions and normalized types cached by class. |
| Method | get |
Describe field names, normalized types, defaults, and metadata. |
| Method | to |
Convert the dataclass instance to a recursively copied dictionary. |
| Class Variable | __slots__ |
Undocumented |
Validate initialization of AWS filesystem entity attributes.
Ensures all required attributes are of correct type and, where applicable, are non-empty.
| Parameters | |
| Returns | |
None | This method does not return a value. |
| Raises | |
TypeError | If any attribute is of the wrong type. |
ValueError | If any required attribute is empty. |