S3 Bucket identifier

Bucket metadata reported by listBuckets

Access permissions (aka Canned ACLs)

This has different meanings depending on whether it's set for buckets or objects

The owner of an entity has always full read & write access

For buckets, read access denotes the ability to list objects

List buckets owned by user

Create bucket

Delete bucket

NOTE: Most S3 implementations require the bucket to be empty before it can be deleted. See documentation of listObjectsFold for a code example deleting a non-empty bucket.

List all objects in a bucket

This operation may cause multiple HTTP requests to be issued

See also listObjectsChunk and listObjectsFold

Convenient foldM-like object listing operation

Here's an usage example for iterating over the list of objects in chunks of 100 objects and deleting those; and finally deleting the bucket:

destroyBucket conn creds bid = do
  listObjectsFold conn creds bid nullObjKey Nothing 100 () $ \() objs [] ->
    forM_ objs $ \omi -> deleteObject conn creds bid (omiKey omi)
  deleteBucket conn creds bid

Primitive operation for list objects

This operation corresponds to a single HTTP service request

The listObjectsChunk and listObjects operations build on this primitive building block.

The name for a key is a non-empty sequence of Unicode characters whose UTF-8 encoding is at most 1024 bytes long.

See also remarks in s3cfgEncodingUrl about permissible code-points.

See also AWS S3's documentation on "Object Key and Metadata"

Test whether ObjKey is the nullObjKey

Represents the null (or empty) ObjKey

Object Metadata

Content-type

Unspecified CType

Denotes an ETag

MD5 Hash

Compute MD5 hash

Hex-encode MD5 digest value

Hex-decode MD5 digest value

Extract MD5 digest value

Construct MD5 digest value from 16 octets

PUT Object

Copy Object

GET Object

DELETE Object

Conditional Request

Note that S3 server implementations vary in their support for conditional requests

S3-level errors

Protocol-level errors and exceptions

S3 Credentials

We use memory pinned ByteStrings because we don't want to have the credential data copied around more than necessary.

Anonymous access

Configure S3 endpoint

Default S3Cfg value with recommended/default settings, i.e.

>>> defaultS3Cfg
S3Cfg {s3cfgBaseUrl = "", s3cfgRegion = "us-east-1", s3cfgSigVersion = SignatureV4, s3cfgEncodingUrl = False, s3cfgDebug = False}

NOTE: At the very least you have to override the s3cfgBaseUrl field.

Denotes version of the S3 request signing algorithm

Represents a single-threaded HTTP channel to the S3 service

Simple single-connection bracket style combinator over connect and close

If you need resource pool management you can use connect in combination with packages such as resource-pool.

Create HTTP(s) connection based on S3Cfg

Close connection constructed via connect