The zaws Reference Manual

Next: , Previous: , Up: (dir)   [Contents][Index]

The zaws Reference Manual

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.

Table of Contents

Next: , Previous: , Up: The zaws Reference Manual   [Contents][Index]

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

Next: , Previous: , Up: The zaws Reference Manual   [Contents][Index]

2 Systems

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

Previous: , Up: Systems   [Contents][Index]

2.1 zaws

Amazon AWS request construction

Author

Zach Beane <xach@xach.com>

License

BSD

Version

1.0.2

Dependencies
  • cl-base64 (system).
  • drakma (system).
  • flexi-streams (system).
  • ironclad (system).
Source

zaws.asd.

Child Components

Next: , Previous: , Up: The zaws Reference Manual   [Contents][Index]

3 Files

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

Previous: , Up: Files   [Contents][Index]

3.1 Lisp

Next: , Previous: , Up: Lisp   [Contents][Index]

3.1.1 zaws/zaws.asd

Source

zaws.asd.

Parent Component

zaws (system).

ASDF Systems

zaws.

Next: , Previous: , Up: Lisp   [Contents][Index]

3.1.2 zaws/package.lisp

Source

zaws.asd.

Parent Component

zaws (system).

Packages

zaws.

Next: , Previous: , Up: Lisp   [Contents][Index]

3.1.3 zaws/utilities.lisp

Dependency

package.lisp (file).

Source

zaws.asd.

Parent Component

zaws (system).

Public Interface
Internals

Next: , Previous: , Up: Lisp   [Contents][Index]

3.1.4 zaws/octet-sink.lisp

Dependency

utilities.lisp (file).

Source

zaws.asd.

Parent Component

zaws (system).

Public Interface
Internals

Next: , Previous: , Up: Lisp   [Contents][Index]

3.1.5 zaws/credentials.lisp

Dependency

octet-sink.lisp (file).

Source

zaws.asd.

Parent Component

zaws (system).

Public Interface

Next: , Previous: , Up: Lisp   [Contents][Index]

3.1.6 zaws/http-message.lisp

Dependency

credentials.lisp (file).

Source

zaws.asd.

Parent Component

zaws (system).

Public Interface
Internals

Next: , Previous: , Up: Lisp   [Contents][Index]

3.1.7 zaws/response.lisp

Dependency

http-message.lisp (file).

Source

zaws.asd.

Parent Component

zaws (system).

Public Interface

Next: , Previous: , Up: Lisp   [Contents][Index]

3.1.8 zaws/request.lisp

Dependency

response.lisp (file).

Source

zaws.asd.

Parent Component

zaws (system).

Public Interface

Next: , Previous: , Up: Lisp   [Contents][Index]

3.1.9 zaws/authentication.lisp

Dependency

request.lisp (file).

Source

zaws.asd.

Parent Component

zaws (system).

Public Interface
Internals

Previous: , Up: Lisp   [Contents][Index]

3.1.10 zaws/common-query.lisp

Dependency

authentication.lisp (file).

Source

zaws.asd.

Parent Component

zaws (system).

Public Interface

Next: , Previous: , Up: The zaws Reference Manual   [Contents][Index]

4 Packages

Packages are listed by definition order.

Previous: , Up: Packages   [Contents][Index]

4.1 zaws

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

Next: , Previous: , Up: The zaws Reference Manual   [Contents][Index]

5 Definitions

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

Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Public Interface

Next: , Previous: , Up: Public Interface   [Contents][Index]

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.

Next: , Previous: , Up: Public Interface   [Contents][Index]

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.

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.

Next: , Previous: , Up: Public Interface   [Contents][Index]

5.1.3 Ordinary functions

Function: aws-url-encode (string)

URL-encode STRING according to AWS’s requirements.

Package

zaws.

Source

utilities.lisp.

Function: base64 (vector)

Encode VECTOR as a base64 string.

Package

zaws.

Source

utilities.lisp.

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.

