Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

storage-kernel-provider-aws-s3

AWS S3 provider for Storage Kernel.

This provider maps StorageLocation.bucket to an S3 bucket and StorageLocation.prefix to an object-key namespace.

Install

uv add storage-kernel-contracts storage-kernel-provider-aws-s3

Usage

from storage_kernel.contracts import StorageClientOptions, StorageLocation, StoragePath
from storage_kernel.provider_aws_s3 import (
    AwsS3StorageProviderOptions,
    create_aws_s3_storage_client,
)

storage = create_aws_s3_storage_client(
    StorageClientOptions(location=StorageLocation(bucket="my-bucket", prefix="prod")),
    AwsS3StorageProviderOptions(region="us-east-1"),
)

await storage.send_content(StoragePath("docs/readme.txt"), "Hello")

The provider uses boto3 behind the provider boundary. When credentials and client are omitted, authentication follows the standard boto3 credential provider chain. An injected client is caller-owned and may be used for custom SDK configuration or tests.

Provider Options

Option Purpose
region AWS region used by the SDK and default public URL generation
credentials Explicit credentials dictionary passed to the SDK factory
public_base_url Optional CDN/custom base URL for get_public_url
client Optional caller-owned boto3 S3 client

Capabilities

  • full binary and text reads/writes
  • object read streams
  • multipart-backed writable upload streams with explicit enablement, bounded part concurrency and optional part retention on errors
  • prefix-based directory listing and recursive deletion
  • same-provider native copy
  • S3 presigned URLs
  • public URLs through public_base_url or S3 bucket URL conventions

Provider SDK errors are normalized into Storage Kernel errors such as path not found, permission denied and provider error.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

storage_kernel_provider_aws_s3-0.1.0a1.tar.gz (9.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file storage_kernel_provider_aws_s3-0.1.0a1.tar.gz.

File metadata

File hashes

Hashes for storage_kernel_provider_aws_s3-0.1.0a1.tar.gz
Algorithm Hash digest
SHA256 3db0d6739a0e0895640ae36c4feb21dff1f64b68ae528d26f8660472b798b3b8
MD5 81d41d6eb024f4cd192cb1ec700c7776
BLAKE2b-256 03ad6b5f19044a7f5b61e889a9f9044ac5ec4913c1766d34aee749dca914f38c

See more details on using hashes here.

File details

Details for the file storage_kernel_provider_aws_s3-0.1.0a1-py3-none-any.whl.

File metadata

File hashes

Hashes for storage_kernel_provider_aws_s3-0.1.0a1-py3-none-any.whl
Algorithm Hash digest
SHA256 a3f743c7feda530221b46e960957668dd5c2a5d6ed175f9abc21d4a9f7b3e3a2
MD5 846b91f13c0363766955687465deca27
BLAKE2b-256 41d7a8d0a9e4d98d6a114252f779548d7758e67293bf92fb8a89c9270023fcc8

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.1.0a1 This release

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page