The hh-aws Reference Manual

Table of Contents

The hh-aws Reference Manual

This is the hh-aws Reference Manual, version 0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 13:43:57 2020 GMT+0.

1 Introduction

hh-aws

This package is a Common Lisp library for acessing the APIs of Amazon Web Services.  Current services supported 
(partially or completely) are:

* Simple Storage Service (S3) -- version 3/1/2006
* SimpleDB (SDB) -- version 7/11/2007
* Elastic Compute Cloud (EC2) -- version 6/15/2010
* Simple Queue Service (SQS) -- version 1/1/2008

All code in this package is licensed under the MIT License.

When possible, the library uses the REST versions of AWS APIs, rather than SOAP.  Also, unfortunately, the library
is still using older versions of some Amazon services, and are in need of update to newer versions of Amazon APIs.

To access AWS, you must have an AWS account.  The library uses the *credentials* variable to locate an object which 
can supply credentials when needed to perform AWS calls.  The object in *credentials* can be any object that implements
generic methods #'access-key-id and #'secret-key, each of which take a single argument.  Each function is expected
to return the appropriate value required by AWS.  By default, the library uses an internal implementation which
assumes the AWS access key id is in a text file located at ~/.aws/access-key-id and the secret key is in a text
file located at ~/.aws/secret-key.

The library exports #:*credentials, #:access-key-id, and #:secret-key, so you are free to add your own implementation
for providing credentials when needed.

To test that your installation is working, place your credentials in the files mentioned above,  load package :hh-aws-tests, 
and then run:

(lisp-unit:run-all-tests :hh-aws-tests)

Note that timing errors or temporary conditions can sometimes make these tests fail.  If it appears Amazon has
reported service unavailable on one or more calls, just run the tests again, as they will likely then succeed.

Contact phil@haphazardhouse.net for any questions, comments, feedback, or contributions, and keep an eye on
http://haphazardhouse.net/projects/hh-aws for info and news about this library.

Thanks!

2 Systems

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

2.1 hh-aws

Version

0.1

Dependencies

• drakma
• puri
• cl-base64
• ironclad
• s-xml

Source

hh-aws.asd (file)

Components

• package.lisp (file)
• utils.lisp (file)
• constants.lisp (file)
• conditions.lisp (file)
• xml.lisp (file)
• common.lisp (file)
• sdb.lisp (file)
• s3.lisp (file)
• sqs.lisp (file)
• ec2.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 hh-aws.asd

Location

hh-aws.asd

Systems

hh-aws (system)

3.1.2 hh-aws/package.lisp

Parent

hh-aws (system)

Location

package.lisp

Packages

• hh-aws-asd
• hh-aws

3.1.3 hh-aws/utils.lisp

Dependency

package.lisp (file)

Parent

hh-aws (system)

Location

utils.lisp

Internal Definitions

• bytes-to-string (function)
• cout (macro)
• detokenize (function)
• ensure-string-ends-with (function)
• format-string (macro)
• hash-entries (function)
• home-dir (function)
• map-name-value-pairs (function)
• putend (macro)
• sort-hashtable (function)
• string-ends-with (function)
• string-starts-with (function)
• string-to-bytes (function)
• use-symbol (function)

3.1.4 hh-aws/constants.lisp

Dependencies

• package.lisp (file)
• utils.lisp (file)

Parent

hh-aws (system)

Location

constants.lisp

Internal Definitions

• *http-reason-phrase-map* (special variable)
• +http-accepted+ (constant)
• +http-authorization-required+ (constant)
• +http-bad-gateway+ (constant)
• +http-bad-request+ (constant)
• +http-conflict+ (constant)
• +http-continue+ (constant)
• +http-created+ (constant)
• +http-expectation-failed+ (constant)
• +http-failed-dependency+ (constant)
• +http-forbidden+ (constant)
• +http-gateway-time-out+ (constant)
• +http-gone+ (constant)
• +http-internal-server-error+ (constant)
• +http-length-required+ (constant)
• +http-method-not-allowed+ (constant)
• +http-moved-permanently+ (constant)
• +http-moved-temporarily+ (constant)
• +http-multi-status+ (constant)
• +http-multiple-choices+ (constant)
• +http-no-content+ (constant)
• +http-non-authoritative-information+ (constant)
• +http-not-acceptable+ (constant)
• +http-not-found+ (constant)
• +http-not-implemented+ (constant)
• +http-not-modified+ (constant)
• +http-ok+ (constant)
• +http-partial-content+ (constant)
• +http-payment-required+ (constant)
• +http-precondition-failed+ (constant)
• +http-proxy-authentication-required+ (constant)
• +http-request-entity-too-large+ (constant)
• +http-request-time-out+ (constant)
• +http-request-uri-too-large+ (constant)
• +http-requested-range-not-satisfiable+ (constant)
• +http-reset-content+ (constant)
• +http-see-other+ (constant)
• +http-service-unavailable+ (constant)
• +http-switching-protocols+ (constant)
• +http-temporary-redirect+ (constant)
• +http-unsupported-media-type+ (constant)
• +http-use-proxy+ (constant)
• +http-version-not-supported+ (constant)
• def-http-return-code (macro)

3.1.5 hh-aws/conditions.lisp

Dependencies

• package.lisp (file)
• utils.lisp (file)

Parent

hh-aws (system)

Location

conditions.lisp

Exported Definitions

• aws-error (condition)
• bad-digest-error (condition)
• bucket-not-empty-error (condition)
• invalid-client-token-id-error (condition)
• invalid-query-expression-error (condition)
• no-such-bucket-error (condition)
• no-such-domain-error (condition)
• no-such-key-error (condition)
• service-unavailable-error (condition)
• signature-does-not-match-error (condition)

Internal Definitions

• error-code (method)
• (setf error-code) (method)
• error-message (method)
• (setf error-message) (method)
• error-response (method)
• (setf error-response) (method)
• raise-aws-condition (macro)

3.1.6 hh-aws/xml.lisp

Dependencies

• package.lisp (file)
• utils.lisp (file)

Parent

hh-aws (system)

Location

xml.lisp

Internal Definitions

• *current-elements* (special variable)
• *current-elements-to-find* (special variable)
• *current-handlers* (special variable)
• *elements-found* (special variable)
• *elements-to-find* (special variable)
• *finds* (special variable)
• builder (class)
• builder-parser (function)
• capture-text (generic function)
• capture-text (method)
• capture-text (method)
• capture-text (method)
• current-element (function)
• current-element-to-find (function)
• current-handler (function)
• current-of (method)
• (setf current-of) (method)
• default-parser (function)
• defxmlparser (macro)
• enter-element (generic function)
• enter-element (method)
• enter-element (method)
• exit-element (generic function)
• exit-element (method)
• exit-element (method)
• exit-element (method)
• find-path-builder (class)
• find-path-parser (function)
• find-responses (function)
• finish-parse (generic function)
• finish-parse (method)
• finish-parse (method)
• move-to-next-element-to-find (function)
• on-finish-element (function)
• on-start-element (function)
• on-text (function)
• path-p (function)
• path-to-match (method)
• (setf path-to-match) (method)
• pop-handler (function)
• push-handler (function)
• results-of (method)
• (setf results-of) (method)

3.1.7 hh-aws/common.lisp

Dependencies

• constants.lisp (file)
• conditions.lisp (file)
• xml.lisp (file)

Parent

hh-aws (system)

Location

common.lisp

Exported Definitions

• *credentials* (special variable)
• access-key-id (generic function)
• access-key-id (method)
• access-key-id (method)
• access-key-id (method)
• secret-key (generic function)
• secret-key (method)
• secret-key (method)
• secret-key (method)

Internal Definitions