Function: iso8601-timestamp (&optional time)

Return an ISO 8601-style UTC timestamp string.

Package

zaws.

Source

utilities.lisp.

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.

Function: octet-vector (&rest octets)

Return a specialized array initialized with OCTETS.

Package

zaws.

Source

utilities.lisp.

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.

Function: rfc1123-timestamp (&optional time)

Return an RFC 1123-style GMT timestamp string.

Package

zaws.

Source

utilities.lisp.

Function: sha256 (vector)
Package

zaws.

Source

authentication.lisp.

Function: submit-common-query (class initargs action &rest action-parameters)
Package

zaws.

Source

common-query.lisp.

Function: utf8 (string)

Return STRING encoded as UTF-8 octets.

Package

zaws.

Source

utilities.lisp.

Next: , Previous: , Up: Public Interface   [Contents][Index]

5.1.4 Generic functions

Generic Function: access-key-id (credentials)

The access key id of CREDENTIALS.

Package

zaws.

Source

credentials.lisp.

Methods
Method: access-key-id ((credentials string))
Method: access-key-id ((credentials pathname))
Method: access-key-id ((credentials cons))
Generic Reader: action (request)

The ’action’ of a common query request.

Package

zaws.

Source

common-query.lisp.

Methods
Reader Method: action ((common-query-request common-query-request))

automatically generated reader method

Target Slot

action.

Generic Reader: action-parameters (request)

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

Package

zaws.

Source

common-query.lisp.

Methods
Reader Method: action-parameters ((common-query-request common-query-request))

automatically generated reader method

Target Slot

action-parameters.

Generic Writer: (setf action-parameters) (object)
Package

zaws.

Methods
Writer Method: (setf action-parameters) ((common-query-request common-query-request))

automatically generated writer method

Source

common-query.lisp.

Target Slot

action-parameters.

Generic Reader: api-version (request)

The API version of a request.

Package

zaws.

Source

common-query.lisp.

Methods
Reader Method: api-version ((common-query-request common-query-request))

automatically generated reader method

Target Slot

api-version.

Generic Function: check-response-error (request response)

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

Package

zaws.

Source

request.lisp.

Methods
Method: check-response-error (request response)
Generic Function: content (object)

The content (aka body) of OBJECT.

Package

zaws.

Source

http-message.lisp.

Methods
Reader Method: content ((http-message http-message))

automatically generated reader method

Target Slot

content.

Method: content (object)
Generic Writer: (setf content) (object)
Package

zaws.

Source

http-message.lisp.

Methods
Writer Method: (setf content) ((http-message http-message))

automatically generated writer method

Target Slot

content.

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.

Methods
Method: content-string (object)
Generic Function: content-type (request)
Package

zaws.

Source

request.lisp.

Methods
Reader Method: content-type ((request request))

automatically generated reader method

Target Slot

content-type.

Method: content-type (request)
Generic Writer: (setf content-type) (object)
Package

zaws.

Methods
Writer Method: (setf content-type) ((request request))

automatically generated writer method

Source

request.lisp.

Target Slot

content-type.

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.

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.

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.

Methods
Method: ensure-header (key value http-message)
Generic Function: ensure-parameter (key value request)
Package

zaws.

Source

request.lisp.

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.

Methods
Method: expiration (credentials)
Generic Function: expiredp (credentials)

Returns T if CREDENTIALS have expired.

Package

zaws.

Source

credentials.lisp.

Methods
Method: expiredp (credentials)
Generic Function: headers (object)

The headers of OBJECT.

Package

zaws.

Source

http-message.lisp.

Methods
Reader Method: headers ((request request))

automatically generated reader method

Source

request.lisp.

Target Slot

headers.

Reader Method: headers ((http-message http-message))

automatically generated reader method

Target Slot

headers.

Method: headers (object)
Generic Writer: (setf headers) (object)
Package

zaws.

Source

http-message.lisp.

Methods
Writer Method: (setf headers) ((request request))

