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

The aws-foundation Reference Manual

This is the aws-foundation Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 14:39:24 2024 GMT+0.

Next: Systems, Previous: The aws-foundation Reference Manual, Up: The aws-foundation Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The aws-foundation Reference Manual [Contents][Index]

2 Systems

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

aws-foundation

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

2.1 `aws-foundation`

Amazon AWS low-level utilities

Author

Bob Felts <wrf3@stablecross.com>

License

BSD

Version

1.0.0

Dependencies

babel (system).
cl-json (system).
cl-json-helper (system).
dexador (system).
ironclad (system).
local-time (system).

Source

aws-foundation.asd.

Child Components

package.lisp (file).
aws-foundation.lisp (file).

Next: Packages, Previous: Systems, Up: The aws-foundation Reference Manual [Contents][Index]

3 Files

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

Lisp

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

Next: aws-foundation/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `aws-foundation/aws-foundation.asd`

Source: aws-foundation.asd.
Parent Component: aws-foundation (system).
ASDF Systems: aws-foundation.

Next: aws-foundation/aws-foundation.lisp, Previous: aws-foundation/aws-foundation.asd, Up: Lisp [Contents][Index]

3.1.2 `aws-foundation/package.lisp`

Source: aws-foundation.asd.
Parent Component: aws-foundation (system).
Packages: aws-foundation.

Previous: aws-foundation/package.lisp, Up: Lisp [Contents][Index]

3.1.3 `aws-foundation/aws-foundation.lisp`

Dependency

package.lisp (file).

Source

aws-foundation.asd.

Parent Component

aws-foundation (system).

Public Interface

aws-get (function).
aws4-post (function).
pool/s (function).
region/s (function).
sha256/ba (function).
sha256/hs64 (function).
string-to-octets (function).

Internals

*dex-keep-alive* (special variable).
*dex-verbose* (special variable).
*nl* (special variable).
aws-datestamp (function).
aws-post (function).
aws-sign (function).
aws-timestamp (function).
aws4-authorization-header (function).
aws4-authorization-string (function).
aws4-credential-scope (function).
aws4-signing-key (function).
ba/hs64 (function).
canonical-headers (function).
format-canonical-header-string (function).
format-canonical-signed-headers-string (function).
json-decode-octets/js (function).
make-aws-endpoint (function).
make-aws-host/s (function).
make-aws-url/s (function).
octets-to-string (function).
pad-hex-string (function).
trim-downcase-header (function).
trim-white (function).

Next: Definitions, Previous: Files, Up: The aws-foundation Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

aws-foundation

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

4.1 `aws-foundation`

Source

package.lisp.

Use List

common-lisp.

Public Interface

aws-get (function).
aws4-post (function).
pool/s (function).
region/s (function).
sha256/ba (function).
sha256/hs64 (function).
string-to-octets (function).

Internals

*dex-keep-alive* (special variable).
*dex-verbose* (special variable).
*nl* (special variable).
aws-datestamp (function).
aws-post (function).
aws-sign (function).
aws-timestamp (function).
aws4-authorization-header (function).
aws4-authorization-string (function).
aws4-credential-scope (function).
aws4-signing-key (function).
ba/hs64 (function).
canonical-headers (function).
format-canonical-header-string (function).
format-canonical-signed-headers-string (function).
json-decode-octets/js (function).
make-aws-endpoint (function).
make-aws-host/s (function).
make-aws-url/s (function).
octets-to-string (function).
pad-hex-string (function).
trim-downcase-header (function).
trim-white (function).

Next: Indexes, Previous: Packages, Up: The aws-foundation Reference Manual [Contents][Index]

5 Definitions

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

Public Interface
Internals

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

5.1 Public Interface

Ordinary functions

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

5.1.1 Ordinary functions

Function: aws-get (url_s &key headers) ¶

Package: aws-foundation.
Source: aws-foundation.lisp.

Function: aws4-post (service region target content &key access-key secret-key the-time) ¶

Package: aws-foundation.
Source: aws-foundation.lisp.

Function: pool/s (pool-id_s) ¶

Package: aws-foundation.
Source: aws-foundation.lisp.

Function: region/s (pool-id_s) ¶

Package: aws-foundation.
Source: aws-foundation.lisp.

