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

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"
}

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.

Minio Play Server ConnectInfo. Credentials are already filled in.

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.

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

The default value for this type.

Represents a bucket in the object store

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.

Removes a bucket from the object store.

Query the object store if a given bucket is present.

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

Fetch bucket location (region)

BucketInfo returned for list buckets call

Lists buckets.

Represents information about an object.

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

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

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

Represents information about a multipart upload.

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.

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

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

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

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

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

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/".

Retrieve the notification configuration on a bucket.

Set the notification configuration on a bucket.

Remove all notifications configured on a bucket.

Represents an object name

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.

Upload the given file to the given object.

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.

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

Perform a server-side copy operation to create an object with the given bucket and object name from the source specification in CopyPartSource. This function performs a multipart copy operation if the new object is to be greater than 5GiB in size.

Get an object's metadata from the object store.

Remove an object from the object store.

Removes an ongoing multipart upload of an object.

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

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.

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.

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.

A PostPolicy is required to perform uploads via browser forms.

Possible validation errors when creating a PostPolicy.

This function creates a PostPolicy after validating its arguments.

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

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

Represents individual conditions in a Post Policy document.

Set the bucket name that the upload should use.

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

Set the content-type header for the upload.

Set the object name constraint for the upload.

Set the object name prefix constraint for the upload.

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

Errors thrown by the library

Various validation errors

Errors returned by S3 compatible service