automatically generated writer method

Source

request.lisp.

Target Slot

headers.

Writer Method: (setf headers) ((http-message http-message))

automatically generated writer method

Target Slot

headers.

Generic Reader: host (request)

The target host of the request.

Package

zaws.

Source

request.lisp.

Methods
Reader Method: host ((request request))

automatically generated reader method

Target Slot

host.

Generic Function: method (request)

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

Package

zaws.

Source

request.lisp.

Methods
Reader Method: method ((request request))

automatically generated reader method

Target Slot

method.

Method: method (request)
Generic Function: parameters (request)
Package

zaws.

Source

request.lisp.

Methods
Reader Method: parameters ((request request))

automatically generated reader method

Target Slot

parameters.

Method: parameters (request)
Generic Writer: (setf parameters) (request)
Package

zaws.

Source

request.lisp.

Methods
Writer Method: (setf parameters) ((request request))

automatically generated writer method

Target Slot

parameters.

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.

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

common-query.lisp.

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.

Methods
Method: process-response (request response)
Generic Reader: protocol (request)

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

Package

zaws.

Source

request.lisp.

Methods
Reader Method: protocol ((request request))

automatically generated reader method

Target Slot

protocol.

Generic Reader: reason-phrase (response)

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

Package

zaws.

Source

response.lisp.

Methods
Reader Method: reason-phrase ((response response))

automatically generated reader method

Target Slot

reason-phrase.

Generic Writer: (setf reason-phrase) (object)
Package

zaws.

Methods
Writer Method: (setf reason-phrase) ((response response))

automatically generated writer method

Source

response.lisp.

Target Slot

reason-phrase.

Generic Reader: request (response)
Package

zaws.

Source

response.lisp.

Methods
Reader Method: request ((response response))

automatically generated reader method

Target Slot

request.

Generic Reader: response-error-request (condition)
Package

zaws.

Methods
Reader Method: response-error-request ((condition response-error))
Source

response.lisp.

Target Slot

request.

Generic Reader: response-error-response (condition)
Package

zaws.

Methods
Reader Method: response-error-response ((condition response-error))
Source

response.lisp.

Target Slot

response.

Generic Function: secret-access-key (credentials)

The secret access key of CREDENTIALS.

Package

zaws.

Source

credentials.lisp.

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.

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.

Methods
Method: sign ((request json-auth-v3))
Method: sign ((request query-auth-v3))
Method: sign ((request query-auth-v2))
Method: sign :before ((request aws-auth-mixin))
Method: sign (request)
Generic Function: sink-write (object sink)

Write OBJECT to SINK.

Package

zaws.

Source

octet-sink.lisp.

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 Reader: status-code (response)

The HTTP status code of RESPONSE as an integer.

Package

zaws.

Source

response.lisp.

Methods
Reader Method: status-code ((response response))

automatically generated reader method

Target Slot

status-code.

Generic Function: string-to-sign (request)

The string to sign for authentication.

Package

zaws.

Source

authentication.lisp.

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.

Methods
Method: submit :before ((request aws-auth-mixin))
Source

authentication.lisp.

Method: submit (request)
Method: submit :around (request)
Generic Function: uri (object)

The URI of OBJECT.

Package

zaws.

Source

http-message.lisp.

Methods
Method: uri ((request request))
Source

request.lisp.

Reader Method: uri ((http-message http-message))

automatically generated reader method

Target Slot

uri.

Generic Writer: (setf uri) (object)
Package

zaws.

Source

http-message.lisp.

Methods
Writer Method: (setf uri) ((http-message http-message))

automatically generated writer method

Target Slot

uri.

Generic Function: uri-path (request)
Package

zaws.

Source

request.lisp.

Methods
Reader Method: uri-path ((request request))

automatically generated reader method

Target Slot

uri-path.

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.

Methods
Method: vector-to-sign ((request json-auth-v3))
Method: vector-to-sign ((request query-auth-v2))
Method: vector-to-sign (request)

