This is the zaws Reference Manual, version 1.0.2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 07:10:07 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
zaws
Amazon AWS request construction
Zach Beane <xach@xach.com>
BSD
1.0.2
cl-base64
(system).
drakma
(system).
flexi-streams
(system).
ironclad
(system).
package.lisp
(file).
utilities.lisp
(file).
octet-sink.lisp
(file).
credentials.lisp
(file).
http-message.lisp
(file).
response.lisp
(file).
request.lisp
(file).
authentication.lisp
(file).
common-query.lisp
(file).
Files are sorted by type and then listed depth-first from the systems components trees.
zaws/zaws.asd
zaws/package.lisp
zaws/utilities.lisp
zaws/octet-sink.lisp
zaws/credentials.lisp
zaws/http-message.lisp
zaws/response.lisp
zaws/request.lisp
zaws/authentication.lisp
zaws/common-query.lisp
zaws/utilities.lisp
package.lisp
(file).
zaws
(system).
aws-url-encode
(function).
base64
(function).
do-parameters
(macro).
iso8601-timestamp
(function).
make-parameters
(function).
octet
(type).
octet-vector
(function).
parse-iso8601-timestamp
(function).
rfc1123-timestamp
(function).
utf8
(function).
*unreserved-octets*
(special variable).
nth-line
(function).
starts-with
(function).
zaws/octet-sink.lisp
utilities.lisp
(file).
zaws
(system).
sink-write
(generic function).
with-octet-sink
(macro).
*ascii-control-code-values*
(special variable).
*ascii-control-codes*
(special variable).
call-with-output-sink
(function).
zaws/credentials.lisp
octet-sink.lisp
(file).
zaws
(system).
*credentials*
(special variable).
access-key-id
(generic function).
expiration
(generic function).
expiredp
(generic function).
secret-access-key
(generic function).
session-token
(generic function).
zaws/http-message.lisp
credentials.lisp
(file).
zaws
(system).
content
(generic function).
(setf content)
(generic writer).
content-string
(generic function).
delete-header
(generic function).
ensure-header
(generic function).
headers
(generic function).
(setf headers)
(generic writer).
uri
(generic function).
(setf uri)
(generic writer).
header-value
(generic function).
http-message
(class).
zaws/response.lisp
http-message.lisp
(file).
zaws
(system).
print-object
(method).
reason-phrase
(generic reader).
(setf reason-phrase)
(writer method).
request
(generic reader).
response
(class).
response-error
(condition).
response-error-request
(reader method).
response-error-response
(reader method).
status-code
(generic reader).
zaws/request.lisp
response.lisp
(file).
zaws
(system).
check-response-error
(generic function).
content-type
(generic function).
(setf content-type)
(writer method).
delete-parameter
(generic function).
ensure-parameter
(generic function).
headers
(reader method).
(setf headers)
(writer method).
host
(generic reader).
method
(generic function).
parameters
(generic function).
(setf parameters)
(generic writer).
print-object
(method).
process-response
(generic function).
protocol
(generic reader).
request
(class).
submit
(generic function).
uri
(method).
uri-path
(generic function).
zaws/authentication.lisp
request.lisp
(file).
zaws
(system).
aws-auth-mixin
(class).
hmac-sha256-signature-base64
(function).
json-auth-v3
(class).
prepare-for-signing
(generic function).
query-auth-v2
(class).
query-auth-v3
(class).
sha256
(function).
sign
(generic function).
string-to-sign
(generic function).
submit
(method).
vector-to-sign
(generic function).
json-auth-v3-headers
(function).
parameters-as-auth-string
(function).
signature-version
(reader method).
zaws/common-query.lisp
authentication.lisp
(file).
zaws
(system).
action
(generic reader).
action-parameters
(generic reader).
(setf action-parameters)
(writer method).
api-version
(generic reader).
common-query-request
(class).
prepare-for-signing
(method).
submit-common-query
(function).
Packages are listed by definition order.
zaws
common-lisp
.
*credentials*
(special variable).
access-key-id
(generic function).
action
(generic reader).
action-parameters
(generic reader).
(setf action-parameters)
(generic writer).
api-version
(generic reader).
aws-auth-mixin
(class).
aws-url-encode
(function).
base64
(function).
check-response-error
(generic function).
common-query-request
(class).
content
(generic function).
(setf content)
(generic writer).
content-string
(generic function).
content-type
(generic function).
(setf content-type)
(generic writer).
delete-header
(generic function).
delete-parameter
(generic function).
do-parameters
(macro).
ensure-header
(generic function).
ensure-parameter
(generic function).
expiration
(generic function).
expiredp
(generic function).
headers
(generic function).
(setf headers)
(generic writer).
hmac-sha256-signature-base64
(function).
host
(generic reader).
iso8601-timestamp
(function).
json-auth-v3
(class).
make-parameters
(function).
method
(generic function).
octet
(type).
octet-vector
(function).
parameters
(generic function).
(setf parameters)
(generic writer).
parse-iso8601-timestamp
(function).
prepare-for-signing
(generic function).
process-response
(generic function).
protocol
(generic reader).
query-auth-v2
(class).
query-auth-v3
(class).
reason-phrase
(generic reader).
(setf reason-phrase)
(generic writer).
request
(generic reader).
request
(class).
response
(class).
response-error
(condition).
response-error-request
(generic reader).
response-error-response
(generic reader).
rfc1123-timestamp
(function).
secret-access-key
(generic function).
session-token
(generic function).
sha256
(function).
sign
(generic function).
sink-write
(generic function).
status-code
(generic reader).
string-to-sign
(generic function).
submit
(generic function).
submit-common-query
(function).
uri
(generic function).
(setf uri)
(generic writer).
uri-path
(generic function).
utf8
(function).
vector-to-sign
(generic function).
with-octet-sink
(macro).
*ascii-control-code-values*
(special variable).
*ascii-control-codes*
(special variable).
*unreserved-octets*
(special variable).
call-with-output-sink
(function).
header-value
(generic function).
http-message
(class).
json-auth-v3-headers
(function).
nth-line
(function).
parameters-as-auth-string
(function).
signature-version
(generic reader).
starts-with
(function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
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
.
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
.
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
.
The access key id of CREDENTIALS.
The ’action’ of a common query request.
zaws
.
common-query-request
)) ¶automatically generated reader method
The parameters given to the ’action’ of a common query request.
zaws
.
common-query-request
)) ¶automatically generated reader method
zaws
.
common-query-request
)) ¶automatically generated writer method
The API version of a request.
zaws
.
common-query-request
)) ¶automatically generated reader method
Check the low-level response object for errors and signal if found.
The content (aka body) of OBJECT.
zaws
.
http-message
)) ¶automatically generated reader method
zaws
.
http-message
)) ¶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
.
request
)) ¶automatically generated writer method
http-message
)) ¶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
.
common-query-request
)) ¶json-auth-v3
)) ¶query-auth-v3
)) ¶query-auth-v2
)) ¶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
.
response-error
)) ¶zaws
.
response-error
)) ¶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
.
json-auth-v3
)) ¶query-auth-v3
)) ¶query-auth-v2
)) ¶aws-auth-mixin
)) ¶Write OBJECT to SINK.
The HTTP status code of RESPONSE as an integer.
The string to sign for authentication.
zaws
.
query-auth-v3
)) ¶Send REQUEST and return a response object, or signal an error if there’s a problem with the response.
zaws
.
aws-auth-mixin
)) ¶The URI of OBJECT.
zaws
.
http-message
)) ¶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
.
json-auth-v3
)) ¶query-auth-v2
)) ¶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
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
.
Return the value of the header named by KEY.
zaws
.
query-auth-v2
)) ¶automatically generated reader method
HTTP-MESSAGE is the parent class of both REQUESTs and RESPONSEs.
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 |
---|
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 |
---|