• add-header (generic function)
• add-header (method)
• add-parameter (generic function)
• add-parameter (method)
• additional-headers-of (generic function)
• additional-headers-of (method)
• aws-date (function)
• aws-timestamp (function)
• call-service (generic function)
• call-service (method)
• call-succeeded (generic function)
• call-succeeded (method)
• canonical-query-string (generic function)
• canonical-query-string (method)
• credentials (class)
• date-header-of (generic function)
• date-header-of (method)
• default-action (generic function)
• defrequest (macro)
• defservice (macro)
• empty-credentials (class)
• endpoint-of (generic function)
• endpoint-of (method)
• error-format (generic function)
• error-format (method)
• explicit-credentials (class)
• extract-errors (generic function)
• extract-errors (method)
• extract-result (generic function)
• extract-result (method)
• has-amz-headers-p (generic function)
• has-amz-headers-p (method)
• headers-of (method)
• (setf headers-of) (method)
• http-host-header (generic function)
• http-host-header (method)
• http-request-uri (generic function)
• http-request-uri (method)
• http-uri (generic function)
• http-uri (method)
• http-verb (generic function)
• http-verb (method)
• make-request (generic function)
• make-request (method)
• make-response (function)
• md5-digest (generic function)
• md5-digest (method)
• message (class)
• method-of (generic function)
• method-of (method)
• parameters-of (method)
• (setf parameters-of) (method)
• request (class)
• request-signature (generic function)
• request-signature (method)
• request-string-to-sign (generic function)
• request-string-to-sign (method)
• response (class)
• response-body (method)
• (setf response-body) (method)
• response-headers (method)
• (setf response-headers) (method)
• response-must-close (method)
• (setf response-must-close) (method)
• response-reason-phrase (method)
• (setf response-reason-phrase) (method)
• response-status-code (method)
• (setf response-status-code) (method)
• response-stream (method)
• (setf response-stream) (method)
• response-values (macro)
• result-format (generic function)
• result-format (method)
• send-http-request (generic function)
• send-http-request (method)
• send-request (generic function)
• send-request (method)
• service (class)
• service-of (method)
• (setf service-of) (method)
• signature-digest-algorithm (generic function)
• signature-digest-algorithm (method)
• signed-parameters-of (generic function)
• signed-parameters-of (method)
• sorted-headers (generic function)
• sorted-headers (method)
• sorted-parameters (generic function)
• sorted-parameters (method)
• uri-of (method)
• (setf uri-of) (method)
• url-decode (function)
• user-private-credentials (class)
• version-of (generic function)

3.1.8 hh-aws/sdb.lisp

Dependency

common.lisp (file)

Parent

hh-aws (system)

Location

sdb.lisp

Exported Definitions

• db-create-domain (function)
• db-delete-attributes (function)
• db-delete-domain (function)
• db-domain-metadata (function)
• db-get-attributes (function)
• db-list-domains (function)
• db-put-attributes (function)
• db-query (function)
• db-query-with-attributes (function)
• db-select (function)

Internal Definitions

• add-attribute-name-parameters (generic function)
• add-attribute-name-parameters (method)
• add-attribute-parameters (generic function)
• add-attribute-parameters (method)
• attributes-of (method)
• (setf attributes-of) (method)
• call-service (method)
• call-service (method)
• call-service (method)
• capture-text (method)
• current-attribute-of (method)
• (setf current-attribute-of) (method)
• db-create-domain-request (class)
• db-delete-attributes-request (class)
• db-delete-domain-request (class)
• db-domain-metadata-request (class)
• db-get-attributes-request (class)
• db-list-domains-request (class)
• db-put-attributes-request (class)
• db-query-request (class)
• db-query-with-attributes-request (class)
• db-request (class)
• db-select-request (class)
• default-action (method)
• default-action (method)
• default-action (method)
• default-action (method)
• default-action (method)
• default-action (method)
• default-action (method)
• default-action (method)
• default-action (method)
• default-action (method)
• endpoint-of (method)
• enter-element (method)
• exit-element (method)
• extract-result (method)
• extract-result (method)
• extract-result (method)
• extract-result (method)
• extract-result (method)
• extract-result (method)
• extract-result (method)
• extract-result (method)
• finish-parse (method)
• items-builder (class)
• items-parser (function)
• result-format (method)
• result-format (method)
• result-format (method)
• result-format (method)
• signed-parameters-of (method)
• simpledb (class)
• version-of (method)

3.1.9 hh-aws/s3.lisp

Dependency

common.lisp (file)

Parent

hh-aws (system)

Location

s3.lisp

Exported Definitions

• s3-create-bucket (function)
• s3-delete-bucket (function)
• s3-delete-bucket-object (function)
• s3-get-bucket-object (function)
• s3-list-bucket-objects (function)
• s3-list-buckets (function)
• s3-put-bucket-object (function)

Internal Definitions

• additional-headers-of (method)
• attributes-of (method)
• (setf attributes-of) (method)
• bucket-contents-builder (class)
• bucket-contents-parser (function)
• bucket-for (method)
• (setf bucket-for) (method)
• bucket-object-for (method)
• (setf bucket-object-for) (method)
• call-service (method)
• call-service (method)
• call-service (method)
• call-service (method)
• call-service (method)
• call-service (method)
• canonicalized-amz-headers-of (generic function)
• canonicalized-amz-headers-of (method)
• canonicalized-resource-of (generic function)
• canonicalized-resource-of (method)
• capture-text (method)
• capture-text (method)
• content-length-of (generic function)
• content-length-of (method)
• content-md5-of (generic function)
• content-md5-of (method)
• content-type-of (generic function)
• content-type-of (method)
• current-attribute-of (method)
• (setf current-attribute-of) (method)
• endpoint-of (method)
• endpoint-of (method)
• enter-element (method)
• enter-element (method)
• exit-element (method)
• exit-element (method)
• extract-result (method)
• extract-result (method)
• extract-result (method)
• extract-result (method)
• extract-result (method)
• extract-result (method)
• extract-result (method)
• extract-result (method)
• finish-parse (method)
• finish-parse (method)
• http-uri (method)
• list-buckets-builder (class)
• list-buckets-parser (function)
• method-of (method)
• method-of (method)
• method-of (method)
• method-of (method)
• method-of (method)
• method-of (method)
• object-content-for (method)
• (setf object-content-for) (method)
• request-string-to-sign (method)
• s3 (class)
• s3-create-bucket-request (class)
• s3-delete-bucket-object-request (class)
• s3-delete-bucket-request (class)
• s3-get-bucket-object-request (class)
• s3-list-bucket-objects-request (class)
• s3-list-buckets-request (class)
• s3-put-bucket-object-request (class)
• s3-request (class)
• send-http-request (method)
• send-http-request (method)
• signature-digest-algorithm (method)
• version-of (method)

3.1.10 hh-aws/sqs.lisp

Dependency

common.lisp (file)

Parent

hh-aws (system)

Location

sqs.lisp

Exported Definitions

• sqs-create-queue (function)
• sqs-delete-message (function)
• sqs-delete-queue (function)
• sqs-get-queue-attributes (function)
• sqs-list-queues (function)
• sqs-receive-message (function)
• sqs-send-message (function)
• sqs-set-queue-attributes (function)

Internal Definitions

• call-service (method)
• call-service (method)
• call-service (method)
• call-service (method)
• call-service (method)
• call-service (method)
• default-action (method)
• default-action (method)
• default-action (method)
• default-action (method)
• default-action (method)
• default-action (method)
• default-action (method)
• default-action (method)
• endpoint-of (method)
• extract-result (method)
• extract-result (method)
• extract-result (method)
• extract-result (method)
• extract-result (method)
• extract-result (method)
• http-uri (method)
• queue-for (method)
• (setf queue-for) (method)
• result-format (method)
• result-format (method)
• result-format (method)
• result-format (method)
• signed-parameters-of (method)
• simple-queue-service (class)
• sqs-create-queue-request (class)
• sqs-delete-message-request (class)
• sqs-delete-queue-request (class)
• sqs-get-queue-attributes-request (class)
• sqs-list-queues-request (class)
• sqs-receive-message-request (class)
• sqs-request (class)
• sqs-send-message-request (class)
• sqs-set-queue-attributes-request (class)
• version-of (method)

