This is the pira Reference Manual, version 0.1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Fri May 15 12:51:25 2026 GMT+0.
pira/pira.asdpira-core/pira-core.asdpira-core/config.lisppira-core/ec2metadata.lisppira-core/session.lisppira-core/credentials-subpackages/base.lisppira-core/credentials-subpackages/env.lisppira-core/credentials-subpackages/shared.lisppira-core/credentials-subpackages/ec2role.lisppira-core/credentials-subpackages/assume-role.lisppira-core/credentials.lisppira-core/shared-config.lisppira-core/make-session.lisppira-core/api.lisppira-core/protocols/aws.lisppira-core/protocols/rest-json1.lisppira-core/protocols/aws-json.lisppira-core/protocols/rest-xml.lisppira-core/protocols/aws-query.lisppira-core/protocols/ec2-query.lisppira-core/main.lisppira/sts/sts.lisppira-core/error/error.lisppira/protocols/ec2-querypira/configpirapira/credentials/envpira/protocols/aws-querypira/protocols/awspira/protocols/aws-jsonpira/credentialspira/sessionpira/make-sessionpira/stspira/ec2metadatapira/credentials/basepira/credentials/sharedpira/credentials/assume-rolepira/apipira/shared-configpira/protocols/rest-json1pira/protocols/rest-xmlpira/errorpira/credentials/ec2roleThe main system appears first, followed by any subsystem dependency.
pira-coreThe core system of Pira, an unofficial AWS SDK for Common Lisp
Eitaro Fukamachi
MIT
0.1.0
smithy/sdk (system).
dexador (system).
quri (system).
trivial-timeout (system).
pira/sts (system).
pira-core/error (system).
local-time (system).
yason (system).
cl-ppcre (system).
alexandria (system).
assoc-utils (system).
parser.ini (system).
aws-sign4 (system).
ironclad/core (system).
config.lisp (file).
ec2metadata.lisp (file).
session.lisp (file).
credentials-subpackages (module).
credentials.lisp (file).
shared-config.lisp (file).
make-session.lisp (file).
api.lisp (file).
protocols (module).
main.lisp (file).
pira/stsEitaro Fukamachi
MIT
smithy/sdk (system).
pira-core/error (system).
sts.lisp (file).
pira-core/errorEitaro Fukamachi
MIT
alexandria (system).
closer-mop (system).
error.lisp (file).
Modules are listed depth-first from the system components tree.
pira-core/credentials-subpackagessession.lisp (file).
pira-core (system).
base.lisp (file).
env.lisp (file).
shared.lisp (file).
ec2role.lisp (file).
assume-role.lisp (file).
pira-core/protocolsapi.lisp (file).
pira-core (system).
aws.lisp (file).
rest-json1.lisp (file).
aws-json.lisp (file).
rest-xml.lisp (file).
aws-query.lisp (file).
ec2-query.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
pira/pira.asdpira-core/pira-core.asdpira-core/config.lisppira-core/ec2metadata.lisppira-core/session.lisppira-core/credentials-subpackages/base.lisppira-core/credentials-subpackages/env.lisppira-core/credentials-subpackages/shared.lisppira-core/credentials-subpackages/ec2role.lisppira-core/credentials-subpackages/assume-role.lisppira-core/credentials.lisppira-core/shared-config.lisppira-core/make-session.lisppira-core/api.lisppira-core/protocols/aws.lisppira-core/protocols/rest-json1.lisppira-core/protocols/aws-json.lisppira-core/protocols/rest-xml.lisppira-core/protocols/aws-query.lisppira-core/protocols/ec2-query.lisppira-core/main.lisppira/sts/sts.lisppira-core/error/error.lisppira-core/config.lisppira-core (system).
*aws-profile* (special variable).
parse-file (function).
read-from-file (function).
%parse-file (function).
*cached-ini* (special variable).
pira-core/ec2metadata.lispconfig.lisp (file).
pira-core (system).
ec2-region (function).
ec2metadata (function).
ec2token (function).
pira-core/session.lispec2metadata.lisp (file).
pira-core (system).
*session* (special variable).
session (structure).
session-credentials (reader).
(setf session-credentials) (writer).
session-endpoint (reader).
(setf session-endpoint) (writer).
session-region (reader).
(setf session-region) (writer).
%make-session (function).
copy-session (function).
session-p (function).
pira-core/credentials-subpackages/base.lispcredentials-subpackages (module).
credentials (class).
credentials-access-key-id (generic function).
credentials-headers (function).
credentials-keys (generic function).
credentials-provider-name (reader method).
(setf credentials-provider-name) (writer method).
credentials-secret-access-key (generic function).
credentials-session-token (generic function).
expiredp (generic function).
make-credentials (function).
provider (class).
provider-expiration (generic function).
(setf provider-expiration) (generic function).
provider-expiry-window (reader method).
(setf provider-expiry-window) (writer method).
retrieve (generic function).
basic-credentials (class).
define-wrapped-method (macro).
provider-credentials (class).
provider-credentials-credentials (function).
pira-core/credentials-subpackages/env.lispcredentials-subpackages (module).
env-provider (class).
expiredp (method).
retrieve (method).
pira-core/credentials-subpackages/ec2role.lispcredentials-subpackages (module).
ec2role-provider (class).
retrieve (method).
*default-token-ttl* (special variable).
*token* (special variable).
*use-imds-v2* (special variable).
copy-token (function).
fetch-token (function).
make-token (function).
token (structure).
token-alive-p (function).
token-created-at (reader).
(setf token-created-at) (writer).
token-p (function).
token-ttl (reader).
(setf token-ttl) (writer).
token-value (reader).
(setf token-value) (writer).
pira-core/credentials-subpackages/assume-role.lispcredentials-subpackages (module).
retrieve (method).
assume-role-provider (class).
pira-core/credentials.lispcredentials-subpackages (module).
pira-core (system).
default-aws-credentials (function).
*chained-providers* (special variable).
pira-core/make-session.lispshared-config.lisp (file).
pira-core (system).
make-session (function).
pira-core/api.lispmake-session.lisp (file).
pira-core (system).
aws-request (function).
*global-service-endpoints* (special variable).
request-host (function).
request-uri (function).
sha-256 (function).
pira-core/protocols/aws.lispprotocols (module).
aws-protocol (class).
make-request-with-protocol (method).
send-request (method).
pira-core/protocols/rest-json1.lispprotocols (module).
additional-headers (method).
find-aws-json-error-type (function).
find-error-shape (method).
rest-json1 (class).
sanitize-error-code (function).
pira-core/protocols/aws-json.lispprotocols (module).
additional-headers (method).
additional-headers (method).
aws-json1-0 (class).
aws-json1-1 (class).
decode-payload (method).
decode-payload (method).
encode-payload (method).
find-error-shape (method).
make-request-with-protocol (method).
aws-json (class).
pira-core/protocols/rest-xml.lispprotocols (module).
additional-headers (method).
deserialize-output-payload (method).
find-error-shape (method).
find-error-tag (function).
get-error-info (function).
get-tag-value (function).
rest-xml (class).
rest-xml-no-error-wrapping-p (reader method).
pira-core/protocols/aws-query.lispprotocols (module).
additional-headers (method).
aws-query (class).
deserialize-output-payload (method).
encode-payload (method).
find-error-shape (method).
make-request-with-protocol (method).
serialize-input (method).
pira-core/protocols/ec2-query.lispprotocols (module).
deserialize-output-payload (method).
ec2-query (class).
pira-core/main.lisppira/sts/sts.lisppira/sts (system).
access-key-id-type (type).
access-key-secret-type (type).
account-type (type).
arn-type (type).
assume-role (function).
assume-role-with-saml (function).
assume-role-with-web-identity (function).
assume-root (function).
assumed-role-id-type (type).
assumed-role-user (class).
audience (type).
client-token-type (type).
context-assertion-type (type).
credentials (class).
date-type (type).
decode-authorization-message (function).
decoded-message-type (type).
duration-seconds-type (type).
encoded-message-type (type).
expired-identity-token-message (type).
expired-token-exception (condition).
external-id-type (type).
federated-id-type (type).
federated-user (class).
get-access-key-info (function).
get-caller-identity (function).
get-federation-token (function).
get-session-token (function).
idp-communication-error-message (type).
idp-rejected-claim-message (type).
idpcommunication-error-exception (condition).
idprejected-claim-exception (condition).
invalid-authorization-message (type).
invalid-authorization-message-exception (condition).
invalid-identity-token-exception (condition).
invalid-identity-token-message (type).
issuer (type).
malformed-policy-document-exception (condition).
malformed-policy-document-message (type).
name-qualifier (type).
non-negative-integer-type (type).
packed-policy-too-large-exception (condition).
packed-policy-too-large-message (type).
policy-descriptor-list-type (function).
policy-descriptor-list-type (type).
policy-descriptor-type (class).
provided-context (class).
provided-contexts-list-type (function).
provided-contexts-list-type (type).
region-disabled-exception (condition).
region-disabled-message (type).
role-duration-seconds-type (type).
role-session-name-type (type).
root-duration-seconds-type (type).
samlassertion-type (type).
serial-number-type (type).
session-policy-document-type (type).
source-identity-type (type).
sts-error (condition).
subject (type).
subject-type (type).
tag (class).
tag-key-list-type (function).
tag-key-list-type (type).
tag-key-type (type).
tag-list-type (function).
tag-list-type (type).
tag-value-type (type).
target-principal-type (type).
token-code-type (type).
token-type (type).
unrestricted-session-policy-document-type (type).
url-type (type).
user-id-type (type).
user-name-type (type).
web-identity-subject-type (type).
%expired-token-exception (class).
%idpcommunication-error-exception (class).
%idprejected-claim-exception (class).
%invalid-authorization-message-exception (class).
%invalid-identity-token-exception (class).
%malformed-policy-document-exception (class).
%packed-policy-too-large-exception (class).
%region-disabled-exception (class).
assume-role-request (class).
assume-role-response (class).
assume-role-with-samlrequest (class).
assume-role-with-samlresponse (class).
assume-role-with-web-identity-request (class).
assume-role-with-web-identity-response (class).
assume-root-request (class).
assume-root-response (class).
decode-authorization-message-request (class).
decode-authorization-message-response (class).
get-access-key-info-request (class).
get-access-key-info-response (class).
get-caller-identity-request (class).
get-caller-identity-response (class).
get-federation-token-request (class).
get-federation-token-response (class).
get-session-token-request (class).
get-session-token-response (class).
pira-core/error/error.lisppira-core/error (system).
aws-error (condition).
aws-error-body (reader method).
aws-error-headers (reader method).
aws-error-operation-name (reader method).
aws-error-status (reader method).
print-object (method).
Packages are listed by definition order.
pira/protocols/ec2-querypira/configpirapira/credentials/envpira/protocols/aws-querypira/protocols/awspira/protocols/aws-jsonpira/credentialspira/sessionpira/make-sessionpira/stspira/ec2metadatapira/credentials/basepira/credentials/sharedpira/credentials/assume-rolepira/apipira/shared-configpira/protocols/rest-json1pira/protocols/rest-xmlpira/errorpira/credentials/ec2rolepira/configcommon-lisp.
*aws-profile* (special variable).
parse-file (function).
read-from-file (function).
%parse-file (function).
*cached-ini* (special variable).
piracommon-lisp.
pira/api.
pira/credentials.
pira/error.
pira/make-session.
pira/session.
pira/protocols/aws-jsoncommon-lisp.
aws-json1-0 (class).
aws-json1-1 (class).
aws-json (class).
pira/credentialscommon-lisp.
pira.
default-aws-credentials (function).
*chained-providers* (special variable).
pira/sessioncommon-lisp.
pira.
*session* (special variable).
session (structure).
session-credentials (reader).
(setf session-credentials) (writer).
session-endpoint (reader).
(setf session-endpoint) (writer).
session-region (reader).
(setf session-region) (writer).
%make-session (function).
copy-session (function).
session-p (function).
pira/make-sessioncommon-lisp.
pira.
make-session (function).
pira/stsaccess-key-id-type (type).
access-key-secret-type (type).
account-type (type).
arn-type (type).
assume-role (function).
assume-role-with-saml (function).
assume-role-with-web-identity (function).
assume-root (function).
assumed-role-id-type (type).
assumed-role-user (class).
audience (type).
client-token-type (type).
context-assertion-type (type).
credentials (class).
date-type (type).
decode-authorization-message (function).
decoded-message-type (type).
duration-seconds-type (type).
encoded-message-type (type).
expired-identity-token-message (type).
expired-token-exception (condition).
external-id-type (type).
federated-id-type (type).
federated-user (class).
get-access-key-info (function).
get-caller-identity (function).
get-federation-token (function).
get-session-token (function).
idp-communication-error-message (type).
idp-rejected-claim-message (type).
idpcommunication-error-exception (condition).
idprejected-claim-exception (condition).
invalid-authorization-message (type).
invalid-authorization-message-exception (condition).
invalid-identity-token-exception (condition).
invalid-identity-token-message (type).
issuer (type).
malformed-policy-document-exception (condition).
malformed-policy-document-message (type).
name-qualifier (type).
non-negative-integer-type (type).
packed-policy-too-large-exception (condition).
packed-policy-too-large-message (type).
policy-descriptor-list-type (function).
policy-descriptor-list-type (type).
policy-descriptor-type (class).
provided-context (class).
provided-contexts-list-type (function).
provided-contexts-list-type (type).
region-disabled-exception (condition).
region-disabled-message (type).
role-duration-seconds-type (type).
role-session-name-type (type).
root-duration-seconds-type (type).
samlassertion-type (type).
serial-number-type (type).
session-policy-document-type (type).
source-identity-type (type).
sts-error (condition).
subject (type).
subject-type (type).
tag (class).
tag-key-list-type (function).
tag-key-list-type (type).
tag-key-type (type).
tag-list-type (function).
tag-list-type (type).
tag-value-type (type).
target-principal-type (type).
token-code-type (type).
token-type (type).
unrestricted-session-policy-document-type (type).
url-type (type).
user-id-type (type).
user-name-type (type).
web-identity-subject-type (type).
%expired-token-exception (class).
%idpcommunication-error-exception (class).
%idprejected-claim-exception (class).
%invalid-authorization-message-exception (class).
%invalid-identity-token-exception (class).
%malformed-policy-document-exception (class).
%packed-policy-too-large-exception (class).
%region-disabled-exception (class).
assume-role-request (class).
assume-role-response (class).
assume-role-with-samlrequest (class).
assume-role-with-samlresponse (class).
assume-role-with-web-identity-request (class).
assume-role-with-web-identity-response (class).
assume-root-request (class).
assume-root-response (class).
decode-authorization-message-request (class).
decode-authorization-message-response (class).
get-access-key-info-request (class).
get-access-key-info-response (class).
get-caller-identity-request (class).
get-caller-identity-response (class).
get-federation-token-request (class).
get-federation-token-response (class).
get-session-token-request (class).
get-session-token-response (class).
pira/ec2metadatacommon-lisp.
ec2-region (function).
ec2metadata (function).
ec2token (function).
pira/credentials/basecommon-lisp.
credentials (class).
credentials-access-key-id (generic function).
credentials-headers (function).
credentials-keys (generic function).
credentials-provider-name (generic reader).
(setf credentials-provider-name) (generic writer).
credentials-secret-access-key (generic function).
credentials-session-token (generic function).
expiredp (generic function).
make-credentials (function).
provider (class).
provider-expiration (generic function).
(setf provider-expiration) (generic function).
provider-expiry-window (generic reader).
(setf provider-expiry-window) (generic writer).
retrieve (generic function).
basic-credentials (class).
define-wrapped-method (macro).
provider-credentials (class).
provider-credentials-credentials (function).
pira/credentials/assume-rolecommon-lisp.
assume-role-provider (class).
pira/apicommon-lisp.
pira.
aws-request (function).
*global-service-endpoints* (special variable).
request-host (function).
request-uri (function).
sha-256 (function).
pira/protocols/rest-json1common-lisp.
find-aws-json-error-type (function).
rest-json1 (class).
sanitize-error-code (function).
pira/protocols/rest-xmlcommon-lisp.
find-error-tag (function).
get-error-info (function).
get-tag-value (function).
rest-xml (class).
rest-xml-no-error-wrapping-p (generic reader).
pira/errorcommon-lisp.
pira.
aws-error (condition).
aws-error-body (generic reader).
aws-error-headers (generic reader).
aws-error-operation-name (generic reader).
aws-error-status (generic reader).
pira/credentials/ec2rolecommon-lisp.
ec2role-provider (class).
*default-token-ttl* (special variable).
*token* (special variable).
*use-imds-v2* (special variable).
copy-token (function).
fetch-token (function).
make-token (function).
token (structure).
token-alive-p (function).
token-created-at (reader).
(setf token-created-at) (writer).
token-p (function).
token-ttl (reader).
(setf token-ttl) (writer).
token-value (reader).
(setf token-value) (writer).
Definitions are sorted by export status, category, package, and then by lexicographic order.
credentials)) ¶provider-credentials)) ¶credentials)) ¶provider-credentials)) ¶basic-credentials)) ¶automatically generated reader method
basic-credentials)) ¶automatically generated writer method
credentials)) ¶provider-credentials)) ¶credentials)) ¶provider-credentials)) ¶shared-provider)) ¶env-provider)) ¶assume-role-provider)) ¶ec2role-provider)) ¶shared-provider)) ¶env-provider)) ¶aws-query) service operation input) ¶smithy/sdk/protocols/base.
aws-json1-1) service operation input) ¶smithy/sdk/protocols/base.
aws-json1-0) service operation input) ¶smithy/sdk/protocols/base.
rest-json1) service operation input) ¶smithy/sdk/protocols/base.
rest-xml) service operation input) ¶smithy/sdk/protocols/base.
aws-json1-1) content-type payload) ¶smithy/sdk/protocols/base.
aws-json1-0) content-type payload) ¶smithy/sdk/protocols/base.
ec2-query) output-class payload) ¶smithy/sdk/protocols/base.
aws-query) output-class payload) ¶smithy/sdk/protocols/base.
rest-xml) (output-class smithy-error) payload) ¶smithy/sdk/protocols/base.
aws-query) content-type payload) ¶smithy/sdk/protocols/base.
aws-json) content-type payload) ¶smithy/sdk/protocols/base.
aws-query) operation status headers payload) ¶smithy/sdk/protocols/base.
aws-json) operation status headers payload) ¶smithy/sdk/protocols/base.
rest-json1) operation status headers payload) ¶smithy/sdk/protocols/base.
rest-xml) operation status headers payload) ¶smithy/sdk/protocols/base.
aws-query) service operation input) ¶smithy/sdk/protocols/base.
aws-protocol) (service aws-service) operation input) ¶smithy/sdk/protocols/base.
aws-json) service operation input) ¶smithy/sdk/protocols/base.
aws-protocol) request) ¶smithy/sdk/protocols/base.
aws-query) service operation input) ¶smithy/sdk/protocols/base.
error.
:%operation-name
This slot is read-only.
:%body
This slot is read-only.
:%headers
This slot is read-only.
:%status
This slot is read-only.
structure-object.
string
(or string null)
(or string null)
(or string null)
(or string null)
(or string null)
structure-object.
(merge-pathnames ".aws/credentials" (user-homedir-pathname))
(merge-pathnames ".aws/config" (user-homedir-pathname))
(or pira/shared-config:assume-role-config null)
protocol.
aws-protocol.
xml.
smithy-structure.
(error "~s is required" :access-key-id)
:access-key-id
(error "~s is required" :secret-access-key)
:secret-access-key
(error "~s is required" :session-token)
:session-token
(error "~s is required" :expiration)
:expiration
aws-protocol.
json.
aws-protocol.
xml.
:no-error-wrapping
This slot is read-only.
ttl.
shared-provider)) ¶automatically generated reader method
shared-provider)) ¶automatically generated writer method
:role-arn
:role-session-name
900
:duration-seconds
:external-id
:policy
:serial-number
:token-code
smithy-input.
(error "~s is required" :role-arn)
:role-arn
(error "~s is required" :role-session-name)
:role-session-name
:policy-arns
:policy
:duration-seconds
:tags
:transitive-tag-keys
:external-id
:serial-number
:token-code
:source-identity
:provided-contexts
smithy-input.
(error "~s is required" :role-arn)
:role-arn
(error "~s is required" :principal-arn)
:principal-arn
(error "~s is required" :samlassertion)
:samlassertion
:policy-arns
:policy
:duration-seconds
smithy-output.
:credentials
:assumed-role-user
:packed-policy-size
:subject
:subject-type
:issuer
:audience
:name-qualifier
:source-identity
smithy-input.
(error "~s is required" :role-arn)
:role-arn
(error "~s is required" :role-session-name)
:role-session-name
(error "~s is required" :web-identity-token)
:web-identity-token
:provider-id
:policy-arns
:policy
:duration-seconds
smithy-output.
:credentials
:subject-from-web-identity-token
:assumed-role-user
:packed-policy-size
:provider
:audience
:source-identity
smithy-input.
(error "~s is required" :target-principal)
:target-principal
(error "~s is required" :task-policy-arn)
:task-policy-arn
:duration-seconds
aws-protocol.
json.
:provider
| Jump to: | %
(
A C D E F G M P R S T |
|---|
| Jump to: | %
(
A C D E F G M P R S T |
|---|
| Jump to: | *
A B C D E F H I K M N O P R S T U V W |
|---|
| Jump to: | *
A B C D E F H I K M N O P R S T U V W |
|---|
| Jump to: | %
A B C D E F G I M N P R S T U W |
|---|
| Jump to: | %
A B C D E F G I M N P R S T U W |
|---|