Network.Minio

Connecting to object storage

data ConnectInfo

Connection Info data type. To create a ConnectInfo value, use one of the provided smart constructors or override fields of the Default instance.

Constructors

ConnectInfo

Fields

• connectHost :: Text
• connectPort :: Int
• connectAccessKey :: Text
• connectSecretKey :: Text
• connectIsSecure :: Bool
• connectRegion :: Region
• connectAutoDiscoverRegion :: Bool

Instances

Eq ConnectInfo

Methods

(==) :: ConnectInfo -> ConnectInfo -> Bool

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

Show ConnectInfo

Methods

showsPrec :: Int -> ConnectInfo -> ShowS

show :: ConnectInfo -> String

showList :: [ConnectInfo] -> ShowS

Default ConnectInfo

Connects to a Minio server located at localhost:9000 with access key minio and secret key minio123. It is over HTTP by default.

Methods

def :: ConnectInfo

awsCI :: ConnectInfo

Default AWS ConnectInfo. Connects to "us-east-1". Credentials should be supplied before use, for e.g.:

awsCI {
  connectAccessKey = "my-access-key"
, connectSecretKey = "my-secret-key"
}

Connection helpers

awsWithRegionCI :: Region -> Bool -> ConnectInfo

AWS ConnectInfo with a specified region. It can optionally disable the automatic discovery of a bucket's region via the Boolean argument.

awsWithRegionCI "us-west-1" False {
  connectAccessKey = "my-access-key"
, connectSecretKey = "my-secret-key"
}

This restricts all operations to the "us-west-1" region and does not perform any bucket location requests.

minioPlayCI :: ConnectInfo

Minio Play Server ConnectInfo. Credentials are already filled in.

minioCI :: Text -> Int -> Bool -> ConnectInfo

ConnectInfo for Minio server. Takes hostname, port and a Boolean to enable TLS.

minioCI "minio.example.com" 9000 True {
  connectAccessKey = "my-access-key"
, connectSecretKey = "my-secret-key"
}

This connects to a Minio server at the given hostname and port over HTTPS.

Minio Monad

The Minio monad provides connection-reuse, bucket-location caching, resource management and simpler error handling functionality. All actions on object storage are performed within this Monad.

data Minio a

Instances

Monad Minio

Methods

(>>=) :: Minio a -> (a -> Minio b) -> Minio b

(>>) :: Minio a -> Minio b -> Minio b

return :: a -> Minio a

fail :: String -> Minio a

Functor Minio

Methods

fmap :: (a -> b) -> Minio a -> Minio b

(<$) :: a -> Minio b -> Minio a

Applicative Minio

Methods

pure :: a -> Minio a

(<*>) :: Minio (a -> b) -> Minio a -> Minio b

liftA2 :: (a -> b -> c) -> Minio a -> Minio b -> Minio c

(*>) :: Minio a -> Minio b -> Minio b

(<*) :: Minio a -> Minio b -> Minio a

MonadIO Minio

Methods

liftIO :: IO a -> Minio a

MonadUnliftIO Minio

Methods

askUnliftIO :: Minio (UnliftIO Minio)

withRunInIO :: ((forall a. Minio a -> IO a) -> IO b) -> Minio b

MonadResource Minio

Methods

liftResourceT :: ResourceT IO a -> Minio a

MonadThrow Minio

Methods

throwM :: Exception e => e -> Minio a

MonadCatch Minio

Methods

catch :: Exception e => Minio a -> (e -> Minio a) -> Minio a

runMinio :: ConnectInfo -> Minio a -> IO (Either MinioErr a)

Run the Minio action and return the result or an error.

def :: Default a => a

The default value for this type.

Bucket Operations

Creation, removal and querying

type Bucket = Text

Represents a bucket in the object store

makeBucket :: Bucket -> Maybe Region -> Minio ()

Creates a new bucket in the object store. The Region can be optionally specified. If not specified, it will use the region configured in ConnectInfo, which is by default, the US Standard Region.

removeBucket :: Bucket -> Minio ()

Removes a bucket from the object store.

bucketExists :: Bucket -> Minio Bool

Query the object store if a given bucket is present.

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

data BucketInfo

BucketInfo returned for list buckets call

Constructors

BucketInfo

Fields

• biName :: Bucket
• biCreationDate :: UTCTime

Instances

Eq BucketInfo

Methods

(==) :: BucketInfo -> BucketInfo -> Bool

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

Show BucketInfo

Methods

showsPrec :: Int -> BucketInfo -> ShowS

show :: BucketInfo -> String

showList :: [BucketInfo] -> ShowS