3.1.11 hh-aws/ec2.lisp

Dependency

common.lisp (file)

Parent

hh-aws (system)

Location

ec2.lisp

Exported Definitions

• ec2-authorize-security-group-ingress (function)
• ec2-describe-availability-zones (function)
• ec2-describe-instances (function)
• ec2-describe-regions (function)
• ec2-describe-security-groups (function)
• ec2-revoke-security-group-ingress (function)

Internal Definitions

• call-service (method)
• call-service (method)
• capture-text (method)
• capture-text (method)
• current-permission-of (method)
• (setf current-permission-of) (method)
• default-action (method)
• default-action (method)
• default-action (method)
• default-action (method)
• default-action (method)
• default-action (method)
• ec2 (class)
• ec2-authorize-security-group-ingress-request (class)
• ec2-describe-availability-zones-request (class)
• ec2-describe-instances-request (class)
• ec2-describe-regions-request (class)
• ec2-describe-security-groups-request (class)
• ec2-instances-parser (function)
• ec2-request (class)
• ec2-revoke-security-group-ingress-request (class)
• endpoint-of (method)
• endpoint-of (method)
• enter-element (method)
• enter-element (method)
• exit-element (method)
• extract-result (method)
• extract-result (method)
• finish-parse (method)
• finish-parse (method)
• region-for (method)
• (setf region-for) (method)
• result-format (method)
• result-format (method)
• result-format (method)
• security-group-builder (class)
• security-groups-parser (function)
• signed-parameters-of (method)
• version-of (method)

4 Packages

Packages are listed by definition order.

4.1 hh-aws-asd

Source

package.lisp (file)

Use List

• asdf/interface
• common-lisp

4.2 hh-aws

Source

package.lisp (file)

Nickname

aws

Use List

• cl-base64
• drakma
• common-lisp

Exported Definitions

• *credentials* (special variable)
• access-key-id (generic function)
• access-key-id (method)
• access-key-id (method)
• access-key-id (method)
• aws-error (condition)
• bad-digest-error (condition)
• bucket-not-empty-error (condition)
• db-create-domain (function)
• db-delete-attributes (function)
• db-delete-domain (function)
• db-domain-metadata (function)
• db-get-attributes (function)
• db-list-domains (function)
• db-put-attributes (function)
• db-query (function)
• db-query-with-attributes (function)
• db-select (function)
• ec2-authorize-security-group-ingress (function)
• ec2-describe-availability-zones (function)
• ec2-describe-instances (function)
• ec2-describe-regions (function)
• ec2-describe-security-groups (function)
• ec2-revoke-security-group-ingress (function)
• invalid-client-token-id-error (condition)
• invalid-query-expression-error (condition)
• no-such-bucket-error (condition)
• no-such-domain-error (condition)
• no-such-key-error (condition)
• s3-create-bucket (function)
• s3-delete-bucket (function)
• s3-delete-bucket-object (function)
• s3-get-bucket-object (function)
• s3-list-bucket-objects (function)
• s3-list-buckets (function)
• s3-put-bucket-object (function)
• secret-key (generic function)
• secret-key (method)
• secret-key (method)
• secret-key (method)
• service-unavailable-error (condition)
• signature-does-not-match-error (condition)
• sqs-create-queue (function)
• sqs-delete-message (function)
• sqs-delete-queue (function)
• sqs-get-queue-attributes (function)
• sqs-list-queues (function)
• sqs-receive-message (function)
• sqs-send-message (function)
• sqs-set-queue-attributes (function)

Internal Definitions

