Skip to content

Commit 8bbfda3

Browse files
committed
deploy: e5381ae
1 parent 68c491e commit 8bbfda3

File tree

103 files changed

+62718
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

103 files changed

+62718
-0
lines changed

develop/api/event_handler/api_gateway.html

+1,656
Large diffs are not rendered by default.

develop/api/event_handler/appsync.html

+426
Large diffs are not rendered by default.

develop/api/event_handler/index.html

+338
Large diffs are not rendered by default.

develop/api/index.html

+114
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
<!doctype html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
6+
<meta name="generator" content="pdoc 0.9.2" />
7+
<title>aws_lambda_powertools API documentation</title>
8+
<meta name="description" content="Top-level package for Lambda Python Powertools." />
9+
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
10+
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
11+
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
12+
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
13+
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
14+
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
15+
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
16+
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
17+
</head>
18+
<body>
19+
<main>
20+
<article id="content">
21+
<header>
22+
<h1 class="title">Package <code>aws_lambda_powertools</code></h1>
23+
</header>
24+
<section id="section-intro">
25+
<p>Top-level package for Lambda Python Powertools.</p>
26+
<details class="source">
27+
<summary>
28+
<span>Expand source code</span>
29+
</summary>
30+
<pre><code class="python"># -*- coding: utf-8 -*-
31+
32+
&#34;&#34;&#34;Top-level package for Lambda Python Powertools.&#34;&#34;&#34;
33+
34+
35+
from .logging import Logger # noqa: F401
36+
from .metrics import Metrics, single_metric # noqa: F401
37+
from .package_logger import set_package_logger_handler
38+
from .tracing import Tracer # noqa: F401
39+
40+
__author__ = &#34;&#34;&#34;Amazon Web Services&#34;&#34;&#34;
41+
42+
set_package_logger_handler()</code></pre>
43+
</details>
44+
</section>
45+
<section>
46+
<h2 class="section-title" id="header-submodules">Sub-modules</h2>
47+
<dl>
48+
<dt><code class="name"><a title="aws_lambda_powertools.event_handler" href="event_handler/index.html">aws_lambda_powertools.event_handler</a></code></dt>
49+
<dd>
50+
<div class="desc"><p>Event handler decorators for common Lambda events</p></div>
51+
</dd>
52+
<dt><code class="name"><a title="aws_lambda_powertools.logging" href="logging/index.html">aws_lambda_powertools.logging</a></code></dt>
53+
<dd>
54+
<div class="desc"><p>Logging utility</p></div>
55+
</dd>
56+
<dt><code class="name"><a title="aws_lambda_powertools.metrics" href="metrics/index.html">aws_lambda_powertools.metrics</a></code></dt>
57+
<dd>
58+
<div class="desc"><p>CloudWatch Embedded Metric Format utility</p></div>
59+
</dd>
60+
<dt><code class="name"><a title="aws_lambda_powertools.middleware_factory" href="middleware_factory/index.html">aws_lambda_powertools.middleware_factory</a></code></dt>
61+
<dd>
62+
<div class="desc"><p>Utilities to enhance middlewares</p></div>
63+
</dd>
64+
<dt><code class="name"><a title="aws_lambda_powertools.package_logger" href="package_logger.html">aws_lambda_powertools.package_logger</a></code></dt>
65+
<dd>
66+
<div class="desc"></div>
67+
</dd>
68+
<dt><code class="name"><a title="aws_lambda_powertools.shared" href="shared/index.html">aws_lambda_powertools.shared</a></code></dt>
69+
<dd>
70+
<div class="desc"></div>
71+
</dd>
72+
<dt><code class="name"><a title="aws_lambda_powertools.tracing" href="tracing/index.html">aws_lambda_powertools.tracing</a></code></dt>
73+
<dd>
74+
<div class="desc"><p>Tracing utility</p></div>
75+
</dd>
76+
<dt><code class="name"><a title="aws_lambda_powertools.utilities" href="utilities/index.html">aws_lambda_powertools.utilities</a></code></dt>
77+
<dd>
78+
<div class="desc"><p>General utilities for Powertools</p></div>
79+
</dd>
80+
</dl>
81+
</section>
82+
<section>
83+
</section>
84+
<section>
85+
</section>
86+
<section>
87+
</section>
88+
</article>
89+
<nav id="sidebar">
90+
<h1>Index</h1>
91+
<div class="toc">
92+
<ul></ul>
93+
</div>
94+
<ul id="index">
95+
<li><h3><a href="#header-submodules">Sub-modules</a></h3>
96+
<ul>
97+
<li><code><a title="aws_lambda_powertools.event_handler" href="event_handler/index.html">aws_lambda_powertools.event_handler</a></code></li>
98+
<li><code><a title="aws_lambda_powertools.logging" href="logging/index.html">aws_lambda_powertools.logging</a></code></li>
99+
<li><code><a title="aws_lambda_powertools.metrics" href="metrics/index.html">aws_lambda_powertools.metrics</a></code></li>
100+
<li><code><a title="aws_lambda_powertools.middleware_factory" href="middleware_factory/index.html">aws_lambda_powertools.middleware_factory</a></code></li>
101+
<li><code><a title="aws_lambda_powertools.package_logger" href="package_logger.html">aws_lambda_powertools.package_logger</a></code></li>
102+
<li><code><a title="aws_lambda_powertools.shared" href="shared/index.html">aws_lambda_powertools.shared</a></code></li>
103+
<li><code><a title="aws_lambda_powertools.tracing" href="tracing/index.html">aws_lambda_powertools.tracing</a></code></li>
104+
<li><code><a title="aws_lambda_powertools.utilities" href="utilities/index.html">aws_lambda_powertools.utilities</a></code></li>
105+
</ul>
106+
</li>
107+
</ul>
108+
</nav>
109+
</main>
110+
<footer id="footer">
111+
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.2</a>.</p>
112+
</footer>
113+
</body>
114+
</html>
+67
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
<!doctype html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
6+
<meta name="generator" content="pdoc 0.9.2" />
7+
<title>aws_lambda_powertools.logging.correlation_paths API documentation</title>
8+
<meta name="description" content="Built-in correlation paths" />
9+
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
10+
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
11+
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
12+
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
13+
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
14+
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
15+
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
16+
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
17+
</head>
18+
<body>
19+
<main>
20+
<article id="content">
21+
<header>
22+
<h1 class="title">Module <code>aws_lambda_powertools.logging.correlation_paths</code></h1>
23+
</header>
24+
<section id="section-intro">
25+
<p>Built-in correlation paths</p>
26+
<details class="source">
27+
<summary>
28+
<span>Expand source code</span>
29+
</summary>
30+
<pre><code class="python">&#34;&#34;&#34;Built-in correlation paths&#34;&#34;&#34;
31+
32+
API_GATEWAY_REST = &#34;requestContext.requestId&#34;
33+
API_GATEWAY_HTTP = API_GATEWAY_REST
34+
APPSYNC_RESOLVER = &#39;request.headers.&#34;x-amzn-trace-id&#34;&#39;
35+
APPLICATION_LOAD_BALANCER = &#39;headers.&#34;x-amzn-trace-id&#34;&#39;
36+
EVENT_BRIDGE = &#34;id&#34;
37+
S3_OBJECT_LAMBDA = &#34;xAmzRequestId&#34;</code></pre>
38+
</details>
39+
</section>
40+
<section>
41+
</section>
42+
<section>
43+
</section>
44+
<section>
45+
</section>
46+
<section>
47+
</section>
48+
</article>
49+
<nav id="sidebar">
50+
<h1>Index</h1>
51+
<div class="toc">
52+
<ul></ul>
53+
</div>
54+
<ul id="index">
55+
<li><h3>Super-module</h3>
56+
<ul>
57+
<li><code><a title="aws_lambda_powertools.logging" href="index.html">aws_lambda_powertools.logging</a></code></li>
58+
</ul>
59+
</li>
60+
</ul>
61+
</nav>
62+
</main>
63+
<footer id="footer">
64+
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.2</a>.</p>
65+
</footer>
66+
</body>
67+
</html>

0 commit comments

Comments
 (0)