listBuckets :: Minio [BucketInfo]

Lists buckets.

Object info type represents object metadata information.

data ObjectInfo

Represents information about an object.

Instances

Eq ObjectInfo

Methods

(==) :: ObjectInfo -> ObjectInfo -> Bool

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

Show ObjectInfo

Methods

showsPrec :: Int -> ObjectInfo -> ShowS

show :: ObjectInfo -> String

showList :: [ObjectInfo] -> ShowS

oiObject :: ObjectInfo -> Object

oiModTime :: ObjectInfo -> UTCTime

oiETag :: ObjectInfo -> ETag

oiSize :: ObjectInfo -> Int64

oiMetadata :: ObjectInfo -> Map Text Text

listObjects :: Bucket -> Maybe Text -> Bool -> ConduitM () ObjectInfo Minio ()

List objects in a bucket matching the given prefix. If recurse is set to True objects matching prefix are recursively listed.

listObjectsV1 :: Bucket -> Maybe Text -> Bool -> ConduitM () ObjectInfo Minio ()

List objects in a bucket matching the given prefix. If recurse is set to True objects matching prefix are recursively listed.

type UploadId = Text

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

data UploadInfo

Represents information about a multipart upload.

Constructors

UploadInfo

Fields

• uiKey :: Object
• uiUploadId :: UploadId
• uiInitTime :: UTCTime
• uiSize :: Int64

Instances

Eq UploadInfo

Methods

(==) :: UploadInfo -> UploadInfo -> Bool

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

Show UploadInfo

Methods

showsPrec :: Int -> UploadInfo -> ShowS

show :: UploadInfo -> String

showList :: [UploadInfo] -> ShowS

listIncompleteUploads :: Bucket -> Maybe Text -> Bool -> ConduitM () UploadInfo Minio ()

List incomplete uploads in a bucket matching the given prefix. If recurse is set to True incomplete uploads for the given prefix are recursively listed.

data ObjectPartInfo

Represents information about an object part in an ongoing multipart upload.

Constructors

ObjectPartInfo

Fields

• opiNumber :: PartNumber
• opiETag :: ETag
• opiSize :: Int64
• opiModTime :: UTCTime

Instances

Eq ObjectPartInfo

Methods

(==) :: ObjectPartInfo -> ObjectPartInfo -> Bool

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

Show ObjectPartInfo

Methods

showsPrec :: Int -> ObjectPartInfo -> ShowS

show :: ObjectPartInfo -> String

showList :: [ObjectPartInfo] -> ShowS

listIncompleteParts :: Bucket -> Object -> UploadId -> ConduitM () ObjectPartInfo Minio ()

List object parts of an ongoing multipart upload for given bucket, object and uploadId.

Bucket Notifications

data Notification

A data-type to represent bucket notification configuration. It is a collection of queue, topic or lambda function configurations. The structure of the types follow closely the XML representation described at https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTnotification.html

Constructors

Notification

Fields

• nQueueConfigurations :: [NotificationConfig]
• nTopicConfigurations :: [NotificationConfig]
• nCloudFunctionConfigurations :: [NotificationConfig]

Instances

Eq Notification

Methods

(==) :: Notification -> Notification -> Bool

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

Show Notification

Methods

showsPrec :: Int -> Notification -> ShowS

show :: Notification -> String

showList :: [Notification] -> ShowS

Default Notification

Methods

def :: Notification

data NotificationConfig

A data-type representing the configuration for a particular notification system. It could represent a Queue, Topic or Lambda Function configuration.

Constructors

NotificationConfig

Fields

• ncId :: Text
• ncArn :: Arn
• ncEvents :: [Event]
• ncFilter :: Filter

Instances

Eq NotificationConfig

Methods

(==) :: NotificationConfig -> NotificationConfig -> Bool

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

Show NotificationConfig

Methods

showsPrec :: Int -> NotificationConfig -> ShowS

show :: NotificationConfig -> String

showList :: [NotificationConfig] -> ShowS

type Arn = Text

data Event

A data-type for events that can occur in the object storage server. Reference: https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html#supported-notification-event-types

Constructors

ObjectCreated

ObjectCreatedPut

ObjectCreatedPost

ObjectCreatedCopy

ObjectCreatedMultipartUpload

ObjectRemoved

ObjectRemovedDelete

ObjectRemovedDeleteMarkerCreated

ReducedRedundancyLostObject

Instances

Eq Event

Methods

(==) :: Event -> Event -> Bool

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

Show Event

Methods

showsPrec :: Int -> Event -> ShowS

show :: Event -> String

