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

Fetch bucket location (region)

Fetch all buckets from the service.

Represents result from a listing of objects in a bucket.

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

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

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

Query the object store if a given bucket exists.

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

Get metadata of an object.

Creates a bucket via a PUT bucket call.

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

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

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.

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

A type to represent a part-number and etag.

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

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

Create a new multipart upload.

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

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

Complete a multipart upload.

Abort a multipart upload.

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

List incomplete multipart uploads.

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

List parts of an ongoing multipart upload.

DELETE a bucket from the service.

DELETE an object from the service.

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

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.

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

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.

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

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

Fetch the policy if any on a bucket.

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

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.