• *current-elements* (special variable)
• *current-elements-to-find* (special variable)
• *current-handlers* (special variable)
• *elements-found* (special variable)
• *elements-to-find* (special variable)
• *finds* (special variable)
• *http-reason-phrase-map* (special variable)
• +http-accepted+ (constant)
• +http-authorization-required+ (constant)
• +http-bad-gateway+ (constant)
• +http-bad-request+ (constant)
• +http-conflict+ (constant)
• +http-continue+ (constant)
• +http-created+ (constant)
• +http-expectation-failed+ (constant)
• +http-failed-dependency+ (constant)
• +http-forbidden+ (constant)
• +http-gateway-time-out+ (constant)
• +http-gone+ (constant)
• +http-internal-server-error+ (constant)
• +http-length-required+ (constant)
• +http-method-not-allowed+ (constant)
• +http-moved-permanently+ (constant)
• +http-moved-temporarily+ (constant)
• +http-multi-status+ (constant)
• +http-multiple-choices+ (constant)
• +http-no-content+ (constant)
• +http-non-authoritative-information+ (constant)
• +http-not-acceptable+ (constant)
• +http-not-found+ (constant)
• +http-not-implemented+ (constant)
• +http-not-modified+ (constant)
• +http-ok+ (constant)
• +http-partial-content+ (constant)
• +http-payment-required+ (constant)
• +http-precondition-failed+ (constant)
• +http-proxy-authentication-required+ (constant)
• +http-request-entity-too-large+ (constant)
• +http-request-time-out+ (constant)
• +http-request-uri-too-large+ (constant)
• +http-requested-range-not-satisfiable+ (constant)
• +http-reset-content+ (constant)
• +http-see-other+ (constant)
• +http-service-unavailable+ (constant)
• +http-switching-protocols+ (constant)
• +http-temporary-redirect+ (constant)
• +http-unsupported-media-type+ (constant)
• +http-use-proxy+ (constant)
• +http-version-not-supported+ (constant)
• add-attribute-name-parameters (generic function)
• add-attribute-name-parameters (method)
• add-attribute-parameters (generic function)
• add-attribute-parameters (method)
• add-header (generic function)
• add-header (method)
• add-parameter (generic function)
• add-parameter (method)
• additional-headers-of (generic function)
• additional-headers-of (method)
• additional-headers-of (method)
• attributes-of (generic function)
• attributes-of (method)
• (setf attributes-of) (method)
• attributes-of (method)
• (setf attributes-of) (method)
• (setf attributes-of) (generic function)
• aws-date (function)
• aws-timestamp (function)
• bucket-contents-builder (class)
• bucket-contents-parser (function)
• bucket-for (generic function)
• bucket-for (method)
• (setf bucket-for) (method)
• (setf bucket-for) (generic function)
• bucket-object-for (generic function)
• bucket-object-for (method)
• (setf bucket-object-for) (method)
• (setf bucket-object-for) (generic function)
• builder (class)
• builder-parser (function)
• bytes-to-string (function)
• call-service (generic function)
• call-service (method)
• call-service (method)
• call-service (method)
• call-service (method)
• call-service (method)
• call-service (method)
• call-service (method)
• call-service (method)
• call-service (method)
• call-service (method)
• call-service (method)
• call-service (method)
• call-service (method)
• call-service (method)
• call-service (method)
• call-service (method)
• call-service (method)
• call-service (method)
• call-succeeded (generic function)
• call-succeeded (method)
• canonical-query-string (generic function)
• canonical-query-string (method)
• canonicalized-amz-headers-of (generic function)
• canonicalized-amz-headers-of (method)
• canonicalized-resource-of (generic function)
• canonicalized-resource-of (method)
• capture-text (generic function)
• capture-text (method)
• capture-text (method)
• capture-text (method)
• capture-text (method)
• capture-text (method)
• capture-text (method)
• capture-text (method)
• capture-text (method)
• content-length-of (generic function)
• content-length-of (method)
• content-md5-of (generic function)
• content-md5-of (method)
• content-type-of (generic function)
• content-type-of (method)
• cout (macro)
• credentials (class)
• current-attribute-of (generic function)
• current-attribute-of (method)
• (setf current-attribute-of) (method)
• current-attribute-of (method)
• (setf current-attribute-of) (method)
• (setf current-attribute-of) (generic function)
• current-element (function)
• current-element-to-find (function)
• current-handler (function)
• current-of (generic function)
• current-of (method)
• (setf current-of) (method)
• (setf current-of) (generic function)
• current-permission-of (generic function)
• current-permission-of (method)
• (setf current-permission-of) (method)
• (setf current-permission-of) (generic function)
• date-header-of (generic function)
• date-header-of (method)
• db-create-domain-request (class)
• db-delete-attributes-request (class)
• db-delete-domain-request (class)
• db-domain-metadata-request (class)
• db-get-attributes-request (class)
• db-list-domains-request (class)
• db-put-attributes-request (class)
• db-query-request (class)
• db-query-with-attributes-request (class)
• db-request (class)
• db-select-request (class)
• def-http-return-code (macro)
• default-action (generic function)
• default-action (method)
• default-action (method)
• default-action (method)
• default-action (method)
• default-action (method)
• default-action (method)
• default-action (method)
• default-action (method)
• default-action (method)
• default-action (method)
• default-action (method)
• default-action (method)
• default-action (method)
• default-action (method)
• default-action (method)
• default-action (method)
• default-action (method)
• default-action (method)
• default-action (method)
• default-action (method)
• default-action (method)
• default-action (method)
• default-action (method)
• default-action (method)
• default-parser (function)
• defrequest (macro)
• defservice (macro)
• defxmlparser (macro)
• detokenize (function)
• ec2 (class)
• ec2-authorize-security-group-ingress-request (class)
• ec2-describe-availability-zones-request (class)
• ec2-describe-instances-request (class)
• ec2-describe-regions-request (class)
• ec2-describe-security-groups-request (class)
• ec2-instances-parser (function)
• ec2-request (class)
• ec2-revoke-security-group-ingress-request (class)
• empty-credentials (class)
• endpoint-of (generic function)
• endpoint-of (method)
• endpoint-of (method)
• endpoint-of (method)
• endpoint-of (method)
• endpoint-of (method)
• endpoint-of (method)
• endpoint-of (method)
• ensure-string-ends-with (function)
• enter-element (generic function)
• enter-element (method)
• enter-element (method)
• enter-element (method)
• enter-element (method)
• enter-element (method)
• enter-element (method)
• enter-element (method)
• error-code (generic function)
• error-code (method)
• (setf error-code) (method)
• (setf error-code) (generic function)
• error-format (generic function)
• error-format (method)
• error-message (generic function)
• error-message (method)
• (setf error-message) (method)
• (setf error-message) (generic function)
• error-response (generic function)
• error-response (method)
• (setf error-response) (method)
• (setf error-response) (generic function)
• exit-element (generic function)
• exit-element (method)
• exit-element (method)
• exit-element (method)
• exit-element (method)
• exit-element (method)
• exit-element (method)
• exit-element (method)
• explicit-credentials (class)
• extract-errors (generic function)
• extract-errors (method)
• extract-result (generic function)
• extract-result (method)
• extract-result (method)
• extract-result (method)
• extract-result (method)
• extract-result (method)
• extract-result (method)
• extract-result (method)
• extract-result (method)
• extract-result (method)
• extract-result (method)
• extract-result (method)
• extract-result (method)
• extract-result (method)
• extract-result (method)
• extract-result (method)
• extract-result (method)
• extract-result (method)
• extract-result (method)
• extract-result (method)
• extract-result (method)
• extract-result (method)
• extract-result (method)
• extract-result (method)
• extract-result (method)
• extract-result (method)
• find-path-builder (class)
• find-path-parser (function)
• find-responses (function)
• finish-parse (generic function)
• finish-parse (method)
• finish-parse (method)
• finish-parse (method)
• finish-parse (method)
• finish-parse (method)
• finish-parse (method)
• finish-parse (method)
• format-string (macro)
• has-amz-headers-p (generic function)
• has-amz-headers-p (method)
• hash-entries (function)
• headers-of (generic function)
• headers-of (method)
• (setf headers-of) (method)
• (setf headers-of) (generic function)
• home-dir (function)
• http-host-header (generic function)
• http-host-header (method)
• http-request-uri (generic function)
• http-request-uri (method)
• http-uri (generic function)
• http-uri (method)
• http-uri (method)
• http-uri (method)
• http-verb (generic function)
• http-verb (method)
• items-builder (class)
• items-parser (function)
• list-buckets-builder (class)
• list-buckets-parser (function)
• make-request (generic function)
• make-request (method)
• make-response (function)
• map-name-value-pairs (function)
• md5-digest (generic function)
• md5-digest (method)
• message (class)
• method-of (generic function)
• method-of (method)
• method-of (method)
• method-of (method)
• method-of (method)
• method-of (method)
• method-of (method)
• method-of (method)
• move-to-next-element-to-find (function)
• object-content-for (generic function)
• object-content-for (method)
• (setf object-content-for) (method)
• (setf object-content-for) (generic function)
• on-finish-element (function)
• on-start-element (function)
• on-text (function)
• parameters-of (generic function)
• parameters-of (method)
• (setf parameters-of) (method)
• (setf parameters-of) (generic function)
• path-p (function)
• path-to-match (generic function)
• path-to-match (method)
• (setf path-to-match) (method)
• (setf path-to-match) (generic function)
• pop-handler (function)
• push-handler (function)
• putend (macro)
• queue-for (generic function)
• queue-for (method)
• (setf queue-for) (method)
• (setf queue-for) (generic function)
• raise-aws-condition (macro)
• region-for (generic function)
• region-for (method)
• (setf region-for) (method)
• (setf region-for) (generic function)
• request (class)
• request-signature (generic function)
• request-signature (method)
• request-string-to-sign (generic function)
• request-string-to-sign (method)
• request-string-to-sign (method)
• response (class)
• response-body (generic function)
• response-body (method)
• (setf response-body) (method)
• (setf response-body) (generic function)
• response-headers (generic function)
• response-headers (method)
• (setf response-headers) (method)
• (setf response-headers) (generic function)
• response-must-close (generic function)
• response-must-close (method)
• (setf response-must-close) (method)
• (setf response-must-close) (generic function)
• response-reason-phrase (generic function)
• response-reason-phrase (method)
• (setf response-reason-phrase) (method)
• (setf response-reason-phrase) (generic function)
• response-status-code (generic function)
• response-status-code (method)
• (setf response-status-code) (method)
• (setf response-status-code) (generic function)
• response-stream (generic function)
• response-stream (method)
• (setf response-stream) (method)
• (setf response-stream) (generic function)
• response-values (macro)
• result-format (generic function)
• result-format (method)
• result-format (method)
• result-format (method)
• result-format (method)
• result-format (method)
• result-format (method)
• result-format (method)
• result-format (method)
• result-format (method)
• result-format (method)
• result-format (method)
• result-format (method)
• results-of (generic function)
• results-of (method)
• (setf results-of) (method)
• (setf results-of) (generic function)
• s3 (class)
• s3-create-bucket-request (class)
• s3-delete-bucket-object-request (class)
• s3-delete-bucket-request (class)
• s3-get-bucket-object-request (class)
• s3-list-bucket-objects-request (class)
• s3-list-buckets-request (class)
• s3-put-bucket-object-request (class)
• s3-request (class)
• security-group-builder (class)
• security-groups-parser (function)
• send-http-request (generic function)
• send-http-request (method)
• send-http-request (method)
• send-http-request (method)
• send-request (generic function)
• send-request (method)
• service (class)
• service-of (generic function)
• service-of (method)
• (setf service-of) (method)
• (setf service-of) (generic function)
• signature-digest-algorithm (generic function)
• signature-digest-algorithm (method)
• signature-digest-algorithm (method)
• signed-parameters-of (generic function)
• signed-parameters-of (method)
• signed-parameters-of (method)
• signed-parameters-of (method)
• signed-parameters-of (method)
• simple-queue-service (class)
• simpledb (class)
• sort-hashtable (function)
• sorted-headers (generic function)
• sorted-headers (method)
• sorted-parameters (generic function)
• sorted-parameters (method)
• sqs-create-queue-request (class)
• sqs-delete-message-request (class)
• sqs-delete-queue-request (class)
• sqs-get-queue-attributes-request (class)
• sqs-list-queues-request (class)
• sqs-receive-message-request (class)
• sqs-request (class)
• sqs-send-message-request (class)
• sqs-set-queue-attributes-request (class)
• string-ends-with (function)
• string-starts-with (function)
• string-to-bytes (function)
• uri-of (generic function)
• uri-of (method)
• (setf uri-of) (method)
• (setf uri-of) (generic function)
• url-decode (function)
• use-symbol (function)
• user-private-credentials (class)
• version-of (generic function)
• version-of (method)
• version-of (method)
• version-of (method)
• version-of (method)