Next: , Previous: , Up: Public Interface   [Contents][Index]

5.1.5 Standalone methods

Method: print-object ((request request) stream)
Source

request.lisp.

Method: print-object ((response response) stream)
Source

response.lisp.

Next: , Previous: , Up: Public Interface   [Contents][Index]

5.1.6 Conditions

Condition: response-error
Package

zaws.

Source

response.lisp.

Direct superclasses

error.

Direct methods
Direct slots
Slot: request
Initargs

:request

Readers

response-error-request.

Writers

This slot is read-only.

Slot: response
Initargs

:response

Readers

response-error-response.

Writers

This slot is read-only.

Next: , Previous: , Up: Public Interface   [Contents][Index]

5.1.7 Classes

Class: aws-auth-mixin

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

Package

zaws.

Source

authentication.lisp.

Direct subclasses
Direct methods
Class: common-query-request
Package

zaws.

Source

common-query.lisp.

Direct superclasses
Direct methods
Direct Default Initargs
InitargValue
:action-parametersnil
Direct slots
Slot: action
Initargs

:action

Readers

action.

Writers

This slot is read-only.

Slot: action-parameters
Initargs

:action-parameters

Readers

action-parameters.

Writers

(setf action-parameters).

Slot: api-version
Initargs

:api-version

Readers

api-version.

Writers

This slot is read-only.

Class: json-auth-v3
Package

zaws.

Source

authentication.lisp.

Direct superclasses

aws-auth-mixin.

Direct methods
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.

Direct superclasses

aws-auth-mixin.

Direct subclasses

common-query-request.

Direct methods
Direct Default Initargs
InitargValue
:signature-version2
Direct slots
Slot: signature-version
Initargs

:signature-version

Readers

signature-version.

Writers

This slot is read-only.

Class: query-auth-v3
Package

zaws.

Source

authentication.lisp.

Direct superclasses

aws-auth-mixin.

Direct methods
Class: request
Package

zaws.

Source

request.lisp.

Direct superclasses

http-message.

Direct subclasses

common-query-request.

Direct methods
Direct Default Initargs
InitargValue
:protocolhttp
:methodget
:content-typeapplication/x-www-form-urlencoded
:parametersnil
:headersnil
:uri-path/
:content
Direct slots
Slot: protocol
Initargs

:protocol

Readers

protocol.

Writers

This slot is read-only.

Slot: host
Initargs

:host

Readers

host.

Writers

This slot is read-only.

Slot: method
Initargs

:method

Readers

method.

Writers

This slot is read-only.

Slot: content-type
Initargs

:content-type

Readers

content-type.

Writers

(setf content-type).

Slot: parameters
Initargs

:parameters

Readers

parameters.

Writers

(setf parameters).

Slot: headers
Initargs

:headers

Readers

headers.

Writers

(setf headers).

Slot: uri-path
Initargs

:uri-path

Readers

uri-path.

Writers

This slot is read-only.

Class: response
Package

zaws.

Source

response.lisp.

Direct superclasses

http-message.

Direct methods
Direct slots
Slot: request
Initargs

:request

Readers

request.

Writers

This slot is read-only.

Slot: status-code
Initargs

:status-code

Readers

status-code.

Writers

This slot is read-only.

Slot: reason-phrase
Initargs

:reason-phrase

Readers

reason-phrase.

Writers

(setf reason-phrase).

Previous: , Up: Public Interface   [Contents][Index]

5.1.8 Types

Type: octet ()
Package

zaws.

Source

utilities.lisp.

Previous: , Up: Definitions   [Contents][Index]

5.2 Internals

Next: , Previous: , Up: Internals   [Contents][Index]

5.2.1 Special variables

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

zaws.

Source

octet-sink.lisp.

Special Variable: *ascii-control-codes*
Package

zaws.

Source

octet-sink.lisp.

Special Variable: *unreserved-octets*
Package

zaws.

Source

utilities.lisp.

