chickadee » amazon-s3

Amazon S3

Warning

This API will change. More S3 features are being added and the API is being changed to be more flexible and easier to use.

Description

A simple API to use the Amazon S3 service. The current version does not come close to supporting all of S3 or AWS. If there is something in the API that you need, that isn't currently there, let me know at t@thintz.com.

Author

Thomas Hintz

Contact me at t@thintz.com.

Requirements

List of user configurable parameters

access-key

(access-key [string]) parameter

This needs to be set before you can access S3. This is your AWS access key.

secret-key

(secret-key [string]) parameter

This needs to be set before you can access S3. This is your AWS secret key.

https

(https [boolean]) parameter

If set to #t Amazon S3 will be accessed via https. Defaults to #f.

List of Procedures

All procedures return three values. The first will be the return value for the procedure. The second is the request-uri. The third is the response object. See http-client's call-with-input-request (Amazon S3 uses this and returns the same values).

Errors are unspecified and will occur if you do anything that results in an error. Such as: not setting up your AWS access or secret keys correctly, trying to access something you don't have permissions to, trying to create a bucket that already exists, etc. This is subject to change.

list-buckets

(list-buckets) procedure

Returns a list of your buckets.

bucket-exists?

(bucket-exists? bucket) procedure

Returns #t when the specified bucket exists, #f otherwise.

create-bucket!

(create-bucket! bucket) procedure

Creates a bucket. If the bucket already exists, you will most likely get an error. The result of this call is unspecified.

delete-bucket!

(delete-bucket! bucket) procedure

Attempts to delete the specified bucket. If the bucket doesn't exist or can't be deleted, you will get an unspecified error.

list-objects

(list-objects bucket) procedure

Returns a list of all the objects in the specified bucket.

put-object!

(put-object! bucket key object-thunk object-length object-type) procedure

This is the basic/raw way of putting an object on S3. It is recommended to use either put-string! or put-sexp!, if you can. Takes a bucket, a key (string) for identifying the object, a thunk that returns the object, the length of the object, and the object type.

If the key already specifies an object on S3, the object will be replaced.

As an example, put-string! is implemented like this: (put-object! bucket key (lambda () string) (string-length string) "text/plain").

The return is unspecified.

put-string!

(put-string! bucket key string) procedure

Simply takes a bucket, key (string) to identify the string, and the string to put on S3; and pushes the string to S3.

If the key already specifies an string on S3, the string will be replaced.

The return is unspecified.

put-sexp!

(put-sexp! bucket key sexp) procedure

Simply takes a bucket, key (string) to identify the sexp, and a quoted s-expression to put on S3; and pushes the s-expression to S3.

If the key already specifies a s-exp on S3, the s-exp will be replaced.

The return is unspecified.

put-file!

(put-file! bucket key file-path) procedure

Upload a file.

get-file

(get-file bucket key file-path) procedure

Retrieve arbitrary item and write it to file-path.

get-object

(get-object bucket key) procedure

Takes a bucket and an object key and returns the object identified by the key. Note that all procedures that call to S3 also return request response.

get-string

(get-string bucket key) procedure

Takes a bucket and an object key and returns the string identified by the key.

get-sexp

(get-sexp bucket key) procedure

Takes a bucket and an object key and returns the s-expression identified by the key. Note that a returned s-expression must be evaled before it can be treated as code.

delete-object!

(delete-object! bucket key) procedure

Takes a bucket and an object key and attempts to delete the object identified by the key. If the object can't be deleted, an unspecified error will occur.

List of macros

with-bucket

(with-bucket bucket ...) syntax

All amazon-s3 operations in the body will use the specified bucket without requiring it to be explicitly set.

WARNING! DEPRECATED This is broken and only works with calls that start with bucket. The next version of this lib will make this pattern obsolete.

(with-bucket "foo"
  (put-file! "foo-file" "~/foo")
  (get-file "foo-file" "~/foo2"))

(with-bucket "foo"
  (+ 1 2 3)) ; this will not work!

Version History

0.8

4

Initial release.

Contents »