S3Bucket

Interface for bucket-specific S3 operations

Types

object Companion : AwsServiceCompanion

abstract val bucketRegion: Region

fun S3Bucket.copyObject(sourceBucket: BucketName, source: BucketKey, destination: BucketKey, storageClass: StorageClass? = null, tags: List<Tag>? = null, taggingDirective: TaggingDirective? = null, headers: List<Pair<String, String?>> = emptyList()): Result<Unit, RemoteFailure>

fun S3Bucket.deleteBucket(): Result<Unit?, RemoteFailure>

fun S3Bucket.deleteObject(key: BucketKey): Result<Unit?, RemoteFailure>

open operator fun get(key: BucketKey): Result<InputStream?, RemoteFailure>

fun S3Bucket.getObject(key: BucketKey): Result<InputStream?, RemoteFailure>

fun S3Bucket.getObjectTagging(key: BucketKey): Result<List<Tag>, RemoteFailure>

fun S3Bucket.headBucket(expectedBucketOwner: String? = null): Result<Unit?, RemoteFailure>

abstract operator fun <R> invoke(action: S3BucketAction<R>): Result<R, RemoteFailure>

fun S3Bucket.listObjectsV2(continuationToken: String? = null, maxKeys: Int? = null, prefix: String? = null, delimiter: String? = null, encodingType: String? = null, expectedBucketOwner: String? = null, requestPayer: String? = null): Result<ObjectList, RemoteFailure>

fun S3Bucket.listObjectsV2Paginated(continuationToken: String? = null, maxKeys: Int? = null, prefix: String? = null, delimiter: String? = null, encodingType: String? = null, expectedBucketOwner: String? = null, requestPayer: String? = null): Sequence<Result<List<ObjectSummary>, RemoteFailure>>

fun S3Bucket.putObject(key: BucketKey, content: InputStream, headers: List<Pair<String, String?>> = emptyList(), tags: List<Tag> = emptyList(), storageClass: StorageClass? = null): Result<Unit, RemoteFailure>

fun S3Bucket.putObjectTagging(key: BucketKey, tags: List<Tag>): Result<Unit, RemoteFailure>

fun S3Bucket.restoreObject(key: BucketKey, days: Int, description: String? = null, tier: RestoreTier? = null): Result<Unit, RemoteFailure>

open operator fun set(key: BucketKey, content: InputStream): Result<Unit, RemoteFailure>