Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the hh-aws Reference Manual, version 0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 16:19:58 2021 GMT+0.
• Introduction | What hh-aws is all about | |
• Systems | The systems documentation | |
• Files | The files documentation | |
• Packages | The packages documentation | |
• Definitions | The symbols documentation | |
• Indexes | Concepts, functions, variables and data types |
hh-aws This package is a Common Lisp library for acessing the APIs of Amazon Web Services. Current services supported (partially or completely) are: * Simple Storage Service (S3) -- version 3/1/2006 * SimpleDB (SDB) -- version 7/11/2007 * Elastic Compute Cloud (EC2) -- version 6/15/2010 * Simple Queue Service (SQS) -- version 1/1/2008 All code in this package is licensed under the MIT License. When possible, the library uses the REST versions of AWS APIs, rather than SOAP. Also, unfortunately, the library is still using older versions of some Amazon services, and are in need of update to newer versions of Amazon APIs. To access AWS, you must have an AWS account. The library uses the *credentials* variable to locate an object which can supply credentials when needed to perform AWS calls. The object in *credentials* can be any object that implements generic methods #'access-key-id and #'secret-key, each of which take a single argument. Each function is expected to return the appropriate value required by AWS. By default, the library uses an internal implementation which assumes the AWS access key id is in a text file located at ~/.aws/access-key-id and the secret key is in a text file located at ~/.aws/secret-key. The library exports #:*credentials, #:access-key-id, and #:secret-key, so you are free to add your own implementation for providing credentials when needed. To test that your installation is working, place your credentials in the files mentioned above, load package :hh-aws-tests, and then run: (lisp-unit:run-all-tests :hh-aws-tests) Note that timing errors or temporary conditions can sometimes make these tests fail. If it appears Amazon has reported service unavailable on one or more calls, just run the tests again, as they will likely then succeed. Contact phil@haphazardhouse.net for any questions, comments, feedback, or contributions, and keep an eye on http://haphazardhouse.net/projects/hh-aws for info and news about this library. Thanks!
Next: Files, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
• The hh-aws system |
0.1
hh-aws.asd (file)
Files are sorted by type and then listed depth-first from the systems components trees.
• Lisp files |
Next: The hh-aws/package․lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
hh-aws.asd
hh-aws (system)
Next: The hh-aws/utils․lisp file, Previous: The hh-aws․asd file, Up: Lisp files [Contents][Index]
hh-aws (system)
package.lisp
Next: The hh-aws/constants․lisp file, Previous: The hh-aws/package․lisp file, Up: Lisp files [Contents][Index]
package.lisp (file)
hh-aws (system)
utils.lisp
Next: The hh-aws/conditions․lisp file, Previous: The hh-aws/utils․lisp file, Up: Lisp files [Contents][Index]
hh-aws (system)
constants.lisp
Next: The hh-aws/xml․lisp file, Previous: The hh-aws/constants․lisp file, Up: Lisp files [Contents][Index]
hh-aws (system)
conditions.lisp
Next: The hh-aws/common․lisp file, Previous: The hh-aws/conditions․lisp file, Up: Lisp files [Contents][Index]
hh-aws (system)
xml.lisp
Next: The hh-aws/sdb․lisp file, Previous: The hh-aws/xml․lisp file, Up: Lisp files [Contents][Index]
hh-aws (system)
common.lisp
Next: The hh-aws/s3․lisp file, Previous: The hh-aws/common․lisp file, Up: Lisp files [Contents][Index]
common.lisp (file)
hh-aws (system)
sdb.lisp
Next: The hh-aws/sqs․lisp file, Previous: The hh-aws/sdb․lisp file, Up: Lisp files [Contents][Index]
common.lisp (file)
hh-aws (system)
s3.lisp
Next: The hh-aws/ec2․lisp file, Previous: The hh-aws/s3․lisp file, Up: Lisp files [Contents][Index]
common.lisp (file)
hh-aws (system)
sqs.lisp
Previous: The hh-aws/sqs․lisp file, Up: Lisp files [Contents][Index]
common.lisp (file)
hh-aws (system)
ec2.lisp
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
• The hh-aws-asd package | ||
• The hh-aws package |
Next: The hh-aws package, Previous: Packages, Up: Packages [Contents][Index]
package.lisp (file)
Previous: The hh-aws-asd package, Up: Packages [Contents][Index]
package.lisp (file)
aws
Definitions are sorted by export status, category, package, and then by lexicographic order.
• Exported definitions | ||
• Internal definitions |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
• Exported special variables | ||
• Exported functions | ||
• Exported generic functions | ||
• Exported conditions |
Next: Exported functions, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
Credentials for authenticating against Amazon Web Services
common.lisp (file)
Next: Exported generic functions, Previous: Exported special variables, Up: Exported definitions [Contents][Index]
Create a domain with the specified name
Delete attributes from the specified item, and if all attributes are gone, delete the item itself
Delete the specified domain
Return metadata about the specified domain
Return the attributes for the specified item in the domain
Set the attributes on the specified item in the domain
Return a list of item names matching the query expression
Return the indicated attributes of items matching the query expression
Return the results of the provided select statement
List all availability zones
List all security groups
Return the contents of the indicated bucket
Return the contents of the indicated bucket
List objects in a bucket
Either create a new bucket object for the content, or update an existing one.
Delete a message from a queue
Get queue attributes
Receive a message from the queue
Send a message to the specified queue
Set queue attributes
Next: Exported conditions, Previous: Exported functions, Up: Exported definitions [Contents][Index]
Return the access key associated with the credentials, to be sent with requests
common.lisp (file)
Return the secret key used to sign requests
common.lisp (file)
Previous: Exported generic functions, Up: Exported definitions [Contents][Index]
conditions.lisp (file)
error (condition)
:code
error-code (generic function)
(setf error-code) (generic function)
:message
error-message (generic function)
(setf error-message) (generic function)
:response
(quote nil)
error-response (generic function)
(setf error-response) (generic function)
conditions.lisp (file)
aws-error (condition)
conditions.lisp (file)
aws-error (condition)
conditions.lisp (file)
aws-error (condition)
conditions.lisp (file)
aws-error (condition)
conditions.lisp (file)
aws-error (condition)
conditions.lisp (file)
aws-error (condition)
conditions.lisp (file)
aws-error (condition)
conditions.lisp (file)
aws-error (condition)
conditions.lisp (file)
aws-error (condition)
Previous: Exported definitions, Up: Definitions [Contents][Index]
• Internal constants | ||
• Internal special variables | ||
• Internal macros | ||
• Internal functions | ||
• Internal generic functions | ||
• Internal classes |
Next: Internal special variables, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
HTTP return code (202) for ’Accepted’.
constants.lisp (file)
HTTP return code (401) for ’Authorization Required’.
constants.lisp (file)
HTTP return code (502) for ’Bad Gateway’.
constants.lisp (file)
HTTP return code (400) for ’Bad Request’.
constants.lisp (file)
HTTP return code (409) for ’Conflict’.
constants.lisp (file)
HTTP return code (100) for ’Continue’.
constants.lisp (file)
HTTP return code (201) for ’Created’.
constants.lisp (file)
HTTP return code (417) for ’Expectation Failed’.
constants.lisp (file)
HTTP return code (424) for ’Failed Dependency’.
constants.lisp (file)
HTTP return code (403) for ’Forbidden’.
constants.lisp (file)
HTTP return code (504) for ’Gateway Time-out’.
constants.lisp (file)
HTTP return code (410) for ’Gone’.
constants.lisp (file)
HTTP return code (500) for ’Internal Server Error’.
constants.lisp (file)
HTTP return code (411) for ’Length Required’.
constants.lisp (file)
HTTP return code (405) for ’Method Not Allowed’.
constants.lisp (file)
HTTP return code (301) for ’Moved Permanently’.
constants.lisp (file)
HTTP return code (302) for ’Moved Temporarily’.
constants.lisp (file)
HTTP return code (207) for ’Multi-Status’.
constants.lisp (file)
HTTP return code (300) for ’Multiple Choices’.
constants.lisp (file)
HTTP return code (204) for ’No Content’.
constants.lisp (file)
HTTP return code (203) for ’Non-Authoritative Information’.
constants.lisp (file)
HTTP return code (406) for ’Not Acceptable’.
constants.lisp (file)
HTTP return code (404) for ’Not Found’.
constants.lisp (file)
HTTP return code (501) for ’Not Implemented’.
constants.lisp (file)
HTTP return code (304) for ’Not Modified’.
constants.lisp (file)
HTTP return code (200) for ’OK’.
constants.lisp (file)
HTTP return code (206) for ’Partial Content’.
constants.lisp (file)
HTTP return code (402) for ’Payment Required’.
constants.lisp (file)
HTTP return code (412) for ’Precondition Failed’.
constants.lisp (file)
HTTP return code (407) for ’Proxy Authentication Required’.
constants.lisp (file)
HTTP return code (413) for ’Request Entity Too Large’.
constants.lisp (file)
HTTP return code (408) for ’Request Time-out’.
constants.lisp (file)
HTTP return code (414) for ’Request-URI Too Large’.
constants.lisp (file)
HTTP return code (416) for ’Requested range not satisfiable’.
constants.lisp (file)
HTTP return code (205) for ’Reset Content’.
constants.lisp (file)
HTTP return code (303) for ’See Other’.
constants.lisp (file)
HTTP return code (503) for ’Service Unavailable’.
constants.lisp (file)
HTTP return code (101) for ’Switching Protocols’.
constants.lisp (file)
HTTP return code (307) for ’Temporary Redirect’.
constants.lisp (file)
HTTP return code (415) for ’Unsupported Media Type’.
constants.lisp (file)
HTTP return code (305) for ’Use Proxy’.
constants.lisp (file)
HTTP return code (505) for ’Version not supported’.
constants.lisp (file)
Next: Internal macros, Previous: Internal constants, Up: Internal definitions [Contents][Index]
A list of current elements; the top one on the list is the current
element, and the prior one can be restored by setting this to the
cdr of itself
The first element is the current element to find; the rest of the list is the elements remaining to be found
The list of active handlers for XML parsing, with the current as the head of the list
The text values for elements currently found
A list of strings, each naming an element whose text we’re interested in
If the list of elements-to-find cycles more than once, then each iteration is added to this list. The final result will be the value of this variable.
Used to map numerical return codes to reason phrases.
constants.lisp (file)
Next: Internal functions, Previous: Internal special variables, Up: Internal definitions [Contents][Index]
utils.lisp (file)
Shortcut to define constants for return codes. NAME is a Lisp symbol, VALUE is the numerical value of the return code, and REASON-PHRASE is the phrase (a string) to be shown in the server’s status line.
constants.lisp (file)
common.lisp (file)
common.lisp (file)
utils.lisp (file)
Append some-object to the end of the list in some-place.
Modifies some-place.
utils.lisp (file)
conditions.lisp (file)
Expand a response into a multiple return values
common.lisp (file)
Next: Internal generic functions, Previous: Internal macros, Up: Internal definitions [Contents][Index]
common.lisp (file)
Return a HTTP-style date string. Borrowed from Zach Bean’s ZS3: http://www.xach.com/lisp/zs3/ (BSD-license)
common.lisp (file)
Borrowed from Arnesi (http://common-lisp.net/project/bese/arnesi.html)
utils.lisp (file)
Combine elements into a string, separating each element by token
utils.lisp (file)
utils.lisp (file)
utils.lisp (file)
Return the user’s home directory
utils.lisp (file)
common.lisp (file)
Apply some lambda (takes 2 arguments) to each name / value
pair in name-value-pairs
utils.lisp (file)
Use predicate to compare pairs of keys & values; predicate
should return true iff pair 1 is less than pair 2 (each pair
is a cons of (key.value) ).
utils.lisp (file)
Return T if target-string ends with search-string,
nil otherwise
utils.lisp (file)
Return T if target-string starts with search-string,
nil otherwise
utils.lisp (file)
Borrowed from Arnesi (http://common-lisp.net/project/bese/arnesi.html)
utils.lisp (file)
common.lisp (file)
Build a symbol from component parts
utils.lisp (file)
Next: Internal classes, Previous: Internal functions, Up: Internal definitions [Contents][Index]
Add the indicated parameters as attribute name / value
pairs to the request
Add the indicated parameters as attribute name / value
pairs to the request
Add a header (usually an amz header) to the request
common.lisp (file)
Add a parameter to the request
common.lisp (file)
Additional headers for the request; for s3, this includes the authorization header
common.lisp (file)
s3.lisp (file)
automatically generated reader method
s3.lisp (file)
automatically generated writer method
s3.lisp (file)
automatically generated reader method
sdb.lisp (file)
automatically generated writer method
sdb.lisp (file)
common.lisp (file)
ec2.lisp (file)
ec2.lisp (file)
sqs.lisp (file)
sqs.lisp (file)
sqs.lisp (file)
sqs.lisp (file)
sqs.lisp (file)
sqs.lisp (file)
s3.lisp (file)
s3.lisp (file)
s3.lisp (file)
s3.lisp (file)
s3.lisp (file)
s3.lisp (file)
sdb.lisp (file)
sdb.lisp (file)
sdb.lisp (file)
Return true if the response indicates success, false otherwise
common.lisp (file)
common.lisp (file)
Return a canonical string representation of amz headers
xml.lisp (file)
ec2.lisp (file)
ec2.lisp (file)
s3.lisp (file)
s3.lisp (file)
sdb.lisp (file)
automatically generated reader method
s3.lisp (file)
automatically generated writer method
s3.lisp (file)
automatically generated reader method
sdb.lisp (file)
automatically generated writer method
sdb.lisp (file)
automatically generated reader method
ec2.lisp (file)
automatically generated writer method
ec2.lisp (file)
common.lisp (file)
Return the default action associated with this request
common.lisp (file)
ec2.lisp (file)
ec2.lisp (file)
ec2.lisp (file)
ec2.lisp (file)
ec2.lisp (file)
ec2.lisp (file)
sqs.lisp (file)
sqs.lisp (file)
sqs.lisp (file)
sqs.lisp (file)
sqs.lisp (file)
sqs.lisp (file)
sqs.lisp (file)
sqs.lisp (file)
sdb.lisp (file)
sdb.lisp (file)
sdb.lisp (file)
sdb.lisp (file)
sdb.lisp (file)
sdb.lisp (file)
sdb.lisp (file)
sdb.lisp (file)
sdb.lisp (file)
sdb.lisp (file)
Hostname of AWS service endpoint (e.g., s3.amazon.com)
common.lisp (file)
ec2.lisp (file)
ec2.lisp (file)
sqs.lisp (file)
s3.lisp (file)
s3.lisp (file)
sdb.lisp (file)
xml.lisp (file)
ec2.lisp (file)
ec2.lisp (file)
s3.lisp (file)
s3.lisp (file)
sdb.lisp (file)
conditions.lisp (file)
common.lisp (file)
conditions.lisp (file)
conditions.lisp (file)
xml.lisp (file)
ec2.lisp (file)
s3.lisp (file)
s3.lisp (file)
sdb.lisp (file)
common.lisp (file)
common.lisp (file)
ec2.lisp (file)
ec2.lisp (file)
sqs.lisp (file)
sqs.lisp (file)
sqs.lisp (file)
sqs.lisp (file)
sqs.lisp (file)
sqs.lisp (file)
s3.lisp (file)
s3.lisp (file)
s3.lisp (file)
s3.lisp (file)
s3.lisp (file)
s3.lisp (file)
s3.lisp (file)
s3.lisp (file)
sdb.lisp (file)
sdb.lisp (file)
sdb.lisp (file)
sdb.lisp (file)
sdb.lisp (file)
sdb.lisp (file)
sdb.lisp (file)
sdb.lisp (file)
xml.lisp (file)
ec2.lisp (file)
ec2.lisp (file)
s3.lisp (file)
s3.lisp (file)
sdb.lisp (file)
common.lisp (file)
HTTP headers associated with the request
common.lisp (file)
common.lisp (file)
common.lisp (file)
The HTTP URI of a request, including scheme, host, and path
common.lisp (file)
sqs.lisp (file)
s3.lisp (file)
common.lisp (file)
Create a new request for the service
common.lisp (file)
Create an MD5 digest of the provided content
common.lisp (file)
common.lisp (file)
s3.lisp (file)
s3.lisp (file)
s3.lisp (file)
s3.lisp (file)
s3.lisp (file)
s3.lisp (file)
Parameters accompanying the message as name-value pairs
common.lisp (file)
Compute the signature of the request and return it’s base64 representation (note: using HMAC256)
common.lisp (file)
String representation of request prepared for signing
common.lisp (file)
s3.lisp (file)
Body of the response (if any)
common.lisp (file)
automatically generated reader method
common.lisp (file)
automatically generated writer method
common.lisp (file)
automatically generated reader method
common.lisp (file)
automatically generated writer method
common.lisp (file)
automatically generated reader method
common.lisp (file)
automatically generated writer method
common.lisp (file)
Status code returned by the server
common.lisp (file)
automatically generated reader method
common.lisp (file)
automatically generated writer method
common.lisp (file)
Return the format that should be used to extract the result from the response’s body
common.lisp (file)
ec2.lisp (file)
ec2.lisp (file)
ec2.lisp (file)
sqs.lisp (file)
sqs.lisp (file)
sqs.lisp (file)
sqs.lisp (file)
sdb.lisp (file)
sdb.lisp (file)
sdb.lisp (file)
sdb.lisp (file)
Send the HTTP request
common.lisp (file)
s3.lisp (file)
s3.lisp (file)
Send a request to its endpoint, and return any supplied response.
common.lisp (file)
Service source or destination of the message
common.lisp (file)
Return the cryptographic diegest algorithm to use when signing the request
common.lisp (file)
s3.lisp (file)
Return the signed form of parameters for the request
(means the addition of the signature parameter); at the moment,
only SimpleDB requires this method.
common.lisp (file)
ec2.lisp (file)
sqs.lisp (file)
sdb.lisp (file)
Sort the headers of the request according to byte-ordering of names, and return the sorted list
common.lisp (file)
Sort the parameters of the request according to byte-ordering of names, and return the sorted list
common.lisp (file)
URI that is the source or destinationof the message
common.lisp (file)
Return the expected version of the service
common.lisp (file)
ec2.lisp (file)
sqs.lisp (file)
s3.lisp (file)
sdb.lisp (file)
Previous: Internal generic functions, Up: Internal definitions [Contents][Index]
s3.lisp (file)
builder (class)
attributes-of (generic function)
(setf attributes-of) (generic function)
current-attribute-of (generic function)
(setf current-attribute-of) (generic function)
xml.lisp (file)
standard-object (class)
results-of (generic function)
(setf results-of) (generic function)
current-of (generic function)
(setf current-of) (generic function)
Encapsulates credentials used for authenticating requests to AWS
common.lisp (file)
standard-object (class)
sdb.lisp (file)
sdb.lisp (file)
sdb.lisp (file)
sdb.lisp (file)
sdb.lisp (file)
sdb.lisp (file)
sdb.lisp (file)
sdb.lisp (file)
sdb.lisp (file)
Base for requests targeting SimpleDB
sdb.lisp (file)
request (class)
sdb.lisp (file)
ec2.lisp (file)
service (class)
ec2.lisp (file)
default-action (method)
ec2.lisp (file)
ec2.lisp (file)
ec2.lisp (file)
ec2.lisp (file)
ec2.lisp (file)
request (class)
:region
region-for (generic function)
(setf region-for) (generic function)
ec2.lisp (file)
default-action (method)
common.lisp (file)
credentials (class)
Credentials explicitly initialized to specific values
common.lisp (file)
credentials (class)
:access-key-id
:secret-key
xml.lisp (file)
builder (class)
:path
path-to-match (generic function)
(setf path-to-match) (generic function)
sdb.lisp (file)
builder (class)
attributes-of (generic function)
(setf attributes-of) (generic function)
current-attribute-of (generic function)
(setf current-attribute-of) (generic function)
s3.lisp (file)
builder (class)
common.lisp (file)
standard-object (class)
Service source or destination of the message
:service
service-of (generic function)
(setf service-of) (generic function)
URI that is the source or destinationof the message
:uri
"/"
uri-of (generic function)
(setf uri-of) (generic function)
Encapsulates a single request sent to a service instance of AWS
common.lisp (file)
message (class)
Parameters accompanying the message as name-value pairs
(make-hash-table :test (quote equal))
parameters-of (generic function)
(setf parameters-of) (generic function)
HTTP headers associated with the request
(make-hash-table :test (quote equal))
headers-of (generic function)
(setf headers-of) (generic function)
Encapsulates a response from a service instance of AWS
common.lisp (file)
message (class)
Body of the response (if any)
:body
response-body (generic function)
(setf response-body) (generic function)
Status code returned by the server
:status-code
response-status-code (generic function)
(setf response-status-code) (generic function)
:headers
response-headers (generic function)
(setf response-headers) (generic function)
:stream
response-stream (generic function)
(setf response-stream) (generic function)
:must-close
response-must-close (generic function)
(setf response-must-close) (generic function)
:reason-phrase
response-reason-phrase (generic function)
(setf response-reason-phrase) (generic function)
s3.lisp (file)
service (class)
s3.lisp (file)
s3.lisp (file)
s3.lisp (file)
s3.lisp (file)
s3.lisp (file)
s3.lisp (file)
extract-result (method)
s3.lisp (file)
Base for requests targeting S3
s3.lisp (file)
request (class)
:bucket
bucket-for (generic function)
(setf bucket-for) (generic function)
:object
bucket-object-for (generic function)
(setf bucket-object-for) (generic function)
:content
object-content-for (generic function)
(setf object-content-for) (generic function)
ec2.lisp (file)
builder (class)
current-permission-of (generic function)
(setf current-permission-of) (generic function)
Encapsulates a specific functional AWS (e.g., S3, SimpleDB, etc.)
common.lisp (file)
standard-object (class)
sqs.lisp (file)
service (class)
sdb.lisp (file)
service (class)
sqs.lisp (file)
sqs.lisp (file)
sqs.lisp (file)
sqs.lisp (file)
sqs.lisp (file)
sqs.lisp (file)
sqs.lisp (file)
request (class)
:queue
queue-for (generic function)
(setf queue-for) (generic function)
sqs.lisp (file)
sqs.lisp (file)
Credentials are stored in a pair of files in ~/.aws; 1 file for the access key id, and one for the secret key.
common.lisp (file)
credentials (class)
Previous: Definitions, Up: Top [Contents][Index]
• Concept index | ||
• Function index | ||
• Variable index | ||
• Data type index |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
Jump to: | F H L |
---|
Jump to: | F H L |
---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
Jump to: | (
A B C D E F G H I L M O P Q R S U V |
---|
Jump to: | (
A B C D E F G H I L M O P Q R S U V |
---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
Jump to: | *
+
A B C H M O P Q R S U |
---|
Jump to: | *
+
A B C H M O P Q R S U |
---|
Previous: Variable index, Up: Indexes [Contents][Index]
Jump to: | A B C D E F H I L M N P R S U |
---|
Jump to: | A B C D E F H I L M N P R S U |
---|