The cl-s3 Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The cl-s3 Reference Manual

This is the cl-s3 Reference Manual, version 1, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:21:55 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

CL-S3

CL-S3 is a Common Lisp library that implements a client interface to the Amazon S3 Web Service.

More specifically, CL-S3

CL-S3 was written by Sven Van Caekenberghe and is available under an LLGPL license.

Please read the full Amazon S3 documentation and study the Common Lisp source code before contacting me with ;-)

There is an interesting post on Nicky Peeters' Blog showing how to get started using CL-S3.


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

2.1 cl-s3

Maintainer

Sven Van Caekenberghe <svc@mac.com>

Author

Sven Van Caekenberghe <svc@mac.com>

License

Lesser Lisp General Public License (LLGPL)

Description

A Common Lisp Amazon S3 client interface package

Version

1

Dependencies
Source

cl-s3.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 cl-s3.asd

Location

cl-s3.asd

Systems

cl-s3 (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

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

Parent

cl-s3 (system)

Location

cl-s3-package.lisp

Packages

cl-s3


Previous: , Up: Lisp files   [Contents][Index]

3.1.3 cl-s3/cl-s3.lisp

Dependency

cl-s3-package.lisp (file)

Parent

cl-s3 (system)

Location

cl-s3.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 cl-s3

A Common Lisp Amazon S3 client interface package

Source

cl-s3-package.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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 (file)

Special Variable: *secret-access-key*

The value of your Amazon Web Services secret access key

Package

cl-s3

Source

cl-s3.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Functions

Function: delete-bucket BUCKET-NAME

Delete a bucket

Package

cl-s3

Source

cl-s3.lisp (file)

Function: delete-object BUCKET-NAME OBJECT-KEY

Delete the object identified by key in bucket

Package

cl-s3

Source

cl-s3.lisp (file)

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 (file)

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 (file)

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 (file)

Function: get-service ()

List all available buckets

Package

cl-s3

Source

cl-s3.lisp (file)

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 (file)

Function: lisp-time->unix-time S

Convert from Common Lisp time to Unix time

Package

cl-s3

Source

cl-s3.lisp (file)

Function: list-buckets ()

Returns a list of all accessible buckets’ string names

Package

cl-s3

Source

cl-s3.lisp (file)

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 (file)

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 (file)

Function: put-bucket BUCKET-NAME

Create a new bucket

Package

cl-s3

Source

cl-s3.lisp (file)

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 (file)

Function: request-date &optional UNIVERSAL-TIME

Generate a GMT HTTP Request Date

Package

cl-s3

Source

cl-s3.lisp (file)

Function: unix-time->lisp-time MS

Convert from Unix time to Common Lisp time

Package

cl-s3

Source

cl-s3.lisp (file)

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 (file)


Previous: , Up: Exported definitions   [Contents][Index]

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 (file)

Direct superclasses

error (condition)

Direct methods

amazon-s3-api-error-xml (method)

Direct slots
Slot: xml
Initargs

:xml

Readers

amazon-s3-api-error-xml (generic function)

Slot: more-values
Initargs

:more-values


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Constants

Constant: +zero-unix-time+
Package

cl-s3

Source

cl-s3.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Special variables

Special Variable: *amazon-host*
Package

cl-s3

Source

cl-s3.lisp (file)

Special Variable: *s3-ns*
Package

cl-s3

Source

cl-s3.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.3 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 (file)

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 (file)

Function: md5sum-sequence DATA-STRING

Compute a MD5 digest on data-string

Package

cl-s3

Source

cl-s3.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.4 Generic functions

Generic Function: amazon-s3-api-error-xml CONDITION
Package

cl-s3

Methods
Method: amazon-s3-api-error-xml (CONDITION amazon-s3-api-error)
Source

cl-s3.lisp (file)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl-s3.asd: The cl-s3<dot>asd file
cl-s3/cl-s3-package.lisp: The cl-s3/cl-s3-package<dot>lisp file
cl-s3/cl-s3.lisp: The cl-s3/cl-s3<dot>lisp file

F
File, Lisp, cl-s3.asd: The cl-s3<dot>asd file
File, Lisp, cl-s3/cl-s3-package.lisp: The cl-s3/cl-s3-package<dot>lisp file
File, Lisp, cl-s3/cl-s3.lisp: The cl-s3/cl-s3<dot>lisp file

L
Lisp File, cl-s3.asd: The cl-s3<dot>asd file
Lisp File, cl-s3/cl-s3-package.lisp: The cl-s3/cl-s3-package<dot>lisp file
Lisp File, cl-s3/cl-s3.lisp: The cl-s3/cl-s3<dot>lisp file

Jump to:   C   F   L  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   A   D   F   G   H   L   M   P   R   U  
Index Entry  Section

A
amazon-s3-api-error-xml: Internal generic functions
amazon-s3-api-error-xml: Internal generic functions

D
delete-bucket: Exported functions
delete-object: Exported functions
do-s3-request: Internal functions
download-file: Exported functions

F
Function, delete-bucket: Exported functions
Function, delete-object: Exported functions
Function, do-s3-request: Internal functions
Function, download-file: Exported functions
Function, get-bucket: Exported functions
Function, get-object: Exported functions
Function, get-service: Exported functions
Function, head-object: Exported functions
Function, hmac-sha1: Internal functions
Function, lisp-time->unix-time: Exported functions
Function, list-buckets: Exported functions
Function, list-objects: Exported functions
Function, make-authorization: Exported functions
Function, md5sum-sequence: Internal functions
Function, put-bucket: Exported functions
Function, put-object: Exported functions
Function, request-date: Exported functions
Function, unix-time->lisp-time: Exported functions
Function, upload-file: Exported functions

G
Generic Function, amazon-s3-api-error-xml: Internal generic functions
get-bucket: Exported functions
get-object: Exported functions
get-service: Exported functions

H
head-object: Exported functions
hmac-sha1: Internal functions

L
lisp-time->unix-time: Exported functions
list-buckets: Exported functions
list-objects: Exported functions

M
make-authorization: Exported functions
md5sum-sequence: Internal functions
Method, amazon-s3-api-error-xml: Internal generic functions

P
put-bucket: Exported functions
put-object: Exported functions

R
request-date: Exported functions

U
unix-time->lisp-time: Exported functions
upload-file: Exported functions

Jump to:   A   D   F   G   H   L   M   P   R   U  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *   +  
C   M   S   X  
Index Entry  Section

*
*access-key-id*: Exported special variables
*amazon-host*: Internal special variables
*s3-ns*: Internal special variables
*secret-access-key*: Exported special variables

+
+zero-unix-time+: Internal constants

C
Constant, +zero-unix-time+: Internal constants

M
more-values: Exported conditions

S
Slot, more-values: Exported conditions
Slot, xml: Exported conditions
Special Variable, *access-key-id*: Exported special variables
Special Variable, *amazon-host*: Internal special variables
Special Variable, *s3-ns*: Internal special variables
Special Variable, *secret-access-key*: Exported special variables

X
xml: Exported conditions

Jump to:   *   +  
C   M   S   X  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   A   C   P   S  
Index Entry  Section

A
amazon-s3-api-error: Exported conditions

C
cl-s3: The cl-s3 system
cl-s3: The cl-s3 package
Condition, amazon-s3-api-error: Exported conditions

P
Package, cl-s3: The cl-s3 package

S
System, cl-s3: The cl-s3 system

Jump to:   A   C   P   S