The zaws Reference Manual

Table of Contents

The zaws Reference Manual

This is the zaws Reference Manual, version 1.0.2, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 12:39:11 2020 GMT+0.

1 Introduction

[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 Beane 
2012-02-02

2 Systems

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

2.1 zaws

Author

Zach Beane <xach@xach.com>

License

BSD

Description

Amazon AWS request construction

Version

1.0.2

Dependencies

• cl-base64
• drakma
• flexi-streams
• ironclad

Source

zaws.asd (file)

Components

• 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)

3 Files

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

3.1 Lisp

3.1.1 zaws.asd

Location

zaws.asd

Systems

zaws (system)

3.1.2 zaws/package.lisp

Parent

zaws (system)

Location

package.lisp

Packages

zaws

3.1.3 zaws/utilities.lisp

Dependency

package.lisp (file)

Parent

zaws (system)

Location

utilities.lisp

Exported Definitions

• 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)

Internal Definitions

• *unreserved-octets* (special variable)
• nth-line (function)
• starts-with (function)

3.1.4 zaws/octet-sink.lisp

Dependency

utilities.lisp (file)

Parent

zaws (system)

Location

octet-sink.lisp

Exported Definitions

• sink-write (generic function)
• sink-write (method)
• sink-write (method)
• sink-write (method)
• sink-write (method)
• sink-write (method)
• with-octet-sink (macro)

Internal Definitions

• *ascii-control-code-values* (special variable)
• *ascii-control-codes* (special variable)
• call-with-output-sink (function)

3.1.5 zaws/credentials.lisp

Dependency

octet-sink.lisp (file)

Parent

zaws (system)

Location

credentials.lisp

Exported Definitions

• *credentials* (special variable)
• access-key-id (generic function)
• access-key-id (method)
• access-key-id (method)
• access-key-id (method)
• expiration (generic function)
• expiration (method)
• expiredp (generic function)
• expiredp (method)
• secret-access-key (generic function)
• secret-access-key (method)
• secret-access-key (method)
• secret-access-key (method)
• session-token (generic function)
• session-token (method)
• session-token (method)
• session-token (method)
• session-token (method)

3.1.6 zaws/http-message.lisp

Dependency

credentials.lisp (file)

Parent

zaws (system)

Location

http-message.lisp

Exported Definitions

• content (generic function)
• content (method)
• (setf content) (method)
• content (method)
• (setf content) (generic function)
• content-string (generic function)
• content-string (method)
• delete-header (generic function)
• delete-header (method)
• ensure-header (generic function)
• ensure-header (method)
• headers (generic function)
• headers (method)
• (setf headers) (method)
• headers (method)
• (setf headers) (generic function)
• uri (generic function)
• uri (method)
• (setf uri) (method)
• (setf uri) (generic function)

Internal Definitions

• header-value (generic function)
• header-value (method)
• http-message (class)

3.1.7 zaws/response.lisp

Dependency

http-message.lisp (file)

Parent

zaws (system)

Location

response.lisp

Exported Definitions

• reason-phrase (generic function)
• reason-phrase (method)
• (setf reason-phrase) (method)
• request (generic function)
• request (method)
• response (class)
• response-error (condition)
• response-error-request (method)
• response-error-response (method)
• status-code (generic function)
• status-code (method)

3.1.8 zaws/request.lisp

Dependency

response.lisp (file)

Parent

zaws (system)

Location

request.lisp

Exported Definitions

• check-response-error (generic function)
• check-response-error (method)
• content-type (generic function)
• content-type (method)
• content-type (method)
• (setf content-type) (method)
• delete-parameter (generic function)
• delete-parameter (method)
• ensure-parameter (generic function)
• ensure-parameter (method)
• headers (method)
• (setf headers) (method)
• host (generic function)
• host (method)
• method (generic function)
• method (method)
• method (method)
• parameters (generic function)
• parameters (method)
• (setf parameters) (method)
• parameters (method)
• (setf parameters) (generic function)
• process-response (generic function)
• process-response (method)
• protocol (generic function)
• protocol (method)
• request (class)
• submit (generic function)
• submit (method)
• submit (method)
• uri (method)
• uri-path (generic function)
• uri-path (method)
• uri-path (method)

