S3Client

interface S3Client

S3 client wrapper protocol mainly used for providing an abstraction layer on top of AWS S3 SDK.

Inheritors

Functions

Link copied to clipboard
abstract suspend fun delete(objectId: String)

Deletes a RFC822 data from AWS S3.

Link copied to clipboard
abstract suspend fun download(key: String): ByteArray

Downloads a RFC822 data from AWS S3.

Link copied to clipboard
abstract suspend fun getObjectMetadata(key: String): ObjectMetadata

Returns the metadata associated with the object with the given key.

Link copied to clipboard
abstract suspend fun list(bucketName: String, prefix: String): List<S3ClientListOutput>

Returns a list of objects from AWS S3

Link copied to clipboard
abstract suspend fun upload(data: ByteArray, objectId: String, metadata: Map<String, String>? = null): String

Uploads a RFC822 data to AWS S3.

Properties

Link copied to clipboard
abstract val bucket: String

S3 bucket used by Email Service for storing RFC822 data.

Link copied to clipboard
abstract val region: String

AWS region hosting the S3 bucket.