showList :: [Event] -> ShowS

data Filter

Constructors

Filter

Fields

• fFilter :: FilterKey

Instances

Eq Filter

Methods

(==) :: Filter -> Filter -> Bool

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

Show Filter

Methods

showsPrec :: Int -> Filter -> ShowS

show :: Filter -> String

showList :: [Filter] -> ShowS

Default Filter

Methods

def :: Filter

data FilterKey

Constructors

FilterKey

Fields

• fkKey :: FilterRules

Instances

Eq FilterKey

Methods

(==) :: FilterKey -> FilterKey -> Bool

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

Show FilterKey

Methods

showsPrec :: Int -> FilterKey -> ShowS

show :: FilterKey -> String

showList :: [FilterKey] -> ShowS

Default FilterKey

Methods

def :: FilterKey

data FilterRules

Constructors

FilterRules

Fields

• frFilterRules :: [FilterRule]

Instances

Eq FilterRules

Methods

(==) :: FilterRules -> FilterRules -> Bool

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

Show FilterRules

Methods

showsPrec :: Int -> FilterRules -> ShowS

show :: FilterRules -> String

showList :: [FilterRules] -> ShowS

Default FilterRules

Methods

def :: FilterRules

data FilterRule

A filter rule that can act based on the suffix or prefix of an object. As an example, let's create two filter rules:

let suffixRule = FilterRule "suffix" ".jpg"
let prefixRule = FilterRule "prefix" "images/"

The suffixRule restricts the notification to be triggered only for objects having a suffix of ".jpg", and the prefixRule restricts it to objects having a prefix of "images/".

Constructors

FilterRule

Fields

• frName :: Text
• frValue :: Text

Instances

Eq FilterRule

Methods

(==) :: FilterRule -> FilterRule -> Bool

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

Show FilterRule

Methods

showsPrec :: Int -> FilterRule -> ShowS

show :: FilterRule -> String

showList :: [FilterRule] -> ShowS

getBucketNotification :: Bucket -> Minio Notification

Retrieve the notification configuration on a bucket.

putBucketNotification :: Bucket -> Notification -> Minio ()

Set the notification configuration on a bucket.

removeAllBucketNotification :: Bucket -> Minio ()

Remove all notifications configured on a bucket.

Object Operations

type Object = Text

Represents an object name

File operations

fGetObject :: Bucket -> Object -> FilePath -> GetObjectOptions -> Minio ()

Fetch the object and write it to the given file safely. The object is first written to a temporary file in the same directory and then moved to the given path.

fPutObject :: Bucket -> Object -> FilePath -> PutObjectOptions -> Minio ()

Upload the given file to the given object.

Conduit-based streaming operations

putObject :: Bucket -> Object -> ConduitM () ByteString Minio () -> Maybe Int64 -> PutObjectOptions -> Minio ()

Put an object from a conduit source. The size can be provided if known; this helps the library select optimal part sizes to perform a multipart upload. If not specified, it is assumed that the object can be potentially 5TiB and selects multipart sizes appropriately.

Input data type represents PutObject options.

data PutObjectOptions

Data type represents various options specified for PutObject call. To specify PutObject options use the poo* accessors.

Instances

Eq PutObjectOptions

Methods

(==) :: PutObjectOptions -> PutObjectOptions -> Bool

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

Show PutObjectOptions

Methods

showsPrec :: Int -> PutObjectOptions -> ShowS

show :: PutObjectOptions -> String

showList :: [PutObjectOptions] -> ShowS

Default PutObjectOptions

Methods

def :: PutObjectOptions

pooContentType :: PutObjectOptions -> Maybe Text

pooContentEncoding :: PutObjectOptions -> Maybe Text

pooContentDisposition :: PutObjectOptions -> Maybe Text

pooContentLanguage :: PutObjectOptions -> Maybe Text

pooCacheControl :: PutObjectOptions -> Maybe Text

pooStorageClass :: PutObjectOptions -> Maybe Text

pooUserMetadata :: PutObjectOptions -> [(Text, Text)]

pooNumThreads :: PutObjectOptions -> Maybe Word

getObject :: Bucket -> Object -> GetObjectOptions -> Minio (ConduitM () ByteString Minio ())

Get an object from the object store as a resumable source (conduit).

Input data type represents GetObject options.

data GetObjectOptions

Instances

Eq GetObjectOptions

Methods

(==) :: GetObjectOptions -> GetObjectOptions -> Bool

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

Show GetObjectOptions

Methods

showsPrec :: Int -> GetObjectOptions -> ShowS

show :: GetObjectOptions -> String

