The zaws Reference Manual

Table of Contents

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 2.3 "Robert April" on Wed Mar 14 04:46:04 2018 GMT+0.


Next: , Previous: , Up: Top   [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: Top   [Contents][Index]

2 Systems

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


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

2.1 zaws

Author

Zach Beane <xach@xach.com>

License

BSD

Description

Amazon AWS request construction

Version

1.0.2

Dependencies
Source

zaws.asd (file)

Components

Next: , Previous: , Up: Top   [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 files   [Contents][Index]

3.1.1 zaws.asd

Location

zaws.asd

Systems

zaws (system)


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

3.1.2 zaws/package.lisp

Parent

zaws (system)

Location

package.lisp

Packages

zaws


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

3.1.3 zaws/utilities.lisp

Dependency

package.lisp (file)

Parent

zaws (system)

Location

utilities.lisp

Exported Definitions
Internal Definitions

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

3.1.4 zaws/octet-sink.lisp

Dependency

utilities.lisp (file)

Parent

zaws (system)

Location

octet-sink.lisp

Exported Definitions
Internal Definitions

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

3.1.5 zaws/credentials.lisp

Dependency

octet-sink.lisp (file)

Parent

zaws (system)

Location

credentials.lisp

Exported Definitions

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

3.1.6 zaws/http-message.lisp

Dependency

credentials.lisp (file)

Parent

zaws (system)

Location

http-message.lisp

Exported Definitions
Internal Definitions

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

3.1.7 zaws/response.lisp

Dependency

http-message.lisp (file)

Parent

zaws (system)

Location

response.lisp

Exported Definitions

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

3.1.8 zaws/request.lisp

Dependency

response.lisp (file)

Parent

zaws (system)

Location

request.lisp

Exported Definitions

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

3.1.9 zaws/authentication.lisp

Dependency

request.lisp (file)

Parent

zaws (system)

Location

authentication.lisp

Exported Definitions
Internal Definitions

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

3.1.10 zaws/common-query.lisp

Dependency

authentication.lisp (file)

Parent

zaws (system)

Location

common-query.lisp

Exported Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 zaws

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [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 Exported definitions


Next: , Previous: , Up: Exported definitions   [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 (file)


Next: , Previous: , Up: Exported definitions   [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 (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)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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

Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.5 Conditions

Condition: response-error ()
Package

zaws

Source

response.lisp (file)

Direct superclasses

error (condition)

Direct methods
Direct slots
Slot: request
Initargs

:request

Readers

response-error-request (generic function)

Slot: response
Initargs

:response

Readers

response-error-response (generic function)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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
Direct methods
Class: common-query-request ()
Package

zaws

Source

common-query.lisp (file)

Direct superclasses
Direct methods
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
InitargValue
:action-parametersnil
Class: json-auth-v3 ()
Package

zaws

Source

authentication.lisp (file)

Direct superclasses

aws-auth-mixin (class)

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 (file)

Direct superclasses

aws-auth-mixin (class)

Direct subclasses

common-query-request (class)

Direct methods
Direct slots
Slot: signature-version
Initargs

:signature-version

Readers

signature-version (generic function)

Direct Default Initargs
InitargValue
:signature-version"2"
Class: query-auth-v3 ()
Package

zaws

Source

authentication.lisp (file)

Direct superclasses

aws-auth-mixin (class)

Direct methods
Class: request ()
Package

zaws

Source

request.lisp (file)

Direct superclasses

http-message (class)

Direct subclasses

common-query-request (class)

Direct methods
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
InitargValue
:protocol"http"
:method:get
:content-type"application/x-www-form-urlencoded"
:parametersnil
:headersnil
:uri-path"/"
:content""
Class: response ()
Package

zaws

Source

response.lisp (file)

Direct superclasses

http-message (class)

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


Previous: , Up: Exported definitions   [Contents][Index]

5.1.7 Types

Type: octet ()
Package

zaws

Source

utilities.lisp (file)


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

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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)


Next: , Previous: , Up: Internal definitions   [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 (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)


Previous: , Up: Internal definitions   [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 (file)

Direct superclasses

standard-object (class)

Direct subclasses
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)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   Z  
Index Entry  Section

F
File, Lisp, zaws.asd: The zaws<dot>asd file
File, Lisp, zaws/authentication.lisp: The zaws/authentication<dot>lisp file
File, Lisp, zaws/common-query.lisp: The zaws/common-query<dot>lisp file
File, Lisp, zaws/credentials.lisp: The zaws/credentials<dot>lisp file
File, Lisp, zaws/http-message.lisp: The zaws/http-message<dot>lisp file
File, Lisp, zaws/octet-sink.lisp: The zaws/octet-sink<dot>lisp file
File, Lisp, zaws/package.lisp: The zaws/package<dot>lisp file
File, Lisp, zaws/request.lisp: The zaws/request<dot>lisp file
File, Lisp, zaws/response.lisp: The zaws/response<dot>lisp file
File, Lisp, zaws/utilities.lisp: The zaws/utilities<dot>lisp file

L
Lisp File, zaws.asd: The zaws<dot>asd file
Lisp File, zaws/authentication.lisp: The zaws/authentication<dot>lisp file
Lisp File, zaws/common-query.lisp: The zaws/common-query<dot>lisp file
Lisp File, zaws/credentials.lisp: The zaws/credentials<dot>lisp file
Lisp File, zaws/http-message.lisp: The zaws/http-message<dot>lisp file
Lisp File, zaws/octet-sink.lisp: The zaws/octet-sink<dot>lisp file
Lisp File, zaws/package.lisp: The zaws/package<dot>lisp file
Lisp File, zaws/request.lisp: The zaws/request<dot>lisp file
Lisp File, zaws/response.lisp: The zaws/response<dot>lisp file
Lisp File, zaws/utilities.lisp: The zaws/utilities<dot>lisp file

Z
zaws.asd: The zaws<dot>asd file
zaws/authentication.lisp: The zaws/authentication<dot>lisp file
zaws/common-query.lisp: The zaws/common-query<dot>lisp file
zaws/credentials.lisp: The zaws/credentials<dot>lisp file
zaws/http-message.lisp: The zaws/http-message<dot>lisp file
zaws/octet-sink.lisp: The zaws/octet-sink<dot>lisp file
zaws/package.lisp: The zaws/package<dot>lisp file
zaws/request.lisp: The zaws/request<dot>lisp file
zaws/response.lisp: The zaws/response<dot>lisp file
zaws/utilities.lisp: The zaws/utilities<dot>lisp file

Jump to:   F   L   Z  

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): Exported generic functions
(setf action-parameters): Exported generic functions
(setf content): Exported generic functions
(setf content): Exported generic functions
(setf content-type): Exported generic functions
(setf content-type): Exported generic functions
(setf headers): Exported generic functions
(setf headers): Exported generic functions
(setf headers): Exported generic functions
(setf parameters): Exported generic functions
(setf parameters): Exported generic functions
(setf reason-phrase): Exported generic functions
(setf reason-phrase): Exported generic functions
(setf uri): Exported generic functions
(setf uri): Exported generic functions

A
access-key-id: Exported generic functions
access-key-id: Exported generic functions
access-key-id: Exported generic functions
access-key-id: Exported generic functions
action: Exported generic functions
action: Exported generic functions
action-parameters: Exported generic functions
action-parameters: Exported generic functions
api-version: Exported generic functions
api-version: Exported generic functions
aws-url-encode: Exported functions

B
base64: Exported functions

C
call-with-output-sink: Internal functions
check-response-error: Exported generic functions
check-response-error: Exported generic functions
content: Exported generic functions
content: Exported generic functions
content: Exported generic functions
content-string: Exported generic functions
content-string: Exported generic functions
content-type: Exported generic functions
content-type: Exported generic functions
content-type: Exported generic functions

D
delete-header: Exported generic functions
delete-header: Exported generic functions
delete-parameter: Exported generic functions
delete-parameter: Exported generic functions
do-parameters: Exported macros

E
ensure-header: Exported generic functions
ensure-header: Exported generic functions
ensure-parameter: Exported generic functions
ensure-parameter: Exported generic functions
expiration: Exported generic functions
expiration: Exported generic functions
expiredp: Exported generic functions
expiredp: Exported generic functions

F
Function, aws-url-encode: Exported functions
Function, base64: Exported functions
Function, call-with-output-sink: Internal functions
Function, hmac-sha256-signature-base64: Exported functions
Function, iso8601-timestamp: Exported functions
Function, json-auth-v3-headers: Internal functions
Function, make-parameters: Exported functions
Function, nth-line: Internal functions
Function, octet-vector: Exported functions
Function, parameters-as-auth-string: Internal functions
Function, parse-iso8601-timestamp: Exported functions
Function, rfc1123-timestamp: Exported functions
Function, sha256: Exported functions
Function, starts-with: Internal functions
Function, submit-common-query: Exported functions
Function, utf8: Exported functions

G
Generic Function, (setf action-parameters): Exported generic functions
Generic Function, (setf content): Exported generic functions
Generic Function, (setf content-type): Exported generic functions
Generic Function, (setf headers): Exported generic functions
Generic Function, (setf parameters): Exported generic functions
Generic Function, (setf reason-phrase): Exported generic functions
Generic Function, (setf uri): Exported generic functions
Generic Function, access-key-id: Exported generic functions
Generic Function, action: Exported generic functions
Generic Function, action-parameters: Exported generic functions
Generic Function, api-version: Exported generic functions
Generic Function, check-response-error: Exported generic functions
Generic Function, content: Exported generic functions
Generic Function, content-string: Exported generic functions
Generic Function, content-type: Exported generic functions
Generic Function, delete-header: Exported generic functions
Generic Function, delete-parameter: Exported generic functions
Generic Function, ensure-header: Exported generic functions
Generic Function, ensure-parameter: Exported generic functions
Generic Function, expiration: Exported generic functions
Generic Function, expiredp: Exported generic functions
Generic Function, header-value: Internal generic functions
Generic Function, headers: Exported generic functions
Generic Function, host: Exported generic functions
Generic Function, method: Exported generic functions
Generic Function, parameters: Exported generic functions
Generic Function, prepare-for-signing: Exported generic functions
Generic Function, process-response: Exported generic functions
Generic Function, protocol: Exported generic functions
Generic Function, reason-phrase: Exported generic functions
Generic Function, request: Exported generic functions
Generic Function, response-error-request: Exported generic functions
Generic Function, response-error-response: Exported generic functions
Generic Function, secret-access-key: Exported generic functions
Generic Function, session-token: Exported generic functions
Generic Function, sign: Exported generic functions
Generic Function, signature-version: Internal generic functions
Generic Function, sink-write: Exported generic functions
Generic Function, status-code: Exported generic functions
Generic Function, string-to-sign: Exported generic functions
Generic Function, submit: Exported generic functions
Generic Function, uri: Exported generic functions
Generic Function, uri-path: Exported generic functions
Generic Function, vector-to-sign: Exported generic functions

H
header-value: Internal generic functions
header-value: Internal generic functions
headers: Exported generic functions
headers: Exported generic functions
headers: Exported generic functions
headers: Exported generic functions
hmac-sha256-signature-base64: Exported functions
host: Exported generic functions
host: Exported generic functions

I
iso8601-timestamp: Exported functions

J
json-auth-v3-headers: Internal functions

M
Macro, do-parameters: Exported macros
Macro, with-octet-sink: Exported macros
make-parameters: Exported functions
method: Exported generic functions
method: Exported generic functions
method: Exported generic functions
Method, (setf action-parameters): Exported generic functions
Method, (setf content): Exported generic functions
Method, (setf content-type): Exported generic functions
Method, (setf headers): Exported generic functions
Method, (setf headers): Exported generic functions
Method, (setf parameters): Exported generic functions
Method, (setf reason-phrase): Exported generic functions
Method, (setf uri): Exported generic functions
Method, access-key-id: Exported generic functions
Method, access-key-id: Exported generic functions
Method, access-key-id: Exported generic functions
Method, action: Exported generic functions
Method, action-parameters: Exported generic functions
Method, api-version: Exported generic functions
Method, check-response-error: Exported generic functions
Method, content: Exported generic functions
Method, content: Exported generic functions
Method, content-string: Exported generic functions
Method, content-type: Exported generic functions
Method, content-type: Exported generic functions
Method, delete-header: Exported generic functions
Method, delete-parameter: Exported generic functions
Method, ensure-header: Exported generic functions
Method, ensure-parameter: Exported generic functions
Method, expiration: Exported generic functions
Method, expiredp: Exported generic functions
Method, header-value: Internal generic functions
Method, headers: Exported generic functions
Method, headers: Exported generic functions
Method, headers: Exported generic functions
Method, host: Exported generic functions
Method, method: Exported generic functions
Method, method: Exported generic functions
Method, parameters: Exported generic functions
Method, parameters: Exported generic functions
Method, prepare-for-signing: Exported generic functions
Method, prepare-for-signing: Exported generic functions
Method, prepare-for-signing: Exported generic functions
Method, prepare-for-signing: Exported generic functions
Method, prepare-for-signing: Exported generic functions
Method, process-response: Exported generic functions
Method, protocol: Exported generic functions
Method, reason-phrase: Exported generic functions
Method, request: Exported generic functions
Method, response-error-request: Exported generic functions
Method, response-error-response: Exported generic functions
Method, secret-access-key: Exported generic functions
Method, secret-access-key: Exported generic functions
Method, secret-access-key: Exported generic functions
Method, session-token: Exported generic functions
Method, session-token: Exported generic functions
Method, session-token: Exported generic functions
Method, session-token: Exported generic functions
Method, sign: Exported generic functions
Method, sign: Exported generic functions
Method, sign: Exported generic functions
Method, sign: Exported generic functions
Method, sign: Exported generic functions
Method, signature-version: Internal generic functions
Method, sink-write: Exported generic functions
Method, sink-write: Exported generic functions
Method, sink-write: Exported generic functions
Method, sink-write: Exported generic functions
Method, sink-write: Exported generic functions
Method, status-code: Exported generic functions
Method, string-to-sign: Exported generic functions
Method, string-to-sign: Exported generic functions
Method, submit: Exported generic functions
Method, submit: Exported generic functions
Method, submit: Exported generic functions
Method, uri: Exported generic functions
Method, uri: Exported generic functions
Method, uri-path: Exported generic functions
Method, uri-path: Exported generic functions
Method, vector-to-sign: Exported generic functions
Method, vector-to-sign: Exported generic functions
Method, vector-to-sign: Exported generic functions

N
nth-line: Internal functions

O
octet-vector: Exported functions

P
parameters: Exported generic functions
parameters: Exported generic functions
parameters: Exported generic functions
parameters-as-auth-string: Internal functions
parse-iso8601-timestamp: Exported functions
prepare-for-signing: Exported generic functions
prepare-for-signing: Exported generic functions
prepare-for-signing: Exported generic functions
prepare-for-signing: Exported generic functions
prepare-for-signing: Exported generic functions
prepare-for-signing: Exported generic functions
process-response: Exported generic functions
process-response: Exported generic functions
protocol: Exported generic functions
protocol: Exported generic functions

R
reason-phrase: Exported generic functions
reason-phrase: Exported generic functions
request: Exported generic functions
request: Exported generic functions
response-error-request: Exported generic functions
response-error-request: Exported generic functions
response-error-response: Exported generic functions
response-error-response: Exported generic functions
rfc1123-timestamp: Exported functions

S
secret-access-key: Exported generic functions
secret-access-key: Exported generic functions
secret-access-key: Exported generic functions
secret-access-key: Exported generic functions
session-token: Exported generic functions
session-token: Exported generic functions
session-token: Exported generic functions
session-token: Exported generic functions
session-token: Exported generic functions
sha256: Exported functions
sign: Exported generic functions
sign: Exported generic functions
sign: Exported generic functions
sign: Exported generic functions
sign: Exported generic functions
sign: Exported generic functions
signature-version: Internal generic functions
signature-version: Internal generic functions
sink-write: Exported generic functions
sink-write: Exported generic functions
sink-write: Exported generic functions
sink-write: Exported generic functions
sink-write: Exported generic functions
sink-write: Exported generic functions
starts-with: Internal functions
status-code: Exported generic functions
status-code: Exported generic functions
string-to-sign: Exported generic functions
string-to-sign: Exported generic functions
string-to-sign: Exported generic functions
submit: Exported generic functions
submit: Exported generic functions
submit: Exported generic functions
submit: Exported generic functions
submit-common-query: Exported functions

U
uri: Exported generic functions
uri: Exported generic functions
uri: Exported generic functions
uri-path: Exported generic functions
uri-path: Exported generic functions
uri-path: Exported generic functions
utf8: Exported functions

V
vector-to-sign: Exported generic functions
vector-to-sign: Exported generic functions
vector-to-sign: Exported generic functions
vector-to-sign: Exported generic functions

W
with-octet-sink: Exported 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*: Internal special variables
*ascii-control-codes*: Internal special variables
*credentials*: Exported special variables
*unreserved-octets*: Internal special variables

A
action: Exported classes
action-parameters: Exported classes
api-version: Exported classes

C
content: Internal classes
content-type: Exported classes

H
headers: Exported classes
headers: Internal classes
host: Exported classes

M
method: Exported classes

P
parameters: Exported classes
protocol: Exported classes

R
reason-phrase: Exported classes
request: Exported conditions
request: Exported classes
response: Exported conditions

S
signature-version: Exported classes
Slot, action: Exported classes
Slot, action-parameters: Exported classes
Slot, api-version: Exported classes
Slot, content: Internal classes
Slot, content-type: Exported classes
Slot, headers: Exported classes
Slot, headers: Internal classes
Slot, host: Exported classes
Slot, method: Exported classes
Slot, parameters: Exported classes
Slot, protocol: Exported classes
Slot, reason-phrase: Exported classes
Slot, request: Exported conditions
Slot, request: Exported classes
Slot, response: Exported conditions
Slot, signature-version: Exported classes
Slot, status-code: Exported classes
Slot, uri: Internal classes
Slot, uri-path: Exported classes
Special Variable, *ascii-control-code-values*: Internal special variables
Special Variable, *ascii-control-codes*: Internal special variables
Special Variable, *credentials*: Exported special variables
Special Variable, *unreserved-octets*: Internal special variables
status-code: Exported classes

U
uri: Internal classes
uri-path: Exported classes

Jump to:   *  
A   C   H   M   P   R   S   U  

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

A.4 Data types

Jump to:   A   C   H   J   O   P   Q   R   S   T   Z  
Index Entry  Section

A
aws-auth-mixin: Exported classes

C
Class, aws-auth-mixin: Exported classes
Class, common-query-request: Exported classes
Class, http-message: Internal classes
Class, json-auth-v3: Exported classes
Class, query-auth-v2: Exported classes
Class, query-auth-v3: Exported classes
Class, request: Exported classes
Class, response: Exported classes
common-query-request: Exported classes
Condition, response-error: Exported conditions

H
http-message: Internal classes

J
json-auth-v3: Exported classes

O
octet: Exported types

P
Package, zaws: The zaws package

Q
query-auth-v2: Exported classes
query-auth-v3: Exported classes

R
request: Exported classes
response: Exported classes
response-error: Exported conditions

S
System, zaws: The zaws system

T
Type, octet: Exported types

Z
zaws: The zaws system
zaws: The zaws package

Jump to:   A   C   H   J   O   P   Q   R   S   T   Z