Function: sha256/ba (vector_ba) ¶

Package: aws-foundation.
Source: aws-foundation.lisp.

Function: sha256/hs64 (vector_ba) ¶

Package: aws-foundation.
Source: aws-foundation.lisp.

Function: string-to-octets (string) ¶

Package: aws-foundation.
Source: aws-foundation.lisp.

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

5.2 Internals

Special variables
Ordinary functions

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

5.2.1 Special variables

Special Variable: *dex-keep-alive* ¶

Package: aws-foundation.
Source: aws-foundation.lisp.

Special Variable: *dex-verbose* ¶

Package: aws-foundation.
Source: aws-foundation.lisp.

Special Variable: *nl* ¶

Package: aws-foundation.
Source: aws-foundation.lisp.

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

5.2.2 Ordinary functions

Function: aws-datestamp (the-time) ¶

Package: aws-foundation.
Source: aws-foundation.lisp.

Function: aws-post (url_s headers content_s) ¶

Package: aws-foundation.
Source: aws-foundation.lisp.

Function: aws-sign (msg key) ¶

Package: aws-foundation.
Source: aws-foundation.lisp.

Function: aws-timestamp (the-time) ¶

Package: aws-foundation.
Source: aws-foundation.lisp.

Function: aws4-authorization-header (aws-host base-headers content_s the-time amz-time region_s service access-key secret-key) ¶

Package: aws-foundation.
Source: aws-foundation.lisp.

Function: aws4-authorization-string (aws-host base-headers content_s the-time amz-time region_s service access-key secret-key) ¶

Package: aws-foundation.
Source: aws-foundation.lisp.

Function: aws4-credential-scope (the-time region service) ¶

Package: aws-foundation.
Source: aws-foundation.lisp.

Function: aws4-signing-key (secret-key the-time region service) ¶

Package: aws-foundation.
Source: aws-foundation.lisp.

Function: ba/hs64 (vector_ba) ¶

Package: aws-foundation.
Source: aws-foundation.lisp.

Function: canonical-headers (headers) ¶

Package: aws-foundation.
Source: aws-foundation.lisp.

Function: format-canonical-header-string (canonical-headers &optional result) ¶

Package: aws-foundation.
Source: aws-foundation.lisp.

Function: format-canonical-signed-headers-string (canonical-headers &optional result separator) ¶

Package: aws-foundation.
Source: aws-foundation.lisp.

Function: json-decode-octets/js (octets) ¶

Package: aws-foundation.
Source: aws-foundation.lisp.

Function: make-aws-endpoint (host_s) ¶

Package: aws-foundation.
Source: aws-foundation.lisp.

Function: make-aws-host/s (service_s region_s) ¶

Package: aws-foundation.
Source: aws-foundation.lisp.

Function: make-aws-url/s (service_s region_s) ¶

Package: aws-foundation.
Source: aws-foundation.lisp.

Function: octets-to-string (octets) ¶

Package: aws-foundation.
Source: aws-foundation.lisp.

Function: pad-hex-string (hs) ¶

Package: aws-foundation.
Source: aws-foundation.lisp.

Function: trim-downcase-header (header) ¶

Package: aws-foundation.
Source: aws-foundation.lisp.

Function: trim-white (s) ¶

Package: aws-foundation.
Source: aws-foundation.lisp.

Previous: Definitions, Up: The aws-foundation Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

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

A.1 Concepts

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

A.2 Functions

Jump to:	A B C F J M O P R S T

	Index Entry	Section

A
	`aws-datestamp`:	Private ordinary functions
	`aws-get`:	Public ordinary functions
	`aws-post`:	Private ordinary functions
	`aws-sign`:	Private ordinary functions
	`aws-timestamp`:	Private ordinary functions
	`aws4-authorization-header`:	Private ordinary functions
	`aws4-authorization-string`:	Private ordinary functions
	`aws4-credential-scope`:	Private ordinary functions
	`aws4-post`:	Public ordinary functions
	`aws4-signing-key`:	Private ordinary functions

B
	`ba/hs64`:	Private ordinary functions

C
	`canonical-headers`:	Private ordinary functions

