Add some examples to lifecycle docs.
[zs3.git] / package.lisp
blob7d4b593de66045a30b8b4893eb4373c61fddf100
1 ;;;;
2 ;;;; Copyright (c) 2008 Zachary Beane, All Rights Reserved
3 ;;;;
4 ;;;; Redistribution and use in source and binary forms, with or without
5 ;;;; modification, are permitted provided that the following conditions
6 ;;;; are met:
7 ;;;;
8 ;;;; * Redistributions of source code must retain the above copyright
9 ;;;; notice, this list of conditions and the following disclaimer.
10 ;;;;
11 ;;;; * Redistributions in binary form must reproduce the above
12 ;;;; copyright notice, this list of conditions and the following
13 ;;;; disclaimer in the documentation and/or other materials
14 ;;;; provided with the distribution.
15 ;;;;
16 ;;;; THIS SOFTWARE IS PROVIDED BY THE AUTHOR 'AS IS' AND ANY EXPRESSED
17 ;;;; OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 ;;;; WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 ;;;; ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
20 ;;;; DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 ;;;; DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
22 ;;;; GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 ;;;; INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
24 ;;;; WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
25 ;;;; NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
26 ;;;; SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 ;;;;
28 ;;;; package.lisp
30 (defpackage #:zs3
31 (:use #:cl)
32 ;; In documentation order and grouping:
33 ;; Credentials
34 (:export #:*credentials*
35 #:access-key
36 #:secret-key
37 #:file-credentials)
38 ;; Buckets
39 (:export #:all-buckets
40 #:creation-date
41 #:name
42 #:all-keys
43 #:bucket-exists-p
44 #:create-bucket
45 #:delete-bucket
46 #:bucket-location
47 #:bucket-lifecycle
48 #:lifecycle-rule)
49 ;; Bucket queries
50 (:export #:query-bucket
51 #:continue-bucket-query
52 #:bucket-name
53 #:keys
54 #:common-prefixes
55 #:prefix
56 #:marker
57 #:delimiter
58 #:truncatedp
59 #:last-modified
60 #:etag
61 #:size
62 #:owner
63 #:storage-class)
64 ;; Objects
65 (:export #:get-object
66 #:get-vector
67 #:get-string
68 #:get-file
69 #:put-object
70 #:put-vector
71 #:put-string
72 #:put-file
73 #:put-stream
74 #:copy-object
75 #:delete-object
76 #:delete-objects
77 #:delete-all-objects
78 #:object-metadata
79 #:set-storage-class)
80 ;; Access Control
81 (:export #:get-acl
82 #:put-acl
83 #:grant
84 #:acl-eqv
85 #:*all-users*
86 #:*aws-users*
87 #:*log-delivery*
88 #:acl-email
89 #:acl-person
90 #:me
91 #:make-public
92 #:make-private)
93 ;; Logging
94 (:export #:enable-logging-to
95 #:disable-logging-to
96 #:enable-logging
97 #:disable-logging
98 #:logging-setup)
99 ;; Misc.
100 (:export #:*use-ssl*
101 #:make-post-policy
102 #:head
103 #:authorized-url
104 #:resource-url)
105 ;; Util
106 (:export #:octet-vector
107 #:now+
108 #:now-
109 #:file-etag
110 #:parameters-alist
111 #:clear-redirects)
112 ;; Conditions
113 (:export #:slow-down
114 #:no-such-bucket
115 #:no-such-key
116 #:access-denied
117 #:signature-mismatch
118 #:precondition-failed
119 #:invalid-bucket-name
120 #:bucket-exists
121 #:too-many-buckets
122 #:ambiguous-grant
123 #:bucket-not-empty
124 #:invalid-logging-target
125 #:key-too-long
126 #:request-time-skewed
127 #:operation-aborted
128 #:no-such-lifecycle-configuration)
129 ;; Cloudfront distribution management
130 (:export #:status
131 #:origin-bucket
132 #:domain-name
133 #:cnames
134 #:default-root-object
135 #:logging-bucket
136 #:logging-prefix
137 #:enabledp
138 #:comment
139 ;; Queries & updates
140 #:all-distributions
141 #:create-distribution
142 #:delete-distribution
143 #:refresh
144 #:enable
145 #:disable
146 #:ensure-cname
147 #:remove-cname
148 #:set-comment
149 #:distributions-for-bucket
150 ;; Invalidations
151 #:invalidate-paths
152 ;; Conditions
153 #:distribution-error
154 #:distribution-error-type
155 #:distribution-error-code
156 #:distribution-error-http-status-code
157 #:distribution-error-detail
158 #:distribution-not-disabled
159 #:cname-already-exists
160 #:too-many-distributions)
161 (:shadow #:method))