3.1.9 zaws/authentication.lisp

Dependency

request.lisp (file)

Parent

zaws (system)

Location

authentication.lisp

Exported Definitions

• aws-auth-mixin (class)
• hmac-sha256-signature-base64 (function)
• json-auth-v3 (class)
• prepare-for-signing (generic function)
• prepare-for-signing (method)
• prepare-for-signing (method)
• prepare-for-signing (method)
• prepare-for-signing (method)
• query-auth-v2 (class)
• query-auth-v3 (class)
• sha256 (function)
• sign (generic function)
• sign (method)
• sign (method)
• sign (method)
• sign (method)
• sign (method)
• string-to-sign (generic function)
• string-to-sign (method)
• string-to-sign (method)
• submit (method)
• vector-to-sign (generic function)
• vector-to-sign (method)
• vector-to-sign (method)
• vector-to-sign (method)

Internal Definitions

• json-auth-v3-headers (function)
• parameters-as-auth-string (function)
• signature-version (method)

3.1.10 zaws/common-query.lisp

Dependency

authentication.lisp (file)

Parent

zaws (system)

Location

common-query.lisp

Exported Definitions

• action (generic function)
• action (method)
• action-parameters (generic function)
• action-parameters (method)
• (setf action-parameters) (method)
• api-version (generic function)
• api-version (method)
• common-query-request (class)
• prepare-for-signing (method)
• submit-common-query (function)

4 Packages

Packages are listed by definition order.

4.1 zaws

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• *credentials* (special variable)
• access-key-id (generic function)
• access-key-id (method)
• access-key-id (method)
• access-key-id (method)
• action (generic function)
• action (method)
• action-parameters (generic function)
• action-parameters (method)
• (setf action-parameters) (generic function)
• (setf action-parameters) (method)
• api-version (generic function)
• api-version (method)
• aws-auth-mixin (class)
• aws-url-encode (function)
• base64 (function)
• check-response-error (generic function)
• check-response-error (method)
• common-query-request (class)
• content (generic function)
• content (method)
• (setf content) (method)
• content (method)
• (setf content) (generic function)
• content-string (generic function)
• content-string (method)
• content-type (generic function)
• content-type (method)
• content-type (method)
• (setf content-type) (generic function)
• (setf content-type) (method)
• delete-header (generic function)
• delete-header (method)
• delete-parameter (generic function)
• delete-parameter (method)
• do-parameters (macro)
• ensure-header (generic function)
• ensure-header (method)
• ensure-parameter (generic function)
• ensure-parameter (method)
• expiration (generic function)
• expiration (method)
• expiredp (generic function)
• expiredp (method)
• headers (generic function)
• headers (method)
• (setf headers) (method)
• headers (method)
• (setf headers) (method)
• headers (method)
• (setf headers) (generic function)
• hmac-sha256-signature-base64 (function)
• host (generic function)
• host (method)
• iso8601-timestamp (function)
• json-auth-v3 (class)
• make-parameters (function)
• method (generic function)
• method (method)
• method (method)
• octet (type)
• octet-vector (function)
• parameters (generic function)
• parameters (method)
• (setf parameters) (method)
• parameters (method)
• (setf parameters) (generic function)
• parse-iso8601-timestamp (function)
• prepare-for-signing (generic function)
• prepare-for-signing (method)
• prepare-for-signing (method)
• prepare-for-signing (method)
• prepare-for-signing (method)
• prepare-for-signing (method)
• process-response (generic function)
• process-response (method)
• protocol (generic function)
• protocol (method)
• query-auth-v2 (class)
• query-auth-v3 (class)
• reason-phrase (generic function)
• reason-phrase (method)
• (setf reason-phrase) (generic function)
• (setf reason-phrase) (method)
• request (generic function)
• request (method)
• request (class)
• response (class)
• response-error (condition)
• response-error-request (generic function)
• response-error-request (method)
• response-error-response (generic function)
• response-error-response (method)
• rfc1123-timestamp (function)
• secret-access-key (generic function)
• secret-access-key (method)
• secret-access-key (method)
• secret-access-key (method)
• session-token (generic function)
• session-token (method)
• session-token (method)
• session-token (method)
• session-token (method)
• sha256 (function)
• sign (generic function)
• sign (method)
• sign (method)
• sign (method)
• sign (method)
• sign (method)
• sink-write (generic function)
• sink-write (method)
• sink-write (method)
• sink-write (method)
• sink-write (method)
• sink-write (method)
• status-code (generic function)
• status-code (method)
• string-to-sign (generic function)
• string-to-sign (method)
• string-to-sign (method)
• submit (generic function)
• submit (method)
• submit (method)
• submit (method)
• submit-common-query (function)
• uri (generic function)
• uri (method)
• uri (method)
• (setf uri) (method)
• (setf uri) (generic function)
• uri-path (generic function)
• uri-path (method)
• uri-path (method)
• utf8 (function)
• vector-to-sign (generic function)
• vector-to-sign (method)
• vector-to-sign (method)
• vector-to-sign (method)
• with-octet-sink (macro)

