Wrapper of AWS SDK's S3AsyncClient into fs2.Stream and cats.effect.IO
Attributes
- Companion
- object
- Experimental
- true
- Graph
-
- Supertypes
-
class Objecttrait Matchableclass Any
Members list
Value members
Concrete methods
Deletes a file in a single request.
Deletes a file in a single request.
Attributes
Reads a file in a single request. Suitable for small files.
Reads a file in a single request. Suitable for small files.
For big files, consider using readFileMultipart instead.
Attributes
Reads a file in multiple parts of the specified @partSize per request. Suitable for big files.
Reads a file in multiple parts of the specified @partSize per request. Suitable for big files.
It does so in constant memory. So at a given time, only the number of bytes indicated by @partSize will be loaded in memory.
For small files, consider using readFile instead.
Value parameters
- partSize
-
in megabytes
Attributes
Uploads a file in a single request. Suitable for small files.
Uploads a file in a single request. Suitable for small files.
For big files, consider using uploadFileMultipart instead.
Attributes
Uploads a file in multiple parts of the specified @partSize per request. Suitable for big files.
Uploads a file in multiple parts of the specified @partSize per request. Suitable for big files.
It does so in constant memory. So at a given time, only the number of bytes indicated by @partSize will be loaded in memory.
Note: AWS S3 API does not support uploading empty files via multipart upload. It does not gracefully respond on attempting to do this and returns a 400
response with a generic error message. This function accepts a boolean uploadEmptyFile
(set to false
by default) to determine how to handle this scenario. If set to false (default) and no data has passed through the stream, it will gracefully abort the multi-part upload request. If set to true, and no data has passed through the stream, an empty file will be uploaded on completion. An Option[ETag]
of None
will be emitted on the stream if no file was uploaded, else a Some(ETag)
will be emitted. Alternatively, If you need to create empty files, consider using consider using uploadFile instead.
For small files, consider using uploadFile instead.
Value parameters
- bucket
-
the bucket name
- key
-
the target file key
- multiPartConcurrency
-
the number of concurrent parts to upload
- partSize
-
the part size indicated in MBs. It must be at least 5, as required by AWS.
- uploadEmptyFiles
-
whether to upload empty files or not, if no data has passed through the stream create an empty file default is false