5 Definitions

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

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *credentials*

Credentials for authenticating against Amazon Web Services

Package

hh-aws

Source

common.lisp (file)

5.1.2 Functions

Function: db-create-domain DOMAIN-NAME

Create a domain with the specified name

Package

hh-aws

Source

sdb.lisp (file)

Function: db-delete-attributes DOMAIN-NAME ITEM-NAME ATTRIBUTES

Delete attributes from the specified item, and if all attributes are gone, delete the item itself

Package

hh-aws

Source

sdb.lisp (file)

Function: db-delete-domain DOMAIN-NAME

Delete the specified domain

Package

hh-aws

Source

sdb.lisp (file)

Function: db-domain-metadata DOMAIN-NAME

Return metadata about the specified domain

Package

hh-aws

Source

sdb.lisp (file)

Function: db-get-attributes DOMAIN-NAME ITEM-NAME

Return the attributes for the specified item in the domain

Package

hh-aws

Source

sdb.lisp (file)

Function: db-list-domains ()

List all domains

Package

hh-aws

Source

sdb.lisp (file)

Function: db-put-attributes DOMAIN-NAME ITEM-NAME ATTRIBUTES

Set the attributes on the specified item in the domain

Package

hh-aws

Source

sdb.lisp (file)

Function: db-query DOMAIN-NAME QUERY-EXPRESSION

Return a list of item names matching the query expression

Package

hh-aws

Source

sdb.lisp (file)

Function: db-query-with-attributes DOMAIN-NAME QUERY-EXPRESSION ATTRIBUTES

Return the indicated attributes of items matching the query expression

Package

hh-aws

Source

sdb.lisp (file)

Function: db-select SELECT-EXPRESSION

Return the results of the provided select statement

Package

hh-aws

Source

sdb.lisp (file)

Function: ec2-authorize-security-group-ingress GROUPNAME PROTOCOL FROM-PORT TO-PORT CIDR-IP

Package

hh-aws

Source

ec2.lisp (file)

Function: ec2-describe-availability-zones ()

List all availability zones

Package

hh-aws

Source

ec2.lisp (file)

Function: ec2-describe-instances REGION-NAME

List all regions

Package

hh-aws

Source

ec2.lisp (file)

Function: ec2-describe-regions ()

List all regions

Package

hh-aws

Source

ec2.lisp (file)

Function: ec2-describe-security-groups REGION-NAME

List all security groups

Package

hh-aws

Source

ec2.lisp (file)

Function: ec2-revoke-security-group-ingress GROUPNAME PROTOCOL FROM-PORT TO-PORT CIDR-IP

Package

hh-aws

Source

ec2.lisp (file)

Function: s3-create-bucket BUCKET-NAME

Create a new bucket

Package

hh-aws

Source

s3.lisp (file)

Function: s3-delete-bucket BUCKET-NAME

Delete a bucket

Package

hh-aws

Source

s3.lisp (file)

Function: s3-delete-bucket-object BUCKET-NAME OBJECT-NAME

Return the contents of the indicated bucket

Package

hh-aws

Source

s3.lisp (file)

Function: s3-get-bucket-object BUCKET-NAME OBJECT-NAME

Return the contents of the indicated bucket

Package

hh-aws

Source

s3.lisp (file)

Function: s3-list-bucket-objects PREFIX BUCKET-NAME

List objects in a bucket

Package

hh-aws

Source

s3.lisp (file)

Function: s3-list-buckets ()

Return list of all buckets in S3

Package

hh-aws

Source

s3.lisp (file)

Function: s3-put-bucket-object BUCKET-NAME OBJECT-NAME CONTENT

Either create a new bucket object for the content, or update an existing one.

Package

hh-aws

Source

s3.lisp (file)

Function: sqs-create-queue QUEUE-NAME

Create a new queue

Package

hh-aws

Source

sqs.lisp (file)

Function: sqs-delete-message QUEUE-NAME RECEIPT-HANDLE

Delete a message from a queue

Package

hh-aws

Source

sqs.lisp (file)

Function: sqs-delete-queue QUEUE-NAME

Delete queue

Package

hh-aws

Source

sqs.lisp (file)

Function: sqs-get-queue-attributes QUEUE-NAME

Get queue attributes

Package

hh-aws

Source

sqs.lisp (file)

Function: sqs-list-queues QUEUE-NAME

List queues

Package

hh-aws

Source

sqs.lisp (file)

Function: sqs-receive-message QUEUE-NAME

Receive a message from the queue

Package

hh-aws

Source

sqs.lisp (file)

Function: sqs-send-message QUEUE-NAME MESSAGE-BODY

Send a message to the specified queue

Package

hh-aws

Source

sqs.lisp (file)

Function: sqs-set-queue-attributes QUEUE-NAME VISIBILITY-TIMEOUT

Set queue attributes

Package

hh-aws

Source

sqs.lisp (file)

5.1.3 Generic functions

Generic Function: access-key-id SOME-CREDENTIALS

Return the access key associated with the credentials, to be sent with requests

Package

hh-aws

Source

common.lisp (file)

Methods

Method: access-key-id (SOME-CREDENTIALS empty-credentials)

Method: access-key-id (SOME-CREDENTIALS explicit-credentials)

Method: access-key-id (SOME-CREDENTIALS user-private-credentials)

Generic Function: secret-key SOME-CREDENTIALS

Return the secret key used to sign requests

Package

hh-aws

Source

common.lisp (file)

Methods

Method: secret-key (SOME-CREDENTIALS empty-credentials)

Method: secret-key (SOME-CREDENTIALS explicit-credentials)

Method: secret-key (SOME-CREDENTIALS user-private-credentials)

5.1.4 Conditions

Condition: aws-error ()

Package

hh-aws

Source

conditions.lisp (file)

Direct superclasses

error (condition)

Direct subclasses

• invalid-client-token-id-error (condition)
• service-unavailable-error (condition)
• no-such-domain-error (condition)
• signature-does-not-match-error (condition)
• invalid-query-expression-error (condition)
• no-such-bucket-error (condition)
• no-such-key-error (condition)
• bad-digest-error (condition)
• bucket-not-empty-error (condition)

Direct methods

• error-response (method)
• error-response (method)
• error-message (method)
• error-message (method)
• error-code (method)
• error-code (method)

Direct slots

Slot: code

Initargs

:code

Readers

error-code (generic function)

Writers

(setf error-code) (generic function)

Slot: message

Initargs

:message

Readers

error-message (generic function)

Writers

(setf error-message) (generic function)

Slot: response

Initargs

:response

Initform

(quote nil)

Readers

error-response (generic function)

Writers

(setf error-response) (generic function)

Condition: bad-digest-error ()

Package

hh-aws

Source

conditions.lisp (file)

Direct superclasses

aws-error (condition)

Condition: bucket-not-empty-error ()

Package

hh-aws

Source

conditions.lisp (file)

Direct superclasses

aws-error (condition)

Condition: invalid-client-token-id-error ()

Package

hh-aws

Source

conditions.lisp (file)

Direct superclasses

aws-error (condition)

Condition: invalid-query-expression-error ()

Package

hh-aws

Source

conditions.lisp (file)

Direct superclasses

aws-error (condition)

Condition: no-such-bucket-error ()

Package