showList :: [GetObjectOptions] -> ShowS

Default GetObjectOptions

Methods

def :: GetObjectOptions

gooRange :: GetObjectOptions -> Maybe ByteRange

ByteRangeFromTo 0 9

means first ten bytes of the source object.

gooIfMatch :: GetObjectOptions -> Maybe ETag

gooIfNoneMatch :: GetObjectOptions -> Maybe ETag

gooIfModifiedSince :: GetObjectOptions -> Maybe UTCTime

gooIfUnmodifiedSince :: GetObjectOptions -> Maybe UTCTime

Server-side copying

copyObject :: DestinationInfo -> SourceInfo -> Minio ()

Perform a server-side copy operation to create an object based on the destination specification in DestinationInfo from the source specification in SourceInfo. This function performs a multipart copy operation if the new object is to be greater than 5GiB in size.

data SourceInfo

Represents source object in server-side copy object

Instances

Eq SourceInfo

Methods

(==) :: SourceInfo -> SourceInfo -> Bool

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

Show SourceInfo

Methods

showsPrec :: Int -> SourceInfo -> ShowS

show :: SourceInfo -> String

showList :: [SourceInfo] -> ShowS

Default SourceInfo

Methods

def :: SourceInfo

srcBucket :: SourceInfo -> Text

srcObject :: SourceInfo -> Text

srcRange :: SourceInfo -> Maybe (Int64, Int64)

srcIfMatch :: SourceInfo -> Maybe Text

srcIfNoneMatch :: SourceInfo -> Maybe Text

srcIfModifiedSince :: SourceInfo -> Maybe UTCTime

srcIfUnmodifiedSince :: SourceInfo -> Maybe UTCTime

data DestinationInfo

Represents destination object in server-side copy object

Instances

Eq DestinationInfo

Methods

(==) :: DestinationInfo -> DestinationInfo -> Bool

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

Show DestinationInfo

Methods

showsPrec :: Int -> DestinationInfo -> ShowS

show :: DestinationInfo -> String

showList :: [DestinationInfo] -> ShowS

Default DestinationInfo

Methods

def :: DestinationInfo

dstBucket :: DestinationInfo -> Text

dstObject :: DestinationInfo -> Text

Querying

statObject :: Bucket -> Object -> Minio ObjectInfo

Get an object's metadata from the object store.

Object removal functions

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

Remove an object from the object store.

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

Removes an ongoing multipart upload of an object.

Presigned Operations

type UrlExpiry = Int

Time to expire for a presigned URL. It interpreted as a number of seconds. The maximum duration that can be specified is 7 days.

presignedPutObjectUrl :: Bucket -> Object -> UrlExpiry -> RequestHeaders -> Minio ByteString

Generate a URL with authentication signature to PUT (upload) an object. Any extra headers if passed, are signed, and so they are required when the URL is used to upload data. This could be used, for example, to set user-metadata on the object.

For a list of possible headers to pass, please refer to the PUT object REST API AWS S3 documentation.

presignedGetObjectUrl :: Bucket -> Object -> UrlExpiry -> Query -> RequestHeaders -> Minio ByteString

Generate a URL with authentication signature to GET (download) an object. All extra query parameters and headers passed here will be signed and are required when the generated URL is used. Query parameters could be used to change the response headers sent by the server. Headers can be used to set Etag match conditions among others.

For a list of possible request parameters and headers, please refer to the GET object REST API AWS S3 documentation.

presignedHeadObjectUrl :: Bucket -> Object -> UrlExpiry -> RequestHeaders -> Minio ByteString

Generate a URL with authentication signature to make a HEAD request on an object. This is used to fetch metadata about an object. All extra headers passed here will be signed and are required when the generated URL is used.

For a list of possible headers to pass, please refer to the HEAD object REST API AWS S3 documentation.

Utilities for POST (browser) uploads

data PostPolicy

A PostPolicy is required to perform uploads via browser forms.

Instances

Eq PostPolicy

Methods

(==) :: PostPolicy -> PostPolicy -> Bool

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

Show PostPolicy

Methods

showsPrec :: Int -> PostPolicy -> ShowS

show :: PostPolicy -> String

showList :: [PostPolicy] -> ShowS

ToJSON PostPolicy

Methods

toJSON :: PostPolicy -> Value

toEncoding :: PostPolicy -> Encoding

toJSONList :: [PostPolicy] -> Value

toEncodingList :: [PostPolicy] -> Encoding

data PostPolicyError

Possible validation errors when creating a PostPolicy.

Constructors

PPEKeyNotSpecified

PPEBucketNotSpecified

PPEConditionKeyEmpty

PPERangeInvalid

Instances

Eq PostPolicyError

Methods

(==) :: PostPolicyError -> PostPolicyError -> Bool

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

Show PostPolicyError

Methods

showsPrec :: Int -> PostPolicyError -> ShowS

show :: PostPolicyError -> String

showList :: [PostPolicyError] -> ShowS

newPostPolicy :: UTCTime -> [PostPolicyCondition] -> Either PostPolicyError PostPolicy

This function creates a PostPolicy after validating its arguments.

presignedPostPolicy :: PostPolicy -> Minio (ByteString, Map Text ByteString)

Generate a presigned URL and POST policy to upload files via a browser. On success, this function returns a URL and POST form-data.

showPostPolicy :: PostPolicy -> ByteString

Convert Post Policy to a string (e.g. for printing).

Utilities to specify Post Policy conditions

data PostPolicyCondition

Represents individual conditions in a Post Policy document.

Instances

Eq PostPolicyCondition

Methods

(==) :: PostPolicyCondition -> PostPolicyCondition -> Bool

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

Show PostPolicyCondition

Methods

showsPrec :: Int -> PostPolicyCondition -> ShowS

show :: PostPolicyCondition -> String

showList :: [PostPolicyCondition] -> ShowS

ToJSON PostPolicyCondition

Methods

toJSON :: PostPolicyCondition -> Value

toEncoding :: PostPolicyCondition -> Encoding

toJSONList :: [PostPolicyCondition] -> Value

toEncodingList :: [PostPolicyCondition] -> Encoding

ppCondBucket :: Bucket -> PostPolicyCondition

Set the bucket name that the upload should use.

ppCondContentLengthRange :: Int64 -> Int64 -> PostPolicyCondition

Set the content length range constraint with minimum and maximum byte count values.

ppCondContentType :: Text -> PostPolicyCondition

Set the content-type header for the upload.

ppCondKey :: Object -> PostPolicyCondition

Set the object name constraint for the upload.

ppCondKeyStartsWith :: Object -> PostPolicyCondition

Set the object name prefix constraint for the upload.

ppCondSuccessActionStatus :: Int -> PostPolicyCondition

Status code that the S3-server should send on a successful POST upload

Error handling

Data types representing various errors that may occur while working with an object storage service.

data MinioErr

Errors thrown by the library

Constructors

MErrHTTP HttpException

MErrIO IOException

MErrService ServiceErr

MErrValidation MErrV

Instances

Eq MinioErr

Methods

(==) :: MinioErr -> MinioErr -> Bool

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

Show MinioErr

Methods

showsPrec :: Int -> MinioErr -> ShowS

show :: MinioErr -> String

showList :: [MinioErr] -> ShowS

Exception MinioErr

Methods

toException :: MinioErr -> SomeException

fromException :: SomeException -> Maybe MinioErr

displayException :: MinioErr -> String

data MErrV

Various validation errors

Constructors

MErrVSinglePUTSizeExceeded Int64

MErrVPutSizeExceeded Int64

MErrVETagHeaderNotFound

MErrVInvalidObjectInfoResponse

MErrVInvalidSrcObjSpec Text

MErrVInvalidSrcObjByteRange (Int64, Int64)

MErrVCopyObjSingleNoRangeAccepted

MErrVRegionNotSupported Text

MErrVXmlParse Text

MErrVInvalidBucketName Text

MErrVInvalidObjectName Text

MErrVInvalidUrlExpiry Int

Instances

Eq MErrV

Methods

(==) :: MErrV -> MErrV -> Bool

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

Show MErrV

Methods

showsPrec :: Int -> MErrV -> ShowS

show :: MErrV -> String

showList :: [MErrV] -> ShowS

Exception MErrV

Methods

toException :: MErrV -> SomeException

fromException :: SomeException -> Maybe MErrV

displayException :: MErrV -> String

data ServiceErr

Errors returned by S3 compatible service

Constructors

BucketAlreadyExists

BucketAlreadyOwnedByYou

NoSuchBucket

InvalidBucketName

NoSuchKey

ServiceErr Text Text

Instances

Eq ServiceErr

Methods

(==) :: ServiceErr -> ServiceErr -> Bool

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

Show ServiceErr

Methods

showsPrec :: Int -> ServiceErr -> ShowS

show :: ServiceErr -> String

showList :: [ServiceErr] -> ShowS

Exception ServiceErr

Methods

toException :: ServiceErr -> SomeException

fromException :: SomeException -> Maybe ServiceErr

displayException :: ServiceErr -> String