Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the zaws Reference Manual, version 1.0.2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Aug 15 06:13:24 2022 GMT+0.
Next: Systems, Previous: The zaws Reference Manual, Up: The zaws Reference Manual [Contents][Index]
[WARNING: This project is still half-baked, but I intend to bake it fully. I recommend waiting.] ZAWS is a library for writing interfaces to Amazon Web Services (AWS). It provides code to do common tasks related to creating & authenticating requests and processing responses. The source code is hosted at https://github.com/xach/zaws/ For full documentation, see doc/index.html. Zach Beane2012-02-02
Next: Files, Previous: Introduction, Up: The zaws Reference Manual [Contents][Index]
The main system appears first, followed by any subsystem dependency.
Amazon AWS request construction
Zach Beane <xach@xach.com>
BSD
1.0.2
Next: Packages, Previous: Systems, Up: The zaws Reference Manual [Contents][Index]
Files are sorted by type and then listed depth-first from the systems components trees.
Next: zaws/utilities.lisp, Previous: zaws/zaws.asd, Up: Lisp [Contents][Index]
Next: zaws/octet-sink.lisp, Previous: zaws/package.lisp, Up: Lisp [Contents][Index]
package.lisp (file).
zaws (system).
Next: zaws/credentials.lisp, Previous: zaws/utilities.lisp, Up: Lisp [Contents][Index]
utilities.lisp (file).
zaws (system).
Next: zaws/http-message.lisp, Previous: zaws/octet-sink.lisp, Up: Lisp [Contents][Index]
octet-sink.lisp (file).
zaws (system).
Next: zaws/response.lisp, Previous: zaws/credentials.lisp, Up: Lisp [Contents][Index]
credentials.lisp (file).
zaws (system).
Next: zaws/request.lisp, Previous: zaws/http-message.lisp, Up: Lisp [Contents][Index]
http-message.lisp (file).
zaws (system).
Next: zaws/authentication.lisp, Previous: zaws/response.lisp, Up: Lisp [Contents][Index]
response.lisp (file).
zaws (system).
Next: zaws/common-query.lisp, Previous: zaws/request.lisp, Up: Lisp [Contents][Index]
request.lisp (file).
zaws (system).
Previous: zaws/authentication.lisp, Up: Lisp [Contents][Index]
authentication.lisp (file).
zaws (system).
Next: Definitions, Previous: Files, Up: The zaws Reference Manual [Contents][Index]
Packages are listed by definition order.
common-lisp.
Next: Indexes, Previous: Packages, Up: The zaws Reference Manual [Contents][Index]
Definitions are sorted by export status, category, package, and then by lexicographic order.
Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]
Next: Macros, Previous: Public Interface, Up: Public Interface [Contents][Index]
The credentials used for authenticating AWS requests. Built-in credentials can be a list, a pathname, or a string designating a pathname. For a list, the first two elements are used as the access key and secret key, and the third element, if present, is the session token. For a pathname, the first two lines of the file are the access key and secret key, and the third line, if present, is the session token.
zaws.
Next: Ordinary functions, Previous: Special variables, Up: Public Interface [Contents][Index]
Evaluate BODY for with KEY and VALUE bound to each car and cdr in in the alist PARAMETERS.
zaws.
Evaluate BODY with SINK bound to a newly created octet
sink. Returns the octet vector accumulated in SINK when finished.
zaws.
Next: Generic functions, Previous: Macros, Up: Public Interface [Contents][Index]
URL-encode STRING according to AWS’s requirements.
zaws.
Return a base64-encoded string of the SHA256-HMAC of VECTOR with the UTF-8 encoded octets of the string SECRET-KEY.
zaws.
Return an ISO 8601-style UTC timestamp string.
zaws.
Convert KEYS-AND-VALUES to an alist suitable for using as parameters or headers in an HTTP request. Keys and values are coerced to strings, if necessary.
zaws.
Return a specialized array initialized with OCTETS.
zaws.
Parse an ISO 8601-style UTC timestamp and return a universal time and fraction of a second as multiple values.
zaws.
Return an RFC 1123-style GMT timestamp string.
zaws.
zaws.
Next: Standalone methods, Previous: Ordinary functions, Up: Public Interface [Contents][Index]
The access key id of CREDENTIALS.
The ’action’ of a common query request.
zaws.
automatically generated reader method
The parameters given to the ’action’ of a common query request.
zaws.
automatically generated reader method
zaws.
automatically generated writer method
The API version of a request.
zaws.
automatically generated reader method
Check the low-level response object for errors and signal if found.
The content (aka body) of OBJECT.
zaws.
automatically generated reader method
zaws.
automatically generated writer method
If the content of OBJECT is a string, return it, otherwise treat it as utf-8 encoded octets and return its conversion to a string.
Remove any header named by KEY from HTTP-MESSAGE’s list of headers.
Remove any parameter named KEY from REQUEST’s list of parameters.
Ensure that the header named by KEY in HTTP-MESSAGE has the value VALUE, updating or creating the header as needed.
The expiration time, as a universal time, of CREDENTIALS.
Returns T if CREDENTIALS have expired.
The headers of OBJECT.
zaws.
automatically generated writer method
automatically generated writer method
The HTTP method as a keyword, e.g. :GET, :POST, :PUT, etc.
Prepare REQUEST for signing by adding or converting any information that needs to be available for the signing process. Returns the REQUST object.
zaws.
Process a valid response object into a suitable specialized object according to REQUEST. The default method returns the response unchanged.
The protocol of the request as a string, e.g. "http" or "https".
zaws.
The HTTP reason phrase (e.g. "OK") of RESPONSE.
zaws.
zaws.
The secret access key of CREDENTIALS.
The session token of CREDENTIALS.
Add authentication information to REQUEST based on the current value of *CREDENTIALS* and the contents of the request. Return the REQUEST object.
zaws.
Write OBJECT to SINK.
The HTTP status code of RESPONSE as an integer.
The string to sign for authentication.
zaws.
Send REQUEST and return a response object, or signal an error if there’s a problem with the response.
zaws.
The URI of OBJECT.
zaws.
automatically generated writer method
uri.
The vector to sign for authentication; should be used in preference to creating a string to sign if the string includes ASCII control codes like LF; otherwise defaults to an UTF-8 encoding of the string to sign.
zaws.
Next: Conditions, Previous: Generic functions, Up: Public Interface [Contents][Index]
Next: Classes, Previous: Standalone methods, Up: Public Interface [Contents][Index]
Next: Types, Previous: Conditions, Up: Public Interface [Contents][Index]
Any class that uses this mixin will be automatically signed before submission.
zaws.
Adding this class as a mixin to a request will automatically sign requests per the AWS Query Auth version 2 spec.
zaws.
Initarg | Value |
---|---|
:protocol | http |
:method | get |
:content-type | application/x-www-form-urlencoded |
:parameters | nil |
:headers | nil |
:uri-path | / |
:content |
:content-type
:parameters
:headers
Previous: Public Interface, Up: Definitions [Contents][Index]
Next: Ordinary functions, Previous: Internals, Up: Internals [Contents][Index]
Next: Generic functions, Previous: Special variables, Up: Internals [Contents][Index]
Call FUN with one argument, an octet sink.
zaws.
Convert the alist PARAMETERS to a string suitable for use in authentication strings-to-sign.
zaws.
Next: Classes, Previous: Ordinary functions, Up: Internals [Contents][Index]
Return the value of the header named by KEY.
zaws.
automatically generated reader method
Previous: Generic functions, Up: Internals [Contents][Index]
HTTP-MESSAGE is the parent class of both REQUESTs and RESPONSEs.
Previous: Definitions, Up: The zaws Reference Manual [Contents][Index]
Jump to: | (
A B C D E F G H I J M N O P R S U V W |
---|
Jump to: | (
A B C D E F G H I J M N O P R S U V W |
---|
Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]
Jump to: | *
A C H M P R S U |
---|
Jump to: | *
A C H M P R S U |
---|
Jump to: | A C F H J O P Q R S T U Z |
---|
Jump to: | A C F H J O P Q R S T U Z |
---|