hh-aws

Source

conditions.lisp (file)

Direct superclasses

aws-error (condition)

Condition: no-such-domain-error ()

Package

hh-aws

Source

conditions.lisp (file)

Direct superclasses

aws-error (condition)

Condition: no-such-key-error ()

Package

hh-aws

Source

conditions.lisp (file)

Direct superclasses

aws-error (condition)

Condition: service-unavailable-error ()

Package

hh-aws

Source

conditions.lisp (file)

Direct superclasses

aws-error (condition)

Condition: signature-does-not-match-error ()

Package

hh-aws

Source

conditions.lisp (file)

Direct superclasses

aws-error (condition)

5.2 Internal definitions

5.2.1 Constants

Constant: +http-accepted+

HTTP return code (202) for ’Accepted’.

Package

hh-aws

Source

constants.lisp (file)

Constant: +http-authorization-required+

HTTP return code (401) for ’Authorization Required’.

Package

hh-aws

Source

constants.lisp (file)

Constant: +http-bad-gateway+

HTTP return code (502) for ’Bad Gateway’.

Package

hh-aws

Source

constants.lisp (file)

Constant: +http-bad-request+

HTTP return code (400) for ’Bad Request’.

Package

hh-aws

Source

constants.lisp (file)

Constant: +http-conflict+

HTTP return code (409) for ’Conflict’.

Package

hh-aws

Source

constants.lisp (file)

Constant: +http-continue+

HTTP return code (100) for ’Continue’.

Package

hh-aws

Source

constants.lisp (file)

Constant: +http-created+

HTTP return code (201) for ’Created’.

Package

hh-aws

Source

constants.lisp (file)

Constant: +http-expectation-failed+

HTTP return code (417) for ’Expectation Failed’.

Package

hh-aws

Source

constants.lisp (file)

Constant: +http-failed-dependency+

HTTP return code (424) for ’Failed Dependency’.

Package

hh-aws

Source

constants.lisp (file)

Constant: +http-forbidden+

HTTP return code (403) for ’Forbidden’.

Package

hh-aws

Source

constants.lisp (file)

Constant: +http-gateway-time-out+

HTTP return code (504) for ’Gateway Time-out’.

Package

hh-aws

Source

constants.lisp (file)

Constant: +http-gone+

HTTP return code (410) for ’Gone’.

Package

hh-aws

Source

constants.lisp (file)

Constant: +http-internal-server-error+

HTTP return code (500) for ’Internal Server Error’.

Package

hh-aws

Source

constants.lisp (file)

Constant: +http-length-required+

HTTP return code (411) for ’Length Required’.

Package

hh-aws

Source

constants.lisp (file)

Constant: +http-method-not-allowed+

HTTP return code (405) for ’Method Not Allowed’.

Package

hh-aws

Source

constants.lisp (file)

Constant: +http-moved-permanently+

HTTP return code (301) for ’Moved Permanently’.

Package

hh-aws

Source

constants.lisp (file)

Constant: +http-moved-temporarily+

HTTP return code (302) for ’Moved Temporarily’.

Package

hh-aws

Source

constants.lisp (file)

Constant: +http-multi-status+

HTTP return code (207) for ’Multi-Status’.

Package

hh-aws

Source

constants.lisp (file)

Constant: +http-multiple-choices+

HTTP return code (300) for ’Multiple Choices’.

Package

hh-aws

Source

constants.lisp (file)

Constant: +http-no-content+

HTTP return code (204) for ’No Content’.

Package

hh-aws

Source

constants.lisp (file)

Constant: +http-non-authoritative-information+

HTTP return code (203) for ’Non-Authoritative Information’.

Package

hh-aws

Source

constants.lisp (file)

Constant: +http-not-acceptable+

HTTP return code (406) for ’Not Acceptable’.

Package

hh-aws

Source

constants.lisp (file)

Constant: +http-not-found+

HTTP return code (404) for ’Not Found’.

Package

hh-aws

Source

constants.lisp (file)

Constant: +http-not-implemented+

HTTP return code (501) for ’Not Implemented’.

Package

hh-aws

Source

constants.lisp (file)

Constant: +http-not-modified+

HTTP return code (304) for ’Not Modified’.

Package

hh-aws

Source

constants.lisp (file)

Constant: +http-ok+

HTTP return code (200) for ’OK’.

Package

hh-aws

Source

constants.lisp (file)

Constant: +http-partial-content+

HTTP return code (206) for ’Partial Content’.

Package

hh-aws

Source

constants.lisp (file)

Constant: +http-payment-required+

HTTP return code (402) for ’Payment Required’.

Package

hh-aws

Source

constants.lisp (file)

Constant: +http-precondition-failed+

HTTP return code (412) for ’Precondition Failed’.

Package

hh-aws

Source

constants.lisp (file)

Constant: +http-proxy-authentication-required+

HTTP return code (407) for ’Proxy Authentication Required’.

Package

hh-aws

Source

constants.lisp (file)

Constant: +http-request-entity-too-large+

HTTP return code (413) for ’Request Entity Too Large’.

Package

hh-aws

Source

constants.lisp (file)

Constant: +http-request-time-out+

HTTP return code (408) for ’Request Time-out’.

Package

hh-aws

Source

constants.lisp (file)

Constant: +http-request-uri-too-large+

HTTP return code (414) for ’Request-URI Too Large’.

Package

hh-aws

Source

constants.lisp (file)

Constant: +http-requested-range-not-satisfiable+

HTTP return code (416) for ’Requested range not satisfiable’.

Package

hh-aws

Source

constants.lisp (file)

Constant: +http-reset-content+

HTTP return code (205) for ’Reset Content’.

Package

hh-aws

Source

constants.lisp (file)

Constant: +http-see-other+

HTTP return code (303) for ’See Other’.

Package

hh-aws

Source

constants.lisp (file)

Constant: +http-service-unavailable+

HTTP return code (503) for ’Service Unavailable’.

Package

hh-aws

Source

constants.lisp (file)

Constant: +http-switching-protocols+

HTTP return code (101) for ’Switching Protocols’.

Package

hh-aws

Source

constants.lisp (file)

Constant: +http-temporary-redirect+

HTTP return code (307) for ’Temporary Redirect’.

Package

hh-aws

Source

constants.lisp (file)

Constant: +http-unsupported-media-type+

HTTP return code (415) for ’Unsupported Media Type’.

Package

hh-aws

Source

constants.lisp (file)

Constant: +http-use-proxy+

HTTP return code (305) for ’Use Proxy’.

Package

hh-aws

Source

constants.lisp (file)

Constant: +http-version-not-supported+

HTTP return code (505) for ’Version not supported’.

Package

hh-aws

Source

constants.lisp (file)

5.2.2 Special variables

Special Variable: *current-elements*

A list of current elements; the top one on the list is the current element, and the prior one can be restored by setting this to the cdr of itself

Package

hh-aws

Source

xml.lisp (file)

Special Variable: *current-elements-to-find*

The first element is the current element to find; the rest of the list is the elements remaining to be found

Package

hh-aws

Source

xml.lisp (file)

Special Variable: *current-handlers*

The list of active handlers for XML parsing, with the current as the head of the list

Package

hh-aws

Source

xml.lisp (file)

Special Variable: *elements-found*

The text values for elements currently found

Package

hh-aws

Source

xml.lisp (file)

Special Variable: *elements-to-find*

A list of strings, each naming an element whose text we’re interested in

Package

hh-aws

Source

xml.lisp (file)

Special Variable: *finds*

If the list of elements-to-find cycles more than once, then each iteration is added to this list. The final result will be the value of this variable.

Package

hh-aws

Source

xml.lisp (file)

Special Variable: *http-reason-phrase-map*

Used to map numerical return codes to reason phrases.

Package

hh-aws

Source

constants.lisp (file)

5.2.3 Macros

Macro: cout &rest ARGS

Package

hh-aws

Source

utils.lisp (file)