Internal Definitions

• *ascii-control-code-values* (special variable)
• *ascii-control-codes* (special variable)
• *unreserved-octets* (special variable)
• call-with-output-sink (function)
• header-value (generic function)
• header-value (method)
• http-message (class)
• json-auth-v3-headers (function)
• nth-line (function)
• parameters-as-auth-string (function)
• signature-version (generic function)
• signature-version (method)
• starts-with (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *credentials*

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.

Package

zaws

Source

credentials.lisp (file)

5.1.2 Macros

Macro: do-parameters (KEY VALUE &optional RESULT) PARAMETERS &body BODY

Evaluate BODY for with KEY and VALUE bound to each car and cdr in in the alist PARAMETERS.

Package

zaws

Source

utilities.lisp (file)

Macro: with-octet-sink (SINK) &body BODY

Evaluate BODY with SINK bound to a newly created octet
sink. Returns the octet vector accumulated in SINK when finished.

Package

zaws

Source

octet-sink.lisp (file)

5.1.3 Functions

Function: aws-url-encode STRING

URL-encode STRING according to AWS’s requirements.

Package

zaws

Source

utilities.lisp (file)

Function: base64 VECTOR

Encode VECTOR as a base64 string.

Package

zaws

Source

utilities.lisp (file)

Function: hmac-sha256-signature-base64 SECRET-KEY VECTOR

Return a base64-encoded string of the SHA256-HMAC of VECTOR with the UTF-8 encoded octets of the string SECRET-KEY.

Package

zaws

Source

authentication.lisp (file)

Function: iso8601-timestamp &optional TIME

Return an ISO 8601-style UTC timestamp string.

Package

zaws

Source

utilities.lisp (file)

Function: make-parameters &rest KEYS-AND-VALUES

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.

Package

zaws

Source

utilities.lisp (file)

Function: octet-vector &rest OCTETS

Return a specialized array initialized with OCTETS.

Package

zaws

Source

utilities.lisp (file)

Function: parse-iso8601-timestamp TIMESTAMP

Parse an ISO 8601-style UTC timestamp and return a universal time and fraction of a second as multiple values.

Package

zaws

Source

utilities.lisp (file)

Function: rfc1123-timestamp &optional TIME

Return an RFC 1123-style GMT timestamp string.

Package

zaws

Source

utilities.lisp (file)

Function: sha256 VECTOR

Package

zaws

Source

authentication.lisp (file)

Function: submit-common-query CLASS INITARGS ACTION &rest ACTION-PARAMETERS

Package

zaws

Source

common-query.lisp (file)

Function: utf8 STRING

Return STRING encoded as UTF-8 octets.

Package

zaws

Source

utilities.lisp (file)

5.1.4 Generic functions

Generic Function: access-key-id CREDENTIALS

The access key id of CREDENTIALS.

Package

zaws

Source

credentials.lisp (file)

Methods

Method: access-key-id (CREDENTIALS string)

Method: access-key-id (CREDENTIALS pathname)

Method: access-key-id (CREDENTIALS cons)

Generic Function: action REQUEST

The ’action’ of a common query request.

Package

zaws

Source

common-query.lisp (file)

Methods

Method: action (COMMON-QUERY-REQUEST common-query-request)

automatically generated reader method

Generic Function: action-parameters REQUEST

The parameters given to the ’action’ of a common query request.

Package

zaws

Source

common-query.lisp (file)

Writer

(setf action-parameters) (generic function)

Methods

Method: action-parameters (COMMON-QUERY-REQUEST common-query-request)

automatically generated reader method

Generic Function: (setf action-parameters) NEW-VALUE OBJECT

Package

zaws

Reader

action-parameters (generic function)

Methods

Method: (setf action-parameters) NEW-VALUE (COMMON-QUERY-REQUEST common-query-request)

automatically generated writer method

Source

common-query.lisp (file)

Generic Function: api-version REQUEST

The API version of a request.

Package

zaws

Source

common-query.lisp (file)

Methods

Method: api-version (COMMON-QUERY-REQUEST common-query-request)

automatically generated reader method

Generic Function: check-response-error REQUEST RESPONSE

Check the low-level response object for errors and signal if found.

Package

zaws

Source

request.lisp (file)

Methods

Method: check-response-error REQUEST RESPONSE

Generic Function: content OBJECT

The content (aka body) of OBJECT.

Package

zaws

Source

http-message.lisp (file)

Writer

(setf content) (generic function)

Methods

Method: content (HTTP-MESSAGE http-message)

automatically generated reader method

Method: content OBJECT

Generic Function: (setf content) NEW-VALUE OBJECT

Package

zaws

Source

http-message.lisp (file)

Reader

content (generic function)

Methods

Method: (setf content) NEW-VALUE (HTTP-MESSAGE http-message)

automatically generated writer method

Generic Function: content-string OBJECT

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.

Package

zaws

Source

http-message.lisp (file)

Methods

Method: content-string OBJECT

Generic Function: content-type REQUEST

Package

zaws

Source

request.lisp (file)

Writer

(setf content-type) (generic function)

Methods

Method: content-type (REQUEST request)

automatically generated reader method

Method: content-type REQUEST

Generic Function: (setf content-type) NEW-VALUE OBJECT

Package

zaws

Reader

content-type (generic function)

Methods

Method: (setf content-type) NEW-VALUE (REQUEST request)

automatically generated writer method

Source

request.lisp (file)

Generic Function: delete-header KEY HTTP-MESSAGE

Remove any header named by KEY from HTTP-MESSAGE’s list of headers.

Package

zaws

Source

http-message.lisp (file)

Methods

Method: delete-header KEY HTTP-MESSAGE

Generic Function: delete-parameter KEY REQUEST

Remove any parameter named KEY from REQUEST’s list of parameters.

Package

zaws

Source

request.lisp (file)

Methods

Method: delete-parameter KEY REQUEST

Generic Function: ensure-header KEY VALUE HTTP-MESSAGE

Ensure that the header named by KEY in HTTP-MESSAGE has the value VALUE, updating or creating the header as needed.

Package

zaws

Source

http-message.lisp (file)

Methods

Method: ensure-header KEY VALUE HTTP-MESSAGE

Generic Function: ensure-parameter KEY VALUE REQUEST

Package

zaws

Source

request.lisp (file)

Methods

Method: ensure-parameter KEY VALUE REQUEST

Generic Function: expiration CREDENTIALS

The expiration time, as a universal time, of CREDENTIALS.

Package

zaws

Source

credentials.lisp (file)

Methods

Method: expiration CREDENTIALS

Generic Function: expiredp CREDENTIALS

Returns T if CREDENTIALS have expired.

Package

zaws

Source

credentials.lisp (file)

Methods

Method: expiredp CREDENTIALS

Generic Function: headers OBJECT

The headers of OBJECT.

Package

zaws

Source

http-message.lisp (file)

Writer

(setf headers) (generic function)

Methods

Method: headers (REQUEST request)

automatically generated reader method

Source

request.lisp (file)

Method: headers (HTTP-MESSAGE http-message)

automatically generated reader method

Method: headers OBJECT

Generic Function: (setf headers) NEW-VALUE OBJECT

Package

zaws

Source

http-message.lisp (file)

Reader

headers (generic function)

Methods

Method: (setf headers) NEW-VALUE (REQUEST request)

automatically generated writer method

Source

request.lisp (file)

Method: (setf headers) NEW-VALUE (HTTP-MESSAGE http-message)

automatically generated writer method

Generic Function: host REQUEST

The target host of the request.

Package

zaws

Source

request.lisp (file)

Methods

Method: host (REQUEST request)

automatically generated reader method

Generic Function: method REQUEST

The HTTP method as a keyword, e.g. :GET, :POST, :PUT, etc.

Package

zaws

Source

request.lisp (file)

Methods

Method: method (REQUEST request)

automatically generated reader method

Method: method REQUEST

Generic Function: parameters REQUEST

Generic Function: (setf parameters) NEW-VALUE REQUEST

Package

zaws

Source

request.lisp (file)

Methods

Method: parameters (REQUEST request)

automatically generated reader method

Method: (setf parameters) NEW-VALUE (REQUEST request)

automatically generated writer method

Method: parameters REQUEST

Generic Function: prepare-for-signing REQUEST

Prepare REQUEST for signing by adding or converting any information that needs to be available for the signing process. Returns the REQUST object.

Package

zaws

Source

authentication.lisp (file)

Methods

Method: prepare-for-signing (REQUEST common-query-request) after

Source

common-query.lisp (file)

Method: prepare-for-signing (REQUEST json-auth-v3)

Method: prepare-for-signing (REQUEST query-auth-v3)

Method: prepare-for-signing (REQUEST query-auth-v2)

Method: prepare-for-signing REQUEST

Generic Function: process-response REQUEST RESPONSE

Process a valid response object into a suitable specialized object according to REQUEST. The default method returns the response unchanged.

Package

zaws

Source

request.lisp (file)

Methods

Method: process-response REQUEST RESPONSE

Generic Function: protocol REQUEST

The protocol of the request as a string, e.g. "http" or "https".

Package

zaws

Source

request.lisp (file)

Methods

Method: protocol (REQUEST request)

automatically generated reader method

Generic Function: reason-phrase RESPONSE

The HTTP reason phrase (e.g. "OK") of RESPONSE.

Package

zaws

Source

response.lisp (file)

Writer

(setf reason-phrase) (generic function)

Methods

Method: reason-phrase (RESPONSE response)

automatically generated reader method

Generic Function: (setf reason-phrase) NEW-VALUE OBJECT

Package

zaws

Reader

reason-phrase (generic function)

Methods

Method: (setf reason-phrase) NEW-VALUE (RESPONSE response)

automatically generated writer method

Source

response.lisp (file)

Generic Function: request RESPONSE

Package

zaws

Source

response.lisp (file)

Methods

Method: request (RESPONSE response)

automatically generated reader method

Generic Function: response-error-request CONDITION

Package

zaws

Methods

Method: response-error-request (CONDITION response-error)

Source

response.lisp (file)

Generic Function: response-error-response CONDITION

Package

zaws

Methods

Method: response-error-response (CONDITION response-error)

Source

response.lisp (file)

Generic Function: secret-access-key CREDENTIALS

The secret access key of CREDENTIALS.

Package

zaws

Source

credentials.lisp (file)

Methods

Method: secret-access-key (CREDENTIALS string)

Method: secret-access-key (CREDENTIALS pathname)

Method: secret-access-key (CREDENTIALS cons)

Generic Function: session-token CREDENTIALS

The session token of CREDENTIALS.

Package

zaws

Source

credentials.lisp (file)

Methods

Method: session-token (CREDENTIALS string)

Method: session-token (CREDENTIALS pathname)

Method: session-token (CREDENTIALS cons)

Method: session-token CREDENTIALS

Generic Function: sign REQUEST

Add authentication information to REQUEST based on the current value of *CREDENTIALS* and the contents of the request. Return the REQUEST object.

Package

zaws

Source

authentication.lisp (file)

Methods

Method: sign (REQUEST json-auth-v3)

Method: sign (REQUEST query-auth-v3)

Method: sign (REQUEST query-auth-v2)

Method: sign (REQUEST aws-auth-mixin) before

Method: sign REQUEST

Generic Function: sink-write OBJECT SINK

Write OBJECT to SINK.

Package

zaws

Source

octet-sink.lisp (file)

Methods

Method: sink-write (VALUE string) SINK

Method: sink-write (VALUE symbol) SINK

Method: sink-write (VALUE character) SINK

Method: sink-write (VALUES cons) SINK

Method: sink-write (VALUE integer) SINK

Generic Function: status-code RESPONSE

The HTTP status code of RESPONSE as an integer.

Package

zaws

Source

response.lisp (file)

Methods

Method: status-code (RESPONSE response)

automatically generated reader method

Generic Function: string-to-sign REQUEST

The string to sign for authentication.

Package

zaws

Source

authentication.lisp (file)

Methods

Method: string-to-sign (REQUEST query-auth-v3)

Method: string-to-sign REQUEST

Generic Function: submit REQUEST

Send REQUEST and return a response object, or signal an error if there’s a problem with the response.

Package

zaws

Source

request.lisp (file)

Methods

Method: submit (REQUEST aws-auth-mixin) before

Source

authentication.lisp (file)

Method: submit REQUEST

Method: submit REQUEST around

Generic Function: uri OBJECT

The URI of OBJECT.

Package

zaws

Source

http-message.lisp (file)

Writer

(setf uri) (generic function)

Methods

Method: uri (REQUEST request)

Source

request.lisp (file)

Method: uri (HTTP-MESSAGE http-message)

automatically generated reader method

Generic Function: (setf uri) NEW-VALUE OBJECT

Package

zaws

Source

http-message.lisp (file)

Reader

uri (generic function)

Methods

Method: (setf uri) NEW-VALUE (HTTP-MESSAGE http-message)

automatically generated writer method

Generic Function: uri-path REQUEST

Package

zaws

Source

request.lisp (file)

Methods

Method: uri-path (REQUEST request)

automatically generated reader method

Method: uri-path REQUEST

Generic Function: vector-to-sign REQUEST

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.

Package

zaws

Source

authentication.lisp (file)

Methods

Method: vector-to-sign (REQUEST json-auth-v3)

Method: vector-to-sign (REQUEST query-auth-v2)

Method: vector-to-sign REQUEST

5.1.5 Conditions

Condition: response-error ()

Package

zaws

Source

response.lisp (file)

Direct superclasses

error (condition)

Direct methods

• response-error-response (method)
• response-error-request (method)

Direct slots

Slot: request

Initargs

:request

Readers

response-error-request (generic function)

Slot: response

Initargs

:response

Readers

response-error-response (generic function)

5.1.6 Classes

Class: aws-auth-mixin ()

Any class that uses this mixin will be automatically signed before submission.

Package

zaws

Source

authentication.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

• query-auth-v2 (class)
• query-auth-v3 (class)
• json-auth-v3 (class)

Direct methods

• submit (method)
• sign (method)

Class: common-query-request ()

Package

zaws

Source

common-query.lisp (file)

Direct superclasses

• query-auth-v2 (class)
• request (class)

Direct methods

• prepare-for-signing (method)
• api-version (method)
• (setf action-parameters) (method)
• action-parameters (method)
• action (method)

Direct slots

Slot: action

Initargs

:action

Readers

action (generic function)

Slot: action-parameters

Initargs

:action-parameters

Readers

action-parameters (generic function)

Writers

(setf action-parameters) (generic function)

Slot: api-version

Initargs

:api-version

Readers

api-version (generic function)

Direct Default Initargs

Initarg	Value
:action-parameters	nil

Class: json-auth-v3 ()

Package

zaws

Source

authentication.lisp (file)

Direct superclasses

aws-auth-mixin (class)

Direct methods

• sign (method)
• vector-to-sign (method)
• prepare-for-signing (method)

Class: query-auth-v2 ()

Adding this class as a mixin to a request will automatically sign requests per the AWS Query Auth version 2 spec.

Package

zaws

Source

authentication.lisp (file)

Direct superclasses

aws-auth-mixin (class)

Direct subclasses

common-query-request (class)

Direct methods

• sign (method)
• vector-to-sign (method)
• prepare-for-signing (method)
• signature-version (method)

Direct slots

Slot: signature-version

Initargs

:signature-version

Readers

signature-version (generic function)

Direct Default Initargs

Initarg	Value
:signature-version	"2"

Class: query-auth-v3 ()

Package

zaws

Source

authentication.lisp (file)

Direct superclasses

aws-auth-mixin (class)

Direct methods

• sign (method)
• string-to-sign (method)
• prepare-for-signing (method)

Class: request ()

Package

zaws

Source

request.lisp (file)

Direct superclasses

http-message (class)

Direct subclasses

common-query-request (class)

Direct methods

• print-object (method)
• uri (method)
• uri-path (method)
• headers (method)
• headers (method)
• parameters (method)
• parameters (method)
• (setf content-type) (method)
• content-type (method)
• method (method)
• host (method)
• protocol (method)

Direct slots

Slot: protocol

Initargs

:protocol

Readers

protocol (generic function)

Slot: host

Initargs

:host

Readers

host (generic function)

Slot: method

Initargs

:method

Readers

method (generic function)

Slot: content-type

Initargs

:content-type

Readers

content-type (generic function)

Writers

(setf content-type) (generic function)

Slot: parameters

Initargs

:parameters

Readers

parameters (generic function)

Writers

(setf parameters) (generic function)

Slot: headers

Initargs

:headers

Readers

headers (generic function)

Writers

(setf headers) (generic function)

Slot: uri-path

Initargs

:uri-path

Readers

uri-path (generic function)

Direct Default Initargs

Initarg	Value
:protocol	"http"
:method	:get
:content-type	"application/x-www-form-urlencoded"
:parameters	nil
:headers	nil
:uri-path	"/"
:content	""

Class: response ()

Package

zaws

Source

response.lisp (file)

Direct superclasses

http-message (class)

Direct methods

• print-object (method)
• (setf reason-phrase) (method)
• reason-phrase (method)
• status-code (method)
• request (method)

Direct slots

Slot: request

Initargs

:request

Readers

request (generic function)

Slot: status-code

Initargs

:status-code

Readers

status-code (generic function)

Slot: reason-phrase

Initargs

:reason-phrase

Readers

reason-phrase (generic function)

Writers

(setf reason-phrase) (generic function)

5.1.7 Types

Type: octet ()

Package

zaws

Source

utilities.lisp (file)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *ascii-control-code-values*

Package

zaws

Source

octet-sink.lisp (file)

Special Variable: *ascii-control-codes*

Package

zaws

Source

octet-sink.lisp (file)

Special Variable: *unreserved-octets*

Package

zaws

Source

utilities.lisp (file)

5.2.2 Functions

Function: call-with-output-sink FUN

Call FUN with one argument, an octet sink.

Package

zaws

Source

octet-sink.lisp (file)

Function: json-auth-v3-headers REQUEST

Package

zaws

Source

authentication.lisp (file)

Function: nth-line N FILE &optional ERRORP

Package

zaws

Source

utilities.lisp (file)

Function: parameters-as-auth-string PARAMETERS

Convert the alist PARAMETERS to a string suitable for use in authentication strings-to-sign.

Package

zaws

Source

authentication.lisp (file)

Function: starts-with PREFIX STRING

Return T if STRING starts with PREFIX.

Package

zaws

Source

utilities.lisp (file)

5.2.3 Generic functions

Generic Function: header-value KEY HTTP-MESSAGE

Return the value of the header named by KEY.

Package

zaws

Source

http-message.lisp (file)

Methods

Method: header-value KEY HTTP-MESSAGE

Generic Function: signature-version OBJECT

Package

zaws

Methods

Method: signature-version (QUERY-AUTH-V2 query-auth-v2)

automatically generated reader method

Source

authentication.lisp (file)

5.2.4 Classes

Class: http-message ()

HTTP-MESSAGE is the parent class of both REQUESTs and RESPONSEs.

Package

zaws

Source

http-message.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

• response (class)
• request (class)

Direct methods

• uri (method)
• uri (method)
• headers (method)
• headers (method)
• content (method)
• content (method)

Direct slots

Slot: content

Initargs

:content

Readers

content (generic function)

Writers

(setf content) (generic function)

Slot: headers

Initargs

:headers

Readers

headers (generic function)

Writers

(setf headers) (generic function)

Slot: uri

Initargs

:uri

Readers

uri (generic function)

Writers

(setf uri) (generic function)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables