ORIONIS API REFERENCE

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

Represent an AWS S3 storage configuration.

Returns
NoneThis class does not return a value.
Method __post_init__ Validate initialization of AWS filesystem entity attributes.
Instance Variable bucket The S3 bucket name.
Instance Variable driver The filesystem driver name. Built-in names are "aws" and "s3".
Instance Variable endpoint The AWS S3 endpoint URL.
Instance Variable key AWS access key ID.
Instance Variable region AWS region where the bucket is located.
Instance Variable secret AWS secret access key.
Instance Variable url The URL endpoint for accessing the S3 bucket.
Instance Variable use_path_style_endpoint Whether to use a path-style endpoint.

Inherited from BaseEntity:

Class Method _cachedFieldMetadata Retrieve field definitions and normalized types cached by class.
Method __init__ Initialize declared fields and public extra attributes.
Method _dynamicAttributes Return public instance attributes that are not declared fields.
Method _validateExtraNames Validate names and storage for public extra attributes.
Method getFields Describe declared fields and, optionally, dynamic attributes.
Method toDict Return a recursively copied dictionary of declared and extra values.
Class Variable __slots__ Declare that this class introduces no additional instance slots.
Class Variable _orionis_field_metadata Cache declared fields and normalized type names for each concrete class.
def __post_init__(self): (source)

Validate initialization of AWS filesystem entity attributes.

Ensures all required attributes are of correct type and, where applicable, are non-empty.

Returns
NoneThis method does not return a value.
Raises
TypeErrorIf any attribute is of the wrong type.
ValueErrorIf any required attribute is empty.

The S3 bucket name.

driver: str, default "orionis.foundation.config.filesystems.entitites.aws" = (source)

The filesystem driver name. Built-in names are "aws" and "s3".

endpoint: str | None, default None = (source)

The AWS S3 endpoint URL.

AWS access key ID.

AWS region where the bucket is located.

AWS secret access key.

url: str | None, default None = (source)

The URL endpoint for accessing the S3 bucket.

use_path_style_endpoint: bool, default False = (source)

Whether to use a path-style endpoint.