The zs3 Reference Manual

This is the zs3 Reference Manual, version 1.3.3, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 08:08:52 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 zs3

A Common Lisp library for working with Amazon’s Simple Storage Service (S3) and CloudFront content delivery service.

Author

Zach Beane <>

License

BSD

Version

1.3.3

Dependencies
  • drakma (system).
  • alexandria (system).
  • cxml (system).
  • ironclad (system).
  • puri (system).
  • cl-base64 (system).
Source

zs3.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 zs3/zs3.asd

Source

zs3.asd.

Parent Component

zs3 (system).

ASDF Systems

zs3.


3.1.2 zs3/package.lisp

Source

zs3.asd.

Parent Component

zs3 (system).

Packages

zs3.


3.1.3 zs3/utils.lisp

Dependency

package.lisp (file).

Source

zs3.asd.

Parent Component

zs3 (system).

Public Interface
Internals

3.1.4 zs3/crypto.lisp

Dependency

utils.lisp (file).

Source

zs3.asd.

Parent Component

zs3 (system).

Public Interface

file-etag (function).

Internals

3.1.5 zs3/xml-binding.lisp

Dependency

crypto.lisp (file).

Source

zs3.asd.

Parent Component

zs3 (system).

Internals

3.1.6 zs3/xml-output.lisp

Dependency

xml-binding.lisp (file).

Source

zs3.asd.

Parent Component

zs3 (system).

Internals

3.1.7 zs3/credentials.lisp

Dependency

xml-output.lisp (file).

Source

zs3.asd.

Parent Component

zs3 (system).

Public Interface
Internals

3.1.8 zs3/post.lisp

Dependency

credentials.lisp (file).

Source

zs3.asd.

Parent Component

zs3 (system).

Internals

3.1.9 zs3/redirects.lisp

Dependency

post.lisp (file).

Source

zs3.asd.

Parent Component

zs3 (system).

Public Interface

clear-redirects (function).

Internals

3.1.10 zs3/request.lisp

Dependency

redirects.lisp (file).

Source

zs3.asd.

Parent Component

zs3 (system).

Public Interface
Internals

3.1.11 zs3/response.lisp

Dependency

request.lisp (file).

Source

zs3.asd.

Parent Component

zs3 (system).

Public Interface
Internals

3.1.12 zs3/objects.lisp

Dependency

response.lisp (file).

Source

zs3.asd.

Parent Component

zs3 (system).

Public Interface
Internals

3.1.13 zs3/bucket-listing.lisp

Dependency

objects.lisp (file).

Source

zs3.asd.

Parent Component

zs3 (system).

Public Interface
Internals

3.1.14 zs3/errors.lisp

Dependency

bucket-listing.lisp (file).

Source

zs3.asd.

Parent Component

zs3 (system).

Public Interface
Internals

3.1.15 zs3/acl.lisp

Dependency

errors.lisp (file).

Source

zs3.asd.

Parent Component

zs3 (system).

Public Interface
Internals

3.1.16 zs3/logging.lisp

Dependency

acl.lisp (file).

Source

zs3.asd.

Parent Component

zs3 (system).

Public Interface

logging-setup (class).

Internals

3.1.17 zs3/location.lisp

Dependency

logging.lisp (file).

Source

zs3.asd.

Parent Component

zs3 (system).

Internals

3.1.18 zs3/interface.lisp

Dependency

location.lisp (file).

Source

zs3.asd.

Parent Component

zs3 (system).

Public Interface
Internals

3.1.19 zs3/cloudfront.lisp

Dependency

interface.lisp (file).

Source

zs3.asd.

Parent Component

zs3 (system).

Public Interface
Internals

3.1.20 zs3/lifecycle.lisp

Dependency

cloudfront.lisp (file).

Source

zs3.asd.

Parent Component

