Network.Minio.S3API

Documentation

type Region = Text

Represents a region TODO: This could be a Sum Type with all defined regions for AWS.

getLocation :: Bucket -> Minio Region

Fetch bucket location (region)

Listing buckets

getService :: Minio [BucketInfo]

Fetch all buckets from the service.

Listing objects

data ListObjectsResult

Represents result from a listing of objects in a bucket.

Instances

Eq ListObjectsResult

Methods

(==) :: ListObjectsResult -> ListObjectsResult -> Bool

(/=) :: ListObjectsResult -> ListObjectsResult -> Bool

Show ListObjectsResult

Methods

showsPrec :: Int -> ListObjectsResult -> ShowS

show :: ListObjectsResult -> String

showList :: [ListObjectsResult] -> ShowS

listObjects' :: Bucket -> Maybe Text -> Maybe Text -> Maybe Text -> Minio ListObjectsResult

List objects in a bucket matching prefix up to delimiter, starting from nextToken.

Retrieving objects

getObject' :: Bucket -> Object -> Query -> [Header] -> Minio ([Header], ResumableSource Minio ByteString)

GET an object from the service and return the response headers and a conduit source for the object content

headObject :: Bucket -> Object -> Minio ObjectInfo

Get metadata of an object.

Creating buckets and objects

putBucket :: Bucket -> Region -> Minio ()

Creates a bucket via a PUT bucket call.

type ETag = Text

A type alias to represent an Entity-Tag returned by S3-compatible APIs.

putObjectSingle :: Bucket -> Object -> [Header] -> Handle -> Int64 -> Int64 -> Minio ETag

PUT an object into the service. This function performs a single PUT object call, and so can only transfer objects upto 5GiB.

copyObjectSingle :: Bucket -> Object -> CopyPartSource -> [Header] -> Minio (ETag, UTCTime)

Performs server-side copy of an object that is upto 5GiB in size. If the object is greater than 5GiB, this function throws the error returned by the server.

Multipart Upload APIs

type UploadId = Text

A type alias to represent an upload-id for multipart upload

type PartTuple = (PartNumber, ETag)

A type to represent a part-number and etag.

data Payload

Represents different kinds of payload that are used with S3 API requests.

Constructors

PayloadBS ByteString

PayloadH Handle Int64 Int64

Instances

Default Payload

Methods

def :: Payload

type PartNumber = Int16

A type alias to represent a part-number for multipart upload

data CopyPartSource

Constructors

CopyPartSource

Fields

• cpSource :: Text
• cpSourceRange :: Maybe (Int64, Int64)

  formatted like "sourceBucketsourceObject"

• cpSourceIfMatch :: Maybe Text

  (0, 9) means first ten bytes of the source object

• cpSourceIfNoneMatch :: Maybe Text
• cpSourceIfUnmodifiedSince :: Maybe UTCTime
• cpSourceIfModifiedSince :: Maybe UTCTime

Instances

Eq CopyPartSource

Methods

(==) :: CopyPartSource -> CopyPartSource -> Bool

(/=) :: CopyPartSource -> CopyPartSource -> Bool

Show CopyPartSource

Methods

showsPrec :: Int -> CopyPartSource -> ShowS

show :: CopyPartSource -> String

showList :: [CopyPartSource] -> ShowS

Default CopyPartSource

Methods

def :: CopyPartSource

newMultipartUpload :: Bucket -> Object -> [Header] -> Minio UploadId

Create a new multipart upload.

putObjectPart :: Bucket -> Object -> UploadId -> PartNumber -> [Header] -> Payload -> Minio PartTuple

PUT a part of an object as part of a multipart upload.

copyObjectPart :: Bucket -> Object -> CopyPartSource -> UploadId -> PartNumber -> [Header] -> Minio (ETag, UTCTime)

Performs server-side copy of an object or part of an object as an upload part of an ongoing multi-part upload.

completeMultipartUpload :: Bucket -> Object -> UploadId -> [PartTuple] -> Minio ETag

Complete a multipart upload.

abortMultipartUpload :: Bucket -> Object -> UploadId -> Minio ()

Abort a multipart upload.

data ListUploadsResult

Represents result from a listing of incomplete uploads to a bucket.

Instances

Eq ListUploadsResult

Methods

(==) :: ListUploadsResult -> ListUploadsResult -> Bool

(/=) :: ListUploadsResult -> ListUploadsResult -> Bool

Show ListUploadsResult

Methods

showsPrec :: Int -> ListUploadsResult -> ShowS

show :: ListUploadsResult -> String

showList :: [ListUploadsResult] -> ShowS

listIncompleteUploads' :: Bucket -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Minio ListUploadsResult

List incomplete multipart uploads.

data ListPartsResult

Represents result from a listing of object parts of an ongoing multipart upload.

Constructors

ListPartsResult

Fields

• lprHasMore :: Bool
• lprNextPart :: Maybe Int
• lprParts :: [ObjectPartInfo]

Instances

Eq ListPartsResult

Methods

(==) :: ListPartsResult -> ListPartsResult -> Bool

(/=) :: ListPartsResult -> ListPartsResult -> Bool

Show ListPartsResult

Methods

showsPrec :: Int -> ListPartsResult -> ShowS

show :: ListPartsResult -> String

showList :: [ListPartsResult] -> ShowS

listIncompleteParts' :: Bucket -> Object -> UploadId -> Maybe Text -> Maybe Text -> Minio ListPartsResult

List parts of an ongoing multipart upload.

Deletion APIs

deleteBucket :: Bucket -> Minio ()

DELETE a bucket from the service.

deleteObject :: Bucket -> Object -> Minio ()

DELETE an object from the service.