The cl-s3 Reference Manual

3.1.1 cl-s3/cl-s3.asd

Source

cl-s3.asd.

Parent Component

cl-s3 (system).

ASDF Systems

cl-s3.

---

3.1.2 cl-s3/cl-s3-package.lisp

Source

cl-s3.asd.

Parent Component

cl-s3 (system).

Packages

cl-s3.

---

3.1.3 cl-s3/cl-s3.lisp

Dependency

cl-s3-package.lisp (file).

Source

cl-s3.asd.

Parent Component

cl-s3 (system).

Public Interface

• *access-key-id* (special variable).
• *secret-access-key* (special variable).
• amazon-s3-api-error (condition).
• delete-bucket (function).
• delete-object (function).
• download-file (function).
• get-bucket (function).
• get-object (function).
• get-service (function).
• head-object (function).
• lisp-time->unix-time (function).
• list-buckets (function).
• list-objects (function).
• make-authorization (function).
• put-bucket (function).
• put-object (function).
• request-date (function).
• unix-time->lisp-time (function).
• upload-file (function).

Internals

• *amazon-host* (special variable).
• *s3-ns* (special variable).
• +zero-unix-time+ (constant).
• amazon-s3-api-error-xml (reader method).
• do-s3-request (function).
• hmac-sha1 (function).
• md5sum-sequence (function).

---

5.1.1 Special variables

Special Variable: *access-key-id* ¶

The value of your Amazon Web Services public access key ID

Package

cl-s3.

Source

cl-s3.lisp.

Special Variable: *secret-access-key* ¶

The value of your Amazon Web Services secret access key

Package

cl-s3.

Source

cl-s3.lisp.

---

5.1.2 Ordinary functions

Function: delete-bucket (bucket-name) ¶

Delete a bucket

Package

cl-s3.

Source

cl-s3.lisp.

Function: delete-object (bucket-name object-key) ¶

Delete the object identified by key in bucket

Package

cl-s3.

Source

cl-s3.lisp.

Function: download-file (bucket key &key dir if-exists element-type) ¶

Assuming key in bucket denotes a file, download it, optionally in dir

Package

cl-s3.

Source

cl-s3.lisp.

Function: get-bucket (bucket-name &key prefix marker max-keys delimiter) ¶

List all keys in a bucket that satisfy a query

Package

cl-s3.

Source

cl-s3.lisp.

Function: get-object (bucket-name object-key &key check-integrity body) ¶

Retrieve the object identified by key in bucket

Package

cl-s3.

Source

cl-s3.lisp.

Function: get-service () ¶

List all available buckets

Package

cl-s3.

Source

cl-s3.lisp.

Function: head-object (bucket-name object-key) ¶

Retrieve all meta-data for the the object identified by key in bucket

Package

cl-s3.

Source

cl-s3.lisp.

Function: lisp-time->unix-time (s) ¶

Convert from Common Lisp time to Unix time

Package

cl-s3.

Source

cl-s3.lisp.

Function: list-buckets () ¶

Returns a list of all accessible buckets’ string names

Package

cl-s3.

Source

cl-s3.lisp.

Function: list-objects (bucket-name &key prefix marker max-keys delimiter) ¶

Return a list of all keys’ strings in bucket, satifying the query

Package

cl-s3.

Source

cl-s3.lisp.

Function: make-authorization (verb resource date &key secret-access-key content-md5 content-type amz-headers) ¶

Compute an Amazon S3 authorization signature

Package

cl-s3.

Source

cl-s3.lisp.

Function: put-bucket (bucket-name) ¶

Create a new bucket

Package

cl-s3.

Source

cl-s3.lisp.

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

Package

cl-s3.

Source

cl-s3.lisp.

Function: request-date (&optional universal-time) ¶

Generate a GMT HTTP Request Date

Package

cl-s3.

Source

cl-s3.lisp.

Function: unix-time->lisp-time (ms) ¶

Convert from Unix time to Common Lisp time

Package

cl-s3.

Source

cl-s3.lisp.

Function: upload-file (pathname bucket &key name element-type mime-type acl) ¶

Upload the file at pathname under bucket, optionally storing it under name

Package

cl-s3.

Source

cl-s3.lisp.

---

5.1.3 Conditions

Condition: amazon-s3-api-error ¶

Thrown when an Amazon S3 API Error is received

Package

cl-s3.

Source

cl-s3.lisp.

Direct superclasses

error.

Direct methods

amazon-s3-api-error-xml.

Direct slots

Slot: xml ¶

Initargs

:xml

Readers

amazon-s3-api-error-xml.

Writers

This slot is read-only.

Slot: more-values ¶

Initargs

:more-values

---

5.2.1 Constants

Constant: +zero-unix-time+ ¶

Package

cl-s3.

Source

cl-s3.lisp.

---

5.2.2 Special variables

Special Variable: *amazon-host* ¶

Package

cl-s3.

Source

cl-s3.lisp.

Special Variable: *s3-ns* ¶

Package

cl-s3.

Source

cl-s3.lisp.

---

5.2.3 Ordinary functions

Function: do-s3-request (verb uri &key content content-type content-length content-md5 amz-headers query body) ¶

Package

cl-s3.

Source

cl-s3.lisp.

Function: hmac-sha1 (data-string key-string) ¶

Compute an RFC 2104 HMAC-SHA1 digest on data-string using key-string

Package

cl-s3.

Source

cl-s3.lisp.

Function: md5sum-sequence (data-string) ¶

Compute a MD5 digest on data-string

Package

cl-s3.

Source

cl-s3.lisp.

---

5.2.4 Generic functions

Generic Reader: amazon-s3-api-error-xml (condition) ¶

Package

cl-s3.

Methods

Reader Method: amazon-s3-api-error-xml ((condition amazon-s3-api-error)) ¶

Source

cl-s3.lisp.

Target Slot

xml.

---