cl-s3

API Reference

cl-s3

A Common Lisp Amazon S3 client interface package

CL-S3

A Common Lisp Amazon S3 client interface package
  • Variable *ACCESS-KEY-ID*
    ""
    The value of your Amazon Web Services public access key ID
  • Variable *SECRET-ACCESS-KEY*
    ""
    The value of your Amazon Web Services secret access key
  • Function REQUEST-DATE (&optional (universal-time (get-universal-time)))
    Generate a GMT HTTP Request Date
  • Function UNIX-TIME->LISP-TIME (ms)
    Convert from Unix time to Common Lisp time
  • Function LISP-TIME->UNIX-TIME (s)
    Convert from Common Lisp time to Unix time
  • Function MAKE-AUTHORIZATION (verb resource date &key (secret-access-key *secret-access-key*) content-md5 content-type amz-headers)
    Compute an Amazon S3 authorization signature
  • Condition AMAZON-S3-API-ERROR  (ERROR)
    Thrown when an Amazon S3 API Error is received
  • Function GET-SERVICE
    List all available buckets
  • Function GET-BUCKET (bucket-name &key prefix marker max-keys delimiter)
    List all keys in a bucket that satisfy a query
  • Function PUT-BUCKET (bucket-name)
    Create a new bucket
  • Function DELETE-BUCKET (bucket-name)
    Delete a bucket
  • Function GET-OBJECT (bucket-name object-key &key check-integrity body)
    Retrieve the object identified by key in bucket
  • Function PUT-OBJECT (bucket-name object-key content content-type &key amz-headers check-integrity content-length)
    Set the object identified by key in bucket to the specified content
  • Function HEAD-OBJECT (bucket-name object-key)
    Retrieve all meta-data for the the object identified by key in bucket
  • Function DELETE-OBJECT (bucket-name object-key)
    Delete the object identified by key in bucket
  • Function LIST-BUCKETS
    Returns a list of all accessible buckets' string names
  • Function LIST-OBJECTS (bucket-name &key prefix marker max-keys delimiter)
    Return a list of all keys' strings in bucket, satifying the query
  • Function DOWNLOAD-FILE (bucket key &key dir (if-exists :supersede) (element-type '(unsigned-byte 8)))
    Assuming key in bucket denotes a file, download it, optionally in dir
  • Function UPLOAD-FILE (pathname bucket &key name (element-type '(unsigned-byte 8)) (mime-type "application/octet-stream") acl)
    Upload the file at pathname under bucket, optionally storing it under name