F
	`format-canonical-header-string`:	Private ordinary functions
	`format-canonical-signed-headers-string`:	Private ordinary functions
	`Function, aws-datestamp`:	Private ordinary functions
	`Function, aws-get`:	Public ordinary functions
	`Function, aws-post`:	Private ordinary functions
	`Function, aws-sign`:	Private ordinary functions
	`Function, aws-timestamp`:	Private ordinary functions
	`Function, aws4-authorization-header`:	Private ordinary functions
	`Function, aws4-authorization-string`:	Private ordinary functions
	`Function, aws4-credential-scope`:	Private ordinary functions
	`Function, aws4-post`:	Public ordinary functions
	`Function, aws4-signing-key`:	Private ordinary functions
	`Function, ba/hs64`:	Private ordinary functions
	`Function, canonical-headers`:	Private ordinary functions
	`Function, format-canonical-header-string`:	Private ordinary functions
	`Function, format-canonical-signed-headers-string`:	Private ordinary functions
	`Function, json-decode-octets/js`:	Private ordinary functions
	`Function, make-aws-endpoint`:	Private ordinary functions
	`Function, make-aws-host/s`:	Private ordinary functions
	`Function, make-aws-url/s`:	Private ordinary functions
	`Function, octets-to-string`:	Private ordinary functions
	`Function, pad-hex-string`:	Private ordinary functions
	`Function, pool/s`:	Public ordinary functions
	`Function, region/s`:	Public ordinary functions
	`Function, sha256/ba`:	Public ordinary functions
	`Function, sha256/hs64`:	Public ordinary functions
	`Function, string-to-octets`:	Public ordinary functions
	`Function, trim-downcase-header`:	Private ordinary functions
	`Function, trim-white`:	Private ordinary functions

J
	`json-decode-octets/js`:	Private ordinary functions

M
	`make-aws-endpoint`:	Private ordinary functions
	`make-aws-host/s`:	Private ordinary functions
	`make-aws-url/s`:	Private ordinary functions

O
	`octets-to-string`:	Private ordinary functions

P
	`pad-hex-string`:	Private ordinary functions
	`pool/s`:	Public ordinary functions

R
	`region/s`:	Public ordinary functions

S
	`sha256/ba`:	Public ordinary functions
	`sha256/hs64`:	Public ordinary functions
	`string-to-octets`:	Public ordinary functions

T
	`trim-downcase-header`:	Private ordinary functions
	`trim-white`:	Private ordinary functions

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	* S

	Index Entry	Section

*
	`dex-keep-alive`:	Private special variables
	`dex-verbose`:	Private special variables
	`nl`:	Private special variables

S
	`Special Variable, dex-keep-alive`:	Private special variables
	`Special Variable, dex-verbose`:	Private special variables
	`Special Variable, nl`:	Private special variables

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

A.4 Data types

Jump to:	A F P S

	Index Entry	Section

A
	`aws-foundation`:	The aws-foundation system
	`aws-foundation`:	The aws-foundation package
	`aws-foundation.asd`:	The aws-foundation/aws-foundation․asd file
	`aws-foundation.lisp`:	The aws-foundation/aws-foundation․lisp file

F
	`File, aws-foundation.asd`:	The aws-foundation/aws-foundation․asd file
	`File, aws-foundation.lisp`:	The aws-foundation/aws-foundation․lisp file
	`File, package.lisp`:	The aws-foundation/package․lisp file

P
	`Package, aws-foundation`:	The aws-foundation package
	`package.lisp`:	The aws-foundation/package․lisp file

S
	`System, aws-foundation`:	The aws-foundation system

The aws-foundation Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 aws-foundation

3 Files

3.1 Lisp

3.1.1 aws-foundation/aws-foundation.asd

3.1.2 aws-foundation/package.lisp

3.1.3 aws-foundation/aws-foundation.lisp

4 Packages

4.1 aws-foundation

5 Definitions

5.1 Public Interface

5.1.1 Ordinary functions

5.2 Internals

5.2.1 Special variables

5.2.2 Ordinary functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `aws-foundation`

3.1.1 `aws-foundation/aws-foundation.asd`

3.1.2 `aws-foundation/package.lisp`

3.1.3 `aws-foundation/aws-foundation.lisp`

4.1 `aws-foundation`