Next: , Previous: , Up: Internals   [Contents][Index]

5.2.2 Ordinary functions

Function: call-with-output-sink (fun)

Call FUN with one argument, an octet sink.

Package

zaws.

Source

octet-sink.lisp.

Function: json-auth-v3-headers (request)
Package

zaws.

Source

authentication.lisp.

Function: nth-line (n file &optional errorp)
Package

zaws.

Source

utilities.lisp.

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.

Function: starts-with (prefix string)

Return T if STRING starts with PREFIX.

Package

zaws.

Source

utilities.lisp.

Next: , Previous: , Up: Internals   [Contents][Index]

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.

Methods
Method: header-value (key http-message)
Generic Reader: signature-version (object)
Package

zaws.

Methods
Reader Method: signature-version ((query-auth-v2 query-auth-v2))

automatically generated reader method

Source

authentication.lisp.

Target Slot

signature-version.

Previous: , Up: Internals   [Contents][Index]

5.2.4 Classes

Class: http-message

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

Package

zaws.

Source

http-message.lisp.

Direct subclasses
Direct methods
Direct slots
Slot: content
Initargs

:content

Readers

content.

Writers

(setf content).

Slot: headers
Initargs

:headers

Readers

headers.

Writers

(setf headers).

Slot: uri
Initargs

:uri

Readers

uri.

Writers

(setf uri).

Previous: , Up: The zaws Reference Manual   [Contents][Index]

