The aws-foundation Reference Manual

Table of Contents

Next: , Previous: , 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 2.4 patchlevel 1 "Will Decker" on Mon Apr 08 12:57:38 2019 GMT+0.


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

1 Introduction

###aws-foundation: A Common Lisp Interface to Amazon AWS Services.

The primary purpose of this libary is provide support for access to Amazon services, such as Cognito or Transcribe.

[Function]
aws4-post (service region target content &key (access-key nil) (secret-key nil) (the-time (local-time:now)))

	=> result, code, response
	
	aws4-post signs and sends a request to Amazon.
	
	On error, **result** is nil.
	
	**code** is the HTTP response code.
	
	On success, **response** is nil.  On error, **response** is the decoded JSON response provided by Amazon.
	
	Example:
	
		(aws-foundation:aws4-post "cognito-idp" "us-east-1"
		                          "AWSCognitoIdentityProviderService.ListUsers"
		                          `(("UserPoolId" . ,pool-id)
		                          ,@(if pagination-token `(("PaginationToken" . ,pagination-token))))
		                          :access-key access-key
		                          :secret-key secret-key))
		                          
		(aws-foundation:aws4-post "transcribe" "us-east-1"
		                          "Transcribe.StartTranscriptionJob"
		                          `(("LanguageCode" . ,language-code)
		                            ("Media" . (("MediaFileUri" . ,url)))
		                            ("MediaFormat" . ,media)
		                            ("MediaSampleRateHertz" . ,sample-rate)
		                            ("TranscriptionJobName" . , job-name))
		                           :access-key access-key
		                           :secret-key secret-key))

[Function]
aws-get (url_s &key (headers nil))

	=> result, code, response

	Constructs and makes an http GET request and decodes the result using Amazon conventions (JSON error
	responses, for example).

[Function]
region/s (pool-id)

	Returns the region portion of a pool id.
	
	(region/s "us-east-1_abcdefghi") -> "us-east-1"

[Function]
pool/s (pool-id)

	Returns the pool portion of a pool id.
	
	(region/s "us-east-1_abcdefghi") -> "abcdefghi"

[Function]
string-to-octets (string)

	Converts string to a vector of octets using utf-8 encoding.

[Function]
sha256/ba (vector)

	Create a sha256 digest of the vector of octets

[Function]
sha256/hs64 (vector)

	Create a 64 character string, padded with '0' on the left, of the sha256 digest of the vector of octets

HTTP engine

Dexador is used to process HTTPS requests. The code encapsulates this in two functions, aws-post and aws-get, so it would be easyto use Drakma, instead.

Repository

https://github.com/stablecross/aws-foundation

####License aws-foundation is available under a BSD-like license. See the file LICENSE for details.

Contact

For any questions or comments, please feel free to email me, Bob Felts wrf3@stablecross.com


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 aws-foundation

Author

Bob Felts <wrf3@stablecross.com>

License

BSD

Description

Amazon AWS low-level utilities

Version

1.0.0

Dependencies
Source

aws-foundation.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 aws-foundation.asd

Location

aws-foundation.asd

Systems

aws-foundation (system)


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

3.1.2 aws-foundation/package.lisp

Parent

aws-foundation (system)

Location

package.lisp

Packages

aws-foundation


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

3.1.3 aws-foundation/aws-foundation.lisp

Dependency

package.lisp (file)

Parent

aws-foundation (system)

Location

aws-foundation.lisp

Exported Definitions
Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 aws-foundation

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


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

5.1.1 Functions

Function: aws-get URL_S &key HEADERS
Package

aws-foundation

Source

aws-foundation.lisp (file)

Function: aws4-post SERVICE REGION TARGET CONTENT &key ACCESS-KEY SECRET-KEY THE-TIME
Package

aws-foundation

Source

aws-foundation.lisp (file)

Function: pool/s POOL-ID_S
Package

aws-foundation

Source

aws-foundation.lisp (file)

Function: region/s POOL-ID_S
Package

aws-foundation

Source

aws-foundation.lisp (file)

Function: sha256/ba VECTOR_BA
Package

aws-foundation

Source

aws-foundation.lisp (file)

Function: sha256/hs64 VECTOR_BA
Package

aws-foundation

Source

aws-foundation.lisp (file)

Function: string-to-octets STRING
Package

aws-foundation

Source

aws-foundation.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: *dex-keep-alive*
Package

aws-foundation

Source

aws-foundation.lisp (file)

Special Variable: *dex-verbose*
Package

aws-foundation

Source

aws-foundation.lisp (file)

Special Variable: *nl*
Package

aws-foundation

Source

aws-foundation.lisp (file)


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

5.2.2 Functions

Function: aws-datestamp THE-TIME
Package

aws-foundation

Source

aws-foundation.lisp (file)

Function: aws-post URL_S HEADERS CONTENT_S
Package

aws-foundation

Source

aws-foundation.lisp (file)

Function: aws-sign MSG KEY
Package

aws-foundation

Source

aws-foundation.lisp (file)

Function: aws-timestamp THE-TIME
Package

aws-foundation

Source

aws-foundation.lisp (file)

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

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

Function: aws4-credential-scope THE-TIME REGION SERVICE
Package

aws-foundation

Source

aws-foundation.lisp (file)

Function: aws4-signing-key SECRET-KEY THE-TIME REGION SERVICE
Package

aws-foundation

Source

aws-foundation.lisp (file)

Function: ba/hs64 VECTOR_BA
Package

aws-foundation

Source

aws-foundation.lisp (file)

Function: canonical-headers HEADERS
Package

aws-foundation

Source

aws-foundation.lisp (file)

Function: format-canonical-header-string CANONICAL-HEADERS &optional RESULT
Package

aws-foundation

Source

aws-foundation.lisp (file)

Function: format-canonical-signed-headers-string CANONICAL-HEADERS &optional RESULT SEPARATOR
Package

aws-foundation

Source

aws-foundation.lisp (file)

Function: json-decode-octets/js OCTETS
Package

aws-foundation

Source

aws-foundation.lisp (file)

Function: make-aws-endpoint HOST_S
Package

aws-foundation

Source

aws-foundation.lisp (file)

Function: make-aws-host/s SERVICE_S REGION_S
Package

aws-foundation

Source

aws-foundation.lisp (file)

Function: make-aws-url/s SERVICE_S REGION_S
Package

aws-foundation

Source

aws-foundation.lisp (file)

Function: octets-to-string OCTETS
Package

aws-foundation

Source

aws-foundation.lisp (file)

Function: pad-hex-string HS
Package

aws-foundation

Source

aws-foundation.lisp (file)

Function: trim-downcase-header HEADER
Package

aws-foundation

Source

aws-foundation.lisp (file)

Function: trim-white S
Package

aws-foundation

Source

aws-foundation.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   A   F   L  
Index Entry  Section

A
aws-foundation.asd: The aws-foundation<dot>asd file
aws-foundation/aws-foundation.lisp: The aws-foundation/aws-foundation<dot>lisp file
aws-foundation/package.lisp: The aws-foundation/package<dot>lisp file

F
File, Lisp, aws-foundation.asd: The aws-foundation<dot>asd file
File, Lisp, aws-foundation/aws-foundation.lisp: The aws-foundation/aws-foundation<dot>lisp file
File, Lisp, aws-foundation/package.lisp: The aws-foundation/package<dot>lisp file

L
Lisp File, aws-foundation.asd: The aws-foundation<dot>asd file
Lisp File, aws-foundation/aws-foundation.lisp: The aws-foundation/aws-foundation<dot>lisp file
Lisp File, aws-foundation/package.lisp: The aws-foundation/package<dot>lisp file

Jump to:   A   F   L  

Next: , Previous: , 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: Internal functions
aws-get: Exported functions
aws-post: Internal functions
aws-sign: Internal functions
aws-timestamp: Internal functions
aws4-authorization-header: Internal functions
aws4-authorization-string: Internal functions
aws4-credential-scope: Internal functions
aws4-post: Exported functions
aws4-signing-key: Internal functions

B
ba/hs64: Internal functions

C
canonical-headers: Internal functions

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

J
json-decode-octets/js: Internal functions

M
make-aws-endpoint: Internal functions
make-aws-host/s: Internal functions
make-aws-url/s: Internal functions

O
octets-to-string: Internal functions

P
pad-hex-string: Internal functions
pool/s: Exported functions

R
region/s: Exported functions

S
sha256/ba: Exported functions
sha256/hs64: Exported functions
string-to-octets: Exported functions

T
trim-downcase-header: Internal functions
trim-white: Internal functions

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

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

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*dex-keep-alive*: Internal special variables
*dex-verbose*: Internal special variables
*nl*: Internal special variables

S
Special Variable, *dex-keep-alive*: Internal special variables
Special Variable, *dex-verbose*: Internal special variables
Special Variable, *nl*: Internal special variables

Jump to:   *  
S  

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

A.4 Data types

Jump to:   A   P   S  
Index Entry  Section

A
aws-foundation: The aws-foundation system
aws-foundation: The aws-foundation package

P
Package, aws-foundation: The aws-foundation package

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

Jump to:   A   P   S