Macro: def-http-return-code NAME VALUE REASON-PHRASE

Shortcut to define constants for return codes. NAME is a Lisp symbol, VALUE is the numerical value of the return code, and REASON-PHRASE is the phrase (a string) to be shown in the server’s status line.

Package

hh-aws

Source

constants.lisp (file)

Macro: defrequest NAME &key DOCUMENTATION BASES SLOTS SERVICE ACTION (METHOD METHOD-OF-METHOD) PARAMETERS ARGS RESULT-FORMAT (RESULT RESULT-METHOD) ERROR-FORMAT (ERROR ERROR-METHOD) (CALL CALL-SERVICE-METHOD) (SEND SEND-REQUEST-METHOD)

Package

hh-aws

Source

common.lisp (file)

Macro: defservice NAME &key DOCUMENTATION BASES SLOTS ENDPOINT VERSION (REQUEST (REQUEST-CLASS &key (SLOTS REQUEST-SLOTS) (DOCUMENTATION REQUEST-DOCUMENTATION) (INIT INIT-METHOD) (QUERY QUERY-METHOD) (ENDPOINT ENDPOINT-METHOD) (URI URI-METHOD) (STRING STRING-METHOD) (DIGEST DIGEST-ALGORITHM) (SIGNED-PARAMETERS SIGNED-PARAMETERS-METHOD) (ADDITIONAL-HEADERS ADDITIONAL-HEADERS-METHOD) (SEND SEND-METHOD) (RESULT RESULT-METHOD)))

Package

hh-aws

Source

common.lisp (file)

Macro: defxmlparser NAME SPECIFIER &key (INITARGS INIT-ARGS) (ENTER ENTER-METHOD) (TEXT TEXT-METHOD) (EXIT EXIT-METHOD) (FINISH FINISH-METHOD)

Package

hh-aws

Source

xml.lisp (file)

Macro: format-string FORMAT-CONTROL-STRING &rest ARGS

Package

hh-aws

Source

utils.lisp (file)

Macro: putend SOME-OBJECT SOME-PLACE

Append some-object to the end of the list in some-place. Modifies some-place.

Package

hh-aws

Source

utils.lisp (file)

Macro: raise-aws-condition CODE MESSAGE RESPONSE

Package

hh-aws

Source

conditions.lisp (file)

Macro: response-values SOME-RESPONSE

Expand a response into a multiple return values

Package

hh-aws

Source

common.lisp (file)

5.2.4 Functions

Function: aws-date &optional TIME

Package

hh-aws

Source

common.lisp (file)

Function: aws-timestamp &optional TIME

Return a HTTP-style date string. Borrowed from Zach Bean’s ZS3: http://www.xach.com/lisp/zs3/ (BSD-license)

Package

hh-aws

Source

common.lisp (file)

Function: bucket-contents-parser INPUT-STREAM &rest MORE-ARGS

Package

hh-aws

Source

s3.lisp (file)

Function: builder-parser INPUT-STREAM &rest MORE-ARGS

Package

hh-aws

Source

xml.lisp (file)

Function: bytes-to-string SOME-BYTES

Borrowed from Arnesi (http://common-lisp.net/project/bese/arnesi.html)

Package

hh-aws

Source

utils.lisp (file)

Function: current-element ()

Package

hh-aws

Source

xml.lisp (file)

Function: current-element-to-find ()

Package

hh-aws

Source

xml.lisp (file)

Function: current-handler ()

Package

hh-aws

Source

xml.lisp (file)

Function: default-parser INPUT-STREAM &rest MORE-ARGS

Package

hh-aws

Source

xml.lisp (file)

Function: detokenize ELEMENTS TOKEN &optional PREFIX

Combine elements into a string, separating each element by token

Package

hh-aws

Source

utils.lisp (file)

Function: ec2-instances-parser INPUT-STREAM &rest MORE-ARGS

Package

hh-aws

Source

ec2.lisp (file)

Function: ensure-string-ends-with TARGET-STRING STRING-ENDING

Package

hh-aws

Source

utils.lisp (file)

Function: find-path-parser INPUT-STREAM &rest MORE-ARGS

Package

hh-aws

Source

xml.lisp (file)

Function: find-responses BODY ELEMENTS-TO-FIND

Package

hh-aws

Source

xml.lisp (file)

Function: hash-entries SOME-HASH

Package

hh-aws

Source

utils.lisp (file)

Function: home-dir ()

Return the user’s home directory

Package

hh-aws

Source

utils.lisp (file)

Function: items-parser INPUT-STREAM &rest MORE-ARGS

Package

hh-aws

Source

sdb.lisp (file)

Function: list-buckets-parser INPUT-STREAM &rest MORE-ARGS

Package

hh-aws

Source

s3.lisp (file)

Function: make-response A-SERVICE BODY STATUS-CODE HEADERS URI STREAM MUST-CLOSE REASON-PHRASE

Package

hh-aws

Source

common.lisp (file)

Function: map-name-value-pairs NAME-VALUE-PAIRS SOME-LAMBDA

Apply some lambda (takes 2 arguments) to each name / value pair in name-value-pairs

Package

hh-aws

Source

utils.lisp (file)

Function: move-to-next-element-to-find ()

Package

hh-aws

Source

xml.lisp (file)

Function: on-finish-element NAME ATTRIBUTES PARENT-SEED SEED

Package

hh-aws

Source

xml.lisp (file)

Function: on-start-element NAME ATTRIBUTES SEED

Package

hh-aws

Source

xml.lisp (file)

Function: on-text TEXT-STRING SEED

Package

hh-aws

Source

xml.lisp (file)

Function: path-p SOME-PATH

Package

hh-aws

Source

xml.lisp (file)

Function: pop-handler ()

Package

hh-aws

Source

xml.lisp (file)

Function: push-handler HANDLER

Package

hh-aws

Source

xml.lisp (file)

Function: security-groups-parser INPUT-STREAM &rest MORE-ARGS

Package

hh-aws

Source

ec2.lisp (file)

Function: sort-hashtable SOME-HASH PREDICATE

Use predicate to compare pairs of keys & values; predicate should return true iff pair 1 is less than pair 2 (each pair is a cons of (key.value) ).

Package

hh-aws

Source

utils.lisp (file)

Function: string-ends-with TARGET-STRING SEARCH-STRING

Return T if target-string ends with search-string, nil otherwise

Package

hh-aws

Source

utils.lisp (file)

Function: string-starts-with TARGET-STRING SEARCH-STRING

Return T if target-string starts with search-string, nil otherwise

Package

hh-aws

Source

utils.lisp (file)

Function: string-to-bytes A-STRING &key PAD-TO

Borrowed from Arnesi (http://common-lisp.net/project/bese/arnesi.html)

Package

hh-aws

Source

utils.lisp (file)

Function: url-decode A-STRING

Package

hh-aws

Source

common.lisp (file)

Function: use-symbol BASE-NAME &key PACKAGE PREFIX POSTFIX

Build a symbol from component parts

Package

hh-aws

Source

utils.lisp (file)

5.2.5 Generic functions

Generic Function: add-attribute-name-parameters SOME-REQUEST ATTRIBUTES

Add the indicated parameters as attribute name / value pairs to the request

Package

hh-aws

Source

sdb.lisp (file)

Methods

Method: add-attribute-name-parameters SOME-REQUEST ATTRIBUTES

Generic Function: add-attribute-parameters SOME-REQUEST ATTRIBUTES

Add the indicated parameters as attribute name / value pairs to the request

Package

hh-aws

Source

sdb.lisp (file)

Methods

Method: add-attribute-parameters SOME-REQUEST ATTRIBUTES

Generic Function: add-header SOME-REQUEST HEADER-NAME HEADER-VALUE

Add a header (usually an amz header) to the request

Package

hh-aws

Source

common.lisp (file)

Methods

Method: add-header (SOME-REQUEST request) HEADER-NAME HEADER-VALUE

Generic Function: add-parameter SOME-REQUEST PARAMETER-NAME PARAMETER-VALUE

Add a parameter to the request

Package

hh-aws

Source

common.lisp (file)

Methods

Method: add-parameter (SOME-REQUEST request) PARAMETER-NAME PARAMETER-VALUE

Generic Function: additional-headers-of SOME-REQUEST

Additional headers for the request; for s3, this includes the authorization header

Package

hh-aws

Source

common.lisp (file)

Methods

Method: additional-headers-of (SOME-REQUEST s3-request)

Source

s3.lisp (file)

Method: additional-headers-of (SOME-REQUEST request)

Generic Function: attributes-of OBJECT

Generic Function: (setf attributes-of) NEW-VALUE OBJECT

Package

hh-aws

Methods

Method: attributes-of (BUCKET-CONTENTS-BUILDER bucket-contents-builder)

automatically generated reader method

Source

s3.lisp (file)

Method: (setf attributes-of) NEW-VALUE (BUCKET-CONTENTS-BUILDER bucket-contents-builder)

automatically generated writer method

Source

s3.lisp (file)

Method: attributes-of (ITEMS-BUILDER items-builder)

automatically generated reader method

Source

sdb.lisp (file)

Method: (setf attributes-of) NEW-VALUE (ITEMS-BUILDER items-builder)

automatically generated writer method

Source

sdb.lisp (file)

Generic Function: bucket-for OBJECT

Generic Function: (setf bucket-for) NEW-VALUE OBJECT

Package

hh-aws

Methods

Method: bucket-for (S3-REQUEST s3-request)

automatically generated reader method

Source

s3.lisp (file)

Method: (setf bucket-for) NEW-VALUE (S3-REQUEST s3-request)

automatically generated writer method

Source

s3.lisp (file)

Generic Function: bucket-object-for OBJECT

Generic Function: (setf bucket-object-for) NEW-VALUE OBJECT

Package

hh-aws

Methods

Method: bucket-object-for (S3-REQUEST s3-request)

automatically generated reader method

Source

s3.lisp (file)

Method: (setf bucket-object-for) NEW-VALUE (S3-REQUEST s3-request)

automatically generated writer method

Source

s3.lisp (file)

Generic Function: call-service REQUEST &optional PARAMETERS ARGUMENTS

Package

hh-aws

Source

common.lisp (file)

Methods

Method: call-service (SOME-REQUEST ec2-describe-security-groups-request) &optional PARAMETERS ARGUMENTS

Source

ec2.lisp (file)

Method: call-service (SOME-REQUEST ec2-describe-instances-request) &optional PARAMETERS ARGUMENTS

Source

ec2.lisp (file)

Method: call-service (SOME-REQUEST sqs-set-queue-attributes-request) &optional PARAMETERS ARGUMENTS

Source

sqs.lisp (file)

Method: call-service (SOME-REQUEST sqs-get-queue-attributes-request) &optional PARAMETERS ARGUMENTS

Source

sqs.lisp (file)

Method: call-service (SOME-REQUEST sqs-delete-message-request) &optional PARAMETERS ARGUMENTS

Source

sqs.lisp (file)

Method: call-service (SOME-REQUEST sqs-receive-message-request) &optional PARAMETERS ARGUMENTS

Source

sqs.lisp (file)

Method: call-service (SOME-REQUEST sqs-send-message-request) &optional PARAMETERS ARGUMENTS

Source

sqs.lisp (file)

Method: call-service (SOME-REQUEST sqs-delete-queue-request) &optional PARAMETERS ARGUMENTS

Source

sqs.lisp (file)

Method: call-service (SOME-REQUEST s3-delete-bucket-object-request) &optional PARAMETERS ARGUMENTS

Source

s3.lisp (file)

Method: call-service (SOME-REQUEST s3-get-bucket-object-request) &optional PARAMETERS ARGUMENTS

Source

s3.lisp (file)

Method: call-service (SOME-REQUEST s3-put-bucket-object-request) &optional PARAMETERS ARGUMENTS

Source

s3.lisp (file)

Method: call-service (SOME-REQUEST s3-list-bucket-objects-request) &optional PARAMETERS ARGUMENTS

Source

s3.lisp (file)

Method: call-service (SOME-REQUEST s3-delete-bucket-request) &optional PARAMETERS ARGUMENTS

Source

s3.lisp (file)

Method: call-service (SOME-REQUEST s3-create-bucket-request) &optional PARAMETERS ARGUMENTS

Source

s3.lisp (file)

Method: call-service (SOME-REQUEST db-query-with-attributes-request) &optional PARAMETERS ARGUMENTS

Source

sdb.lisp (file)

Method: call-service (SOME-REQUEST db-delete-attributes-request) &optional PARAMETERS ARGUMENTS

Source

sdb.lisp (file)

Method: call-service (SOME-REQUEST db-put-attributes-request) &optional PARAMETERS ARGUMENTS

Source

sdb.lisp (file)

Method: call-service (SOME-REQUEST request) &optional PARAMETERS ARGUMENTS

Generic Function: call-succeeded SOME-RESPONSE

Return true if the response indicates success, false otherwise

Package

hh-aws

Source

common.lisp (file)

Methods

Method: call-succeeded (SOME-RESPONSE response)

Generic Function: canonical-query-string SOME-REQUEST

Package

hh-aws

Source

common.lisp (file)

Methods

Method: canonical-query-string (SOME-REQUEST request)

Generic Function: canonicalized-amz-headers-of SOME-REQUEST

Return a canonical string representation of amz headers

Package

hh-aws

Source

s3.lisp (file)

Methods

Method: canonicalized-amz-headers-of (SOME-REQUEST s3-request)

Generic Function: canonicalized-resource-of SOME-REQUEST

Package

hh-aws

Source

s3.lisp (file)

Methods

Method: canonicalized-resource-of (SOME-REQUEST s3-request)

Generic Function: capture-text HANDLER TEXT-STRING

Package

hh-aws

Source

xml.lisp (file)

Methods

Method: capture-text (HANDLER security-group-builder) TEXT-STRING

Source

ec2.lisp (file)

Method: capture-text (HANDLER builder) TEXT-STRING

Source

ec2.lisp (file)

Method: capture-text (HANDLER bucket-contents-builder) TEXT-STRING

Source

s3.lisp (file)

Method: capture-text (HANDLER list-buckets-builder) TEXT-STRING

Source

s3.lisp (file)

Method: capture-text (HANDLER items-builder) TEXT-STRING

Source

sdb.lisp (file)

Method: capture-text (HANDLER find-path-builder) TEXT-STRING

Method: capture-text (HANDLER (eql default)) TEXT-STRING

Method: capture-text HANDLER TEXT-STRING

Generic Function: content-length-of SOME-REQUEST

Package

hh-aws

Source

s3.lisp (file)

Methods

Method: content-length-of (SOME-REQUEST s3-request)

Generic Function: content-md5-of SOME-REQUEST

Package

hh-aws

Source

s3.lisp (file)

Methods

Method: content-md5-of (SOME-REQUEST s3-request)

Generic Function: content-type-of SOME-REQUEST

Package

hh-aws

Source

s3.lisp (file)

Methods

Method: content-type-of (SOME-REQUEST s3-request)

Generic Function: current-attribute-of OBJECT

Generic Function: (setf current-attribute-of) NEW-VALUE OBJECT

Package

hh-aws

Methods

Method: current-attribute-of (BUCKET-CONTENTS-BUILDER bucket-contents-builder)

automatically generated reader method

Source

s3.lisp (file)

Method: (setf current-attribute-of) NEW-VALUE (BUCKET-CONTENTS-BUILDER bucket-contents-builder)

automatically generated writer method

Source

s3.lisp (file)

Method: current-attribute-of (ITEMS-BUILDER items-builder)

automatically generated reader method

Source

sdb.lisp (file)

Method: (setf current-attribute-of) NEW-VALUE (ITEMS-BUILDER items-builder)

automatically generated writer method

Source

sdb.lisp (file)