zs3 (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 zs3

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Special variables

Special Variable: *all-users*
Package

zs3.

Source

acl.lisp.

Special Variable: *aws-users*
Package

zs3.

Source

acl.lisp.

Special Variable: *backoff*

Used as the default value of :BACKOFF when submitting a request. The value should be a cons of two numbers: how many times to try before giving up, and how long to wait (in ms) before trying for the second time. Each subsequent attempt will double that time.

Package

zs3.

Source

response.lisp.

Special Variable: *credentials*

Used as the default initarg value of :CREDENTIALS when creating a request.

Package

zs3.

Source

credentials.lisp.

Special Variable: *keep-alive-stream*

When using http keep-alive, this variable is bound to the stream which is being kept open for repeated usage. It is up to client code to ensure that only one thread at a time is making requests that could use the same stream object concurrently. One way to achive this would be to create a separate binding per thread. The with-keep-alive macro can be useful here.

Package

zs3.

Source

request.lisp.

Special Variable: *log-delivery*
Package

zs3.

Source

acl.lisp.

Special Variable: *s3-endpoint*
Package

zs3.

Source

request.lisp.

Special Variable: *s3-region*
Package

zs3.

Source

request.lisp.

Special Variable: *signed-payload*

When true, compute the SHA256 hash for the body of all requests when submitting to AWS.

Package

zs3.

Source

request.lisp.

Special Variable: *use-content-md5*
Package

zs3.

Source

request.lisp.

Special Variable: *use-keep-alive*

When set to t, this library uses the drakma client with
keep alive enabled. This means that a stream will be reused for multiple requests. The stream itself will be bound to *keep-alive-stream*

Package

zs3.

Source

request.lisp.

Special Variable: *use-ssl*
Package

zs3.

Source

request.lisp.


5.1.2 Macros

Macro: with-keep-alive (&body body)

Create thread-local bindings of the zs3 keep-alive variables around a body of code. Ensure the stream is closed at exit.

Package

zs3.

Source

request.lisp.


5.1.3 Ordinary functions

Function: acl-email (address)
Package

zs3.

Source

acl.lisp.

Function: acl-person (id &optional display-name)
Package

zs3.

Source

acl.lisp.

Function: all-buckets (&key credentials backoff)

Return a vector of all BUCKET objects associated with *CREDENTIALS*.

Package

zs3.

Source

interface.lisp.

Function: all-distributions (&key credentials)
Package

zs3.

Source

cloudfront.lisp.

Function: all-keys (bucket &key prefix credentials backoff)

Reutrn a vector of all KEY objects in BUCKET.

Package

zs3.

Source

interface.lisp.

Function: authorized-url (&key bucket key vhost expires ssl sub-resource content-disposition content-type credentials)
Package

zs3.

Source

interface.lisp.

Function: bucket-exists-p (bucket &key credentials backoff)
Package

zs3.

Source

interface.lisp.

Function: bucket-lifecycle (bucket &key credentials backoff)

Return the bucket lifecycle rules for BUCKET. Signals NO-SUCH-LIFECYCLE-CONFIGURATION if the bucket has no lifecycle configuration.

Package

zs3.

Source

lifecycle.lisp.

Function: (setf bucket-lifecycle) (bucket &key credentials backoff)

Set the lifecycle configuration of BUCKET to RULES. RULES is coerced to a list if needed. If RULES is NIL, the lifecycle configuration is deleted with DELETE-BUCKET-LIFECYCLE.

Package

zs3.

Source

lifecycle.lisp.

Function: bucket-location (bucket &key credentials backoff)

If BUCKET was created with a LocationConstraint, return its constraint.

Package

zs3.

Source

interface.lisp.

Function: clear-redirects ()
Package

zs3.

Source

redirects.lisp.

Function: continue-bucket-query (response)
Package

zs3.

Source

interface.lisp.

Function: copy-object (&key from-bucket from-key to-bucket to-key when-etag-matches unless-etag-matches when-modified-since unless-modified-since metadata access-policy public precondition-errors storage-class tagging credentials backoff)

Copy the object identified by FROM-BUCKET/FROM-KEY to TO-BUCKET/TO-KEY.

If TO-BUCKET is NIL, uses FROM-BUCKET as the target. If TO-KEY is NIL, uses TO-KEY as the target.

If METADATA is provided, it should be an alist of metadata keys and values to set on the new object. Otherwise, the source object’s metadata is copied.

If TAGGING is provided, it should be an alist of tag keys and values to be set on the new object’s tagging resource. Otherwise, the source object’s tagging is copied.

Optional precondition variables are WHEN-ETAG-MATCHES, UNLESS-ETAG-MATCHES, WHEN-MODIFIED-SINCE, UNLESS-MODIFIED-SINCE. The etag variables use an etag as produced by the FILE-ETAG function, i.e. a lowercase hex representation of the file’s MD5 digest, surrounded by quotes. The modified-since variables should use a universal time.

If PUBLIC is T, the new object is visible to all
users. Otherwise, a default ACL is present on the new object.

Package

zs3.

Source

interface.lisp.

Function: create-bucket (name &key access-policy public location credentials backoff)
Package

zs3.

Source

interface.lisp.

Function: create-distribution (bucket-name &key cnames enabled comment)
Package

zs3.

Source

cloudfront.lisp.

Function: delete-all-objects (bucket &key credentials backoff)

Delete all objects in BUCKET.

Package

zs3.

Source

interface.lisp.

Function: delete-bucket (bucket &key credentials backoff)
Package

zs3.

Source

interface.lisp.

Function: delete-object (bucket key &key credentials backoff)

Delete one object from BUCKET identified by KEY.

Package

zs3.

Source

interface.lisp.

Function: delete-objects (bucket keys &key credentials backoff)

Delete the objects in BUCKET identified by the sequence KEYS.

Package

zs3.

Source

interface.lisp.

Function: delete-tagging (&key bucket key credentials backoff)

Deletes the object’s tagging resource.

Package

zs3.

Source

interface.lisp.

Function: disable-logging (bucket &key credentials backoff)

Disable the creation of access logs for BUCKET.

Package

zs3.

Source

interface.lisp.

Function: disable-logging-to (bucket &key credentials backoff)

Configure the ACL of BUCKET to remove permissions for the log delivery group.

Package

zs3.

Source

interface.lisp.

Function: distributions-for-bucket (bucket-name)

Return a list of distributions that are associated with BUCKET-NAME.

Package

zs3.

Source

cloudfront.lisp.

Function: enable-logging (bucket target-bucket target-prefix &key target-grants credentials backoff)

Enable logging of requests to BUCKET, putting logfile objects into TARGET-BUCKET with a key prefix of TARGET-PREFIX.

Package

zs3.

Source

interface.lisp.

Function: enable-logging-to (bucket &key credentials backoff)

Configure the ACL of BUCKET to accept logfile objects.

Package

zs3.

Source

interface.lisp.

Function: file-credentials (file)
Package

zs3.

Source

credentials.lisp.

Function: file-etag (file)
Package

zs3.

Source

crypto.lisp.

Function: get-acl (&key bucket key credentials backoff)
Package

zs3.

Source

interface.lisp.

Function: get-file (bucket key file &key start end when-modified-since unless-modified-since when-etag-matches unless-etag-matches if-exists credentials backoff)
Package

zs3.

Source

interface.lisp.

Function: get-object (bucket key &key when-modified-since unless-modified-since when-etag-matches unless-etag-matches start end output if-exists string-external-format credentials backoff)
Package

zs3.

Source

interface.lisp.

Function: get-string (bucket key &key start end external-format when-modified-since unless-modified-since when-etag-matches unless-etag-matches if-exists credentials backoff)
Package

zs3.

Source

interface.lisp.

Function: get-tagging (&key bucket key credentials backoff)

Returns the current contents of the object’s tagging resource as an alist.

Package

zs3.

Source

interface.lisp.

Function: get-vector (bucket key &key start end when-modified-since unless-modified-since when-etag-matches unless-etag-matches if-exists credentials backoff)
Package

zs3.

Source

interface.lisp.

Function: grant (permission &key to)
Package

zs3.

Source

acl.lisp.

Function: head (&key bucket key parameters credentials backoff)

Return three values: the HTTP status, an alist of Drakma-style HTTP headers, and the HTTP phrase, with the results of a HEAD request for the object specified by the optional BUCKET and KEY arguments.

Package

zs3.

Source

interface.lisp.

Function: invalidate-paths (distribution paths)
Package

zs3.

Source

cloudfront.lisp.

Function: lifecycle-rule (&key id prefix enabled days date action)
Package

zs3.

Source

lifecycle.lisp.

Function: logging-setup (bucket &key credentials backoff)
Package

zs3.

Source

interface.lisp.

Function: make-post-policy (&key expires conditions credentials)

Return an encoded HTTP POST policy string and policy signature as multiple values.

Package

zs3.

Source

interface.lisp.

Function: make-private (&key bucket key credentials backoff)
Package

zs3.

Source

interface.lisp.

Function: make-public (&key bucket key credentials backoff)
Package

zs3.

Source

interface.lisp.

Function: me (&key credentials backoff)

Return a PERSON object corresponding to the current credentials. Cached.

Package

zs3.

Source

interface.lisp.

Function: now+ (delta)
Package

zs3.

Source

utils.lisp.

Function: now- (delta)
Package

zs3.

Source

utils.lisp.

Function: object-metadata (bucket key &key credentials backoff)

Return the metadata headers as an alist, with keywords for the keys.

Package

zs3.

Source

interface.lisp.

Function: object-restoration-status (bucket key &key credentials backoff)
Package

zs3.

Source

lifecycle.lisp.

Function: octet-vector (&rest octets)
Package

zs3.

Source

utils.lisp.

Function: parameters-alist (&rest args &key &allow-other-keys)

Construct an ALIST based on all keyword arguments passed to the function. Keywords are converted to their lowercase symbol name and values are converted to strings.

Package

zs3.

Source

utils.lisp.

Function: put-acl (owner grants &key bucket key credentials backoff)
Package

zs3.

Source

interface.lisp.

Function: put-file (file bucket key &key start end access-policy public metadata cache-control content-disposition content-encoding content-type expires storage-class tagging credentials backoff)
Package

zs3.

Source

interface.lisp.

Function: put-object (object bucket key &key access-policy public metadata string-external-format cache-control content-encoding content-disposition expires content-type storage-class tagging credentials backoff)
Package

zs3.

Source

interface.lisp.

Function: put-stream (stream bucket key &key start end access-policy public metadata cache-control content-disposition content-encoding content-type expires storage-class tagging credentials backoff)
Package

zs3.

Source

interface.lisp.

Function: put-string (string bucket key &key start end access-policy public metadata external-format cache-control content-encoding content-disposition content-type expires storage-class tagging credentials backoff)
Package

zs3.

Source

interface.lisp.

Function: put-tagging (tag-set &key bucket key credentials backoff)

Sets the tag set, given as an alist, to the object’s tagging resource.

Package

zs3.

Source

interface.lisp.

Function: put-vector (vector bucket key &key start end access-policy public metadata cache-control content-encoding content-disposition content-type expires storage-class tagging credentials backoff)
Package

zs3.

Source

interface.lisp.

Function: query-bucket (bucket &key prefix marker max-keys delimiter credentials backoff)
Package

zs3.

Source

interface.lisp.

Function: resource-url (&key bucket key vhost ssl sub-resource)
Package

zs3.

Source

interface.lisp.

Function: restore-object (bucket key &key days credentials backoff)
Package

zs3.

Source

lifecycle.lisp.

Function: set-storage-class (bucket key storage-class &key credentials backoff)

Set the storage class of the object identified by BUCKET and KEY to STORAGE-CLASS.

Package

zs3.

Source

interface.lisp.


5.1.4 Generic functions

Generic Function: access-key (credentials)
Package

zs3.

Source

credentials.lisp.

Methods
Method: access-key ((request request))
Source

request.lisp.

Reader Method: access-key ((file-credentials file-credentials))

automatically generated reader method

Target Slot

access-key.

Method: access-key (object)
Method: access-key ((list cons))
Generic Writer: (setf access-key) (object)
Package

zs3.

Methods
Writer Method: (setf access-key) ((file-credentials file-credentials))

automatically generated writer method

Source

credentials.lisp.

Target Slot

access-key.

Generic Function: acl-eqv (a b)
Package

zs3.

Source

acl.lisp.

Methods
Method: acl-eqv (a b)
Method: acl-eqv ((a acl-group) (b acl-group))
Method: acl-eqv ((a person) (b person))
Method: acl-eqv ((a grant) (b grant))
Generic Reader: bucket-name (object)
Package

zs3.

Methods
Reader Method: bucket-name ((bucket-listing bucket-listing))

automatically generated reader method

Source

bucket-listing.lisp.

Target Slot

bucket-name.

Generic Writer: (setf bucket-name) (object)
Package

zs3.

Methods
Writer Method: (setf bucket-name) ((bucket-listing bucket-listing))

automatically generated writer method

Source

bucket-listing.lisp.

Target Slot

bucket-name.

Generic Reader: cnames (object)
Package

zs3.

Methods
Reader Method: cnames ((distribution distribution))

automatically generated reader method

Source

cloudfront.lisp.

Target Slot

cnames.

Generic Writer: (setf cnames) (object)
Package

zs3.

Methods
Writer Method: (setf cnames) ((distribution distribution))

automatically generated writer method

Source

cloudfront.lisp.

Target Slot

cnames.

Generic Reader: comment (object)
Package

zs3.

Methods
Reader Method: comment ((distribution distribution))

automatically generated reader method

Source

cloudfront.lisp.

Target Slot

comment.

Generic Writer: (setf comment) (object)
Package

zs3.

Methods
Writer Method: (setf comment) ((distribution distribution))

automatically generated writer method

Source

cloudfront.lisp.

Target Slot

comment.

Generic Reader: common-prefixes (object)
Package

zs3.

Methods
Reader Method: common-prefixes ((bucket-listing bucket-listing))

automatically generated reader method

Source

bucket-listing.lisp.

Target Slot

common-prefixes.

Generic Writer: (setf common-prefixes) (object)
Package

zs3.

Methods
Writer Method: (setf common-prefixes) ((bucket-listing bucket-listing))

automatically generated writer method

Source

bucket-listing.lisp.

Target Slot

common-prefixes.

Generic Reader: creation-date (object)
Package

zs3.

Methods
Reader Method: creation-date ((bucket bucket))

automatically generated reader method

Source

objects.lisp.

Target Slot

creation-date.

Generic Writer: (setf creation-date) (object)
Package

zs3.

Methods
Writer Method: (setf creation-date) ((bucket bucket))

automatically generated writer method

Source

objects.lisp.

Target Slot

creation-date.

Generic Reader: default-root-object (object)
Package

zs3.

Methods
Reader Method: default-root-object ((distribution distribution))

automatically generated reader method

Source

cloudfront.lisp.

Target Slot

default-root-object.

Generic Writer: (setf default-root-object) (object)
Package

zs3.

Methods
Writer Method: (setf default-root-object) ((distribution distribution))

automatically generated writer method

Source

cloudfront.lisp.

Target Slot

default-root-object.

Generic Function: delete-distribution (distribution)
Package

zs3.

Source

cloudfront.lisp.

Methods
Method: delete-distribution ((distribution distribution))
Generic Reader: delimiter (object)
Package

zs3.

Methods
Reader Method: delimiter ((bucket-listing bucket-listing))

automatically generated reader method

Source

bucket-listing.lisp.

Target Slot

delimiter.

Generic Writer: (setf delimiter) (object)
Package

zs3.

Methods
Writer Method: (setf delimiter) ((bucket-listing bucket-listing))

automatically generated writer method

Source

bucket-listing.lisp.

Target Slot

delimiter.

Generic Function: disable (distribution)

Mark DISTRIBUTION as disabled. Like ENABLE, DISABLE may take some time to take effect.

Package

zs3.

Source

cloudfront.lisp.

Methods
Method: disable ((rule lifecycle-rule))
Source

lifecycle.lisp.

Method: disable ((distribution distribution))
Generic Reader: distribution-error-code (condition)
Generic Writer: (setf distribution-error-code) (condition)
Package

zs3.

Methods
Reader Method: distribution-error-code ((condition distribution-error))
Writer Method: (setf distribution-error-code) ((condition distribution-error))
Source

cloudfront.lisp.

Target Slot

error-code.

Generic Reader: distribution-error-detail (condition)
Generic Writer: (setf distribution-error-detail) (condition)
Package

zs3.

Methods
Reader Method: distribution-error-detail ((condition distribution-error))
Writer Method: (setf distribution-error-detail) ((condition distribution-error))
Source

cloudfront.lisp.

Target Slot

error-detail.

Generic Reader: distribution-error-http-status-code (condition)
Generic Writer: (setf distribution-error-http-status-code) (condition)
Package

zs3.

Methods
Reader Method: distribution-error-http-status-code ((condition distribution-error))
Writer Method: (setf distribution-error-http-status-code) ((condition distribution-error))
Source

cloudfront.lisp.

Target Slot

http-status-code.

Generic Reader: distribution-error-type (condition)
Generic Writer: (setf distribution-error-type) (condition)
Package

zs3.

Methods
Reader Method: distribution-error-type ((condition distribution-error))
Writer Method: (setf distribution-error-type) ((condition distribution-error))
Source

cloudfront.lisp.

Target Slot

error-type.

Generic Reader: domain-name (object)
Generic Writer: (setf domain-name) (object)
Package

zs3.

Methods
Reader Method: domain-name ((distribution distribution))
Writer Method: (setf domain-name) ((distribution distribution))

Amazon’s assigned domain name.

Source

cloudfront.lisp.

Target Slot

domain-name.

Generic Function: enable (distribution)

Mark DISTRIBUTION as enabled. Enabling can take time to take effect; the STATUS of DISTRIBUTION will change from "InProgress" to "Deployed" when fully enabled.

Package

zs3.

Source

cloudfront.lisp.

Methods
Method: enable ((rule lifecycle-rule))
Source

lifecycle.lisp.

Method: enable ((distribution distribution))
Generic Reader: enabledp (object)
Package

zs3.

Methods
Reader Method: enabledp ((lifecycle-rule lifecycle-rule))

automatically generated reader method

Source

lifecycle.lisp.

Target Slot

enabledp.

Reader Method: enabledp ((distribution distribution))

Whether this distribution should be enabled at creation time or not.

Source

cloudfront.lisp.

Target Slot

enabledp.

Generic Writer: (setf enabledp) (object)
Package

zs3.

Methods
Writer Method: (setf enabledp) ((lifecycle-rule lifecycle-rule))

automatically generated writer method

Source

lifecycle.lisp.

Target Slot

enabledp.

Writer Method: (setf enabledp) ((distribution distribution))

Whether this distribution should be enabled at creation time or not.

Source

cloudfront.lisp.

Target Slot

enabledp.

Generic Function: ensure-cname (distribution cname)

Add CNAME to DISTRIBUTION’s list of CNAMEs, if not already present.

Package

zs3.

Source

cloudfront.lisp.

Methods
Method: ensure-cname ((distribution distribution) cname)
Generic Reader: etag (object)
Package

zs3.

Methods
Reader Method: etag ((distribution distribution))

automatically generated reader method

Source

cloudfront.lisp.

Target Slot

etag.

Reader Method: etag ((key key))

automatically generated reader method

Source

objects.lisp.

Target Slot

etag.

Generic Writer: (setf etag) (object)
Package

zs3.

Methods
Writer Method: (setf etag) ((distribution distribution))

automatically generated writer method

Source

cloudfront.lisp.

Target Slot

etag.

Writer Method: (setf etag) ((key key))

automatically generated writer method

Source

objects.lisp.

Target Slot

etag.

Generic Reader: http-code (object)
Package

zs3.

Methods
Reader Method: http-code ((response response))

automatically generated reader method

Source

response.lisp.

Target Slot

http-code.

Generic Writer: (setf http-code) (object)
Package

zs3.

Methods
Writer Method: (setf http-code) ((response response))

automatically generated writer method

Source

response.lisp.

Target Slot

http-code.

Generic Reader: http-headers (object)
Package

zs3.

Methods
Reader Method: http-headers ((response response))

automatically generated reader method

Source

response.lisp.

Target Slot

http-headers.

Generic Writer: (setf http-headers) (object)
Package

zs3.

Methods
Writer Method: (setf http-headers) ((response response))

automatically generated writer method

Source

response.lisp.

Target Slot

http-headers.

Generic Reader: http-phrase (object)
Package

zs3.

Methods
Reader Method: http-phrase ((response response))

automatically generated reader method

Source

response.lisp.

Target Slot

http-phrase.

Generic Writer: (setf http-phrase) (object)
Package

zs3.

Methods
Writer Method: (setf http-phrase) ((response response))

automatically generated writer method

Source

response.lisp.

Target Slot

http-phrase.

Generic Reader: keys (object)
Package

zs3.

Methods
Reader Method: keys ((bucket-listing bucket-listing))

automatically generated reader method

Source

bucket-listing.lisp.

Target Slot

keys.

Generic Writer: (setf keys) (object)
Package

zs3.

Methods
Writer Method: (setf keys) ((bucket-listing bucket-listing))

automatically generated writer method

Source

bucket-listing.lisp.

Target Slot

keys.

Generic Reader: last-modified (object)
Package

zs3.

Methods
Reader Method: last-modified ((distribution distribution))

Assigned by Amazon.

Source

cloudfront.lisp.

Target Slot

last-modified.

Reader Method: last-modified ((key key))

automatically generated reader method

Source

objects.lisp.

Target Slot

last-modified.

Generic Writer: (setf last-modified) (object)
Package

zs3.

Methods
Writer Method: (setf last-modified) ((distribution distribution))

Assigned by Amazon.

Source

cloudfront.lisp.

Target Slot

last-modified.

Writer Method: (setf last-modified) ((key key))

automatically generated writer method

Source

objects.lisp.

Target Slot

last-modified.

Generic Reader: logging-bucket (object)
Package

zs3.

Methods
Reader Method: logging-bucket ((distribution distribution))

automatically generated reader method

Source

cloudfront.lisp.

Target Slot

logging-bucket.

Generic Writer: (setf logging-bucket) (object)
Package

zs3.

Methods
Writer Method: (setf logging-bucket) ((distribution distribution))

automatically generated writer method

Source

cloudfront.lisp.

Target Slot

logging-bucket.

Generic Reader: logging-prefix (object)
Package

zs3.

Methods
Reader Method: logging-prefix ((distribution distribution))

automatically generated reader method

Source

cloudfront.lisp.

Target Slot

logging-prefix.

Generic Writer: (setf logging-prefix) (object)
Package

zs3.

Methods
Writer Method: (setf logging-prefix) ((distribution distribution))

automatically generated writer method

Source

cloudfront.lisp.

Target Slot

logging-prefix.

Generic Reader: marker (object)
Package

zs3.

Methods
Reader Method: marker ((bucket-listing bucket-listing))

automatically generated reader method

Source

bucket-listing.lisp.

Target Slot

marker.

Generic Writer: (setf marker) (object)
Package

zs3.

Methods
Writer Method: (setf marker) ((bucket-listing bucket-listing))

automatically generated writer method

Source

bucket-listing.lisp.

Target Slot

marker.

Generic Function: name (object)
Package

zs3.

Methods
Reader Method: name ((key key))

automatically generated reader method

Source

objects.lisp.

Target Slot

name.

Method: name ((string string))
Source

objects.lisp.

Reader Method: name ((bucket bucket))

automatically generated reader method

Source

objects.lisp.

Target Slot

name.

Generic Writer: (setf name) (object)
Package

zs3.

Methods
Writer Method: (setf name) ((key key))

automatically generated writer method

Source

objects.lisp.

Target Slot

name.

Writer Method: (setf name) ((bucket bucket))

automatically generated writer method

Source

objects.lisp.

Target Slot

name.

Generic Reader: origin-bucket (object)
Generic Writer: (setf origin-bucket) (object)
Package

zs3.

Methods
Reader Method: origin-bucket ((distribution distribution))
Writer Method: (setf origin-bucket) ((distribution distribution))

The S3 bucket that acts as the source of objects for the distribution.

Source

cloudfront.lisp.

Target Slot

origin-bucket.

Generic Reader: owner (object)
Package

zs3.

Methods
Reader Method: owner ((access-control-list access-control-list))

automatically generated reader method

Source

acl.lisp.

Target Slot

owner.

Reader Method: owner ((all-buckets all-buckets))

automatically generated reader method

Source

bucket-listing.lisp.

Target Slot

owner.

Reader Method: owner ((key key))

automatically generated reader method

Source

objects.lisp.

Target Slot

owner.

Generic Writer: (setf owner) (object)
Package

zs3.

Methods
Writer Method: (setf owner) ((access-control-list access-control-list))

automatically generated writer method

Source

acl.lisp.

Target Slot

owner.

Writer Method: (setf owner) ((all-buckets all-buckets))

automatically generated writer method

Source

bucket-listing.lisp.

Target Slot

owner.

Writer Method: (setf owner) ((key key))

automatically generated writer method

Source

objects.lisp.

Target Slot

owner.

Generic Reader: prefix (object)
Package

zs3.

Methods
Reader Method: prefix ((lifecycle-rule lifecycle-rule))

automatically generated reader method

Source

lifecycle.lisp.

Target Slot

prefix.

Reader Method: prefix ((bucket-listing bucket-listing))

automatically generated reader method

Source

bucket-listing.lisp.

Target Slot

prefix.

Generic Writer: (setf prefix) (object)
Package

zs3.

Methods
Writer Method: (setf prefix) ((lifecycle-rule lifecycle-rule))

automatically generated writer method

Source

lifecycle.lisp.

Target Slot

prefix.

Writer Method: (setf prefix) ((bucket-listing bucket-listing))

automatically generated writer method

Source

bucket-listing.lisp.

Target Slot

prefix.

Generic Function: refresh (distribution)

Pull down the latest data from AWS for DISTRIBUTION and update its slots.

Package

zs3.

Source

cloudfront.lisp.

Methods
Method: refresh ((invalidation invalidation))
Method: refresh ((distribution distribution))
Generic Function: remove-cname (distribution cname)
Package

zs3.

Source

cloudfront.lisp.

Methods
Method: remove-cname (cname (distribution distribution))
Generic Reader: request-error-response (condition)
Package

zs3.

Methods
Reader Method: request-error-response ((condition request-error))
Source

errors.lisp.

Target Slot

response.

Generic Function: secret-key (credentials)
Package

zs3.

Source

credentials.lisp.

Methods
Method: secret-key ((request request))
Source

request.lisp.

Reader Method: secret-key ((file-credentials file-credentials))

automatically generated reader method

Target Slot

secret-key.

Method: secret-key (object)
Method: secret-key ((list cons))
Generic Writer: (setf secret-key) (object)
Package

zs3.

Methods
Writer Method: (setf secret-key) ((file-credentials file-credentials))

automatically generated writer method

Source

credentials.lisp.

Target Slot

secret-key.

Generic Function: set-comment (distribution comment)
Package

zs3.

Source

cloudfront.lisp.

Methods
Method: set-comment ((distribution distribution) comment)
Generic Reader: size (object)
Package

zs3.

Methods
Reader Method: size ((key key))

automatically generated reader method

Source

objects.lisp.

Target Slot

size.

Generic Writer: (setf size) (object)
Package

zs3.

Methods
Writer Method: (setf size) ((key key))

automatically generated writer method

Source

objects.lisp.

Target Slot

size.

Generic Reader: status (object)
Package

zs3.

Methods
Reader Method: status ((invalidation invalidation))

automatically generated reader method

Source

cloudfront.lisp.

Target Slot

status.

Reader Method: status ((distribution distribution))

Assigned by Amazon.

Source

cloudfront.lisp.

Target Slot

status.

Generic Writer: (setf status) (object)
Package

zs3.

Methods
Writer Method: (setf status) ((invalidation invalidation))

automatically generated writer method

Source

cloudfront.lisp.

Target Slot

status.

Writer Method: (setf status) ((distribution distribution))

Assigned by Amazon.

Source

cloudfront.lisp.

Target Slot

status.

Generic Reader: storage-class (object)
Package

zs3.

Methods
Reader Method: storage-class ((key key))

automatically generated reader method

Source

objects.lisp.

Target Slot

storage-class.

Generic Writer: (setf storage-class) (object)
Package

zs3.

Methods
Writer Method: (setf storage-class) ((key key))

automatically generated writer method

Source

objects.lisp.

Target Slot

storage-class.

Generic Reader: truncatedp (object)
Package

zs3.

Methods
Reader Method: truncatedp ((bucket-listing bucket-listing))

automatically generated reader method

Source

bucket-listing.lisp.

Target Slot

truncatedp.

Generic Writer: (setf truncatedp) (object)
Package

zs3.

Methods
Writer Method: (setf truncatedp) ((bucket-listing bucket-listing))

automatically generated writer method

Source

bucket-listing.lisp.

Target Slot

truncatedp.


5.1.5 Standalone methods

Method: initialize-instance :after ((request request) &rest initargs &key &allow-other-keys)
Source

request.lisp.

Method: initialize-instance :after ((distribution distribution) &rest initargs &key &allow-other-keys)
Source

cloudfront.lisp.

Method: print-object ((rule lifecycle-rule) stream)
Source

lifecycle.lisp.

Method: print-object ((email acl-email) stream)
Source

acl.lisp.

Method: print-object ((grant grant) stream)
Source

acl.lisp.

Method: print-object ((response amazon-error) stream)
Source

errors.lisp.

Method: print-object ((key key) stream)
Source

objects.lisp.

Method: print-object ((invalidation invalidation) stream)
Source

cloudfront.lisp.

Method: print-object ((response bucket-listing) stream)
Source

bucket-listing.lisp.

Method: print-object ((person person) stream)
Source

objects.lisp.

Method: print-object ((object access-control-list) stream)
Source

acl.lisp.

Method: print-object ((response response) stream)
Source

response.lisp.

Method: print-object ((group acl-group) stream)
Source

acl.lisp.

Method: print-object ((bucket bucket) stream)
Source

objects.lisp.

Method: print-object ((distribution distribution) stream)
Source

cloudfront.lisp.

Method: slot-unbound (class (object acl-person) (slot (eql zs3::display-name)))
Source

acl.lisp.

Method: slot-unbound (class (credentials lazy-credentials-mixin) (slot (eql zs3::security-token)))
Source

credentials.lisp.

Method: slot-unbound (class (credentials lazy-credentials-mixin) (slot (eql zs3:secret-key)))
Source

credentials.lisp.

Method: slot-unbound (class (credentials lazy-credentials-mixin) (slot (eql zs3:access-key)))
Source

credentials.lisp.

Method: slot-unbound (class (group acl-group) (slot (eql zs3::label)))
Source

acl.lisp.

Method: slot-unbound (class (request request) (slot (eql zs3::signed-string)))
Source

request.lisp.

Method: slot-unbound (class (request request) (slot (eql zs3::content-md5)))
Source

request.lisp.

Method: slot-unbound (class (request request) (slot (eql zs3::date)))
Source

request.lisp.


5.1.6 Conditions

Condition: access-denied
Package

zs3.

Source

errors.lisp.

Direct superclasses

request-error.

Condition: ambiguous-grant
Package

zs3.

Source

errors.lisp.

Direct superclasses
Direct Default Initargs
InitargValue
:urlhttp://docs.aws.amazon.com/amazons3/latest/api/restbucketputacl.html
Condition: bucket-exists
Package

zs3.

Source

errors.lisp.

Direct superclasses
Condition: bucket-not-empty
Package

zs3.

Source

errors.lisp.

Direct superclasses
Direct Default Initargs
InitargValue
:urlhttp://docs.aws.amazon.com/amazons3/latest/api/restbucketdelete.html
Condition: cname-already-exists
Package

zs3.

Source

cloudfront.lisp.

Direct superclasses

distribution-error.

Condition: distribution-error
Package

zs3.

Source

cloudfront.lisp.

Direct superclasses

error.

Direct subclasses
Direct methods
Direct slots
Slot: error-type
Initargs

:error-type

Readers

distribution-error-type.

Writers

(setf distribution-error-type).

Slot: error-code
Initargs

:error-code

Readers

distribution-error-code.

Writers

(setf distribution-error-code).

Slot: http-status-code
Initargs

:http-status-code

Readers

distribution-error-http-status-code.

Writers

(setf distribution-error-http-status-code).

Slot: error-message
Initargs

:error-message

Readers

distribution-error-message.

Writers

(setf distribution-error-message).

Slot: error-detail
Initargs

:error-detail

Readers

distribution-error-detail.

Writers

(setf distribution-error-detail).

Condition: distribution-not-disabled
Package

zs3.

Source

cloudfront.lisp.

Direct superclasses

distribution-error.

Condition: internal-error
Package

zs3.

Source

errors.lisp.

Direct superclasses

request-error.

Condition: invalid-bucket-name
Package

zs3.

Source

errors.lisp.

Direct superclasses
Condition: invalid-logging-target
Package

zs3.

Source

errors.lisp.

Direct superclasses

request-error.

Condition: key-too-long
Package

zs3.

Source

errors.lisp.

Direct superclasses
Direct Default Initargs
InitargValue
:urlhttp://docs.aws.amazon.com/amazons3/latest/dev/usingmetadata.html
Condition: no-such-bucket
Package

zs3.

Source

errors.lisp.

Direct superclasses

request-error.

Direct methods

request-error-bucket-name.

Direct slots
Slot: bucket-name
Initargs

:bucket-name

Readers

request-error-bucket-name.

Writers

This slot is read-only.

Condition: no-such-key
Package

zs3.

Source

errors.lisp.

Direct superclasses

request-error.

Direct methods

request-error-key-name.

Direct slots
Slot: key-name
Initargs

:key-name

Readers

request-error-key-name.

Writers

This slot is read-only.

Condition: no-such-lifecycle-configuration
Package

zs3.

Source

lifecycle.lisp.

Direct superclasses

request-error.

Condition: operation-aborted
Package

zs3.

Source

errors.lisp.

Direct superclasses

request-error.

Condition: precondition-failed
Package

zs3.

Source

errors.lisp.

Direct superclasses

request-error.

Direct methods

request-error-condition.

Direct slots
Slot: condition
Package

common-lisp.

Initargs

:condition

Readers

request-error-condition.

Writers

This slot is read-only.

Condition: request-time-skewed
Package

zs3.

Source

errors.lisp.

Direct superclasses
Direct Default Initargs
InitargValue
:urlhttp://docs.aws.amazon.com/amazons3/latest/dev/restauthentication.html#restauthenticationtimestamp
Condition: restore-already-in-progress
Package

zs3.

Source

lifecycle.lisp.

Direct superclasses

request-error.

Condition: signature-mismatch
Package

zs3.

Source

errors.lisp.

Direct superclasses

request-error.

Direct methods
Direct slots
Slot: string-to-sign
Initargs

:string-to-sign

Readers

request-error-string-to-sign.

Writers

This slot is read-only.

Slot: canonical-request
Initargs

:canonical-request

Readers

request-error-canonical-request.

Writers

This slot is read-only.

Condition: slow-down
Package

zs3.

Source

errors.lisp.

Direct superclasses

request-error.

Condition: too-many-buckets
Package

zs3.

Source

errors.lisp.

Direct superclasses
Condition: too-many-distributions
Package

zs3.

Source

cloudfront.lisp.

Direct superclasses

distribution-error.


5.1.7 Classes

Class: acl-email
Package

zs3.

Source

acl.lisp.

Direct methods
Direct slots
Slot: email
Initargs

:email

Readers

email.

Writers

(setf email).

Class: acl-person
Package

zs3.

Source

acl.lisp.

Direct superclasses

person.

Direct methods

slot-unbound.

Class: all-buckets
Package

zs3.

Source

bucket-listing.lisp.

Direct superclasses

response.

Direct methods
Direct slots
Slot: owner
Initargs

:owner

Readers

owner.

Writers

(setf owner).

Slot: buckets
Initargs

:buckets

Readers

buckets.

Writers

(setf buckets).

Class: file-credentials
Package

zs3.

Source

credentials.lisp.

Direct superclasses

lazy-credentials-mixin.

Direct methods
Direct slots
Slot: file
Initargs

:file

Readers

file.

Writers

(setf file).

Slot: access-key
Readers

access-key.

Writers

(setf access-key).

Slot: secret-key
Readers

secret-key.

Writers

(setf secret-key).

Slot: security-token
Readers

security-token.

Writers

(setf security-token).

Class: grant
Package

zs3.

Source

acl.lisp.

Direct methods
Direct slots
Slot: permission
Initargs

:permission

Readers

permission.

Writers

(setf permission).

Slot: grantee
Initargs

:grantee

Readers

grantee.

Writers

(setf grantee).

Class: lifecycle-rule

A lifecycle rule. See http://docs.amazonwebservices.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#intro-lifecycle-rules.

Package

zs3.

Source

lifecycle.lisp.

Direct methods
Direct Default Initargs
InitargValue
:prefix(string (gensym))
:enabledpt
:daysnil
:datenil
:actionexpire
Direct slots
Slot: id
Initargs

:id

Readers

id.

Writers

(setf id).

Slot: prefix
Initargs

:prefix

Readers

prefix.

Writers

(setf prefix).

Slot: enabledp
Initargs

:enabledp

Readers

enabledp.

Writers

(setf enabledp).

Slot: days

The number of days after which the rule action will take
effect. Can be zero, meaning that it should take effect the next time Amazon’s periodic transitioning process runs. One of DAYS or DATE must be provided.

Initargs

:days

Readers

days.

Writers

(setf days).

Slot: date

The date at [XXX after?] which the rule takes effect. One of DAYS or DATE must be provided.

Initargs

:date

Readers

date.

Writers

(setf date).

Slot: action

The action of this rule; must be either :EXPIRE (the default)
or :TRANSITION. :TRANSITION means matching objects will transition to Glacier storage.

Initargs

:action

Readers

action.

Writers

(setf action).

Class: logging-setup
Package

zs3.

Source

logging.lisp.

Direct methods
Direct Default Initargs
InitargValue
:target-bucketnil
:target-prefixnil
:target-grantsnil
Direct slots
Slot: target-bucket
Initargs

:target-bucket

Readers

target-bucket.

Writers

(setf target-bucket).

Slot: target-prefix
Initargs

:target-prefix

Readers

target-prefix.

Writers

(setf target-prefix).

Slot: target-grants
Initargs

:target-grants

Readers

target-grants.

Writers

(setf target-grants).


5.1.8 Types

Type: octet-vector (&optional size)
Package

zs3.

Source

utils.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *binder-definitions*
Package

zs3.

Source

xml-binding.lisp.

Special Variable: *caller-reference-counter*
Package

zs3.

Source

cloudfront.lisp.

Special Variable: *canned-access-policies*
Package

zs3.

Source

interface.lisp.

Special Variable: *canonical-bucket-name-suffix*
Package

zs3.

Source

cloudfront.lisp.

Special Variable: *cloudfront-base-url*
Package

zs3.

Source

cloudfront.lisp.

Special Variable: *current-element-name*
Package

zs3.

Source

xml-binding.lisp.

Special Variable: *days*
Package

zs3.

Source

utils.lisp.

Special Variable: *distribution-specific-errors*

This table is used to signal the most specific error possible for distribution request error responses.

Package

zs3.

Source

cloudfront.lisp.

Special Variable: *empty-logging-setup*

An empty logging setup; putting this into the logging setup of a bucket effectively disables logging.

Package

zs3.

Source

interface.lisp.

Special Variable: *empty-string-sha256*
Package

zs3.

Source

crypto.lisp.

Special Variable: *file-buffer-size*
Package

zs3.

Source

utils.lisp.

Special Variable: *log-delivery-grants*

This list of grants is used to allow the Amazon log delivery group to write logfile objects into a particular bucket.

Package

zs3.

Source

interface.lisp.

Special Variable: *me-cache*

A cache for the result of the ME function. Keys are Amazon access key strings.

Package

zs3.

Source

interface.lisp.

Special Variable: *months*
Package

zs3.

Source

utils.lisp.

Special Variable: *newline-vector*
Package

zs3.

Source

crypto.lisp.

Special Variable: *permanent-redirects*

Some bucket operations make permanent redirects to different endpoints. This table stores access-key/bucket redirects for use when creating requests.

Package

zs3.

Source

redirects.lisp.

Special Variable: *permissions*
Package

zs3.

Source

acl.lisp.

Special Variable: *public-read-grant*

This grant is added to or removed from an ACL to grant or revoke read access for all users.

Package

zs3.

Source

interface.lisp.

Special Variable: *response-element-classes*
Package

zs3.

Source

response.lisp.

Special Variable: *specific-errors*
Package

zs3.

Source

errors.lisp.

Special Variable: *xsi*
Package

zs3.

Source

acl.lisp.

Special Variable: +unix-time-difference+
Package

zs3.

Source

utils.lisp.


5.2.2 Macros

Macro: alist-bind (bindings alist &body body)
Package

zs3.

Source

xml-binding.lisp.

Macro: catching-xml-errors (&body body)
Package

zs3.

Source

xml-binding.lisp.

Macro: defbinder (name &body source)
Package

zs3.

Source

xml-binding.lisp.

Macro: define-specific-distribution-error (error-xml-code error-name)
Package

zs3.

Source

cloudfront.lisp.

Macro: define-specific-error ((condition-name code) superclasses slots &rest options)
Package

zs3.

Source

errors.lisp.

Macro: with-saved-modifications ((var distribution) &body body)

Make a series of changes to DISTRIBUTION and push the final result to AWS. BODY should not have side-effects on anything but the DISTRIBUTION itself, as it may be re-tried multiple times.

Package

zs3.

Source

cloudfront.lisp.

Macro: with-xml-output (&body body)
Package

zs3.

Source

xml-output.lisp.


5.2.3 Ordinary functions

Function: %delete-distribution (distribution)
Package

zs3.

Source

cloudfront.lisp.

Function: access-policy-header (access-policy public)
Package

zs3.

Source

interface.lisp.

Function: alist-grant (bindings)
Package

zs3.

Source

acl.lisp.

Function: alist-plist (alist)
Package

zs3.

Source

utils.lisp.

Function: alist-to-url-encoded-string (alist)

ALIST is supposed to be an alist of name/value pairs where both names and values are strings. This function returns a string where this list is represented as for the content type ‘application/x-www-form-urlencoded’, i.e. the values are URL-encoded using the external format EXTERNAL-FORMAT, the pairs are joined with a #\& character, and each name is separated from its value with a #\= character.

Package

zs3.

Source

utils.lisp.

Function: bfun (key)
Package

zs3.

Source

xml-binding.lisp.

Function: bindings-distribution (bindings)
Package

zs3.

Source

cloudfront.lisp.

Function: bindings-lifecycle-rules (bindings)

Create a list of lifecycle rules from BINDINGS, which are obtained by xml-binding the LIFECYCLE-CONFIGURATION binder with a document.

Package

zs3.

Source

lifecycle.lisp.

Function: bindings-logging-setup (bindings)
Package

zs3.

Source

logging.lisp.

Function: bucket-region (bucket &key credentials backoff)
Package

zs3.

Source

interface.lisp.

Function: bulk-delete-document (keys)
Package

zs3.

Source

interface.lisp.

Function: bvalue (key bindings)
Package

zs3.

Source

xml-binding.lisp.

Function: call-with-latest (fun distribution)

Call FUN on DISTRIBUTION; if there is an ETag-related error, retries after REFRESHing DISTRIBUTION. FUN should not have side effects on anything but the DISTRIBUTION itself, as it may be re-tried multiple times.

Package

zs3.

Source

cloudfront.lisp.

Function: canned-access-policy (access-policy)
Package

zs3.

Source

interface.lisp.

Function: canonical-distribution-bucket-name (name)
Package

zs3.

Source

cloudfront.lisp.

Function: canonical-headers (headers)
Package

zs3.

Source

request.lisp.

Function: canonical-parameters (parameters)
Package

zs3.

Source

request.lisp.

Function: canonical-parameters-string (request)
Package

zs3.

Source

request.lisp.

Function: canonicalized-request-lines (request)

Return a list of lines canonicalizing the request according to http://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-header-based-auth.html.

Package

zs3.

Source

request.lisp.

Function: check-request-success (response)
Package

zs3.

Source

interface.lisp.

Function: close-keep-alive ()
Package

zs3.

Source

response.lisp.

Function: collect-characters (source)
Package

zs3.

Source

xml-binding.lisp.

Function: collect-rest-alist (source)

Collect the rest of SOURCE, up to an un-nested closing tag, as an alist of element names and their character contents.

Package

zs3.

Source

xml-binding.lisp.

Function: copy-n-octets (count input output)

Copy the first N octets from the stream INPUT to the stream OUTPUT.

Package

zs3.

Source

utils.lisp.

Function: create-alist-binder (key kk)

Return a function that returns the rest of SOURCE as an alist of element-name/element-content data.

Package

zs3.

Source

xml-binding.lisp.

Function: create-alternate-binder (subforms kk)
Package

zs3.

Source

xml-binding.lisp.

Function: create-binder (form &optional k)

Process FORM as an XML binder pattern and return a closure to process an XML source.

Package

zs3.

Source

xml-binding.lisp.

Function: create-bindings-extender (key kk)

Return a function that extends BINDINGS with KEY and a value of whatever character data is pending in SOURCE.

Package

zs3.

Source

xml-binding.lisp.

Function: create-bindings-returner ()

Return a function that does nothing but return its BINDINGS, effectively ending matching.

Package

zs3.

Source

xml-binding.lisp.

Function: create-element-end-matcher (element-name kk)

Return a function that expects to see the end of ELEMENT-NAME next in SOURCE.

Package

zs3.

Source

xml-binding.lisp.

Function: create-element-start-matcher (element-name kk)

Return a function that expects to see the start of ELEMENT-NAME next in SOURCE.

Package

zs3.

Source

xml-binding.lisp.

Function: create-optional-binder (subforms kk)
Package

zs3.

Source

xml-binding.lisp.

Function: create-sequence-binder (key forms kk)

Return a function that creates a list of sub-bindings based on a sub-matcher, with KEY as the key.

Package

zs3.

Source

xml-binding.lisp.

Function: create-skipper (element-name kk)

Return a function that skips input in SOURCE until it sees a closing tag for ELEMENT-NAME. Nested occurrences of elements with the same ELEMENT-NAME are also skipped.

Package

zs3.

Source

xml-binding.lisp.

Function: create-special-processor (operator form k)

Handle special pattern processing forms like BIND, SKIP-REST, SEQUENCE, etc.

Package

zs3.

Source

xml-binding.lisp.

Function: create-sub-binder-binder (binder-name kk)
Package

zs3.

Source

xml-binding.lisp.

Function: delete-bucket-lifecycle (bucket &key credentials backoff)

Delete the lifecycle configuration of BUCKET.

Package

zs3.

Source

lifecycle.lisp.

Function: distribution-document (distribution)
Package

zs3.

Source

cloudfront.lisp.

Function: distribution-request (&key distribution method parameters url-suffix content credentials)
Package

zs3.

Source

cloudfront.lisp.

Function: distribution-request-headers (distribution)
Package

zs3.

Source

cloudfront.lisp.

Function: drained-stream-vector (stream)

Read octets from STREAM until EOF and them as an octet vector.

Package

zs3.

Source

utils.lisp.

Function: ends-with (suffix string)
Package

zs3.

Source

utils.lisp.

Function: ensure-acl-group (uri)
Package

zs3.

Source

acl.lisp.

Function: error-reader-name (suffix)
Package

zs3.

Source

errors.lisp.

Function: file-md5 (file)
Package

zs3.

Source

crypto.lisp.

Function: file-md5/b64 (file)
Package

zs3.

Source

crypto.lisp.

Function: file-md5/hex (file)
Package

zs3.

Source

crypto.lisp.

Function: file-sha256 (file)
Package

zs3.

Source

crypto.lisp.

Function: file-sha256/hex (file)
Package

zs3.

Source

crypto.lisp.

Function: file-size (file)
Package

zs3.

Source

utils.lisp.

Function: file-subset-vector (file start end)
Package

zs3.

Source

utils.lisp.

Function: find-binder (name &optional errorp)
Package

zs3.

Source

xml-binding.lisp.

Function: format-tagging-header (tagging)
Package

zs3.

Source

interface.lisp.

Function: generate-caller-reference ()
Package

zs3.

Source

cloudfront.lisp.

Function: headers-for-signing (request)
Package

zs3.

Source

request.lisp.

Function: hmac-sha256 (key strings)
Package

zs3.

Source

crypto.lisp.

Function: http-date-string (&optional time)

Return a HTTP-style date string.

Package

zs3.

Source

utils.lisp.

Function: invalidation-batch-document (invalidation)
Package

zs3.

Source

cloudfront.lisp.

Function: invalidation-request (invalidation &key url-suffix method content)
Package

zs3.

Source

cloudfront.lisp.

Function: iso8601-basic-date-string (&optional time)

Return an ISO8601-style basic date string.

Package

zs3.

Source

utils.lisp.

Function: iso8601-basic-timestamp-string (&optional time)

Return an ISO8601-style basic date string.

Package

zs3.

Source

utils.lisp.

Function: iso8601-date-string (&optional time)

Return an ISO8601-style date string.

Package

zs3.

Source

utils.lisp.

Function: key-binding-key (binding)
Package

zs3.

Source

bucket-listing.lisp.

Function: keywordify (string-designator)
Package

zs3.

Source

utils.lisp.

Function: last-entry (array)

If ARRAY has one ore more entries, return the last one. Otherwise, return NIL.

Package

zs3.

Source

utils.lisp.

Function: latest-version (distribution)
Package

zs3.

Source

cloudfront.lisp.

Function: lifecycle-document (rules)

Return an XML document that can be posted as the lifecycle
configuration of a bucket. See http://docs.amazonwebservices.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#intro-lifecycle-rules for details.

Package

zs3.

Source

lifecycle.lisp.

Function: location-constraint-xml (location)
Package

zs3.

Source

location.lisp.

Function: make-binder (form)
Package

zs3.

Source

xml-binding.lisp.

Function: make-digester (key &key digest-algorithm)
Package

zs3.

Source

crypto.lisp.

Function: make-file-buffer ()
Package

zs3.

Source

utils.lisp.

Function: make-file-writer-handler (file &key if-exists)
Package

zs3.

Source

interface.lisp.

Function: make-octet-vector (size)
Package

zs3.

Source

utils.lisp.

Function: make-signing-key (credentials &key region service)

The signing key is derived from the credentials, region, date, and
service. A signing key could be saved, shared, and reused, but ZS3 just recomputes it all the time instead.

Package

zs3.

Source

request.lisp.

Function: make-string-writer-handler (external-format)
Package

zs3.

Source

interface.lisp.

Function: maybe-signal-distribution-error (http-status-code content)
Package

zs3.

Source

cloudfront.lisp.

Function: merge-file-buffers (buffers size)

Create one big vector from BUFFERS and TRAILER.

Package

zs3.

Source

utils.lisp.

Function: merge-into (distribution new)

Copy slot values from NEW into DISTRIBUTION.

Package

zs3.

Source

cloudfront.lisp.

Function: modify-and-save (fun distribution)

Call the modification function FUN with DISTRIBUTION as its only argument, and push the modified configuration to Cloudfront. May refresh DISTRIBUTION if needed. FUN should not have side effects on anything but the DISTRIBUTION itself, as it may be re-tried multiple times.

Package

zs3.

Source

cloudfront.lisp.

Function: parameters-for-signing (request)
Package

zs3.

Source

request.lisp.

Function: parse-amazon-timestamp (string)

Convert the ISO 8601-format STRING to a universal time.

Package

zs3.

Source

utils.lisp.

Function: partial-stream-vector (stream n)

Read N octets from STREAM and return them in an octet vector.

Package

zs3.

Source

utils.lisp.

Function: path-to-sign (request)

Everything in the PATH of the request, up to the first ?

Package

zs3.

Source

request.lisp.

Function: payload-sha256 (request)
Package

zs3.

Source

request.lisp.

Function: permission-keyword (permission)
Package

zs3.

Source

acl.lisp.

Function: permission-name (permission)
Package

zs3.

Source

acl.lisp.

Function: policy-signature (key policy)
Package

zs3.

Source

post.lisp.

Function: policy-string64 (policy)
Package

zs3.

Source

post.lisp.

Function: puri-canonicalized-path (path)
Package

zs3.

Source

request.lisp.

Function: put-config (distribution)

Post DISTRIBUTION’s configuration to AWS. Signals an error and does not retry in the event of an etag match problem.

Package

zs3.

Source

cloudfront.lisp.

Function: read-complete-file-buffer (stream &optional buffer)

Read a complete buffer of size *FILE-BUFFER-SIZE*.

Package

zs3.

Source

utils.lisp.

Function: read-exactly-n-octets (stream n &optional buffer)

Read exactly N octets from STREAM into BUFFER. If fewer than N octets are read, signal an CL:END-OF-FILE error. If BUFFER is not supplied or is NIL, create a fresh buffer of length N and return it.

Package

zs3.

Source

utils.lisp.

Function: redirect-key (endpoint bucket &key credentials)
Package

zs3.

Source

redirects.lisp.

Function: redirected-endpoint (endpoint bucket &key credentials)
Package

zs3.

Source

redirects.lisp.

Function: redirected-region (endpoint bucket &key credentials)
Package

zs3.

Source

redirects.lisp.

Function: redirection-data (endpoint bucket &key credentials)
Package

zs3.

Source

redirects.lisp.

Function: (setf redirection-data) (endpoint bucket &key credentials)
Package

zs3.

Source

redirects.lisp.

Function: region-endpoint (region)
Package

zs3.

Source

interface.lisp.

Function: report-request-error (condition stream)
Package

zs3.

Source

errors.lisp.

Function: request-response (request &key body-stream keep-stream handler)
Package

zs3.

Source

response.lisp.

Function: request-signature (request)
Package

zs3.

Source

request.lisp.

Function: restore-request-document (days)
Package

zs3.

Source

lifecycle.lisp.

Function: save (response file)

Write a sequence of octets RESPONSE to FILE.

Package

zs3.

Source

utils.lisp.

Function: send-file-content (fun request)
Package

zs3.

Source

request.lisp.

Function: set-element-class (element-name class)
Package

zs3.

Source

response.lisp.

Function: sign-string (key string)
Package

zs3.

Source

crypto.lisp.

Function: signed-headers (request)
Package

zs3.

Source

request.lisp.

Function: simple-element (name value)
Package

zs3.

Source

xml-output.lisp.

Function: skip-characters (source)
Package

zs3.

Source

xml-binding.lisp.

Function: skip-document-start (source)
Package

zs3.

Source

xml-binding.lisp.

Function: skip-stream-octets (stream count)

Read and discard COUNT octets from STREAM.

Package

zs3.

Source

utils.lisp.

Function: specific-error (amazon-code)
Package

zs3.

Source

errors.lisp.

Function: starts-with (prefix string)
Package

zs3.

Source

utils.lisp.

Function: stream-identity-handler (response)
Package

zs3.

Source

interface.lisp.

Function: stream-subset-vector (stream start end)
Package

zs3.

Source

utils.lisp.

Function: string-octets (string)

Return the UTF-8 encoding of STRING as a vector of octets.

Package

zs3.

Source

utils.lisp.

Function: string-to-sign-lines (request)

Return a list of strings to sign to construct the Authorization header.

Package

zs3.

Source

request.lisp.

Function: string64 (string)
Package

zs3.

Source

utils.lisp.

Function: stringify (thing)
Package

zs3.

Source

utils.lisp.

Function: strings-hmac-sha256/hex (key strings)
Package

zs3.

Source

crypto.lisp.

Function: strings-sha256/hex (strings)
Package

zs3.

Source

crypto.lisp.

Function: submit-request (request &key body-stream keep-stream handler)
Package

zs3.

Source

response.lisp.

Function: try-to-xml-bind (binder-name source)

Like XML-BIND, but catches any XML-BINDING-ERRORs; if any errors are caught, NIL is the primary value and the error object is the secondary value.

Package

zs3.

Source

xml-binding.lisp.

Function: unix-time (&optional universal-time)
Package

zs3.

Source

utils.lisp.

Function: url-decode (string)
Package

zs3.

Source

utils.lisp.

Function: url-encode (string &key encode-slash)

Returns a URL-encoded version of the string STRING using the LispWorks external format EXTERNAL-FORMAT.

Package

zs3.

Source

utils.lisp.

Function: vector-md5/b64 (vector)
Package

zs3.

Source

crypto.lisp.

Function: vector-sha256 (vector)
Package

zs3.

Source

crypto.lisp.

Function: vector-sha256/hex (vector)
Package

zs3.

Source

crypto.lisp.

Function: vector-writer-handler (response)
Package

zs3.

Source

interface.lisp.

Function: xml-bind (binder-name source)
Package

zs3.

Source

xml-binding.lisp.

Function: xml-document-element (source)
Package

zs3.

Source

xml-binding.lisp.

Function: xml-source (source)
Package

zs3.

Source

xml-binding.lisp.


5.2.4 Generic functions

Generic Reader: acl (object)
Package

zs3.

Methods
Reader Method: acl ((acl-response acl-response))

automatically generated reader method

Source

acl.lisp.

Target Slot

acl.

Generic Writer: (setf acl) (object)
Package

zs3.

Methods
Writer Method: (setf acl) ((acl-response acl-response))

automatically generated writer method

Source

acl.lisp.

Target Slot

acl.

Generic Function: acl-serialize (object)
Package

zs3.

Source

acl.lisp.

Methods
Method: acl-serialize ((acl access-control-list))
Method: acl-serialize ((grant grant))
Method: acl-serialize ((grantee acl-email))
Method: acl-serialize ((grantee acl-group))
Method: acl-serialize ((person person))
Generic Reader: action (object)
Generic Writer: (setf action) (object)
Package

zs3.

Methods
Reader Method: action ((lifecycle-rule lifecycle-rule))
Writer Method: (setf action) ((lifecycle-rule lifecycle-rule))

The action of this rule; must be either :EXPIRE (the default)
or :TRANSITION. :TRANSITION means matching objects will transition to Glacier storage.

Source

lifecycle.lisp.

Target Slot

action.

Generic Reader: actual (condition)
Generic Writer: (setf actual) (condition)
Package

zs3.

Methods
Reader Method: actual ((condition xml-binding-error))
Writer Method: (setf actual) ((condition xml-binding-error))
Source

xml-binding.lisp.

Target Slot

actual.

Generic Function: add-line (string digester)
Package

zs3.

Source

crypto.lisp.

Methods
Method: add-line (string digester)
Generic Function: add-newline (digester)
Package

zs3.

Source

crypto.lisp.

Methods
Method: add-newline (digester)
Generic Function: add-string (string digester)
Package

zs3.

Source

crypto.lisp.

Methods
Method: add-string (string digester)
Generic Function: all-amazon-headers (request)
Package

zs3.

Source

request.lisp.

Methods
Method: all-amazon-headers (request)
Generic Function: amz-header-value (request name)
Package

zs3.

Source

request.lisp.

Methods
Method: amz-header-value (request name)
Generic Reader: amz-headers (object)
Generic Writer: (setf amz-headers) (object)
Package

zs3.

Methods
Reader Method: amz-headers ((request request))
Writer Method: (setf amz-headers) ((request request))

An alist of extra Amazon request headers. These should be straight string key/value pairs, WITHOUT any "x-amz-" prefix.

Source

request.lisp.

Target Slot

amz-headers.

Generic Function: authorization-header-value (request)
Package

zs3.

Methods
Method: authorization-header-value ((request request))
Source

request.lisp.

Generic Reader: body (object)
Package

zs3.

Methods
Reader Method: body ((response response))

automatically generated reader method

Source

response.lisp.

Target Slot

body.

Generic Writer: (setf body) (object)
Package

zs3.

Methods
Writer Method: (setf body) ((response response))

automatically generated writer method

Source

response.lisp.

Target Slot

body.

Generic Reader: bucket (object)
Generic Writer: (setf bucket) (object)
Package

zs3.

Methods
Reader Method: bucket ((request request))
Writer Method: (setf bucket) ((request request))

A string naming the bucket to address in the request. If NIL, request is not directed at a specific bucket.

Source

request.lisp.

Target Slot

bucket.

Generic Reader: buckets (object)
Package

zs3.

Methods
Reader Method: buckets ((all-buckets all-buckets))

automatically generated reader method

Source

bucket-listing.lisp.

Target Slot

buckets.

Generic Writer: (setf buckets) (object)
Package

zs3.

Methods
Writer Method: (setf buckets) ((all-buckets all-buckets))

automatically generated writer method

Source

bucket-listing.lisp.

Target Slot

buckets.

Generic Reader: caller-reference (object)
Package

zs3.

Methods
Reader Method: caller-reference ((invalidation invalidation))

automatically generated reader method

Source

cloudfront.lisp.

Target Slot

caller-reference.

Reader Method: caller-reference ((distribution distribution))

A unique value provided by the caller to prevent replays. See http://docs.amazonwebservices.com/AmazonCloudFront/2008-06-30/DeveloperGuide/index.html?AboutCreatingDistributions.html

Source

cloudfront.lisp.

Target Slot

caller-reference.

Generic Writer: (setf caller-reference) (object)
Package

zs3.

Methods
Writer Method: (setf caller-reference) ((invalidation invalidation))

automatically generated writer method

Source

cloudfront.lisp.

Target Slot

caller-reference.

Writer Method: (setf caller-reference) ((distribution distribution))

A unique value provided by the caller to prevent replays. See http://docs.amazonwebservices.com/AmazonCloudFront/2008-06-30/DeveloperGuide/index.html?AboutCreatingDistributions.html

Source

cloudfront.lisp.

Target Slot

caller-reference.

Generic Reader: closure (object)
Package

zs3.

Methods
Reader Method: closure ((binder binder))

automatically generated reader method

Source

xml-binding.lisp.

Target Slot

closure.

Generic Writer: (setf closure) (object)
Package

zs3.

Methods
Writer Method: (setf closure) ((binder binder))

automatically generated writer method

Source

xml-binding.lisp.

Target Slot

closure.

Generic Reader: code (object)
Package

zs3.

Methods
Reader Method: code ((amazon-error amazon-error))

automatically generated reader method

Source

errors.lisp.

Target Slot

code.

Generic Writer: (setf code) (object)
Package

zs3.

Methods
Writer Method: (setf code) ((amazon-error amazon-error))

automatically generated writer method

Source

errors.lisp.

Target Slot

code.

Generic Reader: conditions (object)
Package

zs3.

Methods
Reader Method: conditions ((post-policy post-policy))

automatically generated reader method

Source

post.lisp.

Target Slot

conditions.

Generic Writer: (setf conditions) (object)
Package

zs3.

Methods
Writer Method: (setf conditions) ((post-policy post-policy))

automatically generated writer method

Source

post.lisp.

Target Slot

conditions.

Generic Reader: content (object)
Package

zs3.

Methods
Reader Method: content ((request request))

automatically generated reader method

Source

request.lisp.

Target Slot

content.

Generic Writer: (setf content) (object)
Package

zs3.

Methods
Writer Method: (setf content) ((request request))

automatically generated writer method

Source

request.lisp.

Target Slot

content.

Generic Function: content-length (response)
Package

zs3.

Source

response.lisp.

Methods
Method: content-length (response)
Reader Method: content-length ((request request))

automatically generated reader method

Source

request.lisp.

Target Slot

content-length.

Generic Writer: (setf content-length) (object)
Package

zs3.

Methods
Writer Method: (setf content-length) ((request request))

automatically generated writer method

Source

request.lisp.

Target Slot

content-length.

Generic Reader: content-md5 (object)
Package

zs3.

Methods
Reader Method: content-md5 ((request request))

automatically generated reader method

Source

request.lisp.

Target Slot

content-md5.

Generic Writer: (setf content-md5) (object)
Package

zs3.

Methods
Writer Method: (setf content-md5) ((request request))

automatically generated writer method

Source

request.lisp.

Target Slot

content-md5.

Generic Reader: content-type (object)
Package

zs3.

Methods
Reader Method: content-type ((request request))

automatically generated reader method

Source

request.lisp.

Target Slot

content-type.

Generic Writer: (setf content-type) (object)
Package

zs3.

Methods
Writer Method: (setf content-type) ((request request))

automatically generated writer method

Source

request.lisp.

Target Slot

content-type.

Generic Reader: create-time (object)
Package

zs3.

Methods
Reader Method: create-time ((invalidation invalidation))

automatically generated reader method

Source

cloudfront.lisp.

Target Slot

create-time.

Generic Writer: (setf create-time) (object)
Package

zs3.

Methods
Writer Method: (setf create-time) ((invalidation invalidation))

automatically generated writer method

Source

cloudfront.lisp.

Target Slot

create-time.

Generic Reader: credentials (object)
Generic Writer: (setf credentials) (object)
Package

zs3.

Methods
Reader Method: credentials ((request request))
Writer Method: (setf credentials) ((request request))

An object that has methods for ACCESS-KEY and SECRET-KEY. A list of two strings (the keys) suffices.

Source

request.lisp.

Target Slot

credentials.

Generic Reader: date (object)
Package

zs3.

Methods
Reader Method: date ((lifecycle-rule lifecycle-rule))

The date at [XXX after?] which the rule takes effect. One of DAYS or DATE must be provided.

Source

lifecycle.lisp.

Target Slot

date.

Reader Method: date ((request request))

automatically generated reader method

Source

request.lisp.

Target Slot

date.

Generic Writer: (setf date) (object)
Package

zs3.

Methods
Writer Method: (setf date) ((lifecycle-rule lifecycle-rule))

The date at [XXX after?] which the rule takes effect. One of DAYS or DATE must be provided.

Source

lifecycle.lisp.

Target Slot

date.

Writer Method: (setf date) ((request request))

automatically generated writer method

Source

request.lisp.

Target Slot

date.

Generic Function: date-string (request)
Package

zs3.

Source

request.lisp.

Methods
Method: date-string ((request url-based-request))
Source

interface.lisp.

Method: date-string (request)
Generic Reader: days (object)
Generic Writer: (setf days) (object)
Package

zs3.

Methods
Reader Method: days ((lifecycle-rule lifecycle-rule))
Writer Method: (setf days) ((lifecycle-rule lifecycle-rule))

The number of days after which the rule action will take
effect. Can be zero, meaning that it should take effect the next time Amazon’s periodic transitioning process runs. One of DAYS or DATE must be provided.

Source

lifecycle.lisp.

Target Slot

days.

Generic Function: digest (digester)
Package

zs3.

Source

crypto.lisp.

Methods
Method: digest (digester)
Generic Function: digest64 (digester)
Package

zs3.

Source

crypto.lisp.

Methods
Method: digest64 (digester)
Generic Reader: display-name (object)
Package

zs3.

Methods
Reader Method: display-name ((person person))

automatically generated reader method

Source

objects.lisp.

Target Slot

display-name.

Generic Writer: (setf display-name) (object)
Package

zs3.

Methods
Writer Method: (setf display-name) ((person person))

automatically generated writer method

Source

objects.lisp.

Target Slot

display-name.

Generic Reader: distribution (object)
Package

zs3.

Methods
Reader Method: distribution ((invalidation invalidation))

automatically generated reader method

Source

cloudfront.lisp.

Target Slot

distribution.

Generic Writer: (setf distribution) (object)
Package

zs3.

Methods
Writer Method: (setf distribution) ((invalidation invalidation))

automatically generated writer method

Source

cloudfront.lisp.

Target Slot

distribution.

Generic Reader: distribution-error-message (condition)
Generic Writer: (setf distribution-error-message) (condition)
Package

zs3.

Methods
Reader Method: distribution-error-message ((condition distribution-error))
Writer Method: (setf distribution-error-message) ((condition distribution-error))
Source

cloudfront.lisp.

Target Slot

error-message.

Generic Function: distribution-id (object)
Package

zs3.

Source

cloudfront.lisp.

Methods
Method: distribution-id ((invalidation invalidation))
Generic Function: drakma-headers (request)
Package

zs3.

Source

request.lisp.

Methods
Method: drakma-headers (request)
Generic Reader: email (object)
Package

zs3.

Methods
Reader Method: email ((acl-email acl-email))

automatically generated reader method

Source

acl.lisp.

Target Slot

email.

Generic Writer: (setf email) (object)
Package

zs3.

Methods
Writer Method: (setf email) ((acl-email acl-email))

automatically generated writer method

Source

acl.lisp.

Target Slot

email.

Generic Reader: endpoint (object)
Package

zs3.

Methods
Reader Method: endpoint ((request request))

automatically generated reader method

Source

request.lisp.

Target Slot

endpoint.

Generic Writer: (setf endpoint) (object)
Package

zs3.

Methods
Writer Method: (setf endpoint) ((request request))

automatically generated writer method

Source

request.lisp.

Target Slot

endpoint.

Generic Function: ensure-amz-header (request name value)
Package

zs3.

Source

request.lisp.

Methods
Method: ensure-amz-header (request name value)
Generic Reader: error-data (object)
Package

zs3.

Methods
Reader Method: error-data ((amazon-error amazon-error))

automatically generated reader method

Source

errors.lisp.

Target Slot

error-data.

Generic Writer: (setf error-data) (object)
Package

zs3.

Methods
Writer Method: (setf error-data) ((amazon-error amazon-error))

automatically generated writer method

Source

errors.lisp.

Target Slot

error-data.

Generic Function: error-data-value (name instance)
Package

zs3.

Source

errors.lisp.

Methods
Method: error-data-value (name (response amazon-error))
Generic Reader: expected (condition)
Generic Writer: (setf expected) (condition)
Package

zs3.

Methods
Reader Method: expected ((condition xml-binding-error))
Writer Method: (setf expected) ((condition xml-binding-error))
Source

xml-binding.lisp.

Target Slot

expected.

Generic Reader: expires (object)
Package

zs3.

Methods
Reader Method: expires ((url-based-request url-based-request))

automatically generated reader method

Source

interface.lisp.

Target Slot

expires.

Reader Method: expires ((post-policy post-policy))

automatically generated reader method

Source

post.lisp.

Target Slot

expires.

Generic Writer: (setf expires) (object)
Package

zs3.

Methods
Writer Method: (setf expires) ((url-based-request url-based-request))

automatically generated writer method

Source

interface.lisp.

Target Slot

expires.

Writer Method: (setf expires) ((post-policy post-policy))

automatically generated writer method

Source

post.lisp.

Target Slot

expires.

Generic Reader: extra-http-headers (object)
Generic Writer: (setf extra-http-headers) (object)
Package

zs3.

Methods
Reader Method: extra-http-headers ((request request))
Writer Method: (setf extra-http-headers) ((request request))

An alist of extra HTTP headers to include in the request.

Source

request.lisp.

Target Slot

extra-http-headers.

Generic Reader: file (object)
Package

zs3.

Methods
Reader Method: file ((file-credentials file-credentials))

automatically generated reader method

Source

credentials.lisp.

Target Slot

file.

Generic Writer: (setf file) (object)
Package

zs3.

Methods
Writer Method: (setf file) ((file-credentials file-credentials))

automatically generated writer method

Source

credentials.lisp.

Target Slot

file.

Generic Reader: grantee (object)
Package

zs3.

Methods
Reader Method: grantee ((grant grant))

automatically generated reader method

Source

acl.lisp.

Target Slot

grantee.

Generic Writer: (setf grantee) (object)
Package

zs3.

Methods
Writer Method: (setf grantee) ((grant grant))

automatically generated writer method

Source

acl.lisp.

Target Slot

grantee.

Generic Function: grantee-for-print (grantee)
Package

zs3.

Source

acl.lisp.

Methods
Method: grantee-for-print ((grantee person))
Method: grantee-for-print ((grantee acl-group))
Method: grantee-for-print ((grantee acl-email))
Generic Reader: grants (object)
Package

zs3.

Methods
Reader Method: grants ((access-control-list access-control-list))

automatically generated reader method

Source

acl.lisp.

Target Slot

grants.

Generic Writer: (setf grants) (object)
Package

zs3.

Methods
Writer Method: (setf grants) ((access-control-list access-control-list))

automatically generated writer method

Source

acl.lisp.

Target Slot

grants.

Generic Reader: hmac (object)
Package

zs3.

Methods
Reader Method: hmac ((digester digester))

automatically generated reader method

Source

crypto.lisp.

Target Slot

hmac.

Generic Writer: (setf hmac) (object)
Package

zs3.

Methods
Writer Method: (setf hmac) ((digester digester))

automatically generated writer method

Source

crypto.lisp.

Target Slot

hmac.

Generic Function: host (request)
Package

zs3.

Source

request.lisp.

Methods
Method: host ((request request))
Generic Function: http-method (request)
Package

zs3.

Source

request.lisp.

Methods
Method: http-method (request)
Generic Reader: id (object)
Package

zs3.

Methods
Reader Method: id ((lifecycle-rule lifecycle-rule))

automatically generated reader method

Source

lifecycle.lisp.

Target Slot

id.

Reader Method: id ((invalidation invalidation))

Amazon’s assigned unique ID.

Source

cloudfront.lisp.

Target Slot

id.

Reader Method: id ((distribution distribution))

Amazon’s assigned unique ID.

Source

cloudfront.lisp.

Target Slot

id.

Reader Method: id ((person person))

automatically generated reader method

Source

objects.lisp.

Target Slot

id.

Generic Writer: (setf id) (object)
Package

zs3.

Methods
Writer Method: (setf id) ((lifecycle-rule lifecycle-rule))

automatically generated writer method

Source

lifecycle.lisp.

Target Slot

id.

Writer Method: (setf id) ((invalidation invalidation))

Amazon’s assigned unique ID.

Source

cloudfront.lisp.

Target Slot

id.

Writer Method: (setf id) ((distribution distribution))

Amazon’s assigned unique ID.

Source

cloudfront.lisp.

Target Slot

id.

Writer Method: (setf id) ((person person))

automatically generated writer method

Source

objects.lisp.

Target Slot

id.

Generic Function: initialize-lazy-credentials (credentials)
Package

zs3.

Source

credentials.lisp.

Methods
Method: initialize-lazy-credentials ((credentials file-credentials))
Generic Reader: key (object)
Generic Writer: (setf key) (object)
Package

zs3.

Methods
Reader Method: key ((request request))
Writer Method: (setf key) ((request request))

A string naming the key to address in the request. If NIL, request is not directed at a specific key.

Source

request.lisp.

Target Slot

key.

Generic Reader: label (object)
Package

zs3.

Methods
Reader Method: label ((acl-group acl-group))

automatically generated reader method

Source

acl.lisp.

Target Slot

label.

Generic Writer: (setf label) (object)
Package

zs3.

Methods
Writer Method: (setf label) ((acl-group acl-group))

automatically generated writer method

Source

acl.lisp.

Target Slot

label.

Generic Reader: linked-url (condition)
Package

zs3.

Methods
Reader Method: linked-url ((condition linked))
Source

errors.lisp.

Target Slot

url.

Generic Reader: location (object)
Package

zs3.

Methods
Reader Method: location ((location-constraint location-constraint))

automatically generated reader method

Source

location.lisp.

Target Slot

location.

Generic Writer: (setf location) (object)
Package

zs3.

Methods
Writer Method: (setf location) ((location-constraint location-constraint))

automatically generated writer method

Source

location.lisp.

Target Slot

location.

Generic Function: log-serialize (object)
Package

zs3.

Source

logging.lisp.

Methods
Method: log-serialize ((logging-setup logging-setup))
Generic Reader: max-keys (object)
Package

zs3.

Methods
Reader Method: max-keys ((bucket-listing bucket-listing))

automatically generated reader method

Source

bucket-listing.lisp.

Target Slot

max-keys.

Generic Writer: (setf max-keys) (object)
Package

zs3.

Methods
Writer Method: (setf max-keys) ((bucket-listing bucket-listing))

automatically generated writer method

Source

bucket-listing.lisp.

Target Slot

max-keys.

Generic Function: maybe-signal-error (response)
Package

zs3.

Source

errors.lisp.

Methods
Method: maybe-signal-error (response)
Method: maybe-signal-error ((response amazon-error))
Generic Function: merge-bindings (object bindings)

Update OBJECT with the data from BINDINGS.

Package

zs3.

Source

xml-binding.lisp.

Methods
Method: merge-bindings ((invalidation invalidation) bindings)
Source

cloudfront.lisp.

Generic Reader: message (object)
Package

zs3.

Methods
Reader Method: message ((amazon-error amazon-error))

automatically generated reader method

Source

errors.lisp.

Target Slot

message.

Generic Writer: (setf message) (object)
Package

zs3.

Methods
Writer Method: (setf message) ((amazon-error amazon-error))

automatically generated writer method

Source

errors.lisp.

Target Slot

message.

Generic Reader: metadata (object)
Generic Writer: (setf metadata) (object)
Package

zs3.

Methods
Reader Method: metadata ((request request))
Writer Method: (setf metadata) ((request request))

An alist of Amazon metadata to attach to a request. These should be straight string key/value pairs, WITHOUT any "x-amz-meta-" prefix.

Source

request.lisp.

Target Slot

metadata.

Generic Reader: method (object)
Generic Writer: (setf method) (object)
Package

zs3.

Methods
Reader Method: method ((request request))
Writer Method: (setf method) ((request request))

e.g. :GET, :PUT, :DELETE

Source

request.lisp.

Target Slot

method.

Generic Reader: newline (object)
Package

zs3.

Methods
Reader Method: newline ((digester digester))

automatically generated reader method

Source

crypto.lisp.

Target Slot

newline.

Generic Writer: (setf newline) (object)
Package

zs3.

Methods
Writer Method: (setf newline) ((digester digester))

automatically generated writer method

Source

crypto.lisp.

Target Slot

newline.

Generic Reader: next-marker (object)
Package

zs3.

Methods
Reader Method: next-marker ((bucket-listing bucket-listing))

automatically generated reader method

Source

bucket-listing.lisp.

Target Slot

next-marker.

Generic Writer: (setf next-marker) (object)
Package

zs3.

Methods
Writer Method: (setf next-marker) ((bucket-listing bucket-listing))

automatically generated writer method

Source

bucket-listing.lisp.

Target Slot

next-marker.

Generic Reader: parameters (object)
Generic Writer: (setf parameters) (object)
Package

zs3.

Methods
Reader Method: parameters ((request request))
Writer Method: (setf parameters) ((request request))

An alist of string key/value pairs to send as CGI-style GET parameters with the request. If SUB-RESOURCE is set, these must be NIL.

Source

request.lisp.

Target Slot

parameters.

Generic Reader: paths (object)
Package

zs3.

Methods
Reader Method: paths ((invalidation invalidation))

automatically generated reader method

Source

cloudfront.lisp.

Target Slot

paths.

Generic Writer: (setf paths) (object)
Package

zs3.

Methods
Writer Method: (setf paths) ((invalidation invalidation))

automatically generated writer method

Source

cloudfront.lisp.

Target Slot

paths.

Generic Reader: permission (object)
Package

zs3.

Methods
Reader Method: permission ((grant grant))

automatically generated reader method

Source

acl.lisp.

Target Slot

permission.

Generic Writer: (setf permission) (object)
Package

zs3.

Methods
Writer Method: (setf permission) ((grant grant))

automatically generated writer method

Source

acl.lisp.

Target Slot

permission.

Generic Function: policy-serialize (object stream)
Package

zs3.

Source

post.lisp.

Methods
Method: policy-serialize ((policy post-policy) stream)
Method: policy-serialize ((condition cons) stream)
Generic Reader: region (object)
Package

zs3.

Methods
Reader Method: region ((request request))

automatically generated reader method

Source

request.lisp.

Target Slot

region.

Generic Writer: (setf region) (object)
Package

zs3.

Methods
Writer Method: (setf region) ((request request))

automatically generated writer method

Source

request.lisp.

Target Slot

region.

Generic Reader: request (object)
Package

zs3.

Methods
Reader Method: request ((response response))

automatically generated reader method

Source

response.lisp.

Target Slot

request.

Generic Writer: (setf request) (object)
Package

zs3.

Methods
Writer Method: (setf request) ((response response))

automatically generated writer method

Source

response.lisp.

Target Slot

request.

Generic Reader: request-error-bucket-name (condition)
Package

zs3.

Methods
Reader Method: request-error-bucket-name ((condition no-such-bucket))
Source

errors.lisp.

Target Slot

bucket-name.

Generic Reader: request-error-canonical-request (condition)
Package

zs3.

Methods
Reader Method: request-error-canonical-request ((condition signature-mismatch))
Source

errors.lisp.

Target Slot

canonical-request.

Generic Reader: request-error-condition (condition)
Package

zs3.

Methods
Reader Method: request-error-condition ((condition precondition-failed))
Source

errors.lisp.

Target Slot

condition.

Generic Reader: request-error-data (condition)
Package

zs3.

Methods
Reader Method: request-error-data ((condition request-error))
Source

errors.lisp.

Target Slot

data.

Generic Reader: request-error-endpoint (condition)
Package

zs3.

Methods
Reader Method: request-error-endpoint ((condition temporary-redirect))
Source

errors.lisp.

Target Slot

endpoint.

Reader Method: request-error-endpoint ((condition permanent-redirect))
Source

errors.lisp.

Target Slot

endpoint.

Generic Reader: request-error-key-name (condition)
Package

zs3.

Methods
Reader Method: request-error-key-name ((condition no-such-key))
Source

errors.lisp.

Target Slot

key-name.

Generic Reader: request-error-region (condition)
Package

zs3.

Methods
Reader Method: request-error-region ((condition authorization-header-malformed))
Source

errors.lisp.

Target Slot

region.

Generic Reader: request-error-request (condition)
Package

zs3.

Methods
Reader Method: request-error-request ((condition request-error))
Source

errors.lisp.

Target Slot

request.

Generic Reader: request-error-string-to-sign (condition)
Package

zs3.

Methods
Reader Method: request-error-string-to-sign ((condition signature-mismatch))
Source

errors.lisp.

Target Slot

string-to-sign.

Generic Function: request-path (request)
Package

zs3.

Source

request.lisp.

Methods
Method: request-path (request)
Generic Function: response-specialized-class (name)
Package

zs3.

Source

response.lisp.

Methods
Method: response-specialized-class (name)
Generic Function: security-token (credentials)
Package

zs3.

Source

credentials.lisp.

Methods
Method: security-token ((request request))
Source

request.lisp.

Reader Method: security-token ((file-credentials file-credentials))

automatically generated reader method

Target Slot

security-token.

Method: security-token (object)
Method: security-token ((list cons))
Generic Writer: (setf security-token) (object)
Package

zs3.

Methods
Writer Method: (setf security-token) ((file-credentials file-credentials))

automatically generated writer method

Source

credentials.lisp.

Target Slot

security-token.

Generic Function: send (request &key want-stream stream)
Package

zs3.

Source

request.lisp.

Methods
Method: send (request &key want-stream stream)
Generic Reader: setup (object)
Package

zs3.

Methods
Reader Method: setup ((logging logging))

automatically generated reader method

Source

logging.lisp.

Target Slot

setup.

Generic Writer: (setf setup) (object)
Package

zs3.

Methods
Writer Method: (setf setup) ((logging logging))

automatically generated writer method

Source

logging.lisp.

Target Slot

setup.

Generic Function: signal-specific-error (response condition-name)
Package

zs3.

Source

errors.lisp.

Methods
Method: signal-specific-error ((response amazon-error) (condition-name (eql zs3:restore-already-in-progress)))
Source

lifecycle.lisp.

Method: signal-specific-error ((response amazon-error) (condition-name (eql zs3:no-such-lifecycle-configuration)))
Source

lifecycle.lisp.

Method: signal-specific-error ((response amazon-error) (condition-name (eql zs3:operation-aborted)))
Method: signal-specific-error ((response amazon-error) (condition-name (eql zs3:request-time-skewed)))
Method: signal-specific-error ((response amazon-error) (condition-name (eql zs3:key-too-long)))
Method: signal-specific-error ((response amazon-error) (condition-name (eql zs3:invalid-logging-target)))
Method: signal-specific-error ((response amazon-error) (condition-name (eql zs3:bucket-not-empty)))
Method: signal-specific-error ((response amazon-error) (condition-name (eql zs3:ambiguous-grant)))
Method: signal-specific-error ((response amazon-error) (condition-name (eql zs3:too-many-buckets)))
Method: signal-specific-error ((response amazon-error) (condition-name (eql zs3:bucket-exists)))
Method: signal-specific-error ((response amazon-error) (condition-name (eql zs3:invalid-bucket-name)))
Method: signal-specific-error ((response amazon-error) (condition-name (eql zs3::authorization-header-malformed)))
Method: signal-specific-error ((response amazon-error) (condition-name (eql zs3:precondition-failed)))
Method: signal-specific-error ((response amazon-error) (condition-name (eql zs3:signature-mismatch)))
Method: signal-specific-error ((response amazon-error) (condition-name (eql zs3::temporary-redirect)))
Method: signal-specific-error ((response amazon-error) (condition-name (eql zs3::permanent-redirect)))
Method: signal-specific-error ((response amazon-error) (condition-name (eql zs3::malformed-xml)))
Method: signal-specific-error ((response amazon-error) (condition-name (eql zs3:access-denied)))
Method: signal-specific-error ((response amazon-error) (condition-name (eql zs3:no-such-key)))
Method: signal-specific-error ((response amazon-error) (condition-name (eql zs3:no-such-bucket)))
Method: signal-specific-error ((response amazon-error) (condition-name (eql zs3:slow-down)))
Method: signal-specific-error ((response amazon-error) (condition-name (eql zs3:internal-error)))
Method: signal-specific-error (response condition-name)
Generic Function: signed-path (request)
Package

zs3.

Source

request.lisp.

Methods
Method: signed-path (request)
Generic Reader: signed-stream (object)
Package

zs3.

Methods
Reader Method: signed-stream ((digester digester))

automatically generated reader method

Source

crypto.lisp.

Target Slot

signed-stream.

Generic Writer: (setf signed-stream) (object)
Package

zs3.

Methods
Writer Method: (setf signed-stream) ((digester digester))

automatically generated writer method

Source

crypto.lisp.

Target Slot

signed-stream.

Generic Reader: signed-string (object)
Package

zs3.

Methods
Reader Method: signed-string ((request request))

automatically generated reader method

Source

request.lisp.

Target Slot

signed-string.

Generic Writer: (setf signed-string) (object)
Package

zs3.

Methods
Writer Method: (setf signed-string) ((request request))

automatically generated writer method

Source

request.lisp.

Target Slot

signed-string.

Generic Reader: source (object)
Package

zs3.

Methods
Reader Method: source ((binder binder))

automatically generated reader method

Source

xml-binding.lisp.

Target Slot

source.

Generic Writer: (setf source) (object)
Package

zs3.

Methods
Writer Method: (setf source) ((binder binder))

automatically generated writer method

Source

xml-binding.lisp.

Target Slot

source.

Generic Function: specialize-response (response)
Package

zs3.

Source

response.lisp.

Methods
Method: specialize-response ((response response))
Generic Function: specialized-initialize (object source)
Package

zs3.

Source

response.lisp.

Methods
Method: specialized-initialize ((response location-constraint) source)
Source

location.lisp.

Method: specialized-initialize ((response logging) source)
Source

logging.lisp.

Method: specialized-initialize ((response acl-response) source)
Source

acl.lisp.

Method: specialized-initialize ((response amazon-error) (source null))
Source

errors.lisp.

Method: specialized-initialize ((response amazon-error) source)
Source

errors.lisp.

Method: specialized-initialize ((response bucket-listing) source)
Source

bucket-listing.lisp.

Method: specialized-initialize ((response all-buckets) source)
Source

bucket-listing.lisp.

Method: specialized-initialize (object source)
Generic Reader: ssl (object)
Package

zs3.

Methods
Reader Method: ssl ((request request))

automatically generated reader method

Source

request.lisp.

Target Slot

ssl.

Generic Writer: (setf ssl) (object)
Package

zs3.

Methods
Writer Method: (setf ssl) ((request request))

automatically generated writer method

Source

request.lisp.

Target Slot

ssl.

Generic Reader: sub-resource (object)
Generic Writer: (setf sub-resource) (object)
Package

zs3.

Methods
Reader Method: sub-resource ((request request))
Writer Method: (setf sub-resource) ((request request))

A sub-resource to address as part of the request,
without a leading "?", e.g. "acl", "torrent". If PARAMETERS is set, this must be NIL.

Source

request.lisp.

Target Slot

sub-resource.

Generic Function: successive-marker (response)
Package

zs3.

Source

bucket-listing.lisp.

Methods
Method: successive-marker ((response bucket-listing))
Generic Function: successive-request (response)
Package

zs3.

Source

bucket-listing.lisp.

Methods
Method: successive-request ((response bucket-listing))
Generic Reader: target-bucket (object)
Package

zs3.

Methods
Reader Method: target-bucket ((logging-setup logging-setup))

automatically generated reader method

Source

logging.lisp.

Target Slot

target-bucket.

Generic Writer: (setf target-bucket) (object)
Package

zs3.

Methods
Writer Method: (setf target-bucket) ((logging-setup logging-setup))

automatically generated writer method

Source

logging.lisp.

Target Slot

target-bucket.

Generic Reader: target-grants (object)
Package

zs3.

Methods
Reader Method: target-grants ((logging-setup logging-setup))

automatically generated reader method

Source

logging.lisp.

Target Slot

target-grants.

Generic Writer: (setf target-grants) (object)
Package

zs3.

Methods
Writer Method: (setf target-grants) ((logging-setup logging-setup))

automatically generated writer method

Source

logging.lisp.

Target Slot

target-grants.

Generic Reader: target-prefix (object)
Package

zs3.

Methods
Reader Method: target-prefix ((logging-setup logging-setup))

automatically generated reader method

Source

logging.lisp.

Target Slot

target-prefix.

Generic Writer: (setf target-prefix) (object)
Package

zs3.

Methods
Writer Method: (setf target-prefix) ((logging-setup logging-setup))

automatically generated writer method

Source

logging.lisp.

Target Slot

target-prefix.

Generic Reader: unsupported-credentials-object (condition)
Generic Writer: (setf unsupported-credentials-object) (condition)
Package

zs3.

Methods
Reader Method: unsupported-credentials-object ((condition unsupported-credentials))
Writer Method: (setf unsupported-credentials-object) ((condition unsupported-credentials))
Source

credentials.lisp.

Target Slot

object.

Generic Reader: uri (object)
Package

zs3.

Methods
Reader Method: uri ((acl-group acl-group))

automatically generated reader method

Source

acl.lisp.

Target Slot

uri.

Generic Writer: (setf uri) (object)
Package

zs3.

Methods
Writer Method: (setf uri) ((acl-group acl-group))

automatically generated writer method

Source

acl.lisp.

Target Slot

uri.

Generic Function: url (request)
Package

zs3.

Source

request.lisp.

Methods
Method: url (request)
Generic Function: xml-string (response)
Package

zs3.

Source

response.lisp.

Methods
Method: xml-string (response)
Generic Function: xsi-type (grantee)
Package

zs3.

Source

acl.lisp.

Methods
Method: xsi-type ((grantee acl-group))
Method: xsi-type ((grantee person))
Method: xsi-type ((grantee acl-email))

5.2.5 Conditions

Condition: authorization-header-malformed
Package

zs3.

Source

errors.lisp.

Direct superclasses

request-error.

Direct methods

request-error-region.

Direct slots
Slot: region
Initargs

:region

Readers

request-error-region.

Writers

This slot is read-only.

Condition: bucket-restrictions
Package

zs3.

Source

errors.lisp.

Direct superclasses

linked.

Direct subclasses
Direct Default Initargs
InitargValue
:urlhttp://docs.aws.amazon.com/amazons3/latest/dev/bucketrestrictions.html
Condition: distribution-precondition-failed
Package

zs3.

Source

cloudfront.lisp.

Direct superclasses

distribution-error.

Condition: invalid-if-match-version
Package

zs3.

Source

cloudfront.lisp.

Direct superclasses

distribution-error.

Condition: linked
Package

zs3.

Source

errors.lisp.

Direct superclasses

condition.

Direct subclasses
Direct methods

linked-url.

Direct slots
Slot: url
Initargs

:url

Readers

linked-url.

Writers

This slot is read-only.

Condition: malformed-xml
Package

zs3.

Source

errors.lisp.

Direct superclasses

request-error.

Condition: permanent-redirect
Package

zs3.

Source

errors.lisp.

Direct superclasses
Direct methods

request-error-endpoint.

Direct slots
Slot: endpoint
Initargs

:endpoint

Readers

request-error-endpoint.

Writers

This slot is read-only.

Condition: redirect-error
Package

zs3.

Source

errors.lisp.

Direct superclasses

error.

Direct subclasses
Condition: request-error
Package

zs3.

Source

errors.lisp.

Direct superclasses

error.

Direct subclasses
Direct methods
Direct slots
Slot: request
Initargs

:request

Readers

request-error-request.

Writers

This slot is read-only.

Slot: response
Initargs

:response

Readers

request-error-response.

Writers

This slot is read-only.

Slot: data
Initargs

:data

Readers

request-error-data.

Writers

This slot is read-only.

Condition: temporary-redirect
Package

zs3.

Source

errors.lisp.

Direct superclasses
Direct methods

request-error-endpoint.

Direct slots
Slot: endpoint
Initargs

:endpoint

Readers

request-error-endpoint.

Writers

This slot is read-only.

Condition: unsupported-credentials
Package

zs3.

Source

credentials.lisp.

Direct superclasses

error.

Direct methods
Direct slots
Slot: object
Initargs

:object

Readers

unsupported-credentials-object.

Writers

(setf unsupported-credentials-object).

Condition: xml-binding-error
Package

zs3.

Source

xml-binding.lisp.

Direct superclasses

error.

Direct methods
Direct slots
Slot: expected
Initargs

:expected

Readers

expected.

Writers

(setf expected).

Slot: actual
Initargs

:actual

Readers

actual.

Writers

(setf actual).


5.2.6 Classes

Class: access-control-list
Package

zs3.

Source

acl.lisp.

Direct methods
Direct slots
Slot: owner
Initargs

:owner

Readers

owner.

Writers

(setf owner).

Slot: grants
Initargs

:grants

Readers

grants.

Writers

(setf grants).

Class: acl-group
Package

zs3.

Source

acl.lisp.

Direct methods
Direct slots
Slot: label
Initargs

:label

Readers

label.

Writers

(setf label).

Slot: uri
Initargs

:uri

Readers

uri.

Writers

(setf uri).

Class: acl-response
Package

zs3.

Source

acl.lisp.

Direct superclasses

response.

Direct methods
Direct slots
Slot: acl
Initargs

:acl

Readers

acl.

Writers

(setf acl).

Class: amazon-error
Package

zs3.

Source

errors.lisp.

Direct superclasses

response.

Direct methods
Direct slots
Slot: code
Initargs

:code

Readers

code.

Writers

(setf code).

Slot: message
Initargs

:message

Readers

message.

Writers

(setf message).

Slot: error-data
Initargs

:error-data

Readers

error-data.

Writers

(setf error-data).

Class: binder
Package

zs3.

Source

xml-binding.lisp.

Direct methods
Direct slots
Slot: source
Initargs

:source

Readers

source.

Writers

(setf source).

Slot: closure
Initargs

:closure

Readers

closure.

Writers

(setf closure).

Class: bucket
Package

zs3.

Source

objects.lisp.

Direct methods
Direct slots
Slot: name
Initargs

:name

Readers

name.

Writers

(setf name).

Slot: creation-date
Initargs

:creation-date

Readers

creation-date.

Writers

(setf creation-date).

Class: bucket-listing
Package

zs3.

Source

bucket-listing.lisp.

Direct superclasses

response.

Direct methods
Direct Default Initargs
InitargValue
:next-markernil
:delimiternil
:prefixnil
:max-keysnil
Direct slots
Slot: bucket-name
Initargs

:bucket-name

Readers

bucket-name.

Writers

(setf bucket-name).

Slot: prefix
Initargs

:prefix

Readers

prefix.

Writers

(setf prefix).

Slot: marker
Initargs

:marker

Readers

marker.

Writers

(setf marker).

Slot: next-marker
Initargs

:next-marker

Readers

next-marker.

Writers

(setf next-marker).

Slot: max-keys
Initargs

:max-keys

Readers

max-keys.

Writers

(setf max-keys).

Slot: delimiter
Initargs

:delimiter

Readers

delimiter.

Writers

(setf delimiter).

Slot: truncatedp
Initargs

:truncatedp

Readers

truncatedp.

Writers

(setf truncatedp).

Slot: keys
Initargs

:keys

Readers

keys.

Writers

(setf keys).

Slot: common-prefixes
Initargs

:common-prefixes

Readers

common-prefixes.

Writers

(setf common-prefixes).

Class: digester
Package

zs3.

Source

crypto.lisp.

Direct methods
Direct Default Initargs
InitargValue
:signed-stream(make-string-output-stream)
:newline*newline-vector*
Direct slots
Slot: hmac
Initargs

:hmac

Readers

hmac.

Writers

(setf hmac).

Slot: newline
Allocation

:class

Initargs

:newline

Readers

newline.

Writers

(setf newline).

Slot: signed-stream
Initargs

:signed-stream

Readers

signed-stream.

Writers

(setf signed-stream).

Class: distribution
Package

zs3.

Source

cloudfront.lisp.

Direct methods
Direct slots
Slot: origin-bucket

The S3 bucket that acts as the source of objects for the distribution.

Initargs

:origin-bucket

Readers

origin-bucket.

Writers

(setf origin-bucket).

Slot: caller-reference

A unique value provided by the caller to prevent replays. See http://docs.amazonwebservices.com/AmazonCloudFront/2008-06-30/DeveloperGuide/index.html?AboutCreatingDistributions.html

Initform

(zs3::generate-caller-reference)

Initargs

:caller-reference

Readers

caller-reference.

Writers

(setf caller-reference).

Slot: enabledp

Whether this distribution should be enabled at creation time or not.

Initform

t

Initargs

:enabledp

Readers

enabledp.

Writers

(setf enabledp).

Slot: cnames
Initargs

:cnames

Readers

cnames.

Writers

(setf cnames).

Slot: default-root-object
Initargs

:default-root-object

Readers

default-root-object.

Writers

(setf default-root-object).

Slot: comment
Initargs

:comment

Readers

comment.

Writers

(setf comment).

Slot: logging-bucket
Initargs

:logging-bucket

Readers

logging-bucket.

Writers

(setf logging-bucket).

Slot: logging-prefix
Initargs

:logging-prefix

Readers

logging-prefix.

Writers

(setf logging-prefix).

Slot: id

Amazon’s assigned unique ID.

Initargs

:id

Readers

id.

Writers

(setf id).

Slot: domain-name

Amazon’s assigned domain name.

Initargs

:domain-name

Readers

domain-name.

Writers

(setf domain-name).

Slot: etag
Initargs

:etag

Readers

etag.

Writers

(setf etag).

Slot: status

Assigned by Amazon.

Initargs

:status

Readers

status.

Writers

(setf status).

Slot: last-modified

Assigned by Amazon.

Initargs

:last-modified

Readers

last-modified.

Writers

(setf last-modified).

Class: invalidation
Package

zs3.

Source

cloudfront.lisp.

Direct methods
Direct slots
Slot: id

Amazon’s assigned unique ID.

Initform

"*unset*"

Initargs

:id

Readers

id.

Writers

(setf id).

Slot: distribution
Initargs

:distribution

Readers

distribution.

Writers

(setf distribution).

Slot: create-time
Initform

0

Initargs

:create-time

Readers

create-time.

Writers

(setf create-time).

Slot: status
Initform

"inprogress"

Initargs

:status

Readers

status.

Writers

(setf status).

Slot: caller-reference
Initform

(zs3::generate-caller-reference)

Initargs

:caller-reference

Readers

caller-reference.

Writers

(setf caller-reference).

Slot: paths
Initform

(quote nil)

Initargs

:paths

Readers

paths.

Writers

(setf paths).

Class: key
Package

zs3.

Source

objects.lisp.

Direct methods
Direct slots
Slot: name
Initargs

:name

Readers

name.

Writers

(setf name).

Slot: last-modified
Initargs

:last-modified

Readers

last-modified.

Writers

(setf last-modified).

Slot: etag
Initargs

:etag

Readers

etag.

Writers

(setf etag).

Slot: size
Initargs

:size

Readers

size.

Writers

(setf size).

Slot: owner
Initargs

:owner

Readers

owner.

Writers

(setf owner).

Slot: storage-class
Initargs

:storage-class

Readers

storage-class.

Writers

(setf storage-class).

Class: lazy-credentials-mixin
Package

zs3.

Source

credentials.lisp.

Direct subclasses

file-credentials.

Direct methods
Class: location-constraint
Package

zs3.

Source

location.lisp.

Direct superclasses

response.

Direct methods
Direct slots
Slot: location
Initargs

:location

Readers

location.

Writers

(setf location).

Class: logging
Package

zs3.

Source

logging.lisp.

Direct superclasses

response.

Direct methods
Direct slots
Slot: setup
Initargs

:setup

Readers

setup.

Writers

(setf setup).

Class: person
Package

zs3.

Source

objects.lisp.

Direct subclasses

acl-person.

Direct methods
Direct slots
Slot: id
Initargs

:id

Readers

id.

Writers

(setf id).

Slot: display-name
Initargs

:display-name

Readers

display-name.

Writers

(setf display-name).

Class: post-policy
Package

zs3.

Source

post.lisp.

Direct methods
Direct slots
Slot: expires
Initargs

:expires

Readers

expires.

Writers

(setf expires).

Slot: conditions
Initargs

:conditions

Readers

conditions.

Writers

(setf conditions).

Class: request
Package

zs3.

Source

request.lisp.

Direct subclasses

url-based-request.

Direct methods
Direct Default Initargs
InitargValue
:credentials*credentials*
:methodget
:endpoint*s3-endpoint*
:region*s3-region*
:ssl*use-ssl*
:bucketnil
:keynil
:sub-resourcenil
:parametersnil
:content-typenil
:content-lengtht
:contentnil
:metadatanil
:amz-headersnil
:extra-http-headersnil
Direct slots
Slot: credentials

An object that has methods for ACCESS-KEY and SECRET-KEY. A list of two strings (the keys) suffices.

Initargs

:credentials

Readers

credentials.

Writers

(setf credentials).

Slot: endpoint
Initargs

:endpoint

Readers

endpoint.

Writers

(setf endpoint).

Slot: region
Initargs

:region

Readers

region.

Writers

(setf region).

Slot: ssl
Initargs

:ssl

Readers

ssl.

Writers

(setf ssl).

Slot: method

e.g. :GET, :PUT, :DELETE

Initargs

:method

Readers

method.

Writers

(setf method).

Slot: bucket

A string naming the bucket to address in the request. If NIL, request is not directed at a specific bucket.

Initargs

:bucket

Readers

bucket.

Writers

(setf bucket).

Slot: key

A string naming the key to address in the request. If NIL, request is not directed at a specific key.

Initargs

:key

Readers

key.

Writers

(setf key).

Slot: sub-resource

A sub-resource to address as part of the request,
without a leading "?", e.g. "acl", "torrent". If PARAMETERS is set, this must be NIL.

Initargs

:sub-resource

Readers

sub-resource.

Writers

(setf sub-resource).

Slot: parameters

An alist of string key/value pairs to send as CGI-style GET parameters with the request. If SUB-RESOURCE is set, these must be NIL.

Initargs

:parameters

Readers

parameters.

Writers

(setf parameters).

Slot: content-type
Initargs

:content-type

Readers

content-type.

Writers

(setf content-type).

Slot: content-md5
Initargs

:content-md5

Readers

content-md5.

Writers

(setf content-md5).

Slot: content-length
Initargs

:content-length

Readers

content-length.

Writers

(setf content-length).

Slot: content
Initargs

:content

Readers

content.

Writers

(setf content).

Slot: metadata

An alist of Amazon metadata to attach to a request. These should be straight string key/value pairs, WITHOUT any "x-amz-meta-" prefix.

Initargs

:metadata

Readers

metadata.

Writers

(setf metadata).

Slot: amz-headers

An alist of extra Amazon request headers. These should be straight string key/value pairs, WITHOUT any "x-amz-" prefix.

Initargs

:amz-headers

Readers

amz-headers.

Writers

(setf amz-headers).

Slot: date
Initargs

:date

Readers

date.

Writers

(setf date).

Slot: signed-string
Initargs

:signed-string

Readers

signed-string.

Writers

(setf signed-string).

Slot: extra-http-headers

An alist of extra HTTP headers to include in the request.

Initargs

:extra-http-headers

Readers

extra-http-headers.

Writers

(setf extra-http-headers).

Class: response
Package

zs3.

Source

response.lisp.

Direct subclasses
Direct methods
Direct Default Initargs
InitargValue
:requestnil
:bodynil
:http-code999
:http-phrase<uninitialized>
:http-headersnil
Direct slots
Slot: request
Initargs

:request

Readers

request.

Writers

(setf request).

Slot: body
Initargs

:body

Readers

body.

Writers

(setf body).

Slot: http-code
Initargs

:http-code

Readers

http-code.

Writers

(setf http-code).

Slot: http-phrase
Initargs

:http-phrase

Readers

http-phrase.

Writers

(setf http-phrase).

Slot: http-headers
Initargs

:http-headers

Readers

http-headers.

Writers

(setf http-headers).

Class: url-based-request
Package

zs3.

Source

interface.lisp.

Direct superclasses

request.

Direct methods
Direct Default Initargs
InitargValue
:expires0
Direct slots
Slot: expires
Initargs

:expires

Readers

expires.

Writers

(setf expires).


5.2.7 Types

Type: empty-vector ()
Package

zs3.

Source

utils.lisp.

Type: octet ()
Package

zs3.

Source

utils.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %   (  
A   B   C   D   E   F   G   H   I   K   L   M   N   O   P   Q   R   S   T   U   V   W   X  
Index Entry  Section

%
%delete-distribution: Private ordinary functions

(
(setf access-key): Public generic functions
(setf access-key): Public generic functions
(setf acl): Private generic functions
(setf acl): Private generic functions
(setf action): Private generic functions
(setf action): Private generic functions
(setf actual): Private generic functions
(setf actual): Private generic functions
(setf amz-headers): Private generic functions
(setf amz-headers): Private generic functions
(setf body): Private generic functions
(setf body): Private generic functions
(setf bucket): Private generic functions
(setf bucket): Private generic functions
(setf bucket-lifecycle): Public ordinary functions
(setf bucket-name): Public generic functions
(setf bucket-name): Public generic functions
(setf buckets): Private generic functions
(setf buckets): Private generic functions
(setf caller-reference): Private generic functions
(setf caller-reference): Private generic functions
(setf caller-reference): Private generic functions
(setf closure): Private generic functions
(setf closure): Private generic functions
(setf cnames): Public generic functions
(setf cnames): Public generic functions
(setf code): Private generic functions
(setf code): Private generic functions
(setf comment): Public generic functions
(setf comment): Public generic functions
(setf common-prefixes): Public generic functions
(setf common-prefixes): Public generic functions
(setf conditions): Private generic functions
(setf conditions): Private generic functions
(setf content): Private generic functions
(setf content): Private generic functions
(setf content-length): Private generic functions
(setf content-length): Private generic functions
(setf content-md5): Private generic functions
(setf content-md5): Private generic functions
(setf content-type): Private generic functions
(setf content-type): Private generic functions
(setf create-time): Private generic functions
(setf create-time): Private generic functions
(setf creation-date): Public generic functions
(setf creation-date): Public generic functions
(setf credentials): Private generic functions
(setf credentials): Private generic functions
(setf date): Private generic functions
(setf date): Private generic functions
(setf date): Private generic functions
(setf days): Private generic functions
(setf days): Private generic functions
(setf default-root-object): Public generic functions
(setf default-root-object): Public generic functions
(setf delimiter): Public generic functions
(setf delimiter): Public generic functions
(setf display-name): Private generic functions
(setf display-name): Private generic functions
(setf distribution): Private generic functions
(setf distribution): Private generic functions
(setf distribution-error-code): Public generic functions
(setf distribution-error-code): Public generic functions
(setf distribution-error-detail): Public generic functions
(setf distribution-error-detail): Public generic functions
(setf distribution-error-http-status-code): Public generic functions
(setf distribution-error-http-status-code): Public generic functions
(setf distribution-error-message): Private generic functions
(setf distribution-error-message): Private generic functions
(setf distribution-error-type): Public generic functions
(setf distribution-error-type): Public generic functions
(setf domain-name): Public generic functions
(setf domain-name): Public generic functions
(setf email): Private generic functions
(setf email): Private generic functions
(setf enabledp): Public generic functions
(setf enabledp): Public generic functions
(setf enabledp): Public generic functions
(setf endpoint): Private generic functions
(setf endpoint): Private generic functions
(setf error-data): Private generic functions
(setf error-data): Private generic functions
(setf etag): Public generic functions
(setf etag): Public generic functions
(setf etag): Public generic functions
(setf expected): Private generic functions
(setf expected): Private generic functions
(setf expires): Private generic functions
(setf expires): Private generic functions
(setf expires): Private generic functions
(setf extra-http-headers): Private generic functions
(setf extra-http-headers): Private generic functions
(setf file): Private generic functions
(setf file): Private generic functions
(setf grantee): Private generic functions
(setf grantee): Private generic functions
(setf grants): Private generic functions
(setf grants): Private generic functions
(setf hmac): Private generic functions
(setf hmac): Private generic functions
(setf http-code): Public generic functions
(setf http-code): Public generic functions
(setf http-headers): Public generic functions
(setf http-headers): Public generic functions
(setf http-phrase): Public generic functions
(setf http-phrase): Public generic functions
(setf id): Private generic functions
(setf id): Private generic functions
(setf id): Private generic functions
(setf id): Private generic functions
(setf id): Private generic functions
(setf key): Private generic functions
(setf key): Private generic functions
(setf keys): Public generic functions
(setf keys): Public generic functions
(setf label): Private generic functions
(setf label): Private generic functions
(setf last-modified): Public generic functions
(setf last-modified): Public generic functions
(setf last-modified): Public generic functions
(setf location): Private generic functions
(setf location): Private generic functions
(setf logging-bucket): Public generic functions
(setf logging-bucket): Public generic functions
(setf logging-prefix): Public generic functions
(setf logging-prefix): Public generic functions
(setf marker): Public generic functions
(setf marker): Public generic functions
(setf max-keys): Private generic functions
(setf max-keys): Private generic functions
(setf message): Private generic functions
(setf message): Private generic functions
(setf metadata): Private generic functions
(setf metadata): Private generic functions
(setf method): Private generic functions
(setf method): Private generic functions
(setf name): Public generic functions
(setf name): Public generic functions
(setf name): Public generic functions
(setf newline): Private generic functions
(setf newline): Private generic functions
(setf next-marker): Private generic functions
(setf next-marker): Private generic functions
(setf origin-bucket): Public generic functions
(setf origin-bucket): Public generic functions
(setf owner): Public generic functions
(setf owner): Public generic functions
(setf owner): Public generic functions
(setf owner): Public generic functions
(setf parameters): Private generic functions
(setf parameters): Private generic functions
(setf paths): Private generic functions
(setf paths): Private generic functions
(setf permission): Private generic functions
(setf permission): Private generic functions
(setf prefix): Public generic functions
(setf prefix): Public generic functions
(setf prefix): Public generic functions
(setf redirection-data): Private ordinary functions
(setf region): Private generic functions
(setf region): Private generic functions
(setf request): Private generic functions
(setf request): Private generic functions
(setf secret-key): Public generic functions
(setf secret-key): Public generic functions
(setf security-token): Private generic functions
(setf security-token): Private generic functions
(setf setup): Private generic functions
(setf setup): Private generic functions
(setf signed-stream): Private generic functions
(setf signed-stream): Private generic functions
(setf signed-string): Private generic functions
(setf signed-string): Private generic functions
(setf size): Public generic functions
(setf size): Public generic functions
(setf source): Private generic functions
(setf source): Private generic functions
(setf ssl): Private generic functions
(setf ssl): Private generic functions
(setf status): Public generic functions
(setf status): Public generic functions
(setf status): Public generic functions
(setf storage-class): Public generic functions
(setf storage-class): Public generic functions
(setf sub-resource): Private generic functions
(setf sub-resource): Private generic functions
(setf target-bucket): Private generic functions
(setf target-bucket): Private generic functions
(setf target-grants): Private generic functions
(setf target-grants): Private generic functions
(setf target-prefix): Private generic functions
(setf target-prefix): Private generic functions
(setf truncatedp): Public generic functions
(setf truncatedp): Public generic functions
(setf unsupported-credentials-object): Private generic functions
(setf unsupported-credentials-object): Private generic functions
(setf uri): Private generic functions
(setf uri): Private generic functions

A
access-key: Public generic functions
access-key: Public generic functions
access-key: Public generic functions
access-key: Public generic functions
access-key: Public generic functions
access-policy-header: Private ordinary functions
acl: Private generic functions
acl: Private generic functions
acl-email: Public ordinary functions
acl-eqv: Public generic functions
acl-eqv: Public generic functions
acl-eqv: Public generic functions
acl-eqv: Public generic functions
acl-eqv: Public generic functions
acl-person: Public ordinary functions
acl-serialize: Private generic functions
acl-serialize: Private generic functions
acl-serialize: Private generic functions
acl-serialize: Private generic functions
acl-serialize: Private generic functions
acl-serialize: Private generic functions
action: Private generic functions
action: Private generic functions
actual: Private generic functions
actual: Private generic functions
add-line: Private generic functions
add-line: Private generic functions
add-newline: Private generic functions
add-newline: Private generic functions
add-string: Private generic functions
add-string: Private generic functions
alist-bind: Private macros
alist-grant: