S3Client

Instance Constructors

new S3Client(s3Settings: S3Settings)(implicit system: ActorSystem, mat: Materializer)

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def deleteObject(bucket: String, key: String, versionId: Option[String] = None): Future[Done]

Deletes a S3 Object
Deletes a S3 Object
bucket
the s3 bucket name
key
the s3 object key
versionId
optional version idof the object
returns
A Future of akka.Done
def download(bucket: String, key: String, range: Option[ByteRange] = None, versionId: Option[String] = None, sse: Option[ServerSideEncryption] = None): (Source[ByteString, NotUsed], Future[ObjectMetadata])

Downloads a S3 Object
Downloads a S3 Object
bucket
the s3 bucket name
key
the s3 object key
range
[optional] the ByteRange you want to download
sse
[optional] the server side encryption used on upload
returns
A Source of ByteString and a Future containing the ObjectMetadata
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getObjectMetadata(bucket: String, key: String, versionId: Option[String] = None, sse: Option[ServerSideEncryption] = None): Future[Option[ObjectMetadata]]

Gets the metadata for a S3 Object
Gets the metadata for a S3 Object
bucket
the s3 bucket name
key
the s3 object key
versionId
optional version id of the object
sse
the server side encryption to use
returns
A Future containing an scala.Option that will be scala.None in case the object does not exist
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def listBucket(bucket: String, prefix: Option[String]): Source[ListBucketResultContents, NotUsed]

Will return a source of object metadata for a given bucket with optional prefix using version 2 of the List Bucket API.
Will return a source of object metadata for a given bucket with optional prefix using version 2 of the List Bucket API. This will automatically page through all keys with the given parameters.
The akka.stream.alpakka.s3.list-bucket-api-version can be set to 1 to use the older API version 1
bucket
Which bucket that you list object metadata for
prefix
Prefix of the keys you want to list under passed bucket
returns
Source of ListBucketResultContents

See also
https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGET.html (version 1 API)
https://docs.aws.amazon.com/AmazonS3/latest/API/v2-RESTBucketGET.html (version 1 API)
def multipartCopy(sourceBucket: String, sourceKey: String, targetBucket: String, targetKey: String, sourceVersionId: Option[String] = None, contentType: ContentType = ..., s3Headers: Option[S3Headers] = None, sse: Option[ServerSideEncryption] = None, chunkSize: Int = MinChunkSize, chunkingParallelism: Int = 4): Future[MultipartUploadResult]

Copy an S3 object from source bucket to target bucket using multi part copy upload.
Copy an S3 object from source bucket to target bucket using multi part copy upload.
sourceBucket
source s3 bucket name
sourceKey
source s3 key
targetBucket
target s3 bucket name
targetKey
target s3 key
sourceVersionId
optional version id of source object, if the versioning is enabled in source bucket
contentType
an optional ContentType
s3Headers
any headers you want to add
sse
an optional server side encryption key
chunkSize
the size of the requests sent to S3, minimum MinChunkSize
chunkingParallelism
the number of parallel requests used for the upload, defaults to 4
def multipartUpload(bucket: String, key: String, contentType: ContentType = ..., metaHeaders: MetaHeaders = MetaHeaders(Map()), cannedAcl: CannedAcl = CannedAcl.Private, chunkSize: Int = MinChunkSize, chunkingParallelism: Int = 4, sse: Option[ServerSideEncryption] = None): Sink[ByteString, Future[MultipartUploadResult]]

Uploads a S3 Object by making multiple requests
Uploads a S3 Object by making multiple requests
bucket
the s3 bucket name
key
the s3 object key
contentType
an optional ContentType
metaHeaders
any meta-headers you want to add
cannedAcl
a CannedAcl, defauts to CannedAcl.Private
chunkSize
the size of the requests sent to S3, minimum MinChunkSize
chunkingParallelism
the number of parallel requests used for the upload, defaults to 4
returns
a Sink that accepts ByteString's and materializes to a Future of MultipartUploadResult
def multipartUploadWithHeaders(bucket: String, key: String, contentType: ContentType = ..., chunkSize: Int = MinChunkSize, chunkingParallelism: Int = 4, s3Headers: Option[S3Headers] = None, sse: Option[ServerSideEncryption] = None): Sink[ByteString, Future[MultipartUploadResult]]

Uploads a S3 Object by making multiple requests
Uploads a S3 Object by making multiple requests
bucket
the s3 bucket name
key
the s3 object key
contentType
an optional ContentType
chunkSize
the size of the requests sent to S3, minimum MinChunkSize
chunkingParallelism
the number of parallel requests used for the upload, defaults to 4
s3Headers
any headers you want to add
returns
a Sink that accepts ByteString's and materializes to a Future of MultipartUploadResult
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def putObject(bucket: String, key: String, data: Source[ByteString, _], contentLength: Long, contentType: ContentType = ..., s3Headers: S3Headers, sse: Option[ServerSideEncryption] = None): Future[ObjectMetadata]

Uploads a S3 Object, use this for small files and multipartUpload for bigger ones
Uploads a S3 Object, use this for small files and multipartUpload for bigger ones
bucket
the s3 bucket name
key
the s3 object key
data
a Stream of ByteString
contentLength
the number of bytes that will be uploaded (required!)
contentType
an optional ContentType
s3Headers
any headers you want to add
sse
the server side encryption to use
returns
a Future containing the ObjectMetadata of the uploaded S3 Object
def request(bucket: String, key: String, method: HttpMethod = HttpMethods.GET, versionId: Option[String] = None, s3Headers: S3Headers = S3Headers.empty): Future[HttpResponse]

Use this to extend the library
Use this to extend the library
bucket
the s3 bucket name
key
the s3 object key
method
the HttpMethod to use when making the request
versionId
optional version id of the object
s3Headers
any headers you want to add
returns
a Future containing the raw HttpResponse
val s3Settings: S3Settings
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object S3Client | package scaladsl

final class S3Client extends AnyRef

Instance Constructors

new S3Client(s3Settings: S3Settings)(implicit system: ActorSystem, mat: Materializer)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def deleteObject(bucket: String, key: String, versionId: Option[String] = None): Future[Done]

def download(bucket: String, key: String, range: Option[ByteRange] = None, versionId: Option[String] = None, sse: Option[ServerSideEncryption] = None): (Source[ByteString, NotUsed], Future[ObjectMetadata])

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def getObjectMetadata(bucket: String, key: String, versionId: Option[String] = None, sse: Option[ServerSideEncryption] = None): Future[Option[ObjectMetadata]]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def listBucket(bucket: String, prefix: Option[String]): Source[ListBucketResultContents, NotUsed]

def multipartUploadWithHeaders(bucket: String, key: String, contentType: ContentType = ..., chunkSize: Int = MinChunkSize, chunkingParallelism: Int = 4, s3Headers: Option[S3Headers] = None, sse: Option[ServerSideEncryption] = None): Sink[ByteString, Future[MultipartUploadResult]]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def putObject(bucket: String, key: String, data: Source[ByteString, _], contentLength: Long, contentType: ContentType = ..., s3Headers: S3Headers, sse: Option[ServerSideEncryption] = None): Future[ObjectMetadata]

def request(bucket: String, key: String, method: HttpMethod = HttpMethods.GET, versionId: Option[String] = None, s3Headers: S3Headers = S3Headers.empty): Future[HttpResponse]

val s3Settings: S3Settings

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped