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.

Constructors

ListObjectsResult

Fields

• lorHasMore :: Bool
• lorNextToken :: Maybe Text
• lorObjects :: [ObjectInfo]
• lorCPrefixes :: [Text]

Instances

Eq ListObjectsResult

Methods

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

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

Show ListObjectsResult

Methods

showsPrec :: Int -> ListObjectsResult -> ShowS

show :: ListObjectsResult -> String

showList :: [ListObjectsResult] -> ShowS

data ListObjectsV1Result

Represents result from a listing of objects version 1 in a bucket.

Constructors

ListObjectsV1Result

Fields

• lorHasMore' :: Bool
• lorNextMarker :: Maybe Text
• lorObjects' :: [ObjectInfo]
• lorCPrefixes' :: [Text]

Instances

Eq ListObjectsV1Result

Methods

(==) :: ListObjectsV1Result -> ListObjectsV1Result -> Bool

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

Show ListObjectsV1Result

Methods

showsPrec :: Int -> ListObjectsV1Result -> ShowS

show :: ListObjectsV1Result -> String

showList :: [ListObjectsV1Result] -> ShowS

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

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

listObjectsV1' :: Bucket -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Int -> Minio ListObjectsV1Result

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

Retrieving buckets

headBucket :: Bucket -> Minio Bool

Query the object store if a given bucket exists.

Retrieving objects

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

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] -> ByteString -> Minio ETag

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 -> SourceInfo -> [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

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 :: DestinationInfo -> SourceInfo -> 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.

Constructors

ListUploadsResult

Fields

• lurHasMore :: Bool
• lurNextKey :: Maybe Text
• lurNextUpload :: Maybe Text
• lurUploads :: [(Object, UploadId, UTCTime)]
• lurCPrefixes :: [Text]

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 -> Maybe Int -> 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.

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.

makePresignedUrl :: UrlExpiry -> Method -> Maybe Bucket -> Maybe Object -> Maybe Region -> Query -> RequestHeaders -> Minio ByteString

Generate a presigned URL. This function allows for advanced usage - for simple cases prefer the `presigned*Url` functions.

If region is Nothing, it is picked up from the connection information (no check of bucket existence is performed).

All extra query parameters or headers are signed, and therefore are required to be sent when the generated URL is actually used.

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.

data PostPolicyCondition

Represents individual conditions in a Post Policy document.

Constructors

PPCStartsWith Text Text

PPCEquals Text Text

PPCRange Text Int64 Int64

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

data PostPolicy

A PostPolicy is required to perform uploads via browser forms.

Constructors

PostPolicy

Fields

• expiration :: UTCTime
• conditions :: [PostPolicyCondition]

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.

showPostPolicy :: PostPolicy -> ByteString

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

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.

Bucket Policies

getBucketPolicy :: Bucket -> Minio Text

Fetch the policy if any on a bucket.

setBucketPolicy :: Bucket -> Text -> Minio ()

Set a new policy on a bucket. As a special condition if the policy is empty then we treat it as policy DELETE operation.

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.