minio-hs-1.1.0: A Minio Haskell Library for Amazon S3 compatible cloud storage.

Safe HaskellNone
LanguageHaskell2010

Network.Minio.S3API

Contents

Synopsis

Documentation

type Region = Text Source #

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

getLocation :: Bucket -> Minio Region Source #

Fetch bucket location (region)

Listing buckets

getService :: Minio [BucketInfo] Source #

Fetch all buckets from the service.

Listing objects

data ListObjectsResult Source #

Represents result from a listing of objects in a bucket.

data ListObjectsV1Result Source #

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

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

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 Source #

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

Retrieving buckets

headBucket :: Bucket -> Minio Bool Source #

Query the object store if a given bucket exists.

Retrieving objects

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

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

headObject :: Bucket -> Object -> Minio ObjectInfo Source #

Get metadata of an object.

Creating buckets and objects

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

Creates a bucket via a PUT bucket call.

type ETag = Text Source #

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

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

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) Source #

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 Source #

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

type PartTuple = (PartNumber, ETag) Source #

A type to represent a part-number and etag.

data Payload Source #

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

type PartNumber = Int16 Source #

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

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

Create a new multipart upload.

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

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

copyObjectPart :: DestinationInfo -> SourceInfo -> UploadId -> PartNumber -> [Header] -> Minio (ETag, UTCTime) Source #

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 Source #

Complete a multipart upload.

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

Abort a multipart upload.

data ListUploadsResult Source #

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

listIncompleteUploads' :: Bucket -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Int -> Minio ListUploadsResult Source #

List incomplete multipart uploads.

data ListPartsResult Source #

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

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

List parts of an ongoing multipart upload.

Deletion APIs

deleteBucket :: Bucket -> Minio () Source #

DELETE a bucket from the service.

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

DELETE an object from the service.

Presigned Operations

type UrlExpiry = Int Source #

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 Source #

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 Source #

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 Source #

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 Source #

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.

ppCondBucket :: Bucket -> PostPolicyCondition Source #

Set the bucket name that the upload should use.

ppCondContentLengthRange :: Int64 -> Int64 -> PostPolicyCondition Source #

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

ppCondContentType :: Text -> PostPolicyCondition Source #

Set the content-type header for the upload.

ppCondKey :: Object -> PostPolicyCondition Source #

Set the object name constraint for the upload.

ppCondKeyStartsWith :: Object -> PostPolicyCondition Source #

Set the object name prefix constraint for the upload.

ppCondSuccessActionStatus :: Int -> PostPolicyCondition Source #

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

data PostPolicy Source #

A PostPolicy is required to perform uploads via browser forms.

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

This function creates a PostPolicy after validating its arguments.

showPostPolicy :: PostPolicy -> ByteString Source #

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

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

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 Source #

Fetch the policy if any on a bucket.

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

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 Source #

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

Instances
Eq Notification Source # 
Instance details

Defined in Network.Minio.Data

Show Notification Source # 
Instance details

Defined in Network.Minio.Data

data NotificationConfig Source #

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

Constructors

NotificationConfig 

Fields

type Arn = Text Source #

data Filter Source #

Constructors

Filter 

Fields

Instances
Eq Filter Source # 
Instance details

Defined in Network.Minio.Data

Methods

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

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

Show Filter Source # 
Instance details

Defined in Network.Minio.Data

data FilterKey Source #

Constructors

FilterKey 

Fields

Instances
Eq FilterKey Source # 
Instance details

Defined in Network.Minio.Data

Show FilterKey Source # 
Instance details

Defined in Network.Minio.Data

data FilterRules Source #

Constructors

FilterRules 
Instances
Eq FilterRules Source # 
Instance details

Defined in Network.Minio.Data

Show FilterRules Source # 
Instance details

Defined in Network.Minio.Data

data FilterRule Source #

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

Instances
Eq FilterRule Source # 
Instance details

Defined in Network.Minio.Data

Show FilterRule Source # 
Instance details

Defined in Network.Minio.Data

getBucketNotification :: Bucket -> Minio Notification Source #

Retrieve the notification configuration on a bucket.

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

Set the notification configuration on a bucket.

removeAllBucketNotification :: Bucket -> Minio () Source #

Remove all notifications configured on a bucket.