Appendix A Indexes

Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   (  
A   B   C   D   E   F   G   H   I   J   M   N   O   P   R   S   U   V   W  
Index Entry  Section
(
(setf action-parameters): Public generic functions
(setf action-parameters): Public generic functions
(setf content): Public generic functions
(setf content): Public generic functions
(setf content-type): Public generic functions
(setf content-type): Public generic functions
(setf headers): Public generic functions
(setf headers): Public generic functions
(setf headers): Public generic functions
(setf parameters): Public generic functions
(setf parameters): Public generic functions
(setf reason-phrase): Public generic functions
(setf reason-phrase): Public generic functions
(setf uri): Public generic functions
(setf uri): Public generic functions
A
access-key-id: Public generic functions
access-key-id: Public generic functions
access-key-id: Public generic functions
access-key-id: Public generic functions
action: Public generic functions
action: Public generic functions
action-parameters: Public generic functions
action-parameters: Public generic functions
api-version: Public generic functions
api-version: Public generic functions
aws-url-encode: Public ordinary functions
B
base64: Public ordinary functions
C
call-with-output-sink: Private ordinary functions
check-response-error: Public generic functions
check-response-error: Public generic functions
content: Public generic functions
content: Public generic functions
content: Public generic functions
content-string: Public generic functions
content-string: Public generic functions
content-type: Public generic functions
content-type: Public generic functions
content-type: Public generic functions
D
delete-header: Public generic functions
delete-header: Public generic functions
delete-parameter: Public generic functions
delete-parameter: Public generic functions
do-parameters: Public macros
E
ensure-header: Public generic functions
ensure-header: Public generic functions
ensure-parameter: Public generic functions
ensure-parameter: Public generic functions
expiration: Public generic functions
expiration: Public generic functions
expiredp: Public generic functions
expiredp: Public generic functions
F
Function, aws-url-encode: Public ordinary functions
Function, base64: Public ordinary functions
Function, call-with-output-sink: Private ordinary functions
Function, hmac-sha256-signature-base64: Public ordinary functions
Function, iso8601-timestamp: Public ordinary functions
Function, json-auth-v3-headers: Private ordinary functions
Function, make-parameters: Public ordinary functions
Function, nth-line: Private ordinary functions
Function, octet-vector: Public ordinary functions
Function, parameters-as-auth-string: Private ordinary functions
Function, parse-iso8601-timestamp: Public ordinary functions
Function, rfc1123-timestamp: Public ordinary functions
Function, sha256: Public ordinary functions
Function, starts-with: Private ordinary functions
Function, submit-common-query: Public ordinary functions
Function, utf8: Public ordinary functions
G
Generic Function, (setf action-parameters): Public generic functions
Generic Function, (setf content): Public generic functions
Generic Function, (setf content-type): Public generic functions
Generic Function, (setf headers): Public generic functions
Generic Function, (setf parameters): Public generic functions
Generic Function, (setf reason-phrase): Public generic functions
Generic Function, (setf uri): Public generic functions
Generic Function, access-key-id: Public generic functions
Generic Function, action: Public generic functions
Generic Function, action-parameters: Public generic functions
Generic Function, api-version: Public generic functions
Generic Function, check-response-error: Public generic functions
Generic Function, content: Public generic functions
Generic Function, content-string: Public generic functions
Generic Function, content-type: Public generic functions
Generic Function, delete-header: Public generic functions
Generic Function, delete-parameter: Public generic functions
Generic Function, ensure-header: Public generic functions
Generic Function, ensure-parameter: Public generic functions
Generic Function, expiration: Public generic functions
Generic Function, expiredp: Public generic functions
Generic Function, header-value: Private generic functions
Generic Function, headers: Public generic functions
Generic Function, host: Public generic functions
Generic Function, method: Public generic functions
Generic Function, parameters: Public generic functions
Generic Function, prepare-for-signing: Public generic functions
Generic Function, process-response: Public generic functions
Generic Function, protocol: Public generic functions
Generic Function, reason-phrase: Public generic functions
Generic Function, request: Public generic functions
Generic Function, response-error-request: Public generic functions
Generic Function, response-error-response: Public generic functions
Generic Function, secret-access-key: Public generic functions
Generic Function, session-token: Public generic functions
Generic Function, sign: Public generic functions
Generic Function, signature-version: Private generic functions
Generic Function, sink-write: Public generic functions
Generic Function, status-code: Public generic functions
Generic Function, string-to-sign: Public generic functions
Generic Function, submit: Public generic functions
Generic Function, uri: Public generic functions
Generic Function, uri-path: Public generic functions
Generic Function, vector-to-sign: Public generic functions
H
header-value: Private generic functions
header-value: Private generic functions
headers: Public generic functions
headers: Public generic functions
headers: Public generic functions
headers: Public generic functions
hmac-sha256-signature-base64: Public ordinary functions
host: Public generic functions
host: Public generic functions
I
iso8601-timestamp: Public ordinary functions
J
json-auth-v3-headers: Private ordinary functions
M
Macro, do-parameters: Public macros
Macro, with-octet-sink: Public macros
make-parameters: Public ordinary functions
method: Public generic functions
method: Public generic functions
method: Public generic functions
Method, (setf action-parameters): Public generic functions
Method, (setf content): Public generic functions
Method, (setf content-type): Public generic functions
Method, (setf headers): Public generic functions
Method, (setf headers): Public generic functions
Method, (setf parameters): Public generic functions
Method, (setf reason-phrase): Public generic functions
Method, (setf uri): Public generic functions
Method, access-key-id: Public generic functions
Method, access-key-id: Public generic functions
Method, access-key-id: Public generic functions
Method, action: Public generic functions
Method, action-parameters: Public generic functions
Method, api-version: Public generic functions
Method, check-response-error: Public generic functions
Method, content: Public generic functions
Method, content: Public generic functions
Method, content-string: Public generic functions
Method, content-type: Public generic functions
Method, content-type: Public generic functions
Method, delete-header: Public generic functions
Method, delete-parameter: Public generic functions
Method, ensure-header: Public generic functions
Method, ensure-parameter: Public generic functions
Method, expiration: Public generic functions
Method, expiredp: Public generic functions
Method, header-value: Private generic functions
Method, headers: Public generic functions
Method, headers: Public generic functions
Method, headers: Public generic functions
Method, host: Public generic functions
Method, method: Public generic functions
Method, method: Public generic functions
Method, parameters: Public generic functions
Method, parameters: Public generic functions
Method, prepare-for-signing: Public generic functions
Method, prepare-for-signing: Public generic functions
Method, prepare-for-signing: Public generic functions
Method, prepare-for-signing: Public generic functions
Method, prepare-for-signing: Public generic functions
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, process-response: Public generic functions
Method, protocol: Public generic functions
Method, reason-phrase: Public generic functions
Method, request: Public generic functions
Method, response-error-request: Public generic functions
Method, response-error-response: Public generic functions
Method, secret-access-key: Public generic functions
Method, secret-access-key: Public generic functions
Method, secret-access-key: Public generic functions
Method, session-token: Public generic functions
Method, session-token: Public generic functions
Method, session-token: Public generic functions
Method, session-token: Public generic functions
Method, sign: Public generic functions
Method, sign: Public generic functions
Method, sign: Public generic functions
Method, sign: Public generic functions
Method, sign: Public generic functions
Method, signature-version: Private generic functions
Method, sink-write: Public generic functions
Method, sink-write: Public generic functions
Method, sink-write: Public generic functions
Method, sink-write: Public generic functions
Method, sink-write: Public generic functions
Method, status-code: Public generic functions
Method, string-to-sign: Public generic functions
Method, string-to-sign: Public generic functions
Method, submit: Public generic functions
Method, submit: Public generic functions
Method, submit: Public generic functions
Method, uri: Public generic functions
Method, uri: Public generic functions
Method, uri-path: Public generic functions
Method, uri-path: Public generic functions
Method, vector-to-sign: Public generic functions
Method, vector-to-sign: Public generic functions
Method, vector-to-sign: Public generic functions
N
nth-line: Private ordinary functions
O
octet-vector: Public ordinary functions
P
parameters: Public generic functions
parameters: Public generic functions
parameters: Public generic functions
parameters-as-auth-string: Private ordinary functions
parse-iso8601-timestamp: Public ordinary functions
prepare-for-signing: Public generic functions
prepare-for-signing: Public generic functions
prepare-for-signing: Public generic functions
prepare-for-signing: Public generic functions
prepare-for-signing: Public generic functions
prepare-for-signing: Public generic functions
print-object: Public standalone methods
print-object: Public standalone methods
process-response: Public generic functions
process-response: Public generic functions
protocol: Public generic functions
protocol: Public generic functions
R
reason-phrase: Public generic functions
reason-phrase: Public generic functions
request: Public generic functions
request: Public generic functions
response-error-request: Public generic functions
response-error-request: Public generic functions
response-error-response: Public generic functions
response-error-response: Public generic functions
rfc1123-timestamp: Public ordinary functions
S
secret-access-key: Public generic functions
secret-access-key: Public generic functions
secret-access-key: Public generic functions
secret-access-key: Public generic functions
session-token: Public generic functions
session-token: Public generic functions
session-token: Public generic functions
session-token: Public generic functions
session-token: Public generic functions
sha256: Public ordinary functions
sign: Public generic functions
sign: Public generic functions
sign: Public generic functions
sign: Public generic functions
sign: Public generic functions
sign: Public generic functions
signature-version: Private generic functions
signature-version: Private generic functions
sink-write: Public generic functions
sink-write: Public generic functions
sink-write: Public generic functions
sink-write: Public generic functions
sink-write: Public generic functions
sink-write: Public generic functions
starts-with: Private ordinary functions
status-code: Public generic functions
status-code: Public generic functions
string-to-sign: Public generic functions
string-to-sign: Public generic functions
string-to-sign: Public generic functions
submit: Public generic functions
submit: Public generic functions
submit: Public generic functions
submit: Public generic functions
submit-common-query: Public ordinary functions
U
uri: Public generic functions
uri: Public generic functions
uri: Public generic functions
uri-path: Public generic functions
uri-path: Public generic functions
uri-path: Public generic functions
utf8: Public ordinary functions
V
vector-to-sign: Public generic functions
vector-to-sign: Public generic functions
vector-to-sign: Public generic functions
vector-to-sign: Public generic functions
W
with-octet-sink: Public macros
Jump to:   (  
A   B   C   D   E   F   G   H   I   J   M   N   O   P   R   S   U   V   W  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
A   C   H   M   P   R   S   U  
Index Entry  Section
*
*ascii-control-code-values*: Private special variables
*ascii-control-codes*: Private special variables
*credentials*: Public special variables
*unreserved-octets*: Private special variables
A
action: Public classes
action-parameters: Public classes
api-version: Public classes
C
content: Private classes
content-type: Public classes
H
headers: Public classes
headers: Private classes
host: Public classes
M
method: Public classes
P
parameters: Public classes
protocol: Public classes
R
reason-phrase: Public classes
request: Public conditions
request: Public classes
response: Public conditions
S
signature-version: Public classes
Slot, action: Public classes
Slot, action-parameters: Public classes
Slot, api-version: Public classes
Slot, content: Private classes
Slot, content-type: Public classes
Slot, headers: Public classes
Slot, headers: Private classes
Slot, host: Public classes
Slot, method: Public classes
Slot, parameters: Public classes
Slot, protocol: Public classes
Slot, reason-phrase: Public classes
Slot, request: Public conditions
Slot, request: Public classes
Slot, response: Public conditions
Slot, signature-version: Public classes
Slot, status-code: Public classes
Slot, uri: Private classes
Slot, uri-path: Public classes
Special Variable, *ascii-control-code-values*: Private special variables
Special Variable, *ascii-control-codes*: Private special variables
Special Variable, *credentials*: Public special variables
Special Variable, *unreserved-octets*: Private special variables
status-code: Public classes
U
uri: Private classes
uri-path: Public classes
Jump to:   *  
A   C   H   M   P   R   S   U  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   A   C   F   H   J   O   P   Q   R   S   T   U   Z  
Index Entry  Section
A
authentication.lisp: The zaws/authentication․lisp file
aws-auth-mixin: Public classes
C
Class, aws-auth-mixin: Public classes
Class, common-query-request: Public classes
Class, http-message: Private classes
Class, json-auth-v3: Public classes
Class, query-auth-v2: Public classes
Class, query-auth-v3: Public classes
Class, request: Public classes
Class, response: Public classes
common-query-request: Public classes
common-query.lisp: The zaws/common-query․lisp file
Condition, response-error: Public conditions
credentials.lisp: The zaws/credentials․lisp file
F
File, authentication.lisp: The zaws/authentication․lisp file
File, common-query.lisp: The zaws/common-query․lisp file
File, credentials.lisp: The zaws/credentials․lisp file
File, http-message.lisp: The zaws/http-message․lisp file
File, octet-sink.lisp: The zaws/octet-sink․lisp file
File, package.lisp: The zaws/package․lisp file
File, request.lisp: The zaws/request․lisp file
File, response.lisp: The zaws/response․lisp file
File, utilities.lisp: The zaws/utilities․lisp file
File, zaws.asd: The zaws/zaws․asd file
H
http-message: Private classes
http-message.lisp: The zaws/http-message․lisp file
J
json-auth-v3: Public classes
O
octet: Public types
octet-sink.lisp: The zaws/octet-sink․lisp file
P
Package, zaws: The zaws package
package.lisp: The zaws/package․lisp file
Q
query-auth-v2: Public classes
query-auth-v3: Public classes
R
request: Public classes
request.lisp: The zaws/request․lisp file
response: Public classes
response-error: Public conditions
response.lisp: The zaws/response․lisp file
S
System, zaws: The zaws system
T
Type, octet: Public types
U
utilities.lisp: The zaws/utilities․lisp file
Z
zaws: The zaws system
zaws: The zaws package
zaws.asd: The zaws/zaws․asd file
Jump to:   A   C   F   H   J   O   P   Q   R   S   T   U   Z