diff --git a/docs/.buildinfo b/docs/.buildinfo
new file mode 100644
index 000000000..3ea8ab409
--- /dev/null
+++ b/docs/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: dd997feca9246d9432c476552bc17ff8
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/.nojekyll b/docs/.nojekyll
new file mode 100644
index 000000000..e69de29bb
diff --git a/docs/_sources/api/auth.rst.txt b/docs/_sources/api/auth.rst.txt
new file mode 100644
index 000000000..164d7f7d3
--- /dev/null
+++ b/docs/_sources/api/auth.rst.txt
@@ -0,0 +1,6 @@
+awscrt.auth
+===========
+
+.. automodule:: awscrt.auth
+    :members:
+    :exclude-members: AwsCredentialsProviderBase
diff --git a/docs/_sources/api/common.rst.txt b/docs/_sources/api/common.rst.txt
new file mode 100644
index 000000000..2d2d753ca
--- /dev/null
+++ b/docs/_sources/api/common.rst.txt
@@ -0,0 +1,5 @@
+awscrt.common
+=============
+
+.. automodule:: awscrt.common
+    :members:
diff --git a/docs/_sources/api/crypto.rst.txt b/docs/_sources/api/crypto.rst.txt
new file mode 100644
index 000000000..806d09b95
--- /dev/null
+++ b/docs/_sources/api/crypto.rst.txt
@@ -0,0 +1,5 @@
+awscrt.crypto
+=============
+
+.. automodule:: awscrt.crypto
+    :members:
diff --git a/docs/_sources/api/eventstream.rst.txt b/docs/_sources/api/eventstream.rst.txt
new file mode 100644
index 000000000..90135d2b2
--- /dev/null
+++ b/docs/_sources/api/eventstream.rst.txt
@@ -0,0 +1,9 @@
+awscrt.eventstream
+==================
+
+.. automodule:: awscrt.eventstream
+    :members:
+
+.. automodule:: awscrt.eventstream.rpc
+    :members:
+
diff --git a/docs/_sources/api/exceptions.rst.txt b/docs/_sources/api/exceptions.rst.txt
new file mode 100644
index 000000000..3b7d1b06d
--- /dev/null
+++ b/docs/_sources/api/exceptions.rst.txt
@@ -0,0 +1,5 @@
+awscrt.exceptions
+=================
+
+.. automodule:: awscrt.exceptions
+    :members:
diff --git a/docs/_sources/api/http.rst.txt b/docs/_sources/api/http.rst.txt
new file mode 100644
index 000000000..f27380f7f
--- /dev/null
+++ b/docs/_sources/api/http.rst.txt
@@ -0,0 +1,7 @@
+awscrt.http
+===========
+
+.. automodule:: awscrt.http
+    :members:
+    :inherited-members:
+    :exclude-members: HttpConnectionBase, HttpStreamBase, HttpMessageBase
\ No newline at end of file
diff --git a/docs/_sources/api/io.rst.txt b/docs/_sources/api/io.rst.txt
new file mode 100644
index 000000000..8ab939512
--- /dev/null
+++ b/docs/_sources/api/io.rst.txt
@@ -0,0 +1,5 @@
+awscrt.io
+=========
+
+.. automodule:: awscrt.io
+    :members:
diff --git a/docs/_sources/api/mqtt.rst.txt b/docs/_sources/api/mqtt.rst.txt
new file mode 100644
index 000000000..3b299a4da
--- /dev/null
+++ b/docs/_sources/api/mqtt.rst.txt
@@ -0,0 +1,6 @@
+awscrt.mqtt
+===========
+
+.. automodule:: awscrt.mqtt
+    :members:
+    :exclude-members: reconnect
\ No newline at end of file
diff --git a/docs/_sources/api/mqtt5.rst.txt b/docs/_sources/api/mqtt5.rst.txt
new file mode 100644
index 000000000..5e7a81815
--- /dev/null
+++ b/docs/_sources/api/mqtt5.rst.txt
@@ -0,0 +1,5 @@
+awscrt.mqtt5
+============
+
+.. automodule:: awscrt.mqtt5
+    :members:
diff --git a/docs/_sources/api/s3.rst.txt b/docs/_sources/api/s3.rst.txt
new file mode 100644
index 000000000..f781ff701
--- /dev/null
+++ b/docs/_sources/api/s3.rst.txt
@@ -0,0 +1,5 @@
+awscrt.s3
+=========
+
+.. automodule:: awscrt.s3
+    :members:
diff --git a/docs/_sources/api/websocket.rst.txt b/docs/_sources/api/websocket.rst.txt
new file mode 100644
index 000000000..4379c9bfc
--- /dev/null
+++ b/docs/_sources/api/websocket.rst.txt
@@ -0,0 +1,5 @@
+awscrt.websocket
+================
+
+.. automodule:: awscrt.websocket
+    :members:
diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
new file mode 100644
index 000000000..0558f3f54
--- /dev/null
+++ b/docs/_sources/index.rst.txt
@@ -0,0 +1,30 @@
+Welcome to awscrt's documentation!
+==================================
+Python bindings for the AWS Common Runtime.
+
+GitHub: https://github.com/awslabs/aws-crt-python
+
+PyPI: https://pypi.org/project/awscrt/
+
+API Reference
+-------------
+.. toctree::
+   :maxdepth: 2
+
+   api/auth
+   api/common
+   api/crypto
+   api/exceptions
+   api/eventstream
+   api/http
+   api/io
+   api/mqtt
+   api/mqtt5
+   api/s3
+   api/websocket
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`search`
diff --git a/docs/_static/background_b01.png b/docs/_static/background_b01.png
new file mode 100644
index 000000000..353f26dde
Binary files /dev/null and b/docs/_static/background_b01.png differ
diff --git a/docs/_static/basic.css b/docs/_static/basic.css
new file mode 100644
index 000000000..fab6036ff
--- /dev/null
+++ b/docs/_static/basic.css
@@ -0,0 +1,925 @@
+/*
+ * basic.css
+ * ~~~~~~~~~
+ *
+ * Sphinx stylesheet -- basic theme.
+ *
+ * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+
+/* -- main layout ----------------------------------------------------------- */
+
+div.clearer {
+    clear: both;
+}
+
+div.section::after {
+    display: block;
+    content: '';
+    clear: left;
+}
+
+/* -- relbar ---------------------------------------------------------------- */
+
+div.related {
+    width: 100%;
+    font-size: 90%;
+}
+
+div.related h3 {
+    display: none;
+}
+
+div.related ul {
+    margin: 0;
+    padding: 0 0 0 10px;
+    list-style: none;
+}
+
+div.related li {
+    display: inline;
+}
+
+div.related li.right {
+    float: right;
+    margin-right: 5px;
+}
+
+/* -- sidebar --------------------------------------------------------------- */
+
+div.sphinxsidebarwrapper {
+    padding: 10px 5px 0 10px;
+}
+
+div.sphinxsidebar {
+    float: left;
+    width: 300px;
+    margin-left: -100%;
+    font-size: 90%;
+    word-wrap: break-word;
+    overflow-wrap : break-word;
+}
+
+div.sphinxsidebar ul {
+    list-style: none;
+}
+
+div.sphinxsidebar ul ul,
+div.sphinxsidebar ul.want-points {
+    margin-left: 20px;
+    list-style: square;
+}
+
+div.sphinxsidebar ul ul {
+    margin-top: 0;
+    margin-bottom: 0;
+}
+
+div.sphinxsidebar form {
+    margin-top: 10px;
+}
+
+div.sphinxsidebar input {
+    border: 1px solid #98dbcc;
+    font-family: sans-serif;
+    font-size: 1em;
+}
+
+div.sphinxsidebar #searchbox form.search {
+    overflow: hidden;
+}
+
+div.sphinxsidebar #searchbox input[type="text"] {
+    float: left;
+    width: 80%;
+    padding: 0.25em;
+    box-sizing: border-box;
+}
+
+div.sphinxsidebar #searchbox input[type="submit"] {
+    float: left;
+    width: 20%;
+    border-left: none;
+    padding: 0.25em;
+    box-sizing: border-box;
+}
+
+
+img {
+    border: 0;
+    max-width: 100%;
+}
+
+/* -- search page ----------------------------------------------------------- */
+
+ul.search {
+    margin: 10px 0 0 20px;
+    padding: 0;
+}
+
+ul.search li {
+    padding: 5px 0 5px 20px;
+    background-image: url(file.png);
+    background-repeat: no-repeat;
+    background-position: 0 7px;
+}
+
+ul.search li a {
+    font-weight: bold;
+}
+
+ul.search li p.context {
+    color: #888;
+    margin: 2px 0 0 30px;
+    text-align: left;
+}
+
+ul.keywordmatches li.goodmatch a {
+    font-weight: bold;
+}
+
+/* -- index page ------------------------------------------------------------ */
+
+table.contentstable {
+    width: 90%;
+    margin-left: auto;
+    margin-right: auto;
+}
+
+table.contentstable p.biglink {
+    line-height: 150%;
+}
+
+a.biglink {
+    font-size: 1.3em;
+}
+
+span.linkdescr {
+    font-style: italic;
+    padding-top: 5px;
+    font-size: 90%;
+}
+
+/* -- general index --------------------------------------------------------- */
+
+table.indextable {
+    width: 100%;
+}
+
+table.indextable td {
+    text-align: left;
+    vertical-align: top;
+}
+
+table.indextable ul {
+    margin-top: 0;
+    margin-bottom: 0;
+    list-style-type: none;
+}
+
+table.indextable > tbody > tr > td > ul {
+    padding-left: 0em;
+}
+
+table.indextable tr.pcap {
+    height: 10px;
+}
+
+table.indextable tr.cap {
+    margin-top: 10px;
+    background-color: #f2f2f2;
+}
+
+img.toggler {
+    margin-right: 3px;
+    margin-top: 3px;
+    cursor: pointer;
+}
+
+div.modindex-jumpbox {
+    border-top: 1px solid #ddd;
+    border-bottom: 1px solid #ddd;
+    margin: 1em 0 1em 0;
+    padding: 0.4em;
+}
+
+div.genindex-jumpbox {
+    border-top: 1px solid #ddd;
+    border-bottom: 1px solid #ddd;
+    margin: 1em 0 1em 0;
+    padding: 0.4em;
+}
+
+/* -- domain module index --------------------------------------------------- */
+
+table.modindextable td {
+    padding: 2px;
+    border-collapse: collapse;
+}
+
+/* -- general body styles --------------------------------------------------- */
+
+div.body {
+    min-width: 360px;
+    max-width: 800px;
+}
+
+div.body p, div.body dd, div.body li, div.body blockquote {
+    -moz-hyphens: auto;
+    -ms-hyphens: auto;
+    -webkit-hyphens: auto;
+    hyphens: auto;
+}
+
+a.headerlink {
+    visibility: hidden;
+}
+
+a:visited {
+    color: #551A8B;
+}
+
+h1:hover > a.headerlink,
+h2:hover > a.headerlink,
+h3:hover > a.headerlink,
+h4:hover > a.headerlink,
+h5:hover > a.headerlink,
+h6:hover > a.headerlink,
+dt:hover > a.headerlink,
+caption:hover > a.headerlink,
+p.caption:hover > a.headerlink,
+div.code-block-caption:hover > a.headerlink {
+    visibility: visible;
+}
+
+div.body p.caption {
+    text-align: inherit;
+}
+
+div.body td {
+    text-align: left;
+}
+
+.first {
+    margin-top: 0 !important;
+}
+
+p.rubric {
+    margin-top: 30px;
+    font-weight: bold;
+}
+
+img.align-left, figure.align-left, .figure.align-left, object.align-left {
+    clear: left;
+    float: left;
+    margin-right: 1em;
+}
+
+img.align-right, figure.align-right, .figure.align-right, object.align-right {
+    clear: right;
+    float: right;
+    margin-left: 1em;
+}
+
+img.align-center, figure.align-center, .figure.align-center, object.align-center {
+  display: block;
+  margin-left: auto;
+  margin-right: auto;
+}
+
+img.align-default, figure.align-default, .figure.align-default {
+  display: block;
+  margin-left: auto;
+  margin-right: auto;
+}
+
+.align-left {
+    text-align: left;
+}
+
+.align-center {
+    text-align: center;
+}
+
+.align-default {
+    text-align: center;
+}
+
+.align-right {
+    text-align: right;
+}
+
+/* -- sidebars -------------------------------------------------------------- */
+
+div.sidebar,
+aside.sidebar {
+    margin: 0 0 0.5em 1em;
+    border: 1px solid #ddb;
+    padding: 7px;
+    background-color: #ffe;
+    width: 40%;
+    float: right;
+    clear: right;
+    overflow-x: auto;
+}
+
+p.sidebar-title {
+    font-weight: bold;
+}
+
+nav.contents,
+aside.topic,
+div.admonition, div.topic, blockquote {
+    clear: left;
+}
+
+/* -- topics ---------------------------------------------------------------- */
+
+nav.contents,
+aside.topic,
+div.topic {
+    border: 1px solid #ccc;
+    padding: 7px;
+    margin: 10px 0 10px 0;
+}
+
+p.topic-title {
+    font-size: 1.1em;
+    font-weight: bold;
+    margin-top: 10px;
+}
+
+/* -- admonitions ----------------------------------------------------------- */
+
+div.admonition {
+    margin-top: 10px;
+    margin-bottom: 10px;
+    padding: 7px;
+}
+
+div.admonition dt {
+    font-weight: bold;
+}
+
+p.admonition-title {
+    margin: 0px 10px 5px 0px;
+    font-weight: bold;
+}
+
+div.body p.centered {
+    text-align: center;
+    margin-top: 25px;
+}
+
+/* -- content of sidebars/topics/admonitions -------------------------------- */
+
+div.sidebar > :last-child,
+aside.sidebar > :last-child,
+nav.contents > :last-child,
+aside.topic > :last-child,
+div.topic > :last-child,
+div.admonition > :last-child {
+    margin-bottom: 0;
+}
+
+div.sidebar::after,
+aside.sidebar::after,
+nav.contents::after,
+aside.topic::after,
+div.topic::after,
+div.admonition::after,
+blockquote::after {
+    display: block;
+    content: '';
+    clear: both;
+}
+
+/* -- tables ---------------------------------------------------------------- */
+
+table.docutils {
+    margin-top: 10px;
+    margin-bottom: 10px;
+    border: 0;
+    border-collapse: collapse;
+}
+
+table.align-center {
+    margin-left: auto;
+    margin-right: auto;
+}
+
+table.align-default {
+    margin-left: auto;
+    margin-right: auto;
+}
+
+table caption span.caption-number {
+    font-style: italic;
+}
+
+table caption span.caption-text {
+}
+
+table.docutils td, table.docutils th {
+    padding: 1px 8px 1px 5px;
+    border-top: 0;
+    border-left: 0;
+    border-right: 0;
+    border-bottom: 1px solid #aaa;
+}
+
+th {
+    text-align: left;
+    padding-right: 5px;
+}
+
+table.citation {
+    border-left: solid 1px gray;
+    margin-left: 1px;
+}
+
+table.citation td {
+    border-bottom: none;
+}
+
+th > :first-child,
+td > :first-child {
+    margin-top: 0px;
+}
+
+th > :last-child,
+td > :last-child {
+    margin-bottom: 0px;
+}
+
+/* -- figures --------------------------------------------------------------- */
+
+div.figure, figure {
+    margin: 0.5em;
+    padding: 0.5em;
+}
+
+div.figure p.caption, figcaption {
+    padding: 0.3em;
+}
+
+div.figure p.caption span.caption-number,
+figcaption span.caption-number {
+    font-style: italic;
+}
+
+div.figure p.caption span.caption-text,
+figcaption span.caption-text {
+}
+
+/* -- field list styles ----------------------------------------------------- */
+
+table.field-list td, table.field-list th {
+    border: 0 !important;
+}
+
+.field-list ul {
+    margin: 0;
+    padding-left: 1em;
+}
+
+.field-list p {
+    margin: 0;
+}
+
+.field-name {
+    -moz-hyphens: manual;
+    -ms-hyphens: manual;
+    -webkit-hyphens: manual;
+    hyphens: manual;
+}
+
+/* -- hlist styles ---------------------------------------------------------- */
+
+table.hlist {
+    margin: 1em 0;
+}
+
+table.hlist td {
+    vertical-align: top;
+}
+
+/* -- object description styles --------------------------------------------- */
+
+.sig {
+	font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
+}
+
+.sig-name, code.descname {
+    background-color: transparent;
+    font-weight: bold;
+}
+
+.sig-name {
+	font-size: 1.1em;
+}
+
+code.descname {
+    font-size: 1.2em;
+}
+
+.sig-prename, code.descclassname {
+    background-color: transparent;
+}
+
+.optional {
+    font-size: 1.3em;
+}
+
+.sig-paren {
+    font-size: larger;
+}
+
+.sig-param.n {
+	font-style: italic;
+}
+
+/* C++ specific styling */
+
+.sig-inline.c-texpr,
+.sig-inline.cpp-texpr {
+	font-family: unset;
+}
+
+.sig.c   .k, .sig.c   .kt,
+.sig.cpp .k, .sig.cpp .kt {
+	color: #0033B3;
+}
+
+.sig.c   .m,
+.sig.cpp .m {
+	color: #1750EB;
+}
+
+.sig.c   .s, .sig.c   .sc,
+.sig.cpp .s, .sig.cpp .sc {
+	color: #067D17;
+}
+
+
+/* -- other body styles ----------------------------------------------------- */
+
+ol.arabic {
+    list-style: decimal;
+}
+
+ol.loweralpha {
+    list-style: lower-alpha;
+}
+
+ol.upperalpha {
+    list-style: upper-alpha;
+}
+
+ol.lowerroman {
+    list-style: lower-roman;
+}
+
+ol.upperroman {
+    list-style: upper-roman;
+}
+
+:not(li) > ol > li:first-child > :first-child,
+:not(li) > ul > li:first-child > :first-child {
+    margin-top: 0px;
+}
+
+:not(li) > ol > li:last-child > :last-child,
+:not(li) > ul > li:last-child > :last-child {
+    margin-bottom: 0px;
+}
+
+ol.simple ol p,
+ol.simple ul p,
+ul.simple ol p,
+ul.simple ul p {
+    margin-top: 0;
+}
+
+ol.simple > li:not(:first-child) > p,
+ul.simple > li:not(:first-child) > p {
+    margin-top: 0;
+}
+
+ol.simple p,
+ul.simple p {
+    margin-bottom: 0;
+}
+
+aside.footnote > span,
+div.citation > span {
+    float: left;
+}
+aside.footnote > span:last-of-type,
+div.citation > span:last-of-type {
+  padding-right: 0.5em;
+}
+aside.footnote > p {
+  margin-left: 2em;
+}
+div.citation > p {
+  margin-left: 4em;
+}
+aside.footnote > p:last-of-type,
+div.citation > p:last-of-type {
+    margin-bottom: 0em;
+}
+aside.footnote > p:last-of-type:after,
+div.citation > p:last-of-type:after {
+    content: "";
+    clear: both;
+}
+
+dl.field-list {
+    display: grid;
+    grid-template-columns: fit-content(30%) auto;
+}
+
+dl.field-list > dt {
+    font-weight: bold;
+    word-break: break-word;
+    padding-left: 0.5em;
+    padding-right: 5px;
+}
+
+dl.field-list > dd {
+    padding-left: 0.5em;
+    margin-top: 0em;
+    margin-left: 0em;
+    margin-bottom: 0em;
+}
+
+dl {
+    margin-bottom: 15px;
+}
+
+dd > :first-child {
+    margin-top: 0px;
+}
+
+dd ul, dd table {
+    margin-bottom: 10px;
+}
+
+dd {
+    margin-top: 3px;
+    margin-bottom: 10px;
+    margin-left: 30px;
+}
+
+.sig dd {
+    margin-top: 0px;
+    margin-bottom: 0px;
+}
+
+.sig dl {
+    margin-top: 0px;
+    margin-bottom: 0px;
+}
+
+dl > dd:last-child,
+dl > dd:last-child > :last-child {
+    margin-bottom: 0;
+}
+
+dt:target, span.highlighted {
+    background-color: #fbe54e;
+}
+
+rect.highlighted {
+    fill: #fbe54e;
+}
+
+dl.glossary dt {
+    font-weight: bold;
+    font-size: 1.1em;
+}
+
+.versionmodified {
+    font-style: italic;
+}
+
+.system-message {
+    background-color: #fda;
+    padding: 5px;
+    border: 3px solid red;
+}
+
+.footnote:target  {
+    background-color: #ffa;
+}
+
+.line-block {
+    display: block;
+    margin-top: 1em;
+    margin-bottom: 1em;
+}
+
+.line-block .line-block {
+    margin-top: 0;
+    margin-bottom: 0;
+    margin-left: 1.5em;
+}
+
+.guilabel, .menuselection {
+    font-family: sans-serif;
+}
+
+.accelerator {
+    text-decoration: underline;
+}
+
+.classifier {
+    font-style: oblique;
+}
+
+.classifier:before {
+    font-style: normal;
+    margin: 0 0.5em;
+    content: ":";
+    display: inline-block;
+}
+
+abbr, acronym {
+    border-bottom: dotted 1px;
+    cursor: help;
+}
+
+.translated {
+    background-color: rgba(207, 255, 207, 0.2)
+}
+
+.untranslated {
+    background-color: rgba(255, 207, 207, 0.2)
+}
+
+/* -- code displays --------------------------------------------------------- */
+
+pre {
+    overflow: auto;
+    overflow-y: hidden;  /* fixes display issues on Chrome browsers */
+}
+
+pre, div[class*="highlight-"] {
+    clear: both;
+}
+
+span.pre {
+    -moz-hyphens: none;
+    -ms-hyphens: none;
+    -webkit-hyphens: none;
+    hyphens: none;
+    white-space: nowrap;
+}
+
+div[class*="highlight-"] {
+    margin: 1em 0;
+}
+
+td.linenos pre {
+    border: 0;
+    background-color: transparent;
+    color: #aaa;
+}
+
+table.highlighttable {
+    display: block;
+}
+
+table.highlighttable tbody {
+    display: block;
+}
+
+table.highlighttable tr {
+    display: flex;
+}
+
+table.highlighttable td {
+    margin: 0;
+    padding: 0;
+}
+
+table.highlighttable td.linenos {
+    padding-right: 0.5em;
+}
+
+table.highlighttable td.code {
+    flex: 1;
+    overflow: hidden;
+}
+
+.highlight .hll {
+    display: block;
+}
+
+div.highlight pre,
+table.highlighttable pre {
+    margin: 0;
+}
+
+div.code-block-caption + div {
+    margin-top: 0;
+}
+
+div.code-block-caption {
+    margin-top: 1em;
+    padding: 2px 5px;
+    font-size: small;
+}
+
+div.code-block-caption code {
+    background-color: transparent;
+}
+
+table.highlighttable td.linenos,
+span.linenos,
+div.highlight span.gp {  /* gp: Generic.Prompt */
+  user-select: none;
+  -webkit-user-select: text; /* Safari fallback only */
+  -webkit-user-select: none; /* Chrome/Safari */
+  -moz-user-select: none; /* Firefox */
+  -ms-user-select: none; /* IE10+ */
+}
+
+div.code-block-caption span.caption-number {
+    padding: 0.1em 0.3em;
+    font-style: italic;
+}
+
+div.code-block-caption span.caption-text {
+}
+
+div.literal-block-wrapper {
+    margin: 1em 0;
+}
+
+code.xref, a code {
+    background-color: transparent;
+    font-weight: bold;
+}
+
+h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
+    background-color: transparent;
+}
+
+.viewcode-link {
+    float: right;
+}
+
+.viewcode-back {
+    float: right;
+    font-family: sans-serif;
+}
+
+div.viewcode-block:target {
+    margin: -1px -10px;
+    padding: 0 10px;
+}
+
+/* -- math display ---------------------------------------------------------- */
+
+img.math {
+    vertical-align: middle;
+}
+
+div.body div.math p {
+    text-align: center;
+}
+
+span.eqno {
+    float: right;
+}
+
+span.eqno a.headerlink {
+    position: absolute;
+    z-index: 1;
+}
+
+div.math:hover a.headerlink {
+    visibility: visible;
+}
+
+/* -- printout stylesheet --------------------------------------------------- */
+
+@media print {
+    div.document,
+    div.documentwrapper,
+    div.bodywrapper {
+        margin: 0 !important;
+        width: 100%;
+    }
+
+    div.sphinxsidebar,
+    div.related,
+    div.footer,
+    #top-link {
+        display: none;
+    }
+}
\ No newline at end of file
diff --git a/docs/_static/bizstyle.css b/docs/_static/bizstyle.css
new file mode 100644
index 000000000..0cd1931c1
--- /dev/null
+++ b/docs/_static/bizstyle.css
@@ -0,0 +1,512 @@
+/*
+ * bizstyle.css_t
+ * ~~~~~~~~~~~~~~
+ *
+ * Sphinx stylesheet -- business style theme.
+ *
+ * :copyright: Copyright 2007-2023 by Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+
+@import url("basic.css");
+
+/* -- page layout ----------------------------------------------------------- */
+
+body {
+    font-family: 'Lucida Grande', 'Lucida Sans Unicode', 'Geneva',
+                 'Verdana', sans-serif;
+    font-size: 14px;
+    letter-spacing: -0.01em;
+    line-height: 150%;
+    text-align: center;
+    background-color: white;
+    background-image: url(background_b01.png);
+    color: black;
+    padding: 0;
+    border-right: 1px solid #336699;
+    border-left: 1px solid #336699;
+
+    margin: 0px 40px 0px 40px;
+}
+
+div.document {
+    background-color: white;
+    text-align: left;
+    background-repeat: repeat-x;
+
+    -moz-box-shadow: 2px 2px 5px #000;
+    -webkit-box-shadow: 2px 2px 5px #000;
+}
+
+div.documentwrapper {
+    float: left;
+    width: 100%;
+}
+
+div.bodywrapper {
+    margin: 0 0 0 240px;
+    border-left: 1px solid #ccc;
+}
+
+div.body {
+    margin: 0;
+    padding: 0.5em 20px 20px 20px;
+}
+div.bodywrapper {
+    margin: 0 0 0 calc(300px + 30px);
+}
+
+div.related {
+    font-size: 1em;
+
+    -moz-box-shadow: 2px 2px 5px #000;
+    -webkit-box-shadow: 2px 2px 5px #000;
+}
+
+div.related ul {
+    background-color: #336699;
+    height: 100%;
+    overflow: hidden;
+    border-top: 1px solid #ddd;
+    border-bottom: 1px solid #ddd;
+}
+
+div.related ul li {
+    color: white;
+    margin: 0;
+    padding: 0;
+    height: 2em;
+    float: left;
+}
+
+div.related ul li.right {
+    float: right;
+    margin-right: 5px;
+}
+
+div.related ul li a {
+    margin: 0;
+    padding: 0 5px 0 5px;
+    line-height: 1.75em;
+    color: #fff;
+}
+
+div.related ul li a:hover {
+    color: #fff;
+    text-decoration: underline;
+}
+
+div.sphinxsidebarwrapper {
+    padding: 0;
+}
+
+div.sphinxsidebar {
+    padding: 0.5em 12px 12px 12px;
+    width: 300px;
+    font-size: 1em;
+    text-align: left;
+}
+
+div.sphinxsidebar h3, div.sphinxsidebar h4 {
+    margin: 1em 0 0.5em 0;
+    font-size: 1em;
+    padding: 0.1em 0 0.1em 0.5em;
+    color: white;
+    border: 1px solid #336699;
+    background-color: #336699;
+}
+
+div.sphinxsidebar h3 a {
+    color: white;
+}
+
+div.sphinxsidebar ul {
+    padding-left: 1.5em;
+    margin-top: 7px;
+    padding: 0;
+    line-height: 130%;
+}
+
+div.sphinxsidebar ul ul {
+    margin-left: 20px;
+}
+
+div.sphinxsidebar input {
+    border: 1px solid #336699;
+}
+
+div.footer {
+    background-color: white;
+    color: #336699;
+    padding: 3px 8px 3px 0;
+    clear: both;
+    font-size: 0.8em;
+    text-align: right;
+    border-bottom: 1px solid #336699;
+
+    -moz-box-shadow: 2px 2px 5px #000;
+    -webkit-box-shadow: 2px 2px 5px #000;
+}
+
+div.footer a {
+    color: #336699;
+    text-decoration: underline;
+}
+
+/* -- body styles ----------------------------------------------------------- */
+
+p {
+    margin: 0.8em 0 0.5em 0;
+}
+
+a {
+    color: #336699;
+    text-decoration: none;
+}
+
+a:hover {
+    color: #336699;
+    text-decoration: underline;
+}
+
+a:visited {
+    color: #551a8b;
+}
+
+div.body a {
+    text-decoration: underline;
+}
+
+h1, h2, h3 {
+    color: #336699;
+}
+
+h1 {
+    margin: 0;
+    padding: 0.7em 0 0.3em 0;
+    font-size: 1.5em;
+}
+
+h2 {
+    margin: 1.3em 0 0.2em 0;
+    font-size: 1.35em;
+    padding-bottom: .5em;
+    border-bottom: 1px solid #336699;
+}
+
+h3 {
+    margin: 1em 0 -0.3em 0;
+    font-size: 1.2em;
+    padding-bottom: .3em;
+    border-bottom: 1px solid #CCCCCC;
+}
+
+div.body h1 a, div.body h2 a, div.body h3 a,
+div.body h4 a, div.body h5 a, div.body h6 a {
+    color: black!important;
+}
+
+h1 a.anchor, h2 a.anchor, h3 a.anchor,
+h4 a.anchor, h5 a.anchor, h6 a.anchor {
+    display: none;
+    margin: 0 0 0 0.3em;
+    padding: 0 0.2em 0 0.2em;
+    color: #aaa!important;
+}
+
+h1:hover a.anchor, h2:hover a.anchor, h3:hover a.anchor, h4:hover a.anchor,
+h5:hover a.anchor, h6:hover a.anchor {
+    display: inline;
+}
+
+h1 a.anchor:hover, h2 a.anchor:hover, h3 a.anchor:hover, h4 a.anchor:hover,
+h5 a.anchor:hover, h6 a.anchor:hover {
+    color: #777;
+    background-color: #eee;
+}
+
+a.headerlink {
+    color: #c60f0f!important;
+    font-size: 1em;
+    margin-left: 6px;
+    padding: 0 4px 0 4px;
+    text-decoration: none!important;
+}
+
+a.headerlink:hover {
+    background-color: #ccc;
+    color: white!important;
+}
+
+cite, code, tt {
+    font-family: 'Consolas', 'Deja Vu Sans Mono',
+                 'Bitstream Vera Sans Mono', monospace;
+    font-size: 0.95em;
+    letter-spacing: 0.01em;
+}
+
+code {
+    background-color: #F2F2F2;
+    border-bottom: 1px solid #ddd;
+    color: #333;
+}
+
+code.descname, code.descclassname, code.xref {
+    border: 0;
+}
+
+hr {
+    border: 1px solid #abc;
+    margin: 2em;
+}
+
+a code {
+    border: 0;
+    color: #CA7900;
+}
+
+a code:hover {
+    color: #2491CF;
+}
+
+pre {
+    background-color: transparent !important;
+    font-family: 'Consolas', 'Deja Vu Sans Mono',
+                 'Bitstream Vera Sans Mono', monospace;
+    font-size: 0.95em;
+    letter-spacing: 0.015em;
+    line-height: 120%;
+    padding: 0.5em;
+    border-right: 5px solid #ccc;
+    border-left: 5px solid #ccc;
+}
+
+pre a {
+    color: inherit;
+    text-decoration: underline;
+}
+
+td.linenos pre {
+    padding: 0.5em 0;
+}
+
+div.quotebar {
+    background-color: #f8f8f8;
+    max-width: 250px;
+    float: right;
+    padding: 2px 7px;
+    border: 1px solid #ccc;
+}
+
+nav.contents,
+aside.topic,
+div.topic {
+    background-color: #f8f8f8;
+}
+
+table {
+    border-collapse: collapse;
+    margin: 0 -0.5em 0 -0.5em;
+}
+
+table td, table th {
+    padding: 0.2em 0.5em 0.2em 0.5em;
+}
+
+div.admonition {
+    font-size: 0.9em;
+    margin: 1em 0 1em 0;
+    border: 3px solid #cccccc;
+    background-color: #f7f7f7;
+    padding: 0;
+}
+
+div.admonition p {
+    margin: 0.5em 1em 0.5em 1em;
+    padding: 0;
+}
+
+div.admonition li p {
+    margin-left: 0;
+}
+
+div.admonition pre, div.warning pre {
+    margin: 0;
+}
+
+div.highlight {
+    margin: 0.4em 1em;
+}
+
+div.admonition p.admonition-title {
+    margin: 0;
+    padding: 0.1em 0 0.1em 0.5em;
+    color: white;
+    border-bottom: 3px solid #cccccc;
+    font-weight: bold;
+    background-color: #165e83;
+}
+
+div.danger    { border: 3px solid #f0908d; background-color: #f0cfa0; }
+div.error     { border: 3px solid #f0908d; background-color: #ede4cd; }
+div.warning   { border: 3px solid #f8b862; background-color: #f0cfa0; }
+div.caution   { border: 3px solid #f8b862; background-color: #ede4cd; }
+div.attention { border: 3px solid #f8b862; background-color: #f3f3f3; }
+div.important { border: 3px solid #f0cfa0; background-color: #ede4cd; }
+div.note      { border: 3px solid #f0cfa0; background-color: #f3f3f3; }
+div.hint      { border: 3px solid #bed2c3; background-color: #f3f3f3; }
+div.tip       { border: 3px solid #bed2c3; background-color: #f3f3f3; }
+
+div.danger p.admonition-title, div.error p.admonition-title {
+    background-color: #b7282e;
+    border-bottom: 3px solid #f0908d;
+}
+
+div.caution p.admonition-title,
+div.warning p.admonition-title,
+div.attention p.admonition-title {
+    background-color: #f19072;
+    border-bottom: 3px solid #f8b862;
+}
+
+div.note p.admonition-title, div.important p.admonition-title {
+    background-color: #f8b862;
+    border-bottom: 3px solid #f0cfa0;
+}
+
+div.hint p.admonition-title, div.tip p.admonition-title {
+    background-color: #7ebea5;
+    border-bottom: 3px solid #bed2c3;
+}
+
+div.admonition ul, div.admonition ol,
+div.warning ul, div.warning ol {
+    margin: 0.1em 0.5em 0.5em 3em;
+    padding: 0;
+}
+
+div.versioninfo {
+    margin: 1em 0 0 0;
+    border: 1px solid #ccc;
+    background-color: #DDEAF0;
+    padding: 8px;
+    line-height: 1.3em;
+    font-size: 0.9em;
+}
+
+.viewcode-back {
+    font-family: 'Lucida Grande', 'Lucida Sans Unicode', 'Geneva',
+                 'Verdana', sans-serif;
+}
+
+div.viewcode-block:target {
+    background-color: #f4debf;
+    border-top: 1px solid #ac9;
+    border-bottom: 1px solid #ac9;
+}
+
+p.versionchanged span.versionmodified {
+    font-size: 0.9em;
+    margin-right: 0.2em;
+    padding: 0.1em;
+    background-color: #DCE6A0;
+}
+
+dl.field-list > dt {
+    color: white;
+    background-color: #82A0BE;
+}
+
+dl.field-list > dd {
+    background-color: #f7f7f7;
+}
+
+/* -- table styles ---------------------------------------------------------- */
+
+table.docutils {
+    margin: 1em 0;
+    padding: 0;
+    border: 1px solid white;
+    background-color: #f7f7f7;
+}
+
+table.docutils td, table.docutils th {
+    padding: 1px 8px 1px 5px;
+    border-top: 0;
+    border-left: 0;
+    border-right: 1px solid white;
+    border-bottom: 1px solid white;
+}
+
+table.docutils td p {
+    margin-top: 0;
+    margin-bottom: 0.3em;
+}
+
+table.field-list td, table.field-list th {
+    border: 0 !important;
+    word-break: break-word;
+}
+
+table.footnote td, table.footnote th {
+    border: 0 !important;
+}
+
+th {
+    color: white;
+    text-align: left;
+    padding-right: 5px;
+    background-color: #82A0BE;
+}
+
+div.literal-block-wrapper div.code-block-caption {
+    background-color: #EEE;
+    border-style: solid;
+    border-color: #CCC;
+    border-width: 1px 5px;
+}
+
+/* WIDE DESKTOP STYLE */
+@media only screen and (min-width: 1176px) {
+body {
+    margin: 0 40px 0 40px;
+}
+}
+
+/* TABLET STYLE */
+@media only screen and (min-width: 768px) and (max-width: 991px) {
+body {
+    margin: 0 40px 0 40px;
+}
+}
+
+/* MOBILE LAYOUT (PORTRAIT/320px) */
+@media only screen and (max-width: 767px) {
+body {
+    margin: 0;
+}
+div.bodywrapper {
+    margin: 0;
+    width: 100%;
+    border: none;
+}
+div.sphinxsidebar {
+    display: none;
+}
+}
+
+/* MOBILE LAYOUT (LANDSCAPE/480px) */
+@media only screen and (min-width: 480px) and (max-width: 767px) {
+body {
+    margin: 0 20px 0 20px;
+}
+}
+
+/* RETINA OVERRIDES */
+@media
+only screen and (-webkit-min-device-pixel-ratio: 2),
+only screen and (min-device-pixel-ratio: 2) {
+}
+
+/* -- end ------------------------------------------------------------------- */
\ No newline at end of file
diff --git a/docs/_static/bizstyle.js b/docs/_static/bizstyle.js
new file mode 100644
index 000000000..454ac0001
--- /dev/null
+++ b/docs/_static/bizstyle.js
@@ -0,0 +1,30 @@
+//
+// bizstyle.js
+// ~~~~~~~~~~~
+//
+// Sphinx javascript -- for bizstyle theme.
+//
+// This theme was created by referring to 'sphinxdoc'
+//
+// :copyright: Copyright 2007-2023 by Sphinx team, see AUTHORS.
+// :license: BSD, see LICENSE for details.
+//
+const initialiseBizStyle = () => {
+    if (navigator.userAgent.indexOf("iPhone") > 0 || navigator.userAgent.indexOf("Android") > 0) {
+        document.querySelector("li.nav-item-0 a").innerText = "Top"
+    }
+    const truncator = item => {if (item.textContent.length > 20) {
+        item.title = item.innerText
+        item.innerText = item.innerText.substr(0, 17) + "..."
+      }
+    }
+    document.querySelectorAll("div.related:first ul li:not(.right) a").slice(1).forEach(truncator);
+    document.querySelectorAll("div.related:last ul li:not(.right) a").slice(1).forEach(truncator);
+}
+
+window.addEventListener("resize",
+  () => (document.querySelector("li.nav-item-0 a").innerText = (window.innerWidth <= 776) ? "Top" : "awscrt  documentation")
+)
+
+if (document.readyState !== "loading") initialiseBizStyle()
+else document.addEventListener("DOMContentLoaded", initialiseBizStyle)
\ No newline at end of file
diff --git a/docs/_static/css/custom.css b/docs/_static/css/custom.css
new file mode 100644
index 000000000..5bb62183f
--- /dev/null
+++ b/docs/_static/css/custom.css
@@ -0,0 +1,5 @@
+@import "../bizstyle.css";
+
+span.pre {
+    white-space: pre-wrap !important;
+}
diff --git a/docs/_static/css3-mediaqueries.js b/docs/_static/css3-mediaqueries.js
new file mode 100644
index 000000000..59735f59d
--- /dev/null
+++ b/docs/_static/css3-mediaqueries.js
@@ -0,0 +1 @@
+if(typeof Object.create!=="function"){Object.create=function(e){function t(){}t.prototype=e;return new t}}var ua={toString:function(){return navigator.userAgent},test:function(e){return this.toString().toLowerCase().indexOf(e.toLowerCase())>-1}};ua.version=(ua.toString().toLowerCase().match(/[\s\S]+(?:rv|it|ra|ie)[\/: ]([\d.]+)/)||[])[1];ua.webkit=ua.test("webkit");ua.gecko=ua.test("gecko")&&!ua.webkit;ua.opera=ua.test("opera");ua.ie=ua.test("msie")&&!ua.opera;ua.ie6=ua.ie&&document.compatMode&&typeof document.documentElement.style.maxHeight==="undefined";ua.ie7=ua.ie&&document.documentElement&&typeof document.documentElement.style.maxHeight!=="undefined"&&typeof XDomainRequest==="undefined";ua.ie8=ua.ie&&typeof XDomainRequest!=="undefined";var domReady=function(){var e=[];var t=function(){if(!arguments.callee.done){arguments.callee.done=true;for(var t=0;t<e.length;t++){e[t]()}}};if(document.addEventListener){document.addEventListener("DOMContentLoaded",t,false)}if(ua.ie){(function(){try{document.documentElement.doScroll("left")}catch(e){setTimeout(arguments.callee,50);return}t()})();document.onreadystatechange=function(){if(document.readyState==="complete"){document.onreadystatechange=null;t()}}}if(ua.webkit&&document.readyState){(function(){if(document.readyState!=="loading"){t()}else{setTimeout(arguments.callee,10)}})()}window.onload=t;return function(t){if(typeof t==="function"){e[e.length]=t}return t}}();var cssHelper=function(){var e={BLOCKS:/[^\s{;][^{;]*\{(?:[^{}]*\{[^{}]*\}[^{}]*|[^{}]*)*\}/g,BLOCKS_INSIDE:/[^\s{][^{]*\{[^{}]*\}/g,DECLARATIONS:/[a-zA-Z\-]+[^;]*:[^;]+;/g,RELATIVE_URLS:/url\(['"]?([^\/\)'"][^:\)'"]+)['"]?\)/g,REDUNDANT_COMPONENTS:/(?:\/\*([^*\\\\]|\*(?!\/))+\*\/|@import[^;]+;)/g,REDUNDANT_WHITESPACE:/\s*(,|:|;|\{|\})\s*/g,WHITESPACE_IN_PARENTHESES:/\(\s*(\S*)\s*\)/g,MORE_WHITESPACE:/\s{2,}/g,FINAL_SEMICOLONS:/;\}/g,NOT_WHITESPACE:/\S+/g};var t,n=false;var r=[];var s=function(e){if(typeof e==="function"){r[r.length]=e}};var o=function(){for(var e=0;e<r.length;e++){r[e](t)}};var u={};var a=function(e,t){if(u[e]){var n=u[e].listeners;if(n){for(var r=0;r<n.length;r++){n[r](t)}}}};var f=function(e,t,n){if(ua.ie&&!window.XMLHttpRequest){window.XMLHttpRequest=function(){return new ActiveXObject("Microsoft.XMLHTTP")}}if(!XMLHttpRequest){return""}var r=new XMLHttpRequest;try{r.open("get",e,true);r.setRequestHeader("X_REQUESTED_WITH","XMLHttpRequest")}catch(i){n();return}var s=false;setTimeout(function(){s=true},5e3);document.documentElement.style.cursor="progress";r.onreadystatechange=function(){if(r.readyState===4&&!s){if(!r.status&&location.protocol==="file:"||r.status>=200&&r.status<300||r.status===304||navigator.userAgent.indexOf("Safari")>-1&&typeof r.status==="undefined"){t(r.responseText)}else{n()}document.documentElement.style.cursor="";r=null}};r.send("")};var l=function(t){t=t.replace(e.REDUNDANT_COMPONENTS,"");t=t.replace(e.REDUNDANT_WHITESPACE,"$1");t=t.replace(e.WHITESPACE_IN_PARENTHESES,"($1)");t=t.replace(e.MORE_WHITESPACE," ");t=t.replace(e.FINAL_SEMICOLONS,"}");return t};var c={stylesheet:function(t){var n={};var r=[],i=[],s=[],o=[];var u=t.cssHelperText;var a=t.getAttribute("media");if(a){var f=a.toLowerCase().split(",")}else{var f=["all"]}for(var l=0;l<f.length;l++){r[r.length]=c.mediaQuery(f[l],n)}var h=u.match(e.BLOCKS);if(h!==null){for(var l=0;l<h.length;l++){if(h[l].substring(0,7)==="@media "){var p=c.mediaQueryList(h[l],n);s=s.concat(p.getRules());i[i.length]=p}else{s[s.length]=o[o.length]=c.rule(h[l],n,null)}}}n.element=t;n.getCssText=function(){return u};n.getAttrMediaQueries=function(){return r};n.getMediaQueryLists=function(){return i};n.getRules=function(){return s};n.getRulesWithoutMQ=function(){return o};return n},mediaQueryList:function(t,n){var r={};var i=t.indexOf("{");var s=t.substring(0,i);t=t.substring(i+1,t.length-1);var o=[],u=[];var a=s.toLowerCase().substring(7).split(",");for(var f=0;f<a.length;f++){o[o.length]=c.mediaQuery(a[f],r)}var l=t.match(e.BLOCKS_INSIDE);if(l!==null){for(f=0;f<l.length;f++){u[u.length]=c.rule(l[f],n,r)}}r.type="mediaQueryList";r.getMediaQueries=function(){return o};r.getRules=function(){return u};r.getListText=function(){return s};r.getCssText=function(){return t};return r},mediaQuery:function(t,n){t=t||"";var r,i;if(n.type==="mediaQueryList"){r=n}else{i=n}var s=false,o;var u=[];var a=true;var f=t.match(e.NOT_WHITESPACE);for(var l=0;l<f.length;l++){var c=f[l];if(!o&&(c==="not"||c==="only")){if(c==="not"){s=true}}else if(!o){o=c}else if(c.charAt(0)==="("){var h=c.substring(1,c.length-1).split(":");u[u.length]={mediaFeature:h[0],value:h[1]||null}}}return{getQueryText:function(){return t},getAttrStyleSheet:function(){return i||null},getList:function(){return r||null},getValid:function(){return a},getNot:function(){return s},getMediaType:function(){return o},getExpressions:function(){return u}}},rule:function(e,t,n){var r={};var i=e.indexOf("{");var s=e.substring(0,i);var o=s.split(",");var u=[];var a=e.substring(i+1,e.length-1).split(";");for(var f=0;f<a.length;f++){u[u.length]=c.declaration(a[f],r)}r.getStylesheet=function(){return t||null};r.getMediaQueryList=function(){return n||null};r.getSelectors=function(){return o};r.getSelectorText=function(){return s};r.getDeclarations=function(){return u};r.getPropertyValue=function(e){for(var t=0;t<u.length;t++){if(u[t].getProperty()===e){return u[t].getValue()}}return null};return r},declaration:function(e,t){var n=e.indexOf(":");var r=e.substring(0,n);var i=e.substring(n+1);return{getRule:function(){return t||null},getProperty:function(){return r},getValue:function(){return i}}}};var h=function(e){if(typeof e.cssHelperText!=="string"){return}var n={stylesheet:null,mediaQueryLists:[],rules:[],selectors:{},declarations:[],properties:{}};var r=n.stylesheet=c.stylesheet(e);var s=n.mediaQueryLists=r.getMediaQueryLists();var o=n.rules=r.getRules();var u=n.selectors;var a=function(e){var t=e.getSelectors();for(var n=0;n<t.length;n++){var r=t[n];if(!u[r]){u[r]=[]}u[r][u[r].length]=e}};for(i=0;i<o.length;i++){a(o[i])}var f=n.declarations;for(i=0;i<o.length;i++){f=n.declarations=f.concat(o[i].getDeclarations())}var l=n.properties;for(i=0;i<f.length;i++){var h=f[i].getProperty();if(!l[h]){l[h]=[]}l[h][l[h].length]=f[i]}e.cssHelperParsed=n;t[t.length]=e;return n};var p=function(e,t){return;e.cssHelperText=l(t||e.innerHTML);return h(e)};var d=function(){n=true;t=[];var r=[];var i=function(){for(var e=0;e<r.length;e++){h(r[e])}var t=document.getElementsByTagName("style");for(e=0;e<t.length;e++){p(t[e])}n=false;o()};var s=document.getElementsByTagName("link");for(var u=0;u<s.length;u++){var a=s[u];if(a.getAttribute("rel").indexOf("style")>-1&&a.href&&a.href.length!==0&&!a.disabled){r[r.length]=a}}if(r.length>0){var c=0;var d=function(){c++;if(c===r.length){i()}};var v=function(t){var n=t.href;f(n,function(r){r=l(r).replace(e.RELATIVE_URLS,"url("+n.substring(0,n.lastIndexOf("/"))+"/$1)");t.cssHelperText=r;d()},d)};for(u=0;u<r.length;u++){v(r[u])}}else{i()}};var v={stylesheets:"array",mediaQueryLists:"array",rules:"array",selectors:"object",declarations:"array",properties:"object"};var m={stylesheets:null,mediaQueryLists:null,rules:null,selectors:null,declarations:null,properties:null};var g=function(e,t){if(m[e]!==null){if(v[e]==="array"){return m[e]=m[e].concat(t)}else{var n=m[e];for(var r in t){if(t.hasOwnProperty(r)){if(!n[r]){n[r]=t[r]}else{n[r]=n[r].concat(t[r])}}}return n}}};var y=function(e){m[e]=v[e]==="array"?[]:{};for(var n=0;n<t.length;n++){var r=e==="stylesheets"?"stylesheet":e;g(e,t[n].cssHelperParsed[r])}return m[e]};var b=function(e){if(typeof window.innerWidth!="undefined"){return window["inner"+e]}else if(typeof document.documentElement!=="undefined"&&typeof document.documentElement.clientWidth!=="undefined"&&document.documentElement.clientWidth!=0){return document.documentElement["client"+e]}};return{addStyle:function(e,t,n){var r=document.createElement("style");r.setAttribute("type","text/css");if(t&&t.length>0){r.setAttribute("media",t.join(","))}document.getElementsByTagName("head")[0].appendChild(r);if(r.styleSheet){r.styleSheet.cssText=e}else{r.appendChild(document.createTextNode(e))}r.addedWithCssHelper=true;if(typeof n==="undefined"||n===true){cssHelper.parsed(function(t){var n=p(r,e);for(var i in n){if(n.hasOwnProperty(i)){g(i,n[i])}}a("newStyleParsed",r)})}else{r.parsingDisallowed=true}return r},removeStyle:function(e){return e.parentNode.removeChild(e)},parsed:function(e){if(n){s(e)}else{if(typeof t!=="undefined"){if(typeof e==="function"){e(t)}}else{s(e);d()}}},stylesheets:function(e){cssHelper.parsed(function(t){e(m.stylesheets||y("stylesheets"))})},mediaQueryLists:function(e){cssHelper.parsed(function(t){e(m.mediaQueryLists||y("mediaQueryLists"))})},rules:function(e){cssHelper.parsed(function(t){e(m.rules||y("rules"))})},selectors:function(e){cssHelper.parsed(function(t){e(m.selectors||y("selectors"))})},declarations:function(e){cssHelper.parsed(function(t){e(m.declarations||y("declarations"))})},properties:function(e){cssHelper.parsed(function(t){e(m.properties||y("properties"))})},broadcast:a,addListener:function(e,t){if(typeof t==="function"){if(!u[e]){u[e]={listeners:[]}}u[e].listeners[u[e].listeners.length]=t}},removeListener:function(e,t){if(typeof t==="function"&&u[e]){var n=u[e].listeners;for(var r=0;r<n.length;r++){if(n[r]===t){n.splice(r,1);r-=1}}}},getViewportWidth:function(){return b("Width")},getViewportHeight:function(){return b("Height")}}}();domReady(function(){var t;var n={LENGTH_UNIT:/[0-9]+(em|ex|px|in|cm|mm|pt|pc)$/,RESOLUTION_UNIT:/[0-9]+(dpi|dpcm)$/,ASPECT_RATIO:/^[0-9]+\/[0-9]+$/,ABSOLUTE_VALUE:/^[0-9]*(\.[0-9]+)*$/};var r=[];var i=function(){var e="css3-mediaqueries-test";var t=document.createElement("div");t.id=e;var n=cssHelper.addStyle("@media all and (width) { #"+e+" { width: 1px !important; } }",[],false);document.body.appendChild(t);var r=t.offsetWidth===1;n.parentNode.removeChild(n);t.parentNode.removeChild(t);i=function(){return r};return r};var s=function(){t=document.createElement("div");t.style.cssText="position:absolute;top:-9999em;left:-9999em;"+"margin:0;border:none;padding:0;width:1em;font-size:1em;";document.body.appendChild(t);if(t.offsetWidth!==16){t.style.fontSize=16/t.offsetWidth+"em"}t.style.width=""};var o=function(e){t.style.width=e;var n=t.offsetWidth;t.style.width="";return n};var u=function(e,t){var r=e.length;var i=e.substring(0,4)==="min-";var s=!i&&e.substring(0,4)==="max-";if(t!==null){var u;var a;if(n.LENGTH_UNIT.exec(t)){u="length";a=o(t)}else if(n.RESOLUTION_UNIT.exec(t)){u="resolution";a=parseInt(t,10);var f=t.substring((a+"").length)}else if(n.ASPECT_RATIO.exec(t)){u="aspect-ratio";a=t.split("/")}else if(n.ABSOLUTE_VALUE){u="absolute";a=t}else{u="unknown"}}var l,c;if("device-width"===e.substring(r-12,r)){l=screen.width;if(t!==null){if(u==="length"){return i&&l>=a||s&&l<a||!i&&!s&&l===a}else{return false}}else{return l>0}}else if("device-height"===e.substring(r-13,r)){c=screen.height;if(t!==null){if(u==="length"){return i&&c>=a||s&&c<a||!i&&!s&&c===a}else{return false}}else{return c>0}}else if("width"===e.substring(r-5,r)){l=document.documentElement.clientWidth||document.body.clientWidth;if(t!==null){if(u==="length"){return i&&l>=a||s&&l<a||!i&&!s&&l===a}else{return false}}else{return l>0}}else if("height"===e.substring(r-6,r)){c=document.documentElement.clientHeight||document.body.clientHeight;if(t!==null){if(u==="length"){return i&&c>=a||s&&c<a||!i&&!s&&c===a}else{return false}}else{return c>0}}else if("device-aspect-ratio"===e.substring(r-19,r)){return u==="aspect-ratio"&&screen.width*a[1]===screen.height*a[0]}else if("color-index"===e.substring(r-11,r)){var h=Math.pow(2,screen.colorDepth);if(t!==null){if(u==="absolute"){return i&&h>=a||s&&h<a||!i&&!s&&h===a}else{return false}}else{return h>0}}else if("color"===e.substring(r-5,r)){var p=screen.colorDepth;if(t!==null){if(u==="absolute"){return i&&p>=a||s&&p<a||!i&&!s&&p===a}else{return false}}else{return p>0}}else if("resolution"===e.substring(r-10,r)){var d;if(f==="dpcm"){d=o("1cm")}else{d=o("1in")}if(t!==null){if(u==="resolution"){return i&&d>=a||s&&d<a||!i&&!s&&d===a}else{return false}}else{return d>0}}else{return false}};var a=function(e){var t=e.getValid();var n=e.getExpressions();var r=n.length;if(r>0){for(var i=0;i<r&&t;i++){t=u(n[i].mediaFeature,n[i].value)}var s=e.getNot();return t&&!s||s&&!t}return t};var f=function(e,t){var n=e.getMediaQueries();var i={};for(var s=0;s<n.length;s++){var o=n[s].getMediaType();if(n[s].getExpressions().length===0){continue}var u=true;if(o!=="all"&&t&&t.length>0){u=false;for(var f=0;f<t.length;f++){if(t[f]===o){u=true}}}if(u&&a(n[s])){i[o]=true}}var l=[],c=0;for(var h in i){if(i.hasOwnProperty(h)){if(c>0){l[c++]=","}l[c++]=h}}if(l.length>0){r[r.length]=cssHelper.addStyle("@media "+l.join("")+"{"+e.getCssText()+"}",t,false)}};var l=function(e,t){for(var n=0;n<e.length;n++){f(e[n],t)}};var c=function(e){var t=e.getAttrMediaQueries();var n=false;var i={};for(var s=0;s<t.length;s++){if(a(t[s])){i[t[s].getMediaType()]=t[s].getExpressions().length>0}}var o=[],u=[];for(var f in i){if(i.hasOwnProperty(f)){o[o.length]=f;if(i[f]){u[u.length]=f}if(f==="all"){n=true}}}if(u.length>0){r[r.length]=cssHelper.addStyle(e.getCssText(),u,false)}var c=e.getMediaQueryLists();if(n){l(c)}else{l(c,o)}};var h=function(e){for(var t=0;t<e.length;t++){c(e[t])}if(ua.ie){document.documentElement.style.display="block";setTimeout(function(){document.documentElement.style.display=""},0);setTimeout(function(){cssHelper.broadcast("cssMediaQueriesTested")},100)}else{cssHelper.broadcast("cssMediaQueriesTested")}};var p=function(){for(var e=0;e<r.length;e++){cssHelper.removeStyle(r[e])}r=[];cssHelper.stylesheets(h)};var d=0;var v=function(){var e=cssHelper.getViewportWidth();var t=cssHelper.getViewportHeight();if(ua.ie){var n=document.createElement("div");n.style.position="absolute";n.style.top="-9999em";n.style.overflow="scroll";document.body.appendChild(n);d=n.offsetWidth-n.clientWidth;document.body.removeChild(n)}var r;var s=function(){var n=cssHelper.getViewportWidth();var s=cssHelper.getViewportHeight();if(Math.abs(n-e)>d||Math.abs(s-t)>d){e=n;t=s;clearTimeout(r);r=setTimeout(function(){if(!i()){p()}else{cssHelper.broadcast("cssMediaQueriesTested")}},500)}};window.onresize=function(){var e=window.onresize||function(){};return function(){e();s()}}()};var m=document.documentElement;m.style.marginLeft="-32767px";setTimeout(function(){m.style.marginLeft=""},5e3);return function(){if(!i()){cssHelper.addListener("newStyleParsed",function(e){c(e.cssHelperParsed.stylesheet)});cssHelper.addListener("cssMediaQueriesTested",function(){if(ua.ie){m.style.width="1px"}setTimeout(function(){m.style.width="";m.style.marginLeft=""},0);cssHelper.removeListener("cssMediaQueriesTested",arguments.callee)});s();p()}else{m.style.marginLeft=""}v()}}());try{document.execCommand("BackgroundImageCache",false,true)}catch(e){}
diff --git a/docs/_static/css3-mediaqueries_src.js b/docs/_static/css3-mediaqueries_src.js
new file mode 100644
index 000000000..787862027
--- /dev/null
+++ b/docs/_static/css3-mediaqueries_src.js
@@ -0,0 +1,1104 @@
+/*
+css3-mediaqueries.js - CSS Helper and CSS3 Media Queries Enabler
+
+author: Wouter van der Graaf <wouter at dynora nl>
+version: 1.0 (20110330)
+license: MIT
+website: http://code.google.com/p/css3-mediaqueries-js/
+
+W3C spec: http://www.w3.org/TR/css3-mediaqueries/
+
+Note: use of embedded <style> is not recommended when using media queries, because IE  has no way of returning the raw literal css text from a <style> element.
+*/
+
+
+// true prototypal inheritance (http://javascript.crockford.com/prototypal.html)
+if (typeof Object.create !== 'function') {
+	Object.create = function (o) {
+		function F() {}
+		F.prototype = o;
+		return new F();
+	};
+}
+
+
+// user agent sniffing shortcuts
+var ua = {
+	toString: function () {
+		return navigator.userAgent;
+	},
+	test: function (s) {
+		return this.toString().toLowerCase().indexOf(s.toLowerCase()) > -1;
+	}
+};
+ua.version = (ua.toString().toLowerCase().match(/[\s\S]+(?:rv|it|ra|ie)[\/: ]([\d.]+)/) || [])[1];
+ua.webkit = ua.test('webkit');
+ua.gecko = ua.test('gecko') && !ua.webkit;
+ua.opera = ua.test('opera');
+ua.ie = ua.test('msie') && !ua.opera;
+ua.ie6 = ua.ie && document.compatMode && typeof document.documentElement.style.maxHeight === 'undefined';
+ua.ie7 = ua.ie && document.documentElement && typeof document.documentElement.style.maxHeight !== 'undefined' && typeof XDomainRequest === 'undefined';
+ua.ie8 = ua.ie && typeof XDomainRequest !== 'undefined';
+
+
+
+// initialize when DOM content is loaded
+var domReady = function () {
+	var fns = [];
+	var init = function () {
+		if (!arguments.callee.done) { // run init functions once
+			arguments.callee.done = true;
+			for (var i = 0; i < fns.length; i++) {
+				fns[i]();
+			}
+		}
+	};
+
+	// listeners for different browsers
+	if (document.addEventListener) {
+		document.addEventListener('DOMContentLoaded', init, false);
+	}
+	if (ua.ie) {
+		(function () {
+			try {
+				// throws errors until after ondocumentready
+				document.documentElement.doScroll('left');
+			}
+			catch (e) {
+				setTimeout(arguments.callee, 50);
+				return;
+			}
+			// no errors, fire
+			init();
+		})();
+		// trying to always fire before onload
+		document.onreadystatechange = function () {
+			if (document.readyState === 'complete') {
+				document.onreadystatechange = null;
+				init();
+			}
+		};
+	}
+	if (ua.webkit && document.readyState) {
+		(function () {
+			if (document.readyState !== 'loading') {
+				init();
+			}
+			else {
+				setTimeout(arguments.callee, 10);
+			}
+		})();
+	}
+	window.onload = init; // fallback
+
+	return function (fn) { // add fn to init functions
+		if (typeof fn === 'function') {
+			fns[fns.length] = fn;
+		}
+		return fn;
+	};
+}();
+
+
+
+// helper library for parsing css to objects
+var cssHelper = function () {
+
+	var regExp = {
+		BLOCKS: /[^\s{;][^{;]*\{(?:[^{}]*\{[^{}]*\}[^{}]*|[^{}]*)*\}/g,
+		BLOCKS_INSIDE: /[^\s{][^{]*\{[^{}]*\}/g,
+		DECLARATIONS: /[a-zA-Z\-]+[^;]*:[^;]+;/g,
+		RELATIVE_URLS: /url\(['"]?([^\/\)'"][^:\)'"]+)['"]?\)/g,
+		// strip whitespace and comments, @import is evil
+		REDUNDANT_COMPONENTS: /(?:\/\*([^*\\\\]|\*(?!\/))+\*\/|@import[^;]+;)/g,
+		REDUNDANT_WHITESPACE: /\s*(,|:|;|\{|\})\s*/g,
+        WHITESPACE_IN_PARENTHESES: /\(\s*(\S*)\s*\)/g,
+		MORE_WHITESPACE: /\s{2,}/g,
+		FINAL_SEMICOLONS: /;\}/g,
+		NOT_WHITESPACE: /\S+/g
+	};
+
+	var parsed, parsing = false;
+
+	var waiting = [];
+	var wait = function (fn) {
+		if (typeof fn === 'function') {
+			waiting[waiting.length] = fn;
+		}
+	};
+	var ready = function () {
+		for (var i = 0; i < waiting.length; i++) {
+			waiting[i](parsed);
+		}
+	};
+	var events = {};
+	var broadcast = function (n, v) {
+		if (events[n]) {
+			var listeners = events[n].listeners;
+			if (listeners) {
+				for (var i = 0; i < listeners.length; i++) {
+					listeners[i](v);
+				}
+			}
+		}
+	};
+
+	var requestText = function (url, fnSuccess, fnFailure) {
+		if (ua.ie && !window.XMLHttpRequest) {
+			window.XMLHttpRequest = function () {
+				return new ActiveXObject('Microsoft.XMLHTTP');
+			};
+		}
+		if (!XMLHttpRequest) {
+			return '';
+		}
+		var r = new XMLHttpRequest();
+		try {
+			r.open('get', url, true);
+			r.setRequestHeader('X_REQUESTED_WITH', 'XMLHttpRequest');
+		}
+		catch (e) {
+			fnFailure();
+			return;
+		}
+		var done = false;
+		setTimeout(function () {
+			done = true;
+		}, 5000);
+		document.documentElement.style.cursor = 'progress';
+		r.onreadystatechange = function () {
+			if (r.readyState === 4 && !done) {
+				if (!r.status && location.protocol === 'file:' ||
+						(r.status >= 200 && r.status < 300) ||
+						r.status === 304 ||
+						navigator.userAgent.indexOf('Safari') > -1 && typeof r.status === 'undefined') {
+					fnSuccess(r.responseText);
+				}
+				else {
+					fnFailure();
+				}
+				document.documentElement.style.cursor = '';
+				r = null; // avoid memory leaks
+			}
+		};
+		r.send('');
+	};
+
+	var sanitize = function (text) {
+		text = text.replace(regExp.REDUNDANT_COMPONENTS, '');
+		text = text.replace(regExp.REDUNDANT_WHITESPACE, '$1');
+        text = text.replace(regExp.WHITESPACE_IN_PARENTHESES, '($1)');
+		text = text.replace(regExp.MORE_WHITESPACE, ' ');
+		text = text.replace(regExp.FINAL_SEMICOLONS, '}'); // optional final semicolons
+		return text;
+	};
+
+	var objects = {
+	    stylesheet: function (el) {
+	        var o = {};
+	        var amqs = [], mqls = [], rs = [], rsw = [];
+	        var s = el.cssHelperText;
+
+	        // add attribute media queries
+	        var attr = el.getAttribute('media');
+	        if (attr) {
+	            var qts = attr.toLowerCase().split(',')
+	        }
+	        else {
+	            var qts = ['all'] // imply 'all'
+            }
+	        for (var i = 0; i < qts.length; i++) {
+	            amqs[amqs.length] = objects.mediaQuery(qts[i], o);
+	        }
+
+	        // add media query lists and rules (top down order)
+		    var blocks = s.match(regExp.BLOCKS); // @charset is not a block
+		    if (blocks !== null) {
+			    for (var i = 0; i < blocks.length; i++) {
+				    if (blocks[i].substring(0, 7) === '@media ') { // media query (list)
+					    var mql = objects.mediaQueryList(blocks[i], o);
+					    rs = rs.concat(mql.getRules());
+					    mqls[mqls.length] = mql;
+				    }
+				    else { // regular rule set, page context (@page) or font description (@font-face)
+					    rs[rs.length] = rsw[rsw.length] = objects.rule(blocks[i], o, null);
+				    }
+			    }
+		    }
+
+	        o.element = el;
+	        o.getCssText = function () {
+	            return s;
+	        };
+	        o.getAttrMediaQueries = function () {
+	            return amqs;
+	        };
+	        o.getMediaQueryLists = function () {
+	            return mqls;
+	        };
+	        o.getRules = function () {
+	            return rs;
+	        };
+	        o.getRulesWithoutMQ = function () {
+	            return rsw;
+	        };
+	        return o;
+	    },
+
+		mediaQueryList: function (s, stsh) {
+			var o = {};
+			var idx = s.indexOf('{');
+			var lt = s.substring(0, idx);
+			s = s.substring(idx + 1, s.length - 1);
+			var mqs = [], rs = [];
+
+			// add media queries
+			var qts = lt.toLowerCase().substring(7).split(',');
+			for (var i = 0; i < qts.length; i++) { // parse each media query
+				mqs[mqs.length] = objects.mediaQuery(qts[i], o);
+			}
+
+			// add rule sets
+			var rts = s.match(regExp.BLOCKS_INSIDE);
+			if (rts !== null) {
+				for (i = 0; i < rts.length; i++) {
+					rs[rs.length] = objects.rule(rts[i], stsh, o);
+				}
+			}
+
+			o.type = 'mediaQueryList';
+			o.getMediaQueries = function () {
+				return mqs;
+			};
+			o.getRules = function () {
+				return rs;
+			};
+			o.getListText = function () {
+				return lt;
+			};
+			o.getCssText = function () {
+				return s;
+			};
+			return o;
+		},
+
+		mediaQuery: function (s, listOrSheet) {
+			s = s || '';
+			var mql, stsh;
+			if (listOrSheet.type === 'mediaQueryList') {
+			    mql = listOrSheet;
+		    }
+		    else {
+		        stsh = listOrSheet;
+		    }
+			var not = false, type;
+			var expr = [];
+			var valid = true;
+			var tokens = s.match(regExp.NOT_WHITESPACE);
+
+
+
+			for (var i = 0; i < tokens.length; i++) {
+				var token = tokens[i];
+				if (!type && (token === 'not' || token === 'only')) { // 'not' and 'only' keywords
+					// keyword 'only' does nothing, as if it was not present
+					if (token === 'not') {
+						not = true;
+					}
+				}
+				else if (!type) { // media type
+					type = token;
+				}
+				else if (token.charAt(0) === '(') { // media feature expression
+					var pair = token.substring(1, token.length - 1).split(':');
+					expr[expr.length] = {
+						mediaFeature: pair[0],
+						value: pair[1] || null
+					};
+				}
+			}
+
+			return {
+			    getQueryText: function () {
+			        return s;
+			    },
+			    getAttrStyleSheet: function () {
+			        return stsh || null;
+			    },
+				getList: function () {
+					return mql || null;
+				},
+				getValid: function () {
+					return valid;
+				},
+				getNot: function () {
+					return not;
+				},
+				getMediaType: function () {
+					return type;
+				},
+				getExpressions: function () {
+					return expr;
+				}
+			};
+		},
+
+		rule: function (s, stsh, mql) {
+			var o = {};
+			var idx = s.indexOf('{');
+			var st = s.substring(0, idx);
+			var ss = st.split(',');
+			var ds = [];
+			var dts = s.substring(idx + 1, s.length - 1).split(';');
+			for (var i = 0; i < dts.length; i++) {
+				ds[ds.length] = objects.declaration(dts[i], o);
+			}
+
+			o.getStylesheet = function () {
+			    return stsh || null;
+			};
+			o.getMediaQueryList = function () {
+				return mql || null;
+			};
+			o.getSelectors = function () {
+				return ss;
+			};
+			o.getSelectorText = function () {
+				return st;
+			};
+			o.getDeclarations = function () {
+				return ds;
+			};
+			o.getPropertyValue = function (n) {
+				for (var i = 0; i < ds.length; i++) {
+					if (ds[i].getProperty() === n) {
+						return ds[i].getValue();
+					}
+				}
+				return null;
+			};
+			return o;
+		},
+
+		declaration: function (s, r) {
+			var idx = s.indexOf(':');
+			var p = s.substring(0, idx);
+			var v = s.substring(idx + 1);
+			return {
+				getRule: function () {
+					return r || null;
+				},
+				getProperty: function () {
+					return p;
+				},
+				getValue: function () {
+					return v;
+				}
+			};
+		}
+	};
+
+	var parseText = function (el) {
+		if (typeof el.cssHelperText !== 'string') {
+			return;
+		}
+		var o = {
+		    stylesheet: null,
+			mediaQueryLists: [],
+			rules: [],
+			selectors: {},
+			declarations: [],
+			properties: {}
+		};
+
+		// build stylesheet object
+		var stsh = o.stylesheet = objects.stylesheet(el);
+
+		// collect media query lists
+		var mqls = o.mediaQueryLists = stsh.getMediaQueryLists();
+
+		// collect all rules
+		var ors = o.rules = stsh.getRules();
+
+		// collect all selectors
+		var oss = o.selectors;
+		var collectSelectors = function (r) {
+			var ss = r.getSelectors();
+			for (var i = 0; i < ss.length; i++) {
+				var n = ss[i];
+				if (!oss[n]) {
+					oss[n] = [];
+				}
+				oss[n][oss[n].length] = r;
+			}
+		};
+		for (var i = 0; i < ors.length; i++) {
+			collectSelectors(ors[i]);
+		}
+
+		// collect all declarations
+		var ods = o.declarations;
+		for (i = 0; i < ors.length; i++) {
+			ods = o.declarations = ods.concat(ors[i].getDeclarations());
+		}
+
+		// collect all properties
+		var ops = o.properties;
+		for (i = 0; i < ods.length; i++) {
+			var n = ods[i].getProperty();
+			if (!ops[n]) {
+				ops[n] = [];
+			}
+			ops[n][ops[n].length] = ods[i];
+		}
+
+		el.cssHelperParsed = o;
+		parsed[parsed.length] = el;
+		return o;
+	};
+
+	var parseEmbedded = function (el, s) {
+	    return;
+	    // This function doesn't work because of a bug in IE, where innerHTML gives us parsed css instead of raw literal.
+		el.cssHelperText = sanitize(s || el.innerHTML);
+		return parseText(el);
+	};
+
+	var parse = function () {
+		parsing = true;
+		parsed = [];
+		var linked = [];
+		var finish = function () {
+			for (var i = 0; i < linked.length; i++) {
+				parseText(linked[i]);
+			}
+			var styles = document.getElementsByTagName('style');
+			for (i = 0; i < styles.length; i++) {
+				parseEmbedded(styles[i]);
+			}
+			parsing = false;
+			ready();
+		};
+		var links = document.getElementsByTagName('link');
+		for (var i = 0; i < links.length; i++) {
+			var link = links[i];
+			if (link.getAttribute('rel').indexOf('style') > -1 && link.href && link.href.length !== 0 && !link.disabled) {
+				linked[linked.length] = link;
+			}
+		}
+		if (linked.length > 0) {
+			var c = 0;
+			var checkForFinish = function () {
+				c++;
+				if (c === linked.length) { // parse in right order, so after last link is read
+					finish();
+				}
+			};
+			var processLink = function (link) {
+				var href = link.href;
+				requestText(href, function (text) {
+					// fix url's
+					text = sanitize(text).replace(regExp.RELATIVE_URLS, 'url(' + href.substring(0, href.lastIndexOf('/')) + '/$1)');
+					link.cssHelperText = text;
+					checkForFinish();
+				}, checkForFinish);
+			};
+			for (i = 0; i < linked.length; i++) {
+				processLink(linked[i]);
+			}
+		}
+		else {
+			finish();
+		}
+	};
+
+	var types = {
+	    stylesheets: 'array',
+		mediaQueryLists: 'array',
+		rules: 'array',
+		selectors: 'object',
+		declarations: 'array',
+		properties: 'object'
+	};
+
+	var collections = {
+	    stylesheets: null,
+		mediaQueryLists: null,
+		rules: null,
+		selectors: null,
+		declarations: null,
+		properties: null
+	};
+
+	var addToCollection = function (name, v) {
+		if (collections[name] !== null) {
+			if (types[name] === 'array') {
+				return (collections[name] = collections[name].concat(v));
+			}
+			else {
+				var c = collections[name];
+				for (var n in v) {
+					if (v.hasOwnProperty(n)) {
+						if (!c[n]) {
+							c[n] = v[n];
+						}
+						else {
+							c[n] = c[n].concat(v[n]);
+						}
+					}
+				}
+				return c;
+			}
+		}
+	};
+
+	var collect = function (name) {
+		collections[name] = (types[name] === 'array') ? [] : {};
+		for (var i = 0; i < parsed.length; i++) {
+		    var pname = name === 'stylesheets' ? 'stylesheet' : name; // the exception
+			addToCollection(name, parsed[i].cssHelperParsed[pname]);
+		}
+		return collections[name];
+	};
+
+	// viewport size
+	var getViewportSize = function (d) {
+		if (typeof window.innerWidth != 'undefined') {
+			return window['inner' + d];
+		}
+		else if (typeof document.documentElement !== 'undefined'
+				&& typeof document.documentElement.clientWidth !== 'undefined'
+				&& document.documentElement.clientWidth != 0) {
+			return document.documentElement['client' + d];
+		}
+	};
+
+	// public static functions
+	return {
+		addStyle: function (s, mediaTypes, process) {
+			var el = document.createElement('style');
+			el.setAttribute('type', 'text/css');
+			if (mediaTypes && mediaTypes.length > 0) {
+			    el.setAttribute('media', mediaTypes.join(','));
+			}
+			document.getElementsByTagName('head')[0].appendChild(el);
+			if (el.styleSheet) { // IE
+				el.styleSheet.cssText = s;
+			}
+			else {
+				el.appendChild(document.createTextNode(s));
+			}
+			el.addedWithCssHelper = true;
+			if (typeof process === 'undefined' || process === true) {
+				cssHelper.parsed(function (parsed) {
+					var o = parseEmbedded(el, s);
+					for (var n in o) {
+						if (o.hasOwnProperty(n)) {
+							addToCollection(n, o[n]);
+						}
+					}
+					broadcast('newStyleParsed', el);
+				});
+			}
+			else {
+				el.parsingDisallowed = true;
+			}
+			return el;
+		},
+
+		removeStyle: function (el) {
+			return el.parentNode.removeChild(el);
+		},
+
+		parsed: function (fn) {
+			if (parsing) {
+				wait(fn);
+			}
+			else {
+				if (typeof parsed !== 'undefined') {
+					if (typeof fn === 'function') {
+						fn(parsed);
+					}
+				}
+				else {
+					wait(fn);
+					parse();
+				}
+			}
+		},
+
+		stylesheets: function (fn) {
+		    cssHelper.parsed(function (parsed) {
+		        fn(collections.stylesheets || collect('stylesheets'));
+		    });
+		},
+
+		mediaQueryLists: function (fn) {
+			cssHelper.parsed(function (parsed) {
+				fn(collections.mediaQueryLists || collect('mediaQueryLists'));
+			});
+		},
+
+		rules: function (fn) {
+			cssHelper.parsed(function (parsed) {
+				fn(collections.rules || collect('rules'));
+			});
+		},
+
+		selectors: function (fn) {
+			cssHelper.parsed(function (parsed) {
+				fn(collections.selectors || collect('selectors'));
+			});
+		},
+
+		declarations: function (fn) {
+			cssHelper.parsed(function (parsed) {
+				fn(collections.declarations || collect('declarations'));
+			});
+		},
+
+		properties: function (fn) {
+			cssHelper.parsed(function (parsed) {
+				fn(collections.properties || collect('properties'));
+			});
+		},
+
+		broadcast: broadcast,
+
+		addListener: function (n, fn) { // in case n is 'styleadd': added function is called everytime style is added and parsed
+			if (typeof fn === 'function') {
+				if (!events[n]) {
+					events[n] = {
+						listeners: []
+					};
+				}
+				events[n].listeners[events[n].listeners.length] = fn;
+			}
+		},
+
+		removeListener: function (n, fn) {
+			if (typeof fn === 'function' && events[n]) {
+				var ls = events[n].listeners;
+				for (var i = 0; i < ls.length; i++) {
+					if (ls[i] === fn) {
+						ls.splice(i, 1);
+						i -= 1;
+					}
+				}
+			}
+		},
+
+		getViewportWidth: function () {
+			return getViewportSize('Width');
+		},
+
+		getViewportHeight: function () {
+			return getViewportSize('Height');
+		}
+	};
+}();
+
+
+
+// function to test and apply parsed media queries against browser capabilities
+domReady(function enableCssMediaQueries() {
+	var meter;
+
+	var regExp = {
+		LENGTH_UNIT: /[0-9]+(em|ex|px|in|cm|mm|pt|pc)$/,
+		RESOLUTION_UNIT: /[0-9]+(dpi|dpcm)$/,
+		ASPECT_RATIO: /^[0-9]+\/[0-9]+$/,
+		ABSOLUTE_VALUE: /^[0-9]*(\.[0-9]+)*$/
+	};
+
+	var styles = [];
+
+	var nativeSupport = function () {
+		// check support for media queries
+		var id = 'css3-mediaqueries-test';
+		var el = document.createElement('div');
+		el.id = id;
+		var style = cssHelper.addStyle('@media all and (width) { #' + id +
+			' { width: 1px !important; } }', [], false); // false means don't parse this temp style
+		document.body.appendChild(el);
+		var ret = el.offsetWidth === 1;
+		style.parentNode.removeChild(style);
+		el.parentNode.removeChild(el);
+		nativeSupport = function () {
+			return ret;
+		};
+		return ret;
+	};
+
+	var createMeter = function () { // create measuring element
+		meter = document.createElement('div');
+		meter.style.cssText = 'position:absolute;top:-9999em;left:-9999em;' +
+			'margin:0;border:none;padding:0;width:1em;font-size:1em;'; // cssText is needed for IE, works for the others
+		document.body.appendChild(meter);
+		// meter must have browser default font size of 16px
+		if (meter.offsetWidth !== 16) {
+			meter.style.fontSize = 16 / meter.offsetWidth + 'em';
+		}
+		meter.style.width = '';
+	};
+
+	var measure = function (value) {
+		meter.style.width = value;
+		var amount = meter.offsetWidth;
+		meter.style.width = '';
+		return amount;
+	};
+
+	var testMediaFeature = function (feature, value) {
+		// non-testable features: monochrome|min-monochrome|max-monochrome|scan|grid
+		var l = feature.length;
+		var min = (feature.substring(0, 4) === 'min-');
+		var max = (!min && feature.substring(0, 4) === 'max-');
+
+		if (value !== null) { // determine value type and parse to usable amount
+			var valueType;
+			var amount;
+			if (regExp.LENGTH_UNIT.exec(value)) {
+				valueType = 'length';
+				amount = measure(value);
+			}
+			else if (regExp.RESOLUTION_UNIT.exec(value)) {
+				valueType = 'resolution';
+				amount = parseInt(value, 10);
+				var unit = value.substring((amount + '').length);
+			}
+			else if (regExp.ASPECT_RATIO.exec(value)) {
+				valueType = 'aspect-ratio';
+				amount = value.split('/');
+			}
+			else if (regExp.ABSOLUTE_VALUE) {
+				valueType = 'absolute';
+				amount = value;
+			}
+			else {
+				valueType = 'unknown';
+			}
+		}
+
+		var width, height;
+		if ('device-width' === feature.substring(l - 12, l)) { // screen width
+			width = screen.width;
+			if (value !== null) {
+				if (valueType === 'length') {
+					return ((min && width >= amount) || (max && width < amount) || (!min && !max && width === amount));
+				}
+				else {
+					return false;
+				}
+			}
+			else { // test width without value
+				return width > 0;
+			}
+		}
+		else if ('device-height' === feature.substring(l - 13, l)) { // screen height
+			height = screen.height;
+			if (value !== null) {
+				if (valueType === 'length') {
+					return ((min && height >= amount) || (max && height < amount) || (!min && !max && height === amount));
+				}
+				else {
+					return false;
+				}
+			}
+			else { // test height without value
+				return height > 0;
+			}
+		}
+		else if ('width' === feature.substring(l - 5, l)) { // viewport width
+			width = document.documentElement.clientWidth || document.body.clientWidth; // the latter for IE quirks mode
+			if (value !== null) {
+				if (valueType === 'length') {
+					return ((min && width >= amount) || (max && width < amount) || (!min && !max && width === amount));
+				}
+				else {
+					return false;
+				}
+			}
+			else { // test width without value
+				return width > 0;
+			}
+		}
+		else if ('height' === feature.substring(l - 6, l)) { // viewport height
+			height = document.documentElement.clientHeight || document.body.clientHeight; // the latter for IE quirks mode
+			if (value !== null) {
+				if (valueType === 'length') {
+					return ((min && height >= amount) || (max && height < amount) || (!min && !max && height === amount));
+				}
+				else {
+					return false;
+				}
+			}
+			else { // test height without value
+				return height > 0;
+			}
+		}
+		else if ('device-aspect-ratio' === feature.substring(l - 19, l)) { // screen aspect ratio
+			return valueType === 'aspect-ratio' && screen.width * amount[1] === screen.height * amount[0];
+		}
+		else if ('color-index' === feature.substring(l - 11, l)) { // number of colors
+			var colors = Math.pow(2, screen.colorDepth);
+			if (value !== null) {
+				if (valueType === 'absolute') {
+					return ((min && colors >= amount) || (max && colors < amount) || (!min && !max && colors === amount));
+				}
+				else {
+					return false;
+				}
+			}
+			else { // test height without value
+				return colors > 0;
+			}
+		}
+		else if ('color' === feature.substring(l - 5, l)) { // bits per color component
+			var color = screen.colorDepth;
+			if (value !== null) {
+				if (valueType === 'absolute') {
+					return ((min && color >= amount) || (max && color < amount) || (!min && !max && color === amount));
+				}
+				else {
+					return false;
+				}
+			}
+			else { // test height without value
+				return color > 0;
+			}
+		}
+		else if ('resolution' === feature.substring(l - 10, l)) {
+			var res;
+			if (unit === 'dpcm') {
+				res = measure('1cm');
+			}
+			else {
+				res = measure('1in');
+			}
+			if (value !== null) {
+				if (valueType === 'resolution') {
+					return ((min && res >= amount) || (max && res < amount) || (!min && !max && res === amount));
+				}
+				else {
+					return false;
+				}
+			}
+			else { // test height without value
+				return res > 0;
+			}
+		}
+		else {
+			return false;
+		}
+	};
+
+	var testMediaQuery = function (mq) {
+		var test = mq.getValid();
+		var expressions = mq.getExpressions();
+		var l = expressions.length;
+		if (l > 0) {
+			for (var i = 0; i < l && test; i++) {
+				test = testMediaFeature(expressions[i].mediaFeature, expressions[i].value);
+			}
+			var not = mq.getNot();
+			return (test && !not || not && !test);
+		}
+		return test;
+	};
+
+	var testMediaQueryList = function (mql, ts) {
+	    // ts is null or an array with any media type but 'all'.
+		var mqs = mql.getMediaQueries();
+		var t = {};
+		for (var i = 0; i < mqs.length; i++) {
+		    var type = mqs[i].getMediaType();
+		    if (mqs[i].getExpressions().length === 0) {
+		        continue;
+		        // TODO: Browser check! Assuming old browsers do apply the bare media types, even in a list with media queries.
+		    }
+		    var typeAllowed = true;
+		    if (type !== 'all' && ts && ts.length > 0) {
+		        typeAllowed = false;
+		        for (var j = 0; j < ts.length; j++) {
+		            if (ts[j] === type) {
+		                typeAllowed = true;
+                    }
+		        }
+		    }
+			if (typeAllowed && testMediaQuery(mqs[i])) {
+				t[type] = true;
+			}
+		}
+		var s = [], c = 0;
+		for (var n in t) {
+			if (t.hasOwnProperty(n)) {
+				if (c > 0) {
+					s[c++] = ',';
+				}
+				s[c++] = n;
+			}
+		}
+		if (s.length > 0) {
+			styles[styles.length] = cssHelper.addStyle('@media ' + s.join('') + '{' + mql.getCssText() + '}', ts, false);
+		}
+	};
+
+	var testMediaQueryLists = function (mqls, ts) {
+		for (var i = 0; i < mqls.length; i++) {
+			testMediaQueryList(mqls[i], ts);
+		}
+	};
+
+	var testStylesheet = function (stsh) {
+	    var amqs = stsh.getAttrMediaQueries();
+	    var allPassed = false;
+	    var t = {};
+		for (var i = 0; i < amqs.length; i++) {
+			if (testMediaQuery(amqs[i])) {
+				t[amqs[i].getMediaType()] = amqs[i].getExpressions().length > 0;
+			}
+		}
+		var ts = [], tswe = [];
+		for (var n in t) {
+			if (t.hasOwnProperty(n)) {
+				ts[ts.length] = n;
+				if (t[n]) {
+				    tswe[tswe.length] = n
+				}
+			    if (n === 'all') {
+			        allPassed = true;
+                }
+			}
+		}
+		if (tswe.length > 0) { // types with query expressions that passed the test
+		    styles[styles.length] = cssHelper.addStyle(stsh.getCssText(), tswe, false);
+		}
+		var mqls = stsh.getMediaQueryLists();
+		if (allPassed) {
+		    // If 'all' in media attribute passed the test, then test all @media types in linked CSS and create style with those types.
+		    testMediaQueryLists(mqls);
+		}
+		else {
+		    // Or else, test only media attribute types that passed the test and also 'all'.
+		    // For positive '@media all', create style with attribute types that passed their test.
+		    testMediaQueryLists(mqls, ts);
+	    }
+    };
+
+	var testStylesheets = function (stshs) {
+	    for (var i = 0; i < stshs.length; i++) {
+	        testStylesheet(stshs[i]);
+	    }
+	    if (ua.ie) {
+			// force repaint in IE
+			document.documentElement.style.display = 'block';
+			setTimeout(function () {
+				document.documentElement.style.display = '';
+			}, 0);
+			// delay broadcast somewhat for IE
+			setTimeout(function () {
+				cssHelper.broadcast('cssMediaQueriesTested');
+			}, 100);
+		}
+		else {
+			cssHelper.broadcast('cssMediaQueriesTested');
+		}
+	};
+
+	var test = function () {
+		for (var i = 0; i < styles.length; i++) {
+			cssHelper.removeStyle(styles[i]);
+		}
+		styles = [];
+		cssHelper.stylesheets(testStylesheets);
+	};
+
+	var scrollbarWidth = 0;
+	var checkForResize = function () {
+		var cvpw = cssHelper.getViewportWidth();
+		var cvph = cssHelper.getViewportHeight();
+
+		// determine scrollbar width in IE, see resizeHandler
+		if (ua.ie) {
+			var el = document.createElement('div');
+			el.style.position = 'absolute';
+			el.style.top = '-9999em';
+			el.style.overflow = 'scroll';
+			document.body.appendChild(el);
+			scrollbarWidth = el.offsetWidth - el.clientWidth;
+			document.body.removeChild(el);
+		}
+
+		var timer;
+		var resizeHandler = function () {
+			var vpw = cssHelper.getViewportWidth();
+			var vph = cssHelper.getViewportHeight();
+			// check whether vp size has really changed, because IE also triggers resize event when body size changes
+			// 20px allowance to accommodate short appearance of scrollbars in IE in some cases
+			if (Math.abs(vpw - cvpw) > scrollbarWidth || Math.abs(vph - cvph) > scrollbarWidth) {
+				cvpw = vpw;
+				cvph = vph;
+				clearTimeout(timer);
+				timer = setTimeout(function () {
+					if (!nativeSupport()) {
+						test();
+					}
+					else {
+						cssHelper.broadcast('cssMediaQueriesTested');
+					}
+				}, 500);
+			}
+		};
+
+		window.onresize = function () {
+			var x = window.onresize || function () {}; // save original
+			return function () {
+				x();
+				resizeHandler();
+			};
+		}();
+	};
+
+	// prevent jumping of layout by hiding everything before painting <body>
+    var docEl = document.documentElement;
+	docEl.style.marginLeft = '-32767px';
+
+	// make sure it comes back after a while
+	setTimeout(function () {
+		docEl.style.marginLeft = '';
+	}, 5000);
+
+	return function () {
+		if (!nativeSupport()) { // if browser doesn't support media queries
+			cssHelper.addListener('newStyleParsed', function (el) {
+				testStylesheet(el.cssHelperParsed.stylesheet);
+			});
+			// return visibility after media queries are tested
+			cssHelper.addListener('cssMediaQueriesTested', function () {
+				// force repaint in IE by changing width
+				if (ua.ie) {
+					docEl.style.width = '1px';
+				}
+				setTimeout(function () {
+					docEl.style.width = ''; // undo width
+					docEl.style.marginLeft = ''; // undo hide
+				}, 0);
+				// remove this listener to prevent following execution
+				cssHelper.removeListener('cssMediaQueriesTested', arguments.callee);
+			});
+			createMeter();
+			test();
+		}
+		else {
+			docEl.style.marginLeft = ''; // undo visibility hidden
+		}
+		checkForResize();
+	};
+}());
+
+
+// bonus: hotfix for IE6 SP1 (bug KB823727)
+try {
+	document.execCommand('BackgroundImageCache', false, true);
+} catch (e) {}
diff --git a/docs/_static/doctools.js b/docs/_static/doctools.js
new file mode 100644
index 000000000..d06a71d75
--- /dev/null
+++ b/docs/_static/doctools.js
@@ -0,0 +1,156 @@
+/*
+ * doctools.js
+ * ~~~~~~~~~~~
+ *
+ * Base JavaScript utilities for all Sphinx HTML documentation.
+ *
+ * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+"use strict";
+
+const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([
+  "TEXTAREA",
+  "INPUT",
+  "SELECT",
+  "BUTTON",
+]);
+
+const _ready = (callback) => {
+  if (document.readyState !== "loading") {
+    callback();
+  } else {
+    document.addEventListener("DOMContentLoaded", callback);
+  }
+};
+
+/**
+ * Small JavaScript module for the documentation.
+ */
+const Documentation = {
+  init: () => {
+    Documentation.initDomainIndexTable();
+    Documentation.initOnKeyListeners();
+  },
+
+  /**
+   * i18n support
+   */
+  TRANSLATIONS: {},
+  PLURAL_EXPR: (n) => (n === 1 ? 0 : 1),
+  LOCALE: "unknown",
+
+  // gettext and ngettext don't access this so that the functions
+  // can safely bound to a different name (_ = Documentation.gettext)
+  gettext: (string) => {
+    const translated = Documentation.TRANSLATIONS[string];
+    switch (typeof translated) {
+      case "undefined":
+        return string; // no translation
+      case "string":
+        return translated; // translation exists
+      default:
+        return translated[0]; // (singular, plural) translation tuple exists
+    }
+  },
+
+  ngettext: (singular, plural, n) => {
+    const translated = Documentation.TRANSLATIONS[singular];
+    if (typeof translated !== "undefined")
+      return translated[Documentation.PLURAL_EXPR(n)];
+    return n === 1 ? singular : plural;
+  },
+
+  addTranslations: (catalog) => {
+    Object.assign(Documentation.TRANSLATIONS, catalog.messages);
+    Documentation.PLURAL_EXPR = new Function(
+      "n",
+      `return (${catalog.plural_expr})`
+    );
+    Documentation.LOCALE = catalog.locale;
+  },
+
+  /**
+   * helper function to focus on search bar
+   */
+  focusSearchBar: () => {
+    document.querySelectorAll("input[name=q]")[0]?.focus();
+  },
+
+  /**
+   * Initialise the domain index toggle buttons
+   */
+  initDomainIndexTable: () => {
+    const toggler = (el) => {
+      const idNumber = el.id.substr(7);
+      const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`);
+      if (el.src.substr(-9) === "minus.png") {
+        el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`;
+        toggledRows.forEach((el) => (el.style.display = "none"));
+      } else {
+        el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`;
+        toggledRows.forEach((el) => (el.style.display = ""));
+      }
+    };
+
+    const togglerElements = document.querySelectorAll("img.toggler");
+    togglerElements.forEach((el) =>
+      el.addEventListener("click", (event) => toggler(event.currentTarget))
+    );
+    togglerElements.forEach((el) => (el.style.display = ""));
+    if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler);
+  },
+
+  initOnKeyListeners: () => {
+    // only install a listener if it is really needed
+    if (
+      !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS &&
+      !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS
+    )
+      return;
+
+    document.addEventListener("keydown", (event) => {
+      // bail for input elements
+      if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return;
+      // bail with special keys
+      if (event.altKey || event.ctrlKey || event.metaKey) return;
+
+      if (!event.shiftKey) {
+        switch (event.key) {
+          case "ArrowLeft":
+            if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break;
+
+            const prevLink = document.querySelector('link[rel="prev"]');
+            if (prevLink && prevLink.href) {
+              window.location.href = prevLink.href;
+              event.preventDefault();
+            }
+            break;
+          case "ArrowRight":
+            if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break;
+
+            const nextLink = document.querySelector('link[rel="next"]');
+            if (nextLink && nextLink.href) {
+              window.location.href = nextLink.href;
+              event.preventDefault();
+            }
+            break;
+        }
+      }
+
+      // some keyboard layouts may need Shift to get /
+      switch (event.key) {
+        case "/":
+          if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break;
+          Documentation.focusSearchBar();
+          event.preventDefault();
+      }
+    });
+  },
+};
+
+// quick alias for translations
+const _ = Documentation.gettext;
+
+_ready(Documentation.init);
diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js
new file mode 100644
index 000000000..7e4c114f2
--- /dev/null
+++ b/docs/_static/documentation_options.js
@@ -0,0 +1,13 @@
+const DOCUMENTATION_OPTIONS = {
+    VERSION: '',
+    LANGUAGE: 'en',
+    COLLAPSE_INDEX: false,
+    BUILDER: 'html',
+    FILE_SUFFIX: '.html',
+    LINK_SUFFIX: '.html',
+    HAS_SOURCE: true,
+    SOURCELINK_SUFFIX: '.txt',
+    NAVIGATION_WITH_KEYS: false,
+    SHOW_SEARCH_SUMMARY: true,
+    ENABLE_SEARCH_SHORTCUTS: true,
+};
\ No newline at end of file
diff --git a/docs/_static/file.png b/docs/_static/file.png
new file mode 100644
index 000000000..a858a410e
Binary files /dev/null and b/docs/_static/file.png differ
diff --git a/docs/_static/language_data.js b/docs/_static/language_data.js
new file mode 100644
index 000000000..250f5665f
--- /dev/null
+++ b/docs/_static/language_data.js
@@ -0,0 +1,199 @@
+/*
+ * language_data.js
+ * ~~~~~~~~~~~~~~~~
+ *
+ * This script contains the language-specific data used by searchtools.js,
+ * namely the list of stopwords, stemmer, scorer and splitter.
+ *
+ * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+
+var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"];
+
+
+/* Non-minified version is copied as a separate JS file, is available */
+
+/**
+ * Porter Stemmer
+ */
+var Stemmer = function() {
+
+  var step2list = {
+    ational: 'ate',
+    tional: 'tion',
+    enci: 'ence',
+    anci: 'ance',
+    izer: 'ize',
+    bli: 'ble',
+    alli: 'al',
+    entli: 'ent',
+    eli: 'e',
+    ousli: 'ous',
+    ization: 'ize',
+    ation: 'ate',
+    ator: 'ate',
+    alism: 'al',
+    iveness: 'ive',
+    fulness: 'ful',
+    ousness: 'ous',
+    aliti: 'al',
+    iviti: 'ive',
+    biliti: 'ble',
+    logi: 'log'
+  };
+
+  var step3list = {
+    icate: 'ic',
+    ative: '',
+    alize: 'al',
+    iciti: 'ic',
+    ical: 'ic',
+    ful: '',
+    ness: ''
+  };
+
+  var c = "[^aeiou]";          // consonant
+  var v = "[aeiouy]";          // vowel
+  var C = c + "[^aeiouy]*";    // consonant sequence
+  var V = v + "[aeiou]*";      // vowel sequence
+
+  var mgr0 = "^(" + C + ")?" + V + C;                      // [C]VC... is m>0
+  var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$";    // [C]VC[V] is m=1
+  var mgr1 = "^(" + C + ")?" + V + C + V + C;              // [C]VCVC... is m>1
+  var s_v   = "^(" + C + ")?" + v;                         // vowel in stem
+
+  this.stemWord = function (w) {
+    var stem;
+    var suffix;
+    var firstch;
+    var origword = w;
+
+    if (w.length < 3)
+      return w;
+
+    var re;
+    var re2;
+    var re3;
+    var re4;
+
+    firstch = w.substr(0,1);
+    if (firstch == "y")
+      w = firstch.toUpperCase() + w.substr(1);
+
+    // Step 1a
+    re = /^(.+?)(ss|i)es$/;
+    re2 = /^(.+?)([^s])s$/;
+
+    if (re.test(w))
+      w = w.replace(re,"$1$2");
+    else if (re2.test(w))
+      w = w.replace(re2,"$1$2");
+
+    // Step 1b
+    re = /^(.+?)eed$/;
+    re2 = /^(.+?)(ed|ing)$/;
+    if (re.test(w)) {
+      var fp = re.exec(w);
+      re = new RegExp(mgr0);
+      if (re.test(fp[1])) {
+        re = /.$/;
+        w = w.replace(re,"");
+      }
+    }
+    else if (re2.test(w)) {
+      var fp = re2.exec(w);
+      stem = fp[1];
+      re2 = new RegExp(s_v);
+      if (re2.test(stem)) {
+        w = stem;
+        re2 = /(at|bl|iz)$/;
+        re3 = new RegExp("([^aeiouylsz])\\1$");
+        re4 = new RegExp("^" + C + v + "[^aeiouwxy]$");
+        if (re2.test(w))
+          w = w + "e";
+        else if (re3.test(w)) {
+          re = /.$/;
+          w = w.replace(re,"");
+        }
+        else if (re4.test(w))
+          w = w + "e";
+      }
+    }
+
+    // Step 1c
+    re = /^(.+?)y$/;
+    if (re.test(w)) {
+      var fp = re.exec(w);
+      stem = fp[1];
+      re = new RegExp(s_v);
+      if (re.test(stem))
+        w = stem + "i";
+    }
+
+    // Step 2
+    re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;
+    if (re.test(w)) {
+      var fp = re.exec(w);
+      stem = fp[1];
+      suffix = fp[2];
+      re = new RegExp(mgr0);
+      if (re.test(stem))
+        w = stem + step2list[suffix];
+    }
+
+    // Step 3
+    re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;
+    if (re.test(w)) {
+      var fp = re.exec(w);
+      stem = fp[1];
+      suffix = fp[2];
+      re = new RegExp(mgr0);
+      if (re.test(stem))
+        w = stem + step3list[suffix];
+    }
+
+    // Step 4
+    re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;
+    re2 = /^(.+?)(s|t)(ion)$/;
+    if (re.test(w)) {
+      var fp = re.exec(w);
+      stem = fp[1];
+      re = new RegExp(mgr1);
+      if (re.test(stem))
+        w = stem;
+    }
+    else if (re2.test(w)) {
+      var fp = re2.exec(w);
+      stem = fp[1] + fp[2];
+      re2 = new RegExp(mgr1);
+      if (re2.test(stem))
+        w = stem;
+    }
+
+    // Step 5
+    re = /^(.+?)e$/;
+    if (re.test(w)) {
+      var fp = re.exec(w);
+      stem = fp[1];
+      re = new RegExp(mgr1);
+      re2 = new RegExp(meq1);
+      re3 = new RegExp("^" + C + v + "[^aeiouwxy]$");
+      if (re.test(stem) || (re2.test(stem) && !(re3.test(stem))))
+        w = stem;
+    }
+    re = /ll$/;
+    re2 = new RegExp(mgr1);
+    if (re.test(w) && re2.test(w)) {
+      re = /.$/;
+      w = w.replace(re,"");
+    }
+
+    // and turn initial Y back to y
+    if (firstch == "y")
+      w = firstch.toLowerCase() + w.substr(1);
+    return w;
+  }
+}
+
diff --git a/docs/_static/minus.png b/docs/_static/minus.png
new file mode 100644
index 000000000..d96755fda
Binary files /dev/null and b/docs/_static/minus.png differ
diff --git a/docs/_static/plus.png b/docs/_static/plus.png
new file mode 100644
index 000000000..7107cec93
Binary files /dev/null and b/docs/_static/plus.png differ
diff --git a/docs/_static/pygments.css b/docs/_static/pygments.css
new file mode 100644
index 000000000..8054382b5
--- /dev/null
+++ b/docs/_static/pygments.css
@@ -0,0 +1,75 @@
+pre { line-height: 125%; }
+td.linenos .normal { color: #666666; background-color: transparent; padding-left: 5px; padding-right: 5px; }
+span.linenos { color: #666666; background-color: transparent; padding-left: 5px; padding-right: 5px; }
+td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
+span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
+.highlight .hll { background-color: #ffffcc }
+.highlight { background: #f0f0f0; }
+.highlight .c { color: #60a0b0; font-style: italic } /* Comment */
+.highlight .err { border: 1px solid #FF0000 } /* Error */
+.highlight .k { color: #007020; font-weight: bold } /* Keyword */
+.highlight .o { color: #666666 } /* Operator */
+.highlight .ch { color: #60a0b0; font-style: italic } /* Comment.Hashbang */
+.highlight .cm { color: #60a0b0; font-style: italic } /* Comment.Multiline */
+.highlight .cp { color: #007020 } /* Comment.Preproc */
+.highlight .cpf { color: #60a0b0; font-style: italic } /* Comment.PreprocFile */
+.highlight .c1 { color: #60a0b0; font-style: italic } /* Comment.Single */
+.highlight .cs { color: #60a0b0; background-color: #fff0f0 } /* Comment.Special */
+.highlight .gd { color: #A00000 } /* Generic.Deleted */
+.highlight .ge { font-style: italic } /* Generic.Emph */
+.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */
+.highlight .gr { color: #FF0000 } /* Generic.Error */
+.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
+.highlight .gi { color: #00A000 } /* Generic.Inserted */
+.highlight .go { color: #888888 } /* Generic.Output */
+.highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */
+.highlight .gs { font-weight: bold } /* Generic.Strong */
+.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
+.highlight .gt { color: #0044DD } /* Generic.Traceback */
+.highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */
+.highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */
+.highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */
+.highlight .kp { color: #007020 } /* Keyword.Pseudo */
+.highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */
+.highlight .kt { color: #902000 } /* Keyword.Type */
+.highlight .m { color: #40a070 } /* Literal.Number */
+.highlight .s { color: #4070a0 } /* Literal.String */
+.highlight .na { color: #4070a0 } /* Name.Attribute */
+.highlight .nb { color: #007020 } /* Name.Builtin */
+.highlight .nc { color: #0e84b5; font-weight: bold } /* Name.Class */
+.highlight .no { color: #60add5 } /* Name.Constant */
+.highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */
+.highlight .ni { color: #d55537; font-weight: bold } /* Name.Entity */
+.highlight .ne { color: #007020 } /* Name.Exception */
+.highlight .nf { color: #06287e } /* Name.Function */
+.highlight .nl { color: #002070; font-weight: bold } /* Name.Label */
+.highlight .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */
+.highlight .nt { color: #062873; font-weight: bold } /* Name.Tag */
+.highlight .nv { color: #bb60d5 } /* Name.Variable */
+.highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */
+.highlight .w { color: #bbbbbb } /* Text.Whitespace */
+.highlight .mb { color: #40a070 } /* Literal.Number.Bin */
+.highlight .mf { color: #40a070 } /* Literal.Number.Float */
+.highlight .mh { color: #40a070 } /* Literal.Number.Hex */
+.highlight .mi { color: #40a070 } /* Literal.Number.Integer */
+.highlight .mo { color: #40a070 } /* Literal.Number.Oct */
+.highlight .sa { color: #4070a0 } /* Literal.String.Affix */
+.highlight .sb { color: #4070a0 } /* Literal.String.Backtick */
+.highlight .sc { color: #4070a0 } /* Literal.String.Char */
+.highlight .dl { color: #4070a0 } /* Literal.String.Delimiter */
+.highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */
+.highlight .s2 { color: #4070a0 } /* Literal.String.Double */
+.highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */
+.highlight .sh { color: #4070a0 } /* Literal.String.Heredoc */
+.highlight .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */
+.highlight .sx { color: #c65d09 } /* Literal.String.Other */
+.highlight .sr { color: #235388 } /* Literal.String.Regex */
+.highlight .s1 { color: #4070a0 } /* Literal.String.Single */
+.highlight .ss { color: #517918 } /* Literal.String.Symbol */
+.highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */
+.highlight .fm { color: #06287e } /* Name.Function.Magic */
+.highlight .vc { color: #bb60d5 } /* Name.Variable.Class */
+.highlight .vg { color: #bb60d5 } /* Name.Variable.Global */
+.highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */
+.highlight .vm { color: #bb60d5 } /* Name.Variable.Magic */
+.highlight .il { color: #40a070 } /* Literal.Number.Integer.Long */
\ No newline at end of file
diff --git a/docs/_static/searchtools.js b/docs/_static/searchtools.js
new file mode 100644
index 000000000..7918c3fab
--- /dev/null
+++ b/docs/_static/searchtools.js
@@ -0,0 +1,574 @@
+/*
+ * searchtools.js
+ * ~~~~~~~~~~~~~~~~
+ *
+ * Sphinx JavaScript utilities for the full-text search.
+ *
+ * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+"use strict";
+
+/**
+ * Simple result scoring code.
+ */
+if (typeof Scorer === "undefined") {
+  var Scorer = {
+    // Implement the following function to further tweak the score for each result
+    // The function takes a result array [docname, title, anchor, descr, score, filename]
+    // and returns the new score.
+    /*
+    score: result => {
+      const [docname, title, anchor, descr, score, filename] = result
+      return score
+    },
+    */
+
+    // query matches the full name of an object
+    objNameMatch: 11,
+    // or matches in the last dotted part of the object name
+    objPartialMatch: 6,
+    // Additive scores depending on the priority of the object
+    objPrio: {
+      0: 15, // used to be importantResults
+      1: 5, // used to be objectResults
+      2: -5, // used to be unimportantResults
+    },
+    //  Used when the priority is not in the mapping.
+    objPrioDefault: 0,
+
+    // query found in title
+    title: 15,
+    partialTitle: 7,
+    // query found in terms
+    term: 5,
+    partialTerm: 2,
+  };
+}
+
+const _removeChildren = (element) => {
+  while (element && element.lastChild) element.removeChild(element.lastChild);
+};
+
+/**
+ * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping
+ */
+const _escapeRegExp = (string) =>
+  string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string
+
+const _displayItem = (item, searchTerms, highlightTerms) => {
+  const docBuilder = DOCUMENTATION_OPTIONS.BUILDER;
+  const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX;
+  const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX;
+  const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY;
+  const contentRoot = document.documentElement.dataset.content_root;
+
+  const [docName, title, anchor, descr, score, _filename] = item;
+
+  let listItem = document.createElement("li");
+  let requestUrl;
+  let linkUrl;
+  if (docBuilder === "dirhtml") {
+    // dirhtml builder
+    let dirname = docName + "/";
+    if (dirname.match(/\/index\/$/))
+      dirname = dirname.substring(0, dirname.length - 6);
+    else if (dirname === "index/") dirname = "";
+    requestUrl = contentRoot + dirname;
+    linkUrl = requestUrl;
+  } else {
+    // normal html builders
+    requestUrl = contentRoot + docName + docFileSuffix;
+    linkUrl = docName + docLinkSuffix;
+  }
+  let linkEl = listItem.appendChild(document.createElement("a"));
+  linkEl.href = linkUrl + anchor;
+  linkEl.dataset.score = score;
+  linkEl.innerHTML = title;
+  if (descr) {
+    listItem.appendChild(document.createElement("span")).innerHTML =
+      " (" + descr + ")";
+    // highlight search terms in the description
+    if (SPHINX_HIGHLIGHT_ENABLED)  // set in sphinx_highlight.js
+      highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted"));
+  }
+  else if (showSearchSummary)
+    fetch(requestUrl)
+      .then((responseData) => responseData.text())
+      .then((data) => {
+        if (data)
+          listItem.appendChild(
+            Search.makeSearchSummary(data, searchTerms)
+          );
+        // highlight search terms in the summary
+        if (SPHINX_HIGHLIGHT_ENABLED)  // set in sphinx_highlight.js
+          highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted"));
+      });
+  Search.output.appendChild(listItem);
+};
+const _finishSearch = (resultCount) => {
+  Search.stopPulse();
+  Search.title.innerText = _("Search Results");
+  if (!resultCount)
+    Search.status.innerText = Documentation.gettext(
+      "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories."
+    );
+  else
+    Search.status.innerText = _(
+      `Search finished, found ${resultCount} page(s) matching the search query.`
+    );
+};
+const _displayNextItem = (
+  results,
+  resultCount,
+  searchTerms,
+  highlightTerms,
+) => {
+  // results left, load the summary and display it
+  // this is intended to be dynamic (don't sub resultsCount)
+  if (results.length) {
+    _displayItem(results.pop(), searchTerms, highlightTerms);
+    setTimeout(
+      () => _displayNextItem(results, resultCount, searchTerms, highlightTerms),
+      5
+    );
+  }
+  // search finished, update title and status message
+  else _finishSearch(resultCount);
+};
+
+/**
+ * Default splitQuery function. Can be overridden in ``sphinx.search`` with a
+ * custom function per language.
+ *
+ * The regular expression works by splitting the string on consecutive characters
+ * that are not Unicode letters, numbers, underscores, or emoji characters.
+ * This is the same as ``\W+`` in Python, preserving the surrogate pair area.
+ */
+if (typeof splitQuery === "undefined") {
+  var splitQuery = (query) => query
+      .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu)
+      .filter(term => term)  // remove remaining empty strings
+}
+
+/**
+ * Search Module
+ */
+const Search = {
+  _index: null,
+  _queued_query: null,
+  _pulse_status: -1,
+
+  htmlToText: (htmlString) => {
+    const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html');
+    htmlElement.querySelectorAll(".headerlink").forEach((el) => { el.remove() });
+    const docContent = htmlElement.querySelector('[role="main"]');
+    if (docContent !== undefined) return docContent.textContent;
+    console.warn(
+      "Content block not found. Sphinx search tries to obtain it via '[role=main]'. Could you check your theme or template."
+    );
+    return "";
+  },
+
+  init: () => {
+    const query = new URLSearchParams(window.location.search).get("q");
+    document
+      .querySelectorAll('input[name="q"]')
+      .forEach((el) => (el.value = query));
+    if (query) Search.performSearch(query);
+  },
+
+  loadIndex: (url) =>
+    (document.body.appendChild(document.createElement("script")).src = url),
+
+  setIndex: (index) => {
+    Search._index = index;
+    if (Search._queued_query !== null) {
+      const query = Search._queued_query;
+      Search._queued_query = null;
+      Search.query(query);
+    }
+  },
+
+  hasIndex: () => Search._index !== null,
+
+  deferQuery: (query) => (Search._queued_query = query),
+
+  stopPulse: () => (Search._pulse_status = -1),
+
+  startPulse: () => {
+    if (Search._pulse_status >= 0) return;
+
+    const pulse = () => {
+      Search._pulse_status = (Search._pulse_status + 1) % 4;
+      Search.dots.innerText = ".".repeat(Search._pulse_status);
+      if (Search._pulse_status >= 0) window.setTimeout(pulse, 500);
+    };
+    pulse();
+  },
+
+  /**
+   * perform a search for something (or wait until index is loaded)
+   */
+  performSearch: (query) => {
+    // create the required interface elements
+    const searchText = document.createElement("h2");
+    searchText.textContent = _("Searching");
+    const searchSummary = document.createElement("p");
+    searchSummary.classList.add("search-summary");
+    searchSummary.innerText = "";
+    const searchList = document.createElement("ul");
+    searchList.classList.add("search");
+
+    const out = document.getElementById("search-results");
+    Search.title = out.appendChild(searchText);
+    Search.dots = Search.title.appendChild(document.createElement("span"));
+    Search.status = out.appendChild(searchSummary);
+    Search.output = out.appendChild(searchList);
+
+    const searchProgress = document.getElementById("search-progress");
+    // Some themes don't use the search progress node
+    if (searchProgress) {
+      searchProgress.innerText = _("Preparing search...");
+    }
+    Search.startPulse();
+
+    // index already loaded, the browser was quick!
+    if (Search.hasIndex()) Search.query(query);
+    else Search.deferQuery(query);
+  },
+
+  /**
+   * execute search (requires search index to be loaded)
+   */
+  query: (query) => {
+    const filenames = Search._index.filenames;
+    const docNames = Search._index.docnames;
+    const titles = Search._index.titles;
+    const allTitles = Search._index.alltitles;
+    const indexEntries = Search._index.indexentries;
+
+    // stem the search terms and add them to the correct list
+    const stemmer = new Stemmer();
+    const searchTerms = new Set();
+    const excludedTerms = new Set();
+    const highlightTerms = new Set();
+    const objectTerms = new Set(splitQuery(query.toLowerCase().trim()));
+    splitQuery(query.trim()).forEach((queryTerm) => {
+      const queryTermLower = queryTerm.toLowerCase();
+
+      // maybe skip this "word"
+      // stopwords array is from language_data.js
+      if (
+        stopwords.indexOf(queryTermLower) !== -1 ||
+        queryTerm.match(/^\d+$/)
+      )
+        return;
+
+      // stem the word
+      let word = stemmer.stemWord(queryTermLower);
+      // select the correct list
+      if (word[0] === "-") excludedTerms.add(word.substr(1));
+      else {
+        searchTerms.add(word);
+        highlightTerms.add(queryTermLower);
+      }
+    });
+
+    if (SPHINX_HIGHLIGHT_ENABLED) {  // set in sphinx_highlight.js
+      localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" "))
+    }
+
+    // console.debug("SEARCH: searching for:");
+    // console.info("required: ", [...searchTerms]);
+    // console.info("excluded: ", [...excludedTerms]);
+
+    // array of [docname, title, anchor, descr, score, filename]
+    let results = [];
+    _removeChildren(document.getElementById("search-progress"));
+
+    const queryLower = query.toLowerCase();
+    for (const [title, foundTitles] of Object.entries(allTitles)) {
+      if (title.toLowerCase().includes(queryLower) && (queryLower.length >= title.length/2)) {
+        for (const [file, id] of foundTitles) {
+          let score = Math.round(100 * queryLower.length / title.length)
+          results.push([
+            docNames[file],
+            titles[file] !== title ? `${titles[file]} > ${title}` : title,
+            id !== null ? "#" + id : "",
+            null,
+            score,
+            filenames[file],
+          ]);
+        }
+      }
+    }
+
+    // search for explicit entries in index directives
+    for (const [entry, foundEntries] of Object.entries(indexEntries)) {
+      if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) {
+        for (const [file, id] of foundEntries) {
+          let score = Math.round(100 * queryLower.length / entry.length)
+          results.push([
+            docNames[file],
+            titles[file],
+            id ? "#" + id : "",
+            null,
+            score,
+            filenames[file],
+          ]);
+        }
+      }
+    }
+
+    // lookup as object
+    objectTerms.forEach((term) =>
+      results.push(...Search.performObjectSearch(term, objectTerms))
+    );
+
+    // lookup as search terms in fulltext
+    results.push(...Search.performTermsSearch(searchTerms, excludedTerms));
+
+    // let the scorer override scores with a custom scoring function
+    if (Scorer.score) results.forEach((item) => (item[4] = Scorer.score(item)));
+
+    // now sort the results by score (in opposite order of appearance, since the
+    // display function below uses pop() to retrieve items) and then
+    // alphabetically
+    results.sort((a, b) => {
+      const leftScore = a[4];
+      const rightScore = b[4];
+      if (leftScore === rightScore) {
+        // same score: sort alphabetically
+        const leftTitle = a[1].toLowerCase();
+        const rightTitle = b[1].toLowerCase();
+        if (leftTitle === rightTitle) return 0;
+        return leftTitle > rightTitle ? -1 : 1; // inverted is intentional
+      }
+      return leftScore > rightScore ? 1 : -1;
+    });
+
+    // remove duplicate search results
+    // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept
+    let seen = new Set();
+    results = results.reverse().reduce((acc, result) => {
+      let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(',');
+      if (!seen.has(resultStr)) {
+        acc.push(result);
+        seen.add(resultStr);
+      }
+      return acc;
+    }, []);
+
+    results = results.reverse();
+
+    // for debugging
+    //Search.lastresults = results.slice();  // a copy
+    // console.info("search results:", Search.lastresults);
+
+    // print the results
+    _displayNextItem(results, results.length, searchTerms, highlightTerms);
+  },
+
+  /**
+   * search for object names
+   */
+  performObjectSearch: (object, objectTerms) => {
+    const filenames = Search._index.filenames;
+    const docNames = Search._index.docnames;
+    const objects = Search._index.objects;
+    const objNames = Search._index.objnames;
+    const titles = Search._index.titles;
+
+    const results = [];
+
+    const objectSearchCallback = (prefix, match) => {
+      const name = match[4]
+      const fullname = (prefix ? prefix + "." : "") + name;
+      const fullnameLower = fullname.toLowerCase();
+      if (fullnameLower.indexOf(object) < 0) return;
+
+      let score = 0;
+      const parts = fullnameLower.split(".");
+
+      // check for different match types: exact matches of full name or
+      // "last name" (i.e. last dotted part)
+      if (fullnameLower === object || parts.slice(-1)[0] === object)
+        score += Scorer.objNameMatch;
+      else if (parts.slice(-1)[0].indexOf(object) > -1)
+        score += Scorer.objPartialMatch; // matches in last name
+
+      const objName = objNames[match[1]][2];
+      const title = titles[match[0]];
+
+      // If more than one term searched for, we require other words to be
+      // found in the name/title/description
+      const otherTerms = new Set(objectTerms);
+      otherTerms.delete(object);
+      if (otherTerms.size > 0) {
+        const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase();
+        if (
+          [...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0)
+        )
+          return;
+      }
+
+      let anchor = match[3];
+      if (anchor === "") anchor = fullname;
+      else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname;
+
+      const descr = objName + _(", in ") + title;
+
+      // add custom score for some objects according to scorer
+      if (Scorer.objPrio.hasOwnProperty(match[2]))
+        score += Scorer.objPrio[match[2]];
+      else score += Scorer.objPrioDefault;
+
+      results.push([
+        docNames[match[0]],
+        fullname,
+        "#" + anchor,
+        descr,
+        score,
+        filenames[match[0]],
+      ]);
+    };
+    Object.keys(objects).forEach((prefix) =>
+      objects[prefix].forEach((array) =>
+        objectSearchCallback(prefix, array)
+      )
+    );
+    return results;
+  },
+
+  /**
+   * search for full-text terms in the index
+   */
+  performTermsSearch: (searchTerms, excludedTerms) => {
+    // prepare search
+    const terms = Search._index.terms;
+    const titleTerms = Search._index.titleterms;
+    const filenames = Search._index.filenames;
+    const docNames = Search._index.docnames;
+    const titles = Search._index.titles;
+
+    const scoreMap = new Map();
+    const fileMap = new Map();
+
+    // perform the search on the required terms
+    searchTerms.forEach((word) => {
+      const files = [];
+      const arr = [
+        { files: terms[word], score: Scorer.term },
+        { files: titleTerms[word], score: Scorer.title },
+      ];
+      // add support for partial matches
+      if (word.length > 2) {
+        const escapedWord = _escapeRegExp(word);
+        Object.keys(terms).forEach((term) => {
+          if (term.match(escapedWord) && !terms[word])
+            arr.push({ files: terms[term], score: Scorer.partialTerm });
+        });
+        Object.keys(titleTerms).forEach((term) => {
+          if (term.match(escapedWord) && !titleTerms[word])
+            arr.push({ files: titleTerms[word], score: Scorer.partialTitle });
+        });
+      }
+
+      // no match but word was a required one
+      if (arr.every((record) => record.files === undefined)) return;
+
+      // found search word in contents
+      arr.forEach((record) => {
+        if (record.files === undefined) return;
+
+        let recordFiles = record.files;
+        if (recordFiles.length === undefined) recordFiles = [recordFiles];
+        files.push(...recordFiles);
+
+        // set score for the word in each file
+        recordFiles.forEach((file) => {
+          if (!scoreMap.has(file)) scoreMap.set(file, {});
+          scoreMap.get(file)[word] = record.score;
+        });
+      });
+
+      // create the mapping
+      files.forEach((file) => {
+        if (fileMap.has(file) && fileMap.get(file).indexOf(word) === -1)
+          fileMap.get(file).push(word);
+        else fileMap.set(file, [word]);
+      });
+    });
+
+    // now check if the files don't contain excluded terms
+    const results = [];
+    for (const [file, wordList] of fileMap) {
+      // check if all requirements are matched
+
+      // as search terms with length < 3 are discarded
+      const filteredTermCount = [...searchTerms].filter(
+        (term) => term.length > 2
+      ).length;
+      if (
+        wordList.length !== searchTerms.size &&
+        wordList.length !== filteredTermCount
+      )
+        continue;
+
+      // ensure that none of the excluded terms is in the search result
+      if (
+        [...excludedTerms].some(
+          (term) =>
+            terms[term] === file ||
+            titleTerms[term] === file ||
+            (terms[term] || []).includes(file) ||
+            (titleTerms[term] || []).includes(file)
+        )
+      )
+        break;
+
+      // select one (max) score for the file.
+      const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w]));
+      // add result to the result list
+      results.push([
+        docNames[file],
+        titles[file],
+        "",
+        null,
+        score,
+        filenames[file],
+      ]);
+    }
+    return results;
+  },
+
+  /**
+   * helper function to return a node containing the
+   * search summary for a given text. keywords is a list
+   * of stemmed words.
+   */
+  makeSearchSummary: (htmlText, keywords) => {
+    const text = Search.htmlToText(htmlText);
+    if (text === "") return null;
+
+    const textLower = text.toLowerCase();
+    const actualStartPosition = [...keywords]
+      .map((k) => textLower.indexOf(k.toLowerCase()))
+      .filter((i) => i > -1)
+      .slice(-1)[0];
+    const startWithContext = Math.max(actualStartPosition - 120, 0);
+
+    const top = startWithContext === 0 ? "" : "...";
+    const tail = startWithContext + 240 < text.length ? "..." : "";
+
+    let summary = document.createElement("p");
+    summary.classList.add("context");
+    summary.textContent = top + text.substr(startWithContext, 240).trim() + tail;
+
+    return summary;
+  },
+};
+
+_ready(Search.init);
diff --git a/docs/_static/sphinx_highlight.js b/docs/_static/sphinx_highlight.js
new file mode 100644
index 000000000..8a96c69a1
--- /dev/null
+++ b/docs/_static/sphinx_highlight.js
@@ -0,0 +1,154 @@
+/* Highlighting utilities for Sphinx HTML documentation. */
+"use strict";
+
+const SPHINX_HIGHLIGHT_ENABLED = true
+
+/**
+ * highlight a given string on a node by wrapping it in
+ * span elements with the given class name.
+ */
+const _highlight = (node, addItems, text, className) => {
+  if (node.nodeType === Node.TEXT_NODE) {
+    const val = node.nodeValue;
+    const parent = node.parentNode;
+    const pos = val.toLowerCase().indexOf(text);
+    if (
+      pos >= 0 &&
+      !parent.classList.contains(className) &&
+      !parent.classList.contains("nohighlight")
+    ) {
+      let span;
+
+      const closestNode = parent.closest("body, svg, foreignObject");
+      const isInSVG = closestNode && closestNode.matches("svg");
+      if (isInSVG) {
+        span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
+      } else {
+        span = document.createElement("span");
+        span.classList.add(className);
+      }
+
+      span.appendChild(document.createTextNode(val.substr(pos, text.length)));
+      const rest = document.createTextNode(val.substr(pos + text.length));
+      parent.insertBefore(
+        span,
+        parent.insertBefore(
+          rest,
+          node.nextSibling
+        )
+      );
+      node.nodeValue = val.substr(0, pos);
+      /* There may be more occurrences of search term in this node. So call this
+       * function recursively on the remaining fragment.
+       */
+      _highlight(rest, addItems, text, className);
+
+      if (isInSVG) {
+        const rect = document.createElementNS(
+          "http://www.w3.org/2000/svg",
+          "rect"
+        );
+        const bbox = parent.getBBox();
+        rect.x.baseVal.value = bbox.x;
+        rect.y.baseVal.value = bbox.y;
+        rect.width.baseVal.value = bbox.width;
+        rect.height.baseVal.value = bbox.height;
+        rect.setAttribute("class", className);
+        addItems.push({ parent: parent, target: rect });
+      }
+    }
+  } else if (node.matches && !node.matches("button, select, textarea")) {
+    node.childNodes.forEach((el) => _highlight(el, addItems, text, className));
+  }
+};
+const _highlightText = (thisNode, text, className) => {
+  let addItems = [];
+  _highlight(thisNode, addItems, text, className);
+  addItems.forEach((obj) =>
+    obj.parent.insertAdjacentElement("beforebegin", obj.target)
+  );
+};
+
+/**
+ * Small JavaScript module for the documentation.
+ */
+const SphinxHighlight = {
+
+  /**
+   * highlight the search words provided in localstorage in the text
+   */
+  highlightSearchWords: () => {
+    if (!SPHINX_HIGHLIGHT_ENABLED) return;  // bail if no highlight
+
+    // get and clear terms from localstorage
+    const url = new URL(window.location);
+    const highlight =
+        localStorage.getItem("sphinx_highlight_terms")
+        || url.searchParams.get("highlight")
+        || "";
+    localStorage.removeItem("sphinx_highlight_terms")
+    url.searchParams.delete("highlight");
+    window.history.replaceState({}, "", url);
+
+    // get individual terms from highlight string
+    const terms = highlight.toLowerCase().split(/\s+/).filter(x => x);
+    if (terms.length === 0) return; // nothing to do
+
+    // There should never be more than one element matching "div.body"
+    const divBody = document.querySelectorAll("div.body");
+    const body = divBody.length ? divBody[0] : document.querySelector("body");
+    window.setTimeout(() => {
+      terms.forEach((term) => _highlightText(body, term, "highlighted"));
+    }, 10);
+
+    const searchBox = document.getElementById("searchbox");
+    if (searchBox === null) return;
+    searchBox.appendChild(
+      document
+        .createRange()
+        .createContextualFragment(
+          '<p class="highlight-link">' +
+            '<a href="javascript:SphinxHighlight.hideSearchWords()">' +
+            _("Hide Search Matches") +
+            "</a></p>"
+        )
+    );
+  },
+
+  /**
+   * helper function to hide the search marks again
+   */
+  hideSearchWords: () => {
+    document
+      .querySelectorAll("#searchbox .highlight-link")
+      .forEach((el) => el.remove());
+    document
+      .querySelectorAll("span.highlighted")
+      .forEach((el) => el.classList.remove("highlighted"));
+    localStorage.removeItem("sphinx_highlight_terms")
+  },
+
+  initEscapeListener: () => {
+    // only install a listener if it is really needed
+    if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return;
+
+    document.addEventListener("keydown", (event) => {
+      // bail for input elements
+      if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return;
+      // bail with special keys
+      if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return;
+      if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) {
+        SphinxHighlight.hideSearchWords();
+        event.preventDefault();
+      }
+    });
+  },
+};
+
+_ready(() => {
+  /* Do not call highlightSearchWords() when we are on the search page.
+   * It will highlight words from the *previous* search query.
+   */
+  if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords();
+  SphinxHighlight.initEscapeListener();
+});
diff --git a/docs/api/auth.html b/docs/api/auth.html
new file mode 100644
index 000000000..b8208b5e4
--- /dev/null
+++ b/docs/api/auth.html
@@ -0,0 +1,849 @@
+
+
+<!doctype html>
+
+<html lang="en" data-content_root="../">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+
+    <title>awscrt.auth &#8212; awscrt  documentation</title>
+    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=649a27d8" />
+    <link rel="stylesheet" type="text/css" href="../_static/css/custom.css?v=93be7416" />
+    
+    <script src="../_static/documentation_options.js?v=5929fcd5"></script>
+    <script src="../_static/doctools.js?v=888ff710"></script>
+    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script src="../_static/bizstyle.js"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" />
+    <link rel="next" title="awscrt.common" href="common.html" />
+    <link rel="prev" title="Welcome to awscrt’s documentation!" href="../index.html" />
+    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+    <!--[if lt IE 9]>
+    <script src="_static/css3-mediaqueries.js"></script>
+    <![endif]-->
+  </head><body>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../genindex.html" title="General Index"
+             accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="right" >
+          <a href="common.html" title="awscrt.common"
+             accesskey="N">next</a> |</li>
+        <li class="right" >
+          <a href="../index.html" title="Welcome to awscrt’s documentation!"
+             accesskey="P">previous</a> |</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">awscrt  documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">awscrt.auth</a></li> 
+      </ul>
+    </div>  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body" role="main">
+            
+  <section id="module-awscrt.auth">
+<span id="awscrt-auth"></span><h1>awscrt.auth<a class="headerlink" href="#module-awscrt.auth" title="Link to this heading">¶</a></h1>
+<p>AWS client-side authentication: standard credentials providers and signing.</p>
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.auth.AwsCredentials">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.auth.</span></span><span class="sig-name descname"><span class="pre">AwsCredentials</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">access_key_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">secret_access_key</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session_token</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">expiration</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.auth.AwsCredentials" title="Link to this definition">¶</a></dt>
+<dd><p>AwsCredentials are the public/private data needed to sign an authenticated AWS request.</p>
+<p>AwsCredentials are immutable.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>access_key_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Access key ID</p></li>
+<li><p><strong>secret_access_key</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Secret access key</p></li>
+<li><p><strong>session_token</strong> (<em>Optional</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>]</em>) – Optional security token associated with
+the credentials.</p></li>
+<li><p><strong>expiration</strong> (<em>Optional</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/datetime.html#datetime.datetime" title="(in Python v3.12)"><em>datetime.datetime</em></a><em>]</em>) – Optional expiration datetime,
+that the credentials will no longer be valid past.
+Converted to UTC timezone and rounded down to nearest second.
+If not set, then credentials do not expire.</p></li>
+</ul>
+</dd>
+</dl>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.auth.AwsCredentials.access_key_id">
+<span class="sig-name descname"><span class="pre">access_key_id</span></span><a class="headerlink" href="#awscrt.auth.AwsCredentials.access_key_id" title="Link to this definition">¶</a></dt>
+<dd><p>Access key ID</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.auth.AwsCredentials.secret_access_key">
+<span class="sig-name descname"><span class="pre">secret_access_key</span></span><a class="headerlink" href="#awscrt.auth.AwsCredentials.secret_access_key" title="Link to this definition">¶</a></dt>
+<dd><p>Secret access key</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.auth.AwsCredentials.session_token">
+<span class="sig-name descname"><span class="pre">session_token</span></span><a class="headerlink" href="#awscrt.auth.AwsCredentials.session_token" title="Link to this definition">¶</a></dt>
+<dd><p>Security token associated with
+the credentials. None if not set.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>Optional[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a>]</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.auth.AwsCredentials.expiration">
+<span class="sig-name descname"><span class="pre">expiration</span></span><a class="headerlink" href="#awscrt.auth.AwsCredentials.expiration" title="Link to this definition">¶</a></dt>
+<dd><p>Expiration datetime,
+that the credentials will no longer be valid past.
+None if credentials do not expire.
+Timezone is always UTC.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>Optional[<a class="reference external" href="https://docs.python.org/3/library/datetime.html#datetime.datetime" title="(in Python v3.12)">datetime.datetime</a>]</p>
+</dd>
+</dl>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.auth.AwsCredentialsProvider">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.auth.</span></span><span class="sig-name descname"><span class="pre">AwsCredentialsProvider</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">binding</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.auth.AwsCredentialsProvider" title="Link to this definition">¶</a></dt>
+<dd><p>Credentials providers source the AwsCredentials needed to sign an authenticated AWS request.</p>
+<p>This class provides <cite>new_X()</cite> functions for several built-in provider types.
+To define a custom provider, use the <a class="reference internal" href="#awscrt.auth.AwsCredentialsProvider.new_delegate" title="awscrt.auth.AwsCredentialsProvider.new_delegate"><code class="xref py py-meth docutils literal notranslate"><span class="pre">new_delegate()</span></code></a> function.</p>
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.auth.AwsCredentialsProvider.new_default_chain">
+<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">new_default_chain</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client_bootstrap</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.auth.AwsCredentialsProvider.new_default_chain" title="Link to this definition">¶</a></dt>
+<dd><p>Create the default provider chain used by most AWS SDKs.</p>
+<p>Generally:</p>
+<ol class="arabic simple">
+<li><p>Environment</p></li>
+<li><p>Profile</p></li>
+<li><p>(conditional, off by default) ECS</p></li>
+<li><p>(conditional, on by default) EC2 Instance Metadata</p></li>
+</ol>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>client_bootstrap</strong> (<em>Optional</em><em>[</em><a class="reference internal" href="io.html#awscrt.io.ClientBootstrap" title="awscrt.io.ClientBootstrap"><em>ClientBootstrap</em></a><em>]</em>) – Client bootstrap to use when initiating socket connection.
+If not set, uses the default static ClientBootstrap instead.</p>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p><em>AwsCredentialsProvider</em></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.auth.AwsCredentialsProvider.new_static">
+<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">new_static</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">access_key_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">secret_access_key</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session_token</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.auth.AwsCredentialsProvider.new_static" title="Link to this definition">¶</a></dt>
+<dd><p>Create a simple provider that just returns a fixed set of credentials.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>access_key_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Access key ID</p></li>
+<li><p><strong>secret_access_key</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Secret access key</p></li>
+<li><p><strong>session_token</strong> (<em>Optional</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>]</em>) – Optional session token</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p><em>AwsCredentialsProvider</em></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.auth.AwsCredentialsProvider.new_profile">
+<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">new_profile</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client_bootstrap</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">profile_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">config_filepath</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">credentials_filepath</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.auth.AwsCredentialsProvider.new_profile" title="Link to this definition">¶</a></dt>
+<dd><p>Creates a provider that sources credentials from key-value profiles
+loaded from the aws credentials file.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>client_bootstrap</strong> (<em>Optional</em><em>[</em><a class="reference internal" href="io.html#awscrt.io.ClientBootstrap" title="awscrt.io.ClientBootstrap"><em>ClientBootstrap</em></a><em>]</em>) – Client bootstrap to use when initiating socket connection.
+If not set, uses the static default ClientBootstrap instead.</p></li>
+<li><p><strong>profile_name</strong> (<em>Optional</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>]</em>) – Name of profile to use.
+If not set, uses value from AWS_PROFILE environment variable.
+If that is not set, uses value of “default”</p></li>
+<li><p><strong>config_filepath</strong> (<em>Optional</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>]</em>) – Path to profile config file.
+If not set, uses value from AWS_CONFIG_FILE environment variable.
+If that is not set, uses value of “~/.aws/config”</p></li>
+<li><p><strong>credentials_filepath</strong> (<em>Optional</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>]</em>) – Path to profile credentials file.
+If not set, uses value from AWS_SHARED_CREDENTIALS_FILE environment variable.
+If that is not set, uses value of “~/.aws/credentials”</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p><em>AwsCredentialsProvider</em></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.auth.AwsCredentialsProvider.new_process">
+<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">new_process</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">profile_to_use</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.auth.AwsCredentialsProvider.new_process" title="Link to this definition">¶</a></dt>
+<dd><p>Creates a provider that sources credentials from running an external command or process.</p>
+<p>The command to run is sourced from a profile in the AWS config file, using the standard
+profile selection rules. The profile key the command is read from is “credential_process.”
+Example:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="n">default</span><span class="p">]</span>
+<span class="n">credential_process</span><span class="o">=/</span><span class="n">opt</span><span class="o">/</span><span class="n">amazon</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">my</span><span class="o">-</span><span class="n">credential</span><span class="o">-</span><span class="n">fetcher</span> <span class="o">--</span><span class="n">argsA</span><span class="o">=</span><span class="n">abc</span>
+</pre></div>
+</div>
+<p>On successfully running the command, the output should be a json data with the following
+format:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+    <span class="s2">&quot;Version&quot;</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+    <span class="s2">&quot;AccessKeyId&quot;</span><span class="p">:</span> <span class="s2">&quot;accesskey&quot;</span><span class="p">,</span>
+    <span class="s2">&quot;SecretAccessKey&quot;</span><span class="p">:</span> <span class="s2">&quot;secretAccessKey&quot;</span>
+    <span class="s2">&quot;SessionToken&quot;</span><span class="p">:</span> <span class="s2">&quot;....&quot;</span><span class="p">,</span>
+    <span class="s2">&quot;Expiration&quot;</span><span class="p">:</span> <span class="s2">&quot;2019-05-29T00:21:43Z&quot;</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p>Version here identifies the command output format version.
+This provider is not part of the default provider chain.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>profile_to_use</strong> (<em>Optional</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>]</em>) – Name of profile in which to look for credential_process.
+If not set, uses value from AWS_PROFILE environment variable.
+If that is not set, uses value of “default”</p>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p><em>AwsCredentialsProvider</em></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.auth.AwsCredentialsProvider.new_environment">
+<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">new_environment</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.auth.AwsCredentialsProvider.new_environment" title="Link to this definition">¶</a></dt>
+<dd><p>Creates a provider that returns credentials sourced from environment variables.</p>
+<ul class="simple">
+<li><p>AWS_ACCESS_KEY_ID</p></li>
+<li><p>AWS_SECRET_ACCESS_KEY</p></li>
+<li><p>AWS_SESSION_TOKEN</p></li>
+</ul>
+<dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p><em>AwsCredentialsProvider</em></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.auth.AwsCredentialsProvider.new_chain">
+<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">new_chain</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">providers</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.auth.AwsCredentialsProvider.new_chain" title="Link to this definition">¶</a></dt>
+<dd><p>Creates a provider that sources credentials from an ordered sequence of providers.</p>
+<p>This provider uses the first set of credentials successfully queried.
+Providers are queried one at a time; a provider is not queried until the
+preceding provider has failed to source credentials.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>providers</strong> (<em>List</em><em>[</em><a class="reference internal" href="#awscrt.auth.AwsCredentialsProvider" title="awscrt.auth.AwsCredentialsProvider"><em>AwsCredentialsProvider</em></a><em>]</em>) – List of credentials providers.</p>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p><em>AwsCredentialsProvider</em></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.auth.AwsCredentialsProvider.new_delegate">
+<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">new_delegate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">get_credentials</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.auth.AwsCredentialsProvider.new_delegate" title="Link to this definition">¶</a></dt>
+<dd><p>Creates a provider that sources credentials from a custom
+synchronous callback.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>get_credentials</strong> – Callable which takes no arguments and returns
+<a class="reference internal" href="#awscrt.auth.AwsCredentials" title="awscrt.auth.AwsCredentials"><code class="xref py py-class docutils literal notranslate"><span class="pre">AwsCredentials</span></code></a>.</p>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p><em>AwsCredentialsProvider</em></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.auth.AwsCredentialsProvider.new_cognito">
+<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">new_cognito</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">endpoint</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">identity</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">tls_ctx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="io.html#awscrt.io.ClientTlsContext" title="awscrt.io.ClientTlsContext"><span class="pre">ClientTlsContext</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">logins</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.12)"><span class="pre">Sequence</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Tuple" title="(in Python v3.12)"><span class="pre">Tuple</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">custom_role_arn</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_bootstrap</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="io.html#awscrt.io.ClientBootstrap" title="awscrt.io.ClientBootstrap"><span class="pre">ClientBootstrap</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">http_proxy_options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="http.html#awscrt.http.HttpProxyOptions" title="awscrt.http.HttpProxyOptions"><span class="pre">HttpProxyOptions</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.auth.AwsCredentialsProvider.new_cognito" title="Link to this definition">¶</a></dt>
+<dd><p>Creates a provider that sources credentials from the AWS Cognito Identity service.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>endpoint</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Cognito Identity service regional endpoint to source credentials from.</p></li>
+<li><p><strong>identity</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Cognito identity to fetch credentials relative to.</p></li>
+<li><p><strong>tls_ctx</strong> (<a class="reference internal" href="io.html#awscrt.io.ClientTlsContext" title="awscrt.io.ClientTlsContext"><em>ClientTlsContext</em></a>) – Client TLS context to use when querying cognito credentials by HTTP.</p></li>
+<li><p><strong>logins</strong> (<em>Optional</em><em>[</em><em>Sequence</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.12)"><em>tuple</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>]</em><em>]</em><em>]</em>) – Sequence of tuples specifying pairs of identity provider name
+and token values, representing established login contexts for identity authentication purposes.</p></li>
+<li><p><strong>custom_role_arn</strong> (<em>Optional</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>]</em>) – ARN of the role to be assumed when multiple roles were received in the
+token from the identity provider.</p></li>
+<li><p><strong>client_bootstrap</strong> (<em>Optional</em><em>[</em><a class="reference internal" href="io.html#awscrt.io.ClientBootstrap" title="awscrt.io.ClientBootstrap"><em>ClientBootstrap</em></a><em>]</em>) – Client bootstrap to use when initiating a socket connection.
+If not set, uses the static default ClientBootstrap instead.</p></li>
+<li><p><strong>http_proxy_options</strong> (<em>Optional</em><em>[</em><a class="reference internal" href="http.html#awscrt.http.HttpProxyOptions" title="awscrt.http.HttpProxyOptions"><em>HttpProxyOptions</em></a><em>]</em>) – Optional HTTP proxy options.
+If None is provided then an HTTP proxy is not used.</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p><em>AwsCredentialsProvider</em></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.auth.AwsCredentialsProvider.new_x509">
+<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">new_x509</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">endpoint</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">thing_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">role_alias</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">tls_ctx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="io.html#awscrt.io.ClientTlsContext" title="awscrt.io.ClientTlsContext"><span class="pre">ClientTlsContext</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_bootstrap</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="io.html#awscrt.io.ClientBootstrap" title="awscrt.io.ClientBootstrap"><span class="pre">ClientBootstrap</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">http_proxy_options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="http.html#awscrt.http.HttpProxyOptions" title="awscrt.http.HttpProxyOptions"><span class="pre">HttpProxyOptions</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.auth.AwsCredentialsProvider.new_x509" title="Link to this definition">¶</a></dt>
+<dd><p>Creates a provider that sources credentials from IoT’s X509 credentials service.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>endpoint</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – X509 service regional endpoint to source credentials from.
+This is a per-account value that can be determined via the CLI:
+<cite>aws iot describe-endpoint –endpoint-type iot:CredentialProvider</cite></p></li>
+<li><p><strong>thing_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – The name of the IoT thing to use to fetch credentials.</p></li>
+<li><p><strong>role_alias</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – The name of the role alias to fetch credentials through.</p></li>
+<li><p><strong>tls_ctx</strong> (<a class="reference internal" href="io.html#awscrt.io.ClientTlsContext" title="awscrt.io.ClientTlsContext"><em>ClientTlsContext</em></a>) – The client TLS context to use when establishing the http connection to IoT’s X509 credentials service.</p></li>
+<li><p><strong>client_bootstrap</strong> (<em>Optional</em><em>[</em><a class="reference internal" href="io.html#awscrt.io.ClientBootstrap" title="awscrt.io.ClientBootstrap"><em>ClientBootstrap</em></a><em>]</em>) – Client bootstrap to use when initiating a socket connection.
+If not set, uses the static default ClientBootstrap instead.</p></li>
+<li><p><strong>http_proxy_options</strong> (<em>Optional</em><em>[</em><a class="reference internal" href="http.html#awscrt.http.HttpProxyOptions" title="awscrt.http.HttpProxyOptions"><em>HttpProxyOptions</em></a><em>]</em>) – Optional HTTP proxy options.
+If None is provided then an HTTP proxy is not used.</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p><em>AwsCredentialsProvider</em></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.auth.AwsCredentialsProvider.get_credentials">
+<span class="sig-name descname"><span class="pre">get_credentials</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.auth.AwsCredentialsProvider.get_credentials" title="Link to this definition">¶</a></dt>
+<dd><p>Asynchronously fetch AwsCredentials.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p><em>concurrent.futures.Future</em> – A Future which will contain
+<a class="reference internal" href="#awscrt.auth.AwsCredentials" title="awscrt.auth.AwsCredentials"><code class="xref py py-class docutils literal notranslate"><span class="pre">AwsCredentials</span></code></a> (or an exception) when the operation completes.
+The operation may complete on a different thread.</p>
+</dd>
+</dl>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.auth.AwsSigningAlgorithm">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.auth.</span></span><span class="sig-name descname"><span class="pre">AwsSigningAlgorithm</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.auth.AwsSigningAlgorithm" title="Link to this definition">¶</a></dt>
+<dd><p>AWS signing algorithm enumeration.</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.auth.AwsSigningAlgorithm.V4">
+<span class="sig-name descname"><span class="pre">V4</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#awscrt.auth.AwsSigningAlgorithm.V4" title="Link to this definition">¶</a></dt>
+<dd><p>Signature Version 4</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.auth.AwsSigningAlgorithm.V4_ASYMMETRIC">
+<span class="sig-name descname"><span class="pre">V4_ASYMMETRIC</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#awscrt.auth.AwsSigningAlgorithm.V4_ASYMMETRIC" title="Link to this definition">¶</a></dt>
+<dd><p>Signature Version 4 - Asymmetric</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.auth.AwsSigningAlgorithm.V4_S3EXPRESS">
+<span class="sig-name descname"><span class="pre">V4_S3EXPRESS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#awscrt.auth.AwsSigningAlgorithm.V4_S3EXPRESS" title="Link to this definition">¶</a></dt>
+<dd><p>Signature Version 4 - S3 Express</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.auth.AwsSignatureType">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.auth.</span></span><span class="sig-name descname"><span class="pre">AwsSignatureType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.auth.AwsSignatureType" title="Link to this definition">¶</a></dt>
+<dd><p>Which sort of signature should be computed from the signable.</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.auth.AwsSignatureType.HTTP_REQUEST_HEADERS">
+<span class="sig-name descname"><span class="pre">HTTP_REQUEST_HEADERS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#awscrt.auth.AwsSignatureType.HTTP_REQUEST_HEADERS" title="Link to this definition">¶</a></dt>
+<dd><p>A signature for a full HTTP request should be computed,
+with header updates applied to the signing result.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.auth.AwsSignatureType.HTTP_REQUEST_QUERY_PARAMS">
+<span class="sig-name descname"><span class="pre">HTTP_REQUEST_QUERY_PARAMS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#awscrt.auth.AwsSignatureType.HTTP_REQUEST_QUERY_PARAMS" title="Link to this definition">¶</a></dt>
+<dd><p>A signature for a full HTTP request should be computed,
+with query param updates applied to the signing result.</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.auth.AwsSignedBodyValue">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.auth.</span></span><span class="sig-name descname"><span class="pre">AwsSignedBodyValue</span></span><a class="headerlink" href="#awscrt.auth.AwsSignedBodyValue" title="Link to this definition">¶</a></dt>
+<dd><p>Values for use with <a class="reference internal" href="#awscrt.auth.AwsSigningConfig.signed_body_value" title="awscrt.auth.AwsSigningConfig.signed_body_value"><code class="xref py py-attr docutils literal notranslate"><span class="pre">AwsSigningConfig.signed_body_value</span></code></a>.</p>
+<p>Some services use special values (e.g. “UNSIGNED-PAYLOAD”) when the body
+is not being signed in the usual way.</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.auth.AwsSignedBodyValue.EMPTY_SHA256">
+<span class="sig-name descname"><span class="pre">EMPTY_SHA256</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855'</span></em><a class="headerlink" href="#awscrt.auth.AwsSignedBodyValue.EMPTY_SHA256" title="Link to this definition">¶</a></dt>
+<dd><p>The SHA-256 of the empty string.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.auth.AwsSignedBodyValue.UNSIGNED_PAYLOAD">
+<span class="sig-name descname"><span class="pre">UNSIGNED_PAYLOAD</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'UNSIGNED-PAYLOAD'</span></em><a class="headerlink" href="#awscrt.auth.AwsSignedBodyValue.UNSIGNED_PAYLOAD" title="Link to this definition">¶</a></dt>
+<dd><p>Unsigned payload option (not accepted by all services)</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.auth.AwsSignedBodyValue.STREAMING_AWS4_HMAC_SHA256_PAYLOAD">
+<span class="sig-name descname"><span class="pre">STREAMING_AWS4_HMAC_SHA256_PAYLOAD</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'STREAMING-AWS4-HMAC-SHA256-PAYLOAD'</span></em><a class="headerlink" href="#awscrt.auth.AwsSignedBodyValue.STREAMING_AWS4_HMAC_SHA256_PAYLOAD" title="Link to this definition">¶</a></dt>
+<dd><p>Each payload chunk will be signed (not accepted by all services)</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.auth.AwsSignedBodyValue.STREAMING_AWS4_HMAC_SHA256_EVENTS">
+<span class="sig-name descname"><span class="pre">STREAMING_AWS4_HMAC_SHA256_EVENTS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'STREAMING-AWS4-HMAC-SHA256-EVENTS'</span></em><a class="headerlink" href="#awscrt.auth.AwsSignedBodyValue.STREAMING_AWS4_HMAC_SHA256_EVENTS" title="Link to this definition">¶</a></dt>
+<dd><p>Each event will be signed (not accepted by all services)</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.auth.AwsSignedBodyHeaderType">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.auth.</span></span><span class="sig-name descname"><span class="pre">AwsSignedBodyHeaderType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.auth.AwsSignedBodyHeaderType" title="Link to this definition">¶</a></dt>
+<dd><p>Controls if signing adds a header containing the canonical request’s signed body value.</p>
+<p>See <a class="reference internal" href="#awscrt.auth.AwsSigningConfig.signed_body_value" title="awscrt.auth.AwsSigningConfig.signed_body_value"><code class="xref py py-attr docutils literal notranslate"><span class="pre">AwsSigningConfig.signed_body_value</span></code></a>.</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.auth.AwsSignedBodyHeaderType.NONE">
+<span class="sig-name descname"><span class="pre">NONE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#awscrt.auth.AwsSignedBodyHeaderType.NONE" title="Link to this definition">¶</a></dt>
+<dd><p>Do not add a header.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.auth.AwsSignedBodyHeaderType.X_AMZ_CONTENT_SHA_256">
+<span class="sig-name descname"><span class="pre">X_AMZ_CONTENT_SHA_256</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#awscrt.auth.AwsSignedBodyHeaderType.X_AMZ_CONTENT_SHA_256" title="Link to this definition">¶</a></dt>
+<dd><p>Add the “x-amz-content-sha-256” header with the canonical request’s signed body value</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.auth.AwsSigningConfig">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.auth.</span></span><span class="sig-name descname"><span class="pre">AwsSigningConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">algorithm</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">AwsSigningAlgorithm.V4</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">signature_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">AwsSignatureType.HTTP_REQUEST_HEADERS</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">credentials_provider</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">region</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">date</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">should_sign_header</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_double_uri_encode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">should_normalize_uri_path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">signed_body_value</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">signed_body_header_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">AwsSignedBodyHeaderType.NONE</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">expiration_in_seconds</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">omit_session_token</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.auth.AwsSigningConfig" title="Link to this definition">¶</a></dt>
+<dd><p>Configuration for use in AWS-related signing.</p>
+<p>AwsSigningConfig is immutable.</p>
+<p>It is good practice to use a new config for each signature, or the date might get too old.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>algorithm</strong> (<a class="reference internal" href="#awscrt.auth.AwsSigningAlgorithm" title="awscrt.auth.AwsSigningAlgorithm"><em>AwsSigningAlgorithm</em></a>) – Which signing algorithm to use.</p></li>
+<li><p><strong>signature_type</strong> (<a class="reference internal" href="#awscrt.auth.AwsSignatureType" title="awscrt.auth.AwsSignatureType"><em>AwsSignatureType</em></a>) – Which sort of signature should be
+computed from the signable.</p></li>
+<li><p><strong>credentials_provider</strong> (<a class="reference internal" href="#awscrt.auth.AwsCredentialsProvider" title="awscrt.auth.AwsCredentialsProvider"><em>AwsCredentialsProvider</em></a>) – Credentials provider
+to fetch signing credentials with. If the algorithm is
+<a class="reference internal" href="#awscrt.auth.AwsSigningAlgorithm.V4_ASYMMETRIC" title="awscrt.auth.AwsSigningAlgorithm.V4_ASYMMETRIC"><code class="xref py py-attr docutils literal notranslate"><span class="pre">AwsSigningAlgorithm.V4_ASYMMETRIC</span></code></a>, ECC-based credentials will be derived from the
+fetched credentials.</p></li>
+<li><p><strong>region</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – If the algorithm is <a class="reference internal" href="#awscrt.auth.AwsSigningAlgorithm.V4" title="awscrt.auth.AwsSigningAlgorithm.V4"><code class="xref py py-attr docutils literal notranslate"><span class="pre">AwsSigningAlgorithm.V4</span></code></a>, the region to sign against.
+If the algorithm is <a class="reference internal" href="#awscrt.auth.AwsSigningAlgorithm.V4_ASYMMETRIC" title="awscrt.auth.AwsSigningAlgorithm.V4_ASYMMETRIC"><code class="xref py py-attr docutils literal notranslate"><span class="pre">AwsSigningAlgorithm.V4_ASYMMETRIC</span></code></a>, the value of the
+“X-amzn-region-set” header (added in signing).</p></li>
+<li><p><strong>service</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Name of service to sign a request for.</p></li>
+<li><p><strong>date</strong> (<em>Optional</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/datetime.html#datetime.datetime" title="(in Python v3.12)"><em>datetime.datetime</em></a><em>]</em>) – Date and time to use during the
+signing process. If None is provided then
+<cite>datetime.datetime.now(datetime.timezone.utc)</cite> is used.
+Naive dates (lacking timezone info) are assumed to be in local time.</p></li>
+<li><p><strong>should_sign_header</strong> (<em>Optional</em><em>[</em><em>Callable</em><em>[</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>]</em><em>, </em><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a><em>]</em><em>]</em>) – <p>Optional function to control which headers are
+a part of the canonical request.</p>
+<p>Skipping auth-required headers will result in an unusable signature.
+Headers injected by the signing process are not skippable.
+This function does not override the internal check function
+(x-amzn-trace-id, user-agent), but rather supplements it.
+In particular, a header will get signed if and only if it returns
+true to both the internal check (skips x-amzn-trace-id, user-agent)
+and this function (if defined).</p>
+</p></li>
+<li><p><strong>use_double_uri_encode</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – Whether to double-encode the resource path
+when constructing the canonical request (assuming the path is already
+encoded). Default is True. All services except S3 use double encoding.</p></li>
+<li><p><strong>should_normalize_uri_path</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – Whether the resource paths are
+normalized when building the canonical request. Default is True.</p></li>
+<li><p><strong>signed_body_value</strong> (<em>Optional</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>]</em>) – If set, this value is used as the
+canonical request’s body value. Typically, this is the SHA-256
+of the payload, written as lowercase hex. If this has been
+precalculated, it can be set here. Special values used by certain
+services can also be set (see <a class="reference internal" href="#awscrt.auth.AwsSignedBodyValue" title="awscrt.auth.AwsSignedBodyValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">AwsSignedBodyValue</span></code></a>). If <cite>None</cite>
+is passed (the default), the typical value will be calculated from
+the payload during signing.</p></li>
+<li><p><strong>signed_body_header_type</strong> (<a class="reference internal" href="#awscrt.auth.AwsSignedBodyHeaderType" title="awscrt.auth.AwsSignedBodyHeaderType"><em>AwsSignedBodyHeaderType</em></a>) – Controls if signing
+adds a header containing the canonical request’s signed body value.
+Default is to not add a header.</p></li>
+<li><p><strong>expiration_in_seconds</strong> (<em>Optional</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a><em>]</em>) – If set, and signature_type is
+<a class="reference internal" href="#awscrt.auth.AwsSignatureType.HTTP_REQUEST_QUERY_PARAMS" title="awscrt.auth.AwsSignatureType.HTTP_REQUEST_QUERY_PARAMS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">AwsSignatureType.HTTP_REQUEST_QUERY_PARAMS</span></code></a>, then signing will add “X-Amz-Expires”
+to the query string, equal to the value specified here.</p></li>
+<li><p><strong>omit_session_token</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – If set True, the “X-Amz-Security-Token”
+query param is omitted from the canonical request.
+The default False should be used for most services.</p></li>
+</ul>
+</dd>
+</dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.auth.AwsSigningConfig.replace">
+<span class="sig-name descname"><span class="pre">replace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.auth.AwsSigningConfig.replace" title="Link to this definition">¶</a></dt>
+<dd><p>Return an AwsSigningConfig with the same attributes, except for those
+attributes given new values by whichever keyword arguments are specified.</p>
+</dd></dl>
+
+<dl class="py property">
+<dt class="sig sig-object py" id="awscrt.auth.AwsSigningConfig.algorithm">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">algorithm</span></span><a class="headerlink" href="#awscrt.auth.AwsSigningConfig.algorithm" title="Link to this definition">¶</a></dt>
+<dd><p>Which signing algorithm to use</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference internal" href="#awscrt.auth.AwsSigningAlgorithm" title="awscrt.auth.AwsSigningAlgorithm">AwsSigningAlgorithm</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py property">
+<dt class="sig sig-object py" id="awscrt.auth.AwsSigningConfig.signature_type">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">signature_type</span></span><a class="headerlink" href="#awscrt.auth.AwsSigningConfig.signature_type" title="Link to this definition">¶</a></dt>
+<dd><p>Which sort of signature should be computed from the signable.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference internal" href="#awscrt.auth.AwsSignatureType" title="awscrt.auth.AwsSignatureType">AwsSignatureType</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py property">
+<dt class="sig sig-object py" id="awscrt.auth.AwsSigningConfig.credentials_provider">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">credentials_provider</span></span><a class="headerlink" href="#awscrt.auth.AwsSigningConfig.credentials_provider" title="Link to this definition">¶</a></dt>
+<dd><p>Credentials provider to fetch signing credentials with.
+If the algorithm is <a class="reference internal" href="#awscrt.auth.AwsSigningAlgorithm.V4_ASYMMETRIC" title="awscrt.auth.AwsSigningAlgorithm.V4_ASYMMETRIC"><code class="xref py py-attr docutils literal notranslate"><span class="pre">AwsSigningAlgorithm.V4_ASYMMETRIC</span></code></a>, ECC-based credentials will be derived
+from the fetched credentials.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference internal" href="#awscrt.auth.AwsCredentialsProvider" title="awscrt.auth.AwsCredentialsProvider">AwsCredentialsProvider</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py property">
+<dt class="sig sig-object py" id="awscrt.auth.AwsSigningConfig.region">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">region</span></span><a class="headerlink" href="#awscrt.auth.AwsSigningConfig.region" title="Link to this definition">¶</a></dt>
+<dd><p>If signing algorithm is <a class="reference internal" href="#awscrt.auth.AwsSigningAlgorithm.V4" title="awscrt.auth.AwsSigningAlgorithm.V4"><code class="xref py py-attr docutils literal notranslate"><span class="pre">AwsSigningAlgorithm.V4</span></code></a>, the region to sign against.
+If the algorithm is <a class="reference internal" href="#awscrt.auth.AwsSigningAlgorithm.V4_ASYMMETRIC" title="awscrt.auth.AwsSigningAlgorithm.V4_ASYMMETRIC"><code class="xref py py-attr docutils literal notranslate"><span class="pre">AwsSigningAlgorithm.V4_ASYMMETRIC</span></code></a>, the value of the
+“X-amzn-region-set header” (added in signing).</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py property">
+<dt class="sig sig-object py" id="awscrt.auth.AwsSigningConfig.service">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">service</span></span><a class="headerlink" href="#awscrt.auth.AwsSigningConfig.service" title="Link to this definition">¶</a></dt>
+<dd><p>Name of service to sign a request for</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py property">
+<dt class="sig sig-object py" id="awscrt.auth.AwsSigningConfig.date">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">date</span></span><a class="headerlink" href="#awscrt.auth.AwsSigningConfig.date" title="Link to this definition">¶</a></dt>
+<dd><p>Date and time to use during the signing process.</p>
+<p>If None is provided, then <cite>datetime.datetime.now(datetime.timezone.utc)</cite>
+at time of object construction is used.</p>
+<p>It is good practice to use a new config for each signature, or the date might get too old.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/datetime.html#datetime.datetime" title="(in Python v3.12)">datetime.datetime</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py property">
+<dt class="sig sig-object py" id="awscrt.auth.AwsSigningConfig.should_sign_header">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">should_sign_header</span></span><a class="headerlink" href="#awscrt.auth.AwsSigningConfig.should_sign_header" title="Link to this definition">¶</a></dt>
+<dd><p>Optional function to control which
+headers are a part of the canonical request.</p>
+<p>Skipping auth-required headers will result in an unusable signature.
+Headers injected by the signing process are not skippable.
+This function does not override the internal check function
+(x-amzn-trace-id, user-agent), but rather supplements it. In particular,
+a header will get signed if and only if it returns true to both
+the internal check (skips x-amzn-trace-id, user-agent) and this function (if defined).</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>Optional[Callable[[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a>], <a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)">bool</a>]]</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py property">
+<dt class="sig sig-object py" id="awscrt.auth.AwsSigningConfig.use_double_uri_encode">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">use_double_uri_encode</span></span><a class="headerlink" href="#awscrt.auth.AwsSigningConfig.use_double_uri_encode" title="Link to this definition">¶</a></dt>
+<dd><p>Whether to double-encode the resource path when constructing
+the canonical request (assuming the path is already encoded).</p>
+<p>By default, all services except S3 use double encoding.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)">bool</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py property">
+<dt class="sig sig-object py" id="awscrt.auth.AwsSigningConfig.should_normalize_uri_path">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">should_normalize_uri_path</span></span><a class="headerlink" href="#awscrt.auth.AwsSigningConfig.should_normalize_uri_path" title="Link to this definition">¶</a></dt>
+<dd><p>Whether the resource paths are normalized when building the
+canonical request.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)">bool</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py property">
+<dt class="sig sig-object py" id="awscrt.auth.AwsSigningConfig.signed_body_value">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">signed_body_value</span></span><a class="headerlink" href="#awscrt.auth.AwsSigningConfig.signed_body_value" title="Link to this definition">¶</a></dt>
+<dd><p>What to use as the canonical request’s body value.
+If <cite>None</cite> is set (the default), a value will be calculated from
+the payload during signing. Typically, this is the SHA-256 of the
+payload, written as lowercase hex. If this has been precalculated,
+it can be set here. Special values used by certain services can also
+be set (see <a class="reference internal" href="#awscrt.auth.AwsSignedBodyValue" title="awscrt.auth.AwsSignedBodyValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">AwsSignedBodyValue</span></code></a>).</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>Optional[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a>]</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py property">
+<dt class="sig sig-object py" id="awscrt.auth.AwsSigningConfig.signed_body_header_type">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">signed_body_header_type</span></span><a class="headerlink" href="#awscrt.auth.AwsSigningConfig.signed_body_header_type" title="Link to this definition">¶</a></dt>
+<dd><p>Controls if signing adds a header containing
+the canonical request’s signed body value.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference internal" href="#awscrt.auth.AwsSignedBodyHeaderType" title="awscrt.auth.AwsSignedBodyHeaderType">AwsSignedBodyHeaderType</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py property">
+<dt class="sig sig-object py" id="awscrt.auth.AwsSigningConfig.expiration_in_seconds">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">expiration_in_seconds</span></span><a class="headerlink" href="#awscrt.auth.AwsSigningConfig.expiration_in_seconds" title="Link to this definition">¶</a></dt>
+<dd><p>If set, and signature_type is <a class="reference internal" href="#awscrt.auth.AwsSignatureType.HTTP_REQUEST_QUERY_PARAMS" title="awscrt.auth.AwsSignatureType.HTTP_REQUEST_QUERY_PARAMS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">AwsSignatureType.HTTP_REQUEST_QUERY_PARAMS</span></code></a>,
+then signing will add “X-Amz-Expires” to the query string, equal to the
+value specified here. Otherwise, this is None has no effect.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>Optional[<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)">int</a>]</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py property">
+<dt class="sig sig-object py" id="awscrt.auth.AwsSigningConfig.omit_session_token">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">omit_session_token</span></span><a class="headerlink" href="#awscrt.auth.AwsSigningConfig.omit_session_token" title="Link to this definition">¶</a></dt>
+<dd><p>Whether the “X-Amz-Security-Token” query param is omitted
+from the canonical request. This should be False for most services.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)">bool</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="awscrt.auth.aws_sign_request">
+<span class="sig-prename descclassname"><span class="pre">awscrt.auth.</span></span><span class="sig-name descname"><span class="pre">aws_sign_request</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">http_request</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">signing_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.auth.aws_sign_request" title="Link to this definition">¶</a></dt>
+<dd><p>Perform AWS HTTP request signing.</p>
+<p>The <a class="reference internal" href="http.html#awscrt.http.HttpRequest" title="awscrt.http.HttpRequest"><code class="xref py py-class docutils literal notranslate"><span class="pre">awscrt.http.HttpRequest</span></code></a> is transformed asynchronously,
+according to the <a class="reference internal" href="#awscrt.auth.AwsSigningConfig" title="awscrt.auth.AwsSigningConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">AwsSigningConfig</span></code></a>.</p>
+<p>When signing:</p>
+<ol class="arabic simple">
+<li><p>It is good practice to use a new config for each signature,
+or the date might get too old.</p></li>
+<li><p>Do not add the following headers to requests before signing, they may be added by the signer:
+x-amz-content-sha256,
+X-Amz-Date,
+Authorization</p></li>
+<li><p>Do not add the following query params to requests before signing, they may be added by the signer:
+X-Amz-Signature,
+X-Amz-Date,
+X-Amz-Credential,
+X-Amz-Algorithm,
+X-Amz-SignedHeaders</p></li>
+</ol>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>http_request</strong> (<a class="reference internal" href="http.html#awscrt.http.HttpRequest" title="awscrt.http.HttpRequest"><em>awscrt.http.HttpRequest</em></a>) – The HTTP request to sign.</p></li>
+<li><p><strong>signing_config</strong> (<a class="reference internal" href="#awscrt.auth.AwsSigningConfig" title="awscrt.auth.AwsSigningConfig"><em>AwsSigningConfig</em></a>) – Configuration for signing.</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p><em>concurrent.futures.Future</em> – A Future whose result will be the signed
+<a class="reference internal" href="http.html#awscrt.http.HttpRequest" title="awscrt.http.HttpRequest"><code class="xref py py-class docutils literal notranslate"><span class="pre">awscrt.http.HttpRequest</span></code></a>. The future will contain an exception
+if the signing process fails.</p>
+</dd>
+</dl>
+</dd></dl>
+
+</section>
+
+
+            <div class="clearer"></div>
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+  <div>
+    <h3><a href="../index.html">Table of Contents</a></h3>
+    <ul>
+<li><a class="reference internal" href="#">awscrt.auth</a><ul>
+<li><a class="reference internal" href="#awscrt.auth.AwsCredentials"><code class="docutils literal notranslate"><span class="pre">AwsCredentials</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.auth.AwsCredentials.access_key_id"><code class="docutils literal notranslate"><span class="pre">access_key_id</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.auth.AwsCredentials.secret_access_key"><code class="docutils literal notranslate"><span class="pre">secret_access_key</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.auth.AwsCredentials.session_token"><code class="docutils literal notranslate"><span class="pre">session_token</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.auth.AwsCredentials.expiration"><code class="docutils literal notranslate"><span class="pre">expiration</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.auth.AwsCredentialsProvider"><code class="docutils literal notranslate"><span class="pre">AwsCredentialsProvider</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.auth.AwsCredentialsProvider.new_default_chain"><code class="docutils literal notranslate"><span class="pre">new_default_chain()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.auth.AwsCredentialsProvider.new_static"><code class="docutils literal notranslate"><span class="pre">new_static()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.auth.AwsCredentialsProvider.new_profile"><code class="docutils literal notranslate"><span class="pre">new_profile()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.auth.AwsCredentialsProvider.new_process"><code class="docutils literal notranslate"><span class="pre">new_process()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.auth.AwsCredentialsProvider.new_environment"><code class="docutils literal notranslate"><span class="pre">new_environment()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.auth.AwsCredentialsProvider.new_chain"><code class="docutils literal notranslate"><span class="pre">new_chain()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.auth.AwsCredentialsProvider.new_delegate"><code class="docutils literal notranslate"><span class="pre">new_delegate()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.auth.AwsCredentialsProvider.new_cognito"><code class="docutils literal notranslate"><span class="pre">new_cognito()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.auth.AwsCredentialsProvider.new_x509"><code class="docutils literal notranslate"><span class="pre">new_x509()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.auth.AwsCredentialsProvider.get_credentials"><code class="docutils literal notranslate"><span class="pre">get_credentials()</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.auth.AwsSigningAlgorithm"><code class="docutils literal notranslate"><span class="pre">AwsSigningAlgorithm</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.auth.AwsSigningAlgorithm.V4"><code class="docutils literal notranslate"><span class="pre">V4</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.auth.AwsSigningAlgorithm.V4_ASYMMETRIC"><code class="docutils literal notranslate"><span class="pre">V4_ASYMMETRIC</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.auth.AwsSigningAlgorithm.V4_S3EXPRESS"><code class="docutils literal notranslate"><span class="pre">V4_S3EXPRESS</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.auth.AwsSignatureType"><code class="docutils literal notranslate"><span class="pre">AwsSignatureType</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.auth.AwsSignatureType.HTTP_REQUEST_HEADERS"><code class="docutils literal notranslate"><span class="pre">HTTP_REQUEST_HEADERS</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.auth.AwsSignatureType.HTTP_REQUEST_QUERY_PARAMS"><code class="docutils literal notranslate"><span class="pre">HTTP_REQUEST_QUERY_PARAMS</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.auth.AwsSignedBodyValue"><code class="docutils literal notranslate"><span class="pre">AwsSignedBodyValue</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.auth.AwsSignedBodyValue.EMPTY_SHA256"><code class="docutils literal notranslate"><span class="pre">EMPTY_SHA256</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.auth.AwsSignedBodyValue.UNSIGNED_PAYLOAD"><code class="docutils literal notranslate"><span class="pre">UNSIGNED_PAYLOAD</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.auth.AwsSignedBodyValue.STREAMING_AWS4_HMAC_SHA256_PAYLOAD"><code class="docutils literal notranslate"><span class="pre">STREAMING_AWS4_HMAC_SHA256_PAYLOAD</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.auth.AwsSignedBodyValue.STREAMING_AWS4_HMAC_SHA256_EVENTS"><code class="docutils literal notranslate"><span class="pre">STREAMING_AWS4_HMAC_SHA256_EVENTS</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.auth.AwsSignedBodyHeaderType"><code class="docutils literal notranslate"><span class="pre">AwsSignedBodyHeaderType</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.auth.AwsSignedBodyHeaderType.NONE"><code class="docutils literal notranslate"><span class="pre">NONE</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.auth.AwsSignedBodyHeaderType.X_AMZ_CONTENT_SHA_256"><code class="docutils literal notranslate"><span class="pre">X_AMZ_CONTENT_SHA_256</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.auth.AwsSigningConfig"><code class="docutils literal notranslate"><span class="pre">AwsSigningConfig</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.auth.AwsSigningConfig.replace"><code class="docutils literal notranslate"><span class="pre">replace()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.auth.AwsSigningConfig.algorithm"><code class="docutils literal notranslate"><span class="pre">algorithm</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.auth.AwsSigningConfig.signature_type"><code class="docutils literal notranslate"><span class="pre">signature_type</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.auth.AwsSigningConfig.credentials_provider"><code class="docutils literal notranslate"><span class="pre">credentials_provider</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.auth.AwsSigningConfig.region"><code class="docutils literal notranslate"><span class="pre">region</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.auth.AwsSigningConfig.service"><code class="docutils literal notranslate"><span class="pre">service</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.auth.AwsSigningConfig.date"><code class="docutils literal notranslate"><span class="pre">date</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.auth.AwsSigningConfig.should_sign_header"><code class="docutils literal notranslate"><span class="pre">should_sign_header</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.auth.AwsSigningConfig.use_double_uri_encode"><code class="docutils literal notranslate"><span class="pre">use_double_uri_encode</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.auth.AwsSigningConfig.should_normalize_uri_path"><code class="docutils literal notranslate"><span class="pre">should_normalize_uri_path</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.auth.AwsSigningConfig.signed_body_value"><code class="docutils literal notranslate"><span class="pre">signed_body_value</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.auth.AwsSigningConfig.signed_body_header_type"><code class="docutils literal notranslate"><span class="pre">signed_body_header_type</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.auth.AwsSigningConfig.expiration_in_seconds"><code class="docutils literal notranslate"><span class="pre">expiration_in_seconds</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.auth.AwsSigningConfig.omit_session_token"><code class="docutils literal notranslate"><span class="pre">omit_session_token</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.auth.aws_sign_request"><code class="docutils literal notranslate"><span class="pre">aws_sign_request()</span></code></a></li>
+</ul>
+</li>
+</ul>
+
+  </div>
+  <div>
+    <h4>Previous topic</h4>
+    <p class="topless"><a href="../index.html"
+                          title="previous chapter">Welcome to awscrt’s documentation!</a></p>
+  </div>
+  <div>
+    <h4>Next topic</h4>
+    <p class="topless"><a href="common.html"
+                          title="next chapter">awscrt.common</a></p>
+  </div>
+  <div role="note" aria-label="source link">
+    <h3>This Page</h3>
+    <ul class="this-page-menu">
+      <li><a href="../_sources/api/auth.rst.txt"
+            rel="nofollow">Show Source</a></li>
+    </ul>
+   </div>
+<div id="searchbox" style="display: none" role="search">
+  <h3 id="searchlabel">Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="../search.html" method="get">
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+      <input type="submit" value="Go" />
+    </form>
+    </div>
+</div>
+<script>document.getElementById('searchbox').style.display = "block"</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../genindex.html" title="General Index"
+             >index</a></li>
+        <li class="right" >
+          <a href="../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="right" >
+          <a href="common.html" title="awscrt.common"
+             >next</a> |</li>
+        <li class="right" >
+          <a href="../index.html" title="Welcome to awscrt’s documentation!"
+             >previous</a> |</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">awscrt  documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">awscrt.auth</a></li> 
+      </ul>
+    </div>
+    <div class="footer" role="contentinfo">
+    &#169; Copyright 2020, Amazon Web Services, Inc.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
+    </div>
+  </body>
+</html>
\ No newline at end of file
diff --git a/docs/api/common.html b/docs/api/common.html
new file mode 100644
index 000000000..faf38bcbd
--- /dev/null
+++ b/docs/api/common.html
@@ -0,0 +1,143 @@
+
+
+<!doctype html>
+
+<html lang="en" data-content_root="../">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+
+    <title>awscrt.common &#8212; awscrt  documentation</title>
+    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=649a27d8" />
+    <link rel="stylesheet" type="text/css" href="../_static/css/custom.css?v=93be7416" />
+    
+    <script src="../_static/documentation_options.js?v=5929fcd5"></script>
+    <script src="../_static/doctools.js?v=888ff710"></script>
+    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script src="../_static/bizstyle.js"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" />
+    <link rel="next" title="awscrt.crypto" href="crypto.html" />
+    <link rel="prev" title="awscrt.auth" href="auth.html" />
+    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+    <!--[if lt IE 9]>
+    <script src="_static/css3-mediaqueries.js"></script>
+    <![endif]-->
+  </head><body>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../genindex.html" title="General Index"
+             accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="right" >
+          <a href="crypto.html" title="awscrt.crypto"
+             accesskey="N">next</a> |</li>
+        <li class="right" >
+          <a href="auth.html" title="awscrt.auth"
+             accesskey="P">previous</a> |</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">awscrt  documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">awscrt.common</a></li> 
+      </ul>
+    </div>  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body" role="main">
+            
+  <section id="module-awscrt.common">
+<span id="awscrt-common"></span><h1>awscrt.common<a class="headerlink" href="#module-awscrt.common" title="Link to this heading">¶</a></h1>
+<p>Cross-platform library for <cite>awscrt</cite>.</p>
+<dl class="py function">
+<dt class="sig sig-object py" id="awscrt.common.get_cpu_group_count">
+<span class="sig-prename descclassname"><span class="pre">awscrt.common.</span></span><span class="sig-name descname"><span class="pre">get_cpu_group_count</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></span><a class="headerlink" href="#awscrt.common.get_cpu_group_count" title="Link to this definition">¶</a></dt>
+<dd><p>Returns number of processor groups on the system.</p>
+<p>Useful for working with non-uniform memory access (NUMA) nodes.</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="awscrt.common.get_cpu_count_for_group">
+<span class="sig-prename descclassname"><span class="pre">awscrt.common.</span></span><span class="sig-name descname"><span class="pre">get_cpu_count_for_group</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">group_idx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></span><a class="headerlink" href="#awscrt.common.get_cpu_count_for_group" title="Link to this definition">¶</a></dt>
+<dd><p>Returns number of processors in a given group.</p>
+</dd></dl>
+
+</section>
+
+
+            <div class="clearer"></div>
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+  <div>
+    <h3><a href="../index.html">Table of Contents</a></h3>
+    <ul>
+<li><a class="reference internal" href="#">awscrt.common</a><ul>
+<li><a class="reference internal" href="#awscrt.common.get_cpu_group_count"><code class="docutils literal notranslate"><span class="pre">get_cpu_group_count()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.common.get_cpu_count_for_group"><code class="docutils literal notranslate"><span class="pre">get_cpu_count_for_group()</span></code></a></li>
+</ul>
+</li>
+</ul>
+
+  </div>
+  <div>
+    <h4>Previous topic</h4>
+    <p class="topless"><a href="auth.html"
+                          title="previous chapter">awscrt.auth</a></p>
+  </div>
+  <div>
+    <h4>Next topic</h4>
+    <p class="topless"><a href="crypto.html"
+                          title="next chapter">awscrt.crypto</a></p>
+  </div>
+  <div role="note" aria-label="source link">
+    <h3>This Page</h3>
+    <ul class="this-page-menu">
+      <li><a href="../_sources/api/common.rst.txt"
+            rel="nofollow">Show Source</a></li>
+    </ul>
+   </div>
+<div id="searchbox" style="display: none" role="search">
+  <h3 id="searchlabel">Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="../search.html" method="get">
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+      <input type="submit" value="Go" />
+    </form>
+    </div>
+</div>
+<script>document.getElementById('searchbox').style.display = "block"</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../genindex.html" title="General Index"
+             >index</a></li>
+        <li class="right" >
+          <a href="../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="right" >
+          <a href="crypto.html" title="awscrt.crypto"
+             >next</a> |</li>
+        <li class="right" >
+          <a href="auth.html" title="awscrt.auth"
+             >previous</a> |</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">awscrt  documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">awscrt.common</a></li> 
+      </ul>
+    </div>
+    <div class="footer" role="contentinfo">
+    &#169; Copyright 2020, Amazon Web Services, Inc.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
+    </div>
+  </body>
+</html>
\ No newline at end of file
diff --git a/docs/api/crypto.html b/docs/api/crypto.html
new file mode 100644
index 000000000..bdc292222
--- /dev/null
+++ b/docs/api/crypto.html
@@ -0,0 +1,234 @@
+
+
+<!doctype html>
+
+<html lang="en" data-content_root="../">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+
+    <title>awscrt.crypto &#8212; awscrt  documentation</title>
+    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=649a27d8" />
+    <link rel="stylesheet" type="text/css" href="../_static/css/custom.css?v=93be7416" />
+    
+    <script src="../_static/documentation_options.js?v=5929fcd5"></script>
+    <script src="../_static/doctools.js?v=888ff710"></script>
+    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script src="../_static/bizstyle.js"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" />
+    <link rel="next" title="awscrt.exceptions" href="exceptions.html" />
+    <link rel="prev" title="awscrt.common" href="common.html" />
+    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+    <!--[if lt IE 9]>
+    <script src="_static/css3-mediaqueries.js"></script>
+    <![endif]-->
+  </head><body>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../genindex.html" title="General Index"
+             accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="right" >
+          <a href="exceptions.html" title="awscrt.exceptions"
+             accesskey="N">next</a> |</li>
+        <li class="right" >
+          <a href="common.html" title="awscrt.common"
+             accesskey="P">previous</a> |</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">awscrt  documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">awscrt.crypto</a></li> 
+      </ul>
+    </div>  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body" role="main">
+            
+  <section id="module-awscrt.crypto">
+<span id="awscrt-crypto"></span><h1>awscrt.crypto<a class="headerlink" href="#module-awscrt.crypto" title="Link to this heading">¶</a></h1>
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.crypto.RSAEncryptionAlgorithm">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.crypto.</span></span><span class="sig-name descname"><span class="pre">RSAEncryptionAlgorithm</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.crypto.RSAEncryptionAlgorithm" title="Link to this definition">¶</a></dt>
+<dd><p>RSA Encryption Algorithm</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.crypto.RSAEncryptionAlgorithm.PKCS1_5">
+<span class="sig-name descname"><span class="pre">PKCS1_5</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#awscrt.crypto.RSAEncryptionAlgorithm.PKCS1_5" title="Link to this definition">¶</a></dt>
+<dd><p>PKCSv1.5 padding</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.crypto.RSAEncryptionAlgorithm.OAEP_SHA256">
+<span class="sig-name descname"><span class="pre">OAEP_SHA256</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#awscrt.crypto.RSAEncryptionAlgorithm.OAEP_SHA256" title="Link to this definition">¶</a></dt>
+<dd><p>OAEP padding with sha256 hash function</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.crypto.RSAEncryptionAlgorithm.OAEP_SHA512">
+<span class="sig-name descname"><span class="pre">OAEP_SHA512</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#awscrt.crypto.RSAEncryptionAlgorithm.OAEP_SHA512" title="Link to this definition">¶</a></dt>
+<dd><p>OAEP padding with sha512 hash function</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.crypto.RSASignatureAlgorithm">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.crypto.</span></span><span class="sig-name descname"><span class="pre">RSASignatureAlgorithm</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.crypto.RSASignatureAlgorithm" title="Link to this definition">¶</a></dt>
+<dd><p>RSA Encryption Algorithm</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.crypto.RSASignatureAlgorithm.PKCS1_5_SHA256">
+<span class="sig-name descname"><span class="pre">PKCS1_5_SHA256</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#awscrt.crypto.RSASignatureAlgorithm.PKCS1_5_SHA256" title="Link to this definition">¶</a></dt>
+<dd><p>PKCSv1.5 padding with sha256 hash function</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.crypto.RSASignatureAlgorithm.PSS_SHA256">
+<span class="sig-name descname"><span class="pre">PSS_SHA256</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#awscrt.crypto.RSASignatureAlgorithm.PSS_SHA256" title="Link to this definition">¶</a></dt>
+<dd><p>PSS padding with sha256 hash function</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.crypto.RSA">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.crypto.</span></span><span class="sig-name descname"><span class="pre">RSA</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">binding</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.crypto.RSA" title="Link to this definition">¶</a></dt>
+<dd><dl class="py method">
+<dt class="sig sig-object py" id="awscrt.crypto.RSA.new_private_key_from_pem_data">
+<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">new_private_key_from_pem_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pem_data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.12)"><span class="pre">bytes</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytearray" title="(in Python v3.12)"><span class="pre">bytearray</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#memoryview" title="(in Python v3.12)"><span class="pre">memoryview</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#awscrt.crypto.RSA" title="awscrt.crypto.RSA"><span class="pre">RSA</span></a></span></span><a class="headerlink" href="#awscrt.crypto.RSA.new_private_key_from_pem_data" title="Link to this definition">¶</a></dt>
+<dd><p>Creates a new instance of private RSA key pair from pem data.
+Raises ValueError if pem does not have private key object.</p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.crypto.RSA.new_public_key_from_pem_data">
+<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">new_public_key_from_pem_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pem_data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.12)"><span class="pre">bytes</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytearray" title="(in Python v3.12)"><span class="pre">bytearray</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#memoryview" title="(in Python v3.12)"><span class="pre">memoryview</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#awscrt.crypto.RSA" title="awscrt.crypto.RSA"><span class="pre">RSA</span></a></span></span><a class="headerlink" href="#awscrt.crypto.RSA.new_public_key_from_pem_data" title="Link to this definition">¶</a></dt>
+<dd><p>Creates a new instance of public RSA key pair from pem data.
+Raises ValueError if pem does not have public key object.</p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.crypto.RSA.encrypt">
+<span class="sig-name descname"><span class="pre">encrypt</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">encryption_algorithm</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.crypto.RSAEncryptionAlgorithm" title="awscrt.crypto.RSAEncryptionAlgorithm"><span class="pre">RSAEncryptionAlgorithm</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">plaintext</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.12)"><span class="pre">bytes</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytearray" title="(in Python v3.12)"><span class="pre">bytearray</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#memoryview" title="(in Python v3.12)"><span class="pre">memoryview</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.12)"><span class="pre">bytes</span></a></span></span><a class="headerlink" href="#awscrt.crypto.RSA.encrypt" title="Link to this definition">¶</a></dt>
+<dd><p>Encrypts data using a given algorithm.</p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.crypto.RSA.decrypt">
+<span class="sig-name descname"><span class="pre">decrypt</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">encryption_algorithm</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.crypto.RSAEncryptionAlgorithm" title="awscrt.crypto.RSAEncryptionAlgorithm"><span class="pre">RSAEncryptionAlgorithm</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">ciphertext</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.12)"><span class="pre">bytes</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytearray" title="(in Python v3.12)"><span class="pre">bytearray</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#memoryview" title="(in Python v3.12)"><span class="pre">memoryview</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.12)"><span class="pre">bytes</span></a></span></span><a class="headerlink" href="#awscrt.crypto.RSA.decrypt" title="Link to this definition">¶</a></dt>
+<dd><p>Decrypts data using a given algorithm.</p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.crypto.RSA.sign">
+<span class="sig-name descname"><span class="pre">sign</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">signature_algorithm</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.crypto.RSASignatureAlgorithm" title="awscrt.crypto.RSASignatureAlgorithm"><span class="pre">RSASignatureAlgorithm</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">digest</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.12)"><span class="pre">bytes</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytearray" title="(in Python v3.12)"><span class="pre">bytearray</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#memoryview" title="(in Python v3.12)"><span class="pre">memoryview</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.12)"><span class="pre">bytes</span></a></span></span><a class="headerlink" href="#awscrt.crypto.RSA.sign" title="Link to this definition">¶</a></dt>
+<dd><p>Signs data using a given algorithm.
+Note: function expects digest of the message, ex sha256</p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.crypto.RSA.verify">
+<span class="sig-name descname"><span class="pre">verify</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">signature_algorithm</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.crypto.RSASignatureAlgorithm" title="awscrt.crypto.RSASignatureAlgorithm"><span class="pre">RSASignatureAlgorithm</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">digest</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.12)"><span class="pre">bytes</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytearray" title="(in Python v3.12)"><span class="pre">bytearray</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#memoryview" title="(in Python v3.12)"><span class="pre">memoryview</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">signature</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.12)"><span class="pre">bytes</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytearray" title="(in Python v3.12)"><span class="pre">bytearray</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#memoryview" title="(in Python v3.12)"><span class="pre">memoryview</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a></span></span><a class="headerlink" href="#awscrt.crypto.RSA.verify" title="Link to this definition">¶</a></dt>
+<dd><p>Verifies signature against digest.
+Returns True if signature matches and False if not.</p>
+</dd></dl>
+
+</dd></dl>
+
+</section>
+
+
+            <div class="clearer"></div>
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+  <div>
+    <h3><a href="../index.html">Table of Contents</a></h3>
+    <ul>
+<li><a class="reference internal" href="#">awscrt.crypto</a><ul>
+<li><a class="reference internal" href="#awscrt.crypto.RSAEncryptionAlgorithm"><code class="docutils literal notranslate"><span class="pre">RSAEncryptionAlgorithm</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.crypto.RSAEncryptionAlgorithm.PKCS1_5"><code class="docutils literal notranslate"><span class="pre">PKCS1_5</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.crypto.RSAEncryptionAlgorithm.OAEP_SHA256"><code class="docutils literal notranslate"><span class="pre">OAEP_SHA256</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.crypto.RSAEncryptionAlgorithm.OAEP_SHA512"><code class="docutils literal notranslate"><span class="pre">OAEP_SHA512</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.crypto.RSASignatureAlgorithm"><code class="docutils literal notranslate"><span class="pre">RSASignatureAlgorithm</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.crypto.RSASignatureAlgorithm.PKCS1_5_SHA256"><code class="docutils literal notranslate"><span class="pre">PKCS1_5_SHA256</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.crypto.RSASignatureAlgorithm.PSS_SHA256"><code class="docutils literal notranslate"><span class="pre">PSS_SHA256</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.crypto.RSA"><code class="docutils literal notranslate"><span class="pre">RSA</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.crypto.RSA.new_private_key_from_pem_data"><code class="docutils literal notranslate"><span class="pre">new_private_key_from_pem_data()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.crypto.RSA.new_public_key_from_pem_data"><code class="docutils literal notranslate"><span class="pre">new_public_key_from_pem_data()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.crypto.RSA.encrypt"><code class="docutils literal notranslate"><span class="pre">encrypt()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.crypto.RSA.decrypt"><code class="docutils literal notranslate"><span class="pre">decrypt()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.crypto.RSA.sign"><code class="docutils literal notranslate"><span class="pre">sign()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.crypto.RSA.verify"><code class="docutils literal notranslate"><span class="pre">verify()</span></code></a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+
+  </div>
+  <div>
+    <h4>Previous topic</h4>
+    <p class="topless"><a href="common.html"
+                          title="previous chapter">awscrt.common</a></p>
+  </div>
+  <div>
+    <h4>Next topic</h4>
+    <p class="topless"><a href="exceptions.html"
+                          title="next chapter">awscrt.exceptions</a></p>
+  </div>
+  <div role="note" aria-label="source link">
+    <h3>This Page</h3>
+    <ul class="this-page-menu">
+      <li><a href="../_sources/api/crypto.rst.txt"
+            rel="nofollow">Show Source</a></li>
+    </ul>
+   </div>
+<div id="searchbox" style="display: none" role="search">
+  <h3 id="searchlabel">Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="../search.html" method="get">
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+      <input type="submit" value="Go" />
+    </form>
+    </div>
+</div>
+<script>document.getElementById('searchbox').style.display = "block"</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../genindex.html" title="General Index"
+             >index</a></li>
+        <li class="right" >
+          <a href="../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="right" >
+          <a href="exceptions.html" title="awscrt.exceptions"
+             >next</a> |</li>
+        <li class="right" >
+          <a href="common.html" title="awscrt.common"
+             >previous</a> |</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">awscrt  documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">awscrt.crypto</a></li> 
+      </ul>
+    </div>
+    <div class="footer" role="contentinfo">
+    &#169; Copyright 2020, Amazon Web Services, Inc.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
+    </div>
+  </body>
+</html>
\ No newline at end of file
diff --git a/docs/api/eventstream.html b/docs/api/eventstream.html
new file mode 100644
index 000000000..c0172fa4c
--- /dev/null
+++ b/docs/api/eventstream.html
@@ -0,0 +1,924 @@
+
+
+<!doctype html>
+
+<html lang="en" data-content_root="../">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+
+    <title>awscrt.eventstream &#8212; awscrt  documentation</title>
+    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=649a27d8" />
+    <link rel="stylesheet" type="text/css" href="../_static/css/custom.css?v=93be7416" />
+    
+    <script src="../_static/documentation_options.js?v=5929fcd5"></script>
+    <script src="../_static/doctools.js?v=888ff710"></script>
+    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script src="../_static/bizstyle.js"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" />
+    <link rel="next" title="awscrt.http" href="http.html" />
+    <link rel="prev" title="awscrt.exceptions" href="exceptions.html" />
+    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+    <!--[if lt IE 9]>
+    <script src="_static/css3-mediaqueries.js"></script>
+    <![endif]-->
+  </head><body>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../genindex.html" title="General Index"
+             accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="right" >
+          <a href="http.html" title="awscrt.http"
+             accesskey="N">next</a> |</li>
+        <li class="right" >
+          <a href="exceptions.html" title="awscrt.exceptions"
+             accesskey="P">previous</a> |</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">awscrt  documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">awscrt.eventstream</a></li> 
+      </ul>
+    </div>  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body" role="main">
+            
+  <section id="module-awscrt.eventstream">
+<span id="awscrt-eventstream"></span><h1>awscrt.eventstream<a class="headerlink" href="#module-awscrt.eventstream" title="Link to this heading">¶</a></h1>
+<p>event-stream library for <cite>awscrt</cite>.</p>
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.eventstream.HeaderType">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.eventstream.</span></span><span class="sig-name descname"><span class="pre">HeaderType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.eventstream.HeaderType" title="Link to this definition">¶</a></dt>
+<dd><p>Supported types for the value within a Header</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.eventstream.HeaderType.BOOL_TRUE">
+<span class="sig-name descname"><span class="pre">BOOL_TRUE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#awscrt.eventstream.HeaderType.BOOL_TRUE" title="Link to this definition">¶</a></dt>
+<dd><p>Value is True.</p>
+<p>No actual value is transmitted on the wire.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.eventstream.HeaderType.BOOL_FALSE">
+<span class="sig-name descname"><span class="pre">BOOL_FALSE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#awscrt.eventstream.HeaderType.BOOL_FALSE" title="Link to this definition">¶</a></dt>
+<dd><p>Value is False.</p>
+<p>No actual value is transmitted on the wire.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.eventstream.HeaderType.BYTE">
+<span class="sig-name descname"><span class="pre">BYTE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#awscrt.eventstream.HeaderType.BYTE" title="Link to this definition">¶</a></dt>
+<dd><p>Value is signed 8-bit int.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.eventstream.HeaderType.INT16">
+<span class="sig-name descname"><span class="pre">INT16</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">3</span></em><a class="headerlink" href="#awscrt.eventstream.HeaderType.INT16" title="Link to this definition">¶</a></dt>
+<dd><p>Value is signed 16-bit int.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.eventstream.HeaderType.INT32">
+<span class="sig-name descname"><span class="pre">INT32</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">4</span></em><a class="headerlink" href="#awscrt.eventstream.HeaderType.INT32" title="Link to this definition">¶</a></dt>
+<dd><p>Value is signed 32-bit int.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.eventstream.HeaderType.INT64">
+<span class="sig-name descname"><span class="pre">INT64</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">5</span></em><a class="headerlink" href="#awscrt.eventstream.HeaderType.INT64" title="Link to this definition">¶</a></dt>
+<dd><p>Value is signed 64-bit int.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.eventstream.HeaderType.BYTE_BUF">
+<span class="sig-name descname"><span class="pre">BYTE_BUF</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">6</span></em><a class="headerlink" href="#awscrt.eventstream.HeaderType.BYTE_BUF" title="Link to this definition">¶</a></dt>
+<dd><p>Value is raw bytes.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.eventstream.HeaderType.STRING">
+<span class="sig-name descname"><span class="pre">STRING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">7</span></em><a class="headerlink" href="#awscrt.eventstream.HeaderType.STRING" title="Link to this definition">¶</a></dt>
+<dd><p>Value is a str.</p>
+<p>Transmitted on the wire as utf-8</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.eventstream.HeaderType.TIMESTAMP">
+<span class="sig-name descname"><span class="pre">TIMESTAMP</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">8</span></em><a class="headerlink" href="#awscrt.eventstream.HeaderType.TIMESTAMP" title="Link to this definition">¶</a></dt>
+<dd><p>Value is a posix timestamp (seconds since Unix epoch).</p>
+<p>Transmitted on the wire as a 64-bit int</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.eventstream.HeaderType.UUID">
+<span class="sig-name descname"><span class="pre">UUID</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">9</span></em><a class="headerlink" href="#awscrt.eventstream.HeaderType.UUID" title="Link to this definition">¶</a></dt>
+<dd><p>Value is a UUID.</p>
+<p>Transmitted on the wire as 16 bytes</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.eventstream.Header">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.eventstream.</span></span><span class="sig-name descname"><span class="pre">Header</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.12)"><span class="pre">Any</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">header_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.eventstream.HeaderType" title="awscrt.eventstream.HeaderType"><span class="pre">HeaderType</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.eventstream.Header" title="Link to this definition">¶</a></dt>
+<dd><p>A header in an event-stream message.</p>
+<p>Each header has a name, value, and type.
+<a class="reference internal" href="#awscrt.eventstream.HeaderType" title="awscrt.eventstream.HeaderType"><code class="xref py py-class docutils literal notranslate"><span class="pre">HeaderType</span></code></a> enumerates the supported value types.</p>
+<p>Create a header with one of the Header.from_X() functions.</p>
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.eventstream.Header.from_bool">
+<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_bool</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#awscrt.eventstream.Header" title="awscrt.eventstream.Header"><span class="pre">Header</span></a></span></span><a class="headerlink" href="#awscrt.eventstream.Header.from_bool" title="Link to this definition">¶</a></dt>
+<dd><p>Create a Header of type <a class="reference internal" href="#awscrt.eventstream.HeaderType.BOOL_TRUE" title="awscrt.eventstream.HeaderType.BOOL_TRUE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">BOOL_TRUE</span></code></a> or <a class="reference internal" href="#awscrt.eventstream.HeaderType.BOOL_FALSE" title="awscrt.eventstream.HeaderType.BOOL_FALSE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">BOOL_FALSE</span></code></a></p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.eventstream.Header.from_byte">
+<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_byte</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#awscrt.eventstream.Header" title="awscrt.eventstream.Header"><span class="pre">Header</span></a></span></span><a class="headerlink" href="#awscrt.eventstream.Header.from_byte" title="Link to this definition">¶</a></dt>
+<dd><p>Create a Header of type <a class="reference internal" href="#awscrt.eventstream.HeaderType.BYTE" title="awscrt.eventstream.HeaderType.BYTE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">BYTE</span></code></a></p>
+<p>The value must fit in an 8-bit signed int</p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.eventstream.Header.from_int16">
+<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_int16</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#awscrt.eventstream.Header" title="awscrt.eventstream.Header"><span class="pre">Header</span></a></span></span><a class="headerlink" href="#awscrt.eventstream.Header.from_int16" title="Link to this definition">¶</a></dt>
+<dd><p>Create a Header of type <a class="reference internal" href="#awscrt.eventstream.HeaderType.INT16" title="awscrt.eventstream.HeaderType.INT16"><code class="xref py py-attr docutils literal notranslate"><span class="pre">INT16</span></code></a></p>
+<p>The value must fit in an 16-bit signed int</p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.eventstream.Header.from_int32">
+<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_int32</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#awscrt.eventstream.Header" title="awscrt.eventstream.Header"><span class="pre">Header</span></a></span></span><a class="headerlink" href="#awscrt.eventstream.Header.from_int32" title="Link to this definition">¶</a></dt>
+<dd><p>Create a Header of type <a class="reference internal" href="#awscrt.eventstream.HeaderType.INT32" title="awscrt.eventstream.HeaderType.INT32"><code class="xref py py-attr docutils literal notranslate"><span class="pre">INT32</span></code></a></p>
+<p>The value must fit in an 32-bit signed int</p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.eventstream.Header.from_int64">
+<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_int64</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#awscrt.eventstream.Header" title="awscrt.eventstream.Header"><span class="pre">Header</span></a></span></span><a class="headerlink" href="#awscrt.eventstream.Header.from_int64" title="Link to this definition">¶</a></dt>
+<dd><p>Create a Header of type <a class="reference internal" href="#awscrt.eventstream.HeaderType.INT64" title="awscrt.eventstream.HeaderType.INT64"><code class="xref py py-attr docutils literal notranslate"><span class="pre">INT64</span></code></a></p>
+<p>The value must fit in an 64-bit signed int</p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.eventstream.Header.from_byte_buf">
+<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_byte_buf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.ByteString" title="(in Python v3.12)"><span class="pre">ByteString</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#awscrt.eventstream.Header" title="awscrt.eventstream.Header"><span class="pre">Header</span></a></span></span><a class="headerlink" href="#awscrt.eventstream.Header.from_byte_buf" title="Link to this definition">¶</a></dt>
+<dd><p>Create a Header of type <a class="reference internal" href="#awscrt.eventstream.HeaderType.BYTE_BUF" title="awscrt.eventstream.HeaderType.BYTE_BUF"><code class="xref py py-attr docutils literal notranslate"><span class="pre">BYTE_BUF</span></code></a></p>
+<p>The value must be a bytes-like object</p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.eventstream.Header.from_string">
+<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#awscrt.eventstream.Header" title="awscrt.eventstream.Header"><span class="pre">Header</span></a></span></span><a class="headerlink" href="#awscrt.eventstream.Header.from_string" title="Link to this definition">¶</a></dt>
+<dd><p>Create a Header of type <a class="reference internal" href="#awscrt.eventstream.HeaderType.STRING" title="awscrt.eventstream.HeaderType.STRING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">STRING</span></code></a></p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.eventstream.Header.from_timestamp">
+<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_timestamp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#awscrt.eventstream.Header" title="awscrt.eventstream.Header"><span class="pre">Header</span></a></span></span><a class="headerlink" href="#awscrt.eventstream.Header.from_timestamp" title="Link to this definition">¶</a></dt>
+<dd><p>Create a Header of type <a class="reference internal" href="#awscrt.eventstream.HeaderType.TIMESTAMP" title="awscrt.eventstream.HeaderType.TIMESTAMP"><code class="xref py py-attr docutils literal notranslate"><span class="pre">TIMESTAMP</span></code></a></p>
+<p>Value must be a posix timestamp (seconds since Unix epoch)</p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.eventstream.Header.from_uuid">
+<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_uuid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/uuid.html#uuid.UUID" title="(in Python v3.12)"><span class="pre">UUID</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#awscrt.eventstream.Header" title="awscrt.eventstream.Header"><span class="pre">Header</span></a></span></span><a class="headerlink" href="#awscrt.eventstream.Header.from_uuid" title="Link to this definition">¶</a></dt>
+<dd><p>Create a Header of type <a class="reference internal" href="#awscrt.eventstream.HeaderType.UUID" title="awscrt.eventstream.HeaderType.UUID"><code class="xref py py-attr docutils literal notranslate"><span class="pre">UUID</span></code></a></p>
+<p>The value must be a UUID</p>
+</dd></dl>
+
+<dl class="py property">
+<dt class="sig sig-object py" id="awscrt.eventstream.Header.name">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></em><a class="headerlink" href="#awscrt.eventstream.Header.name" title="Link to this definition">¶</a></dt>
+<dd><p>Header name</p>
+</dd></dl>
+
+<dl class="py property">
+<dt class="sig sig-object py" id="awscrt.eventstream.Header.type">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#awscrt.eventstream.HeaderType" title="awscrt.eventstream.HeaderType"><span class="pre">HeaderType</span></a></em><a class="headerlink" href="#awscrt.eventstream.Header.type" title="Link to this definition">¶</a></dt>
+<dd><p>Header type</p>
+</dd></dl>
+
+<dl class="py property">
+<dt class="sig sig-object py" id="awscrt.eventstream.Header.value">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">value</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.12)"><span class="pre">Any</span></a></em><a class="headerlink" href="#awscrt.eventstream.Header.value" title="Link to this definition">¶</a></dt>
+<dd><p>Header value</p>
+<p>The header’s type determines the value’s type.
+Use the value_as_X() methods for type-checked queries.</p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.eventstream.Header.value_as_bool">
+<span class="sig-name descname"><span class="pre">value_as_bool</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a></span></span><a class="headerlink" href="#awscrt.eventstream.Header.value_as_bool" title="Link to this definition">¶</a></dt>
+<dd><p>Return bool value</p>
+<p>Raises an exception if type is not <a class="reference internal" href="#awscrt.eventstream.HeaderType.BOOL_TRUE" title="awscrt.eventstream.HeaderType.BOOL_TRUE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">BOOL_TRUE</span></code></a> or <a class="reference internal" href="#awscrt.eventstream.HeaderType.BOOL_FALSE" title="awscrt.eventstream.HeaderType.BOOL_FALSE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">BOOL_FALSE</span></code></a></p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.eventstream.Header.value_as_byte">
+<span class="sig-name descname"><span class="pre">value_as_byte</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></span><a class="headerlink" href="#awscrt.eventstream.Header.value_as_byte" title="Link to this definition">¶</a></dt>
+<dd><p>Return value of 8-bit signed int</p>
+<p>Raises an exception if type is not <a class="reference internal" href="#awscrt.eventstream.HeaderType.BYTE" title="awscrt.eventstream.HeaderType.BYTE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">BYTE</span></code></a></p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.eventstream.Header.value_as_int16">
+<span class="sig-name descname"><span class="pre">value_as_int16</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></span><a class="headerlink" href="#awscrt.eventstream.Header.value_as_int16" title="Link to this definition">¶</a></dt>
+<dd><p>Return value of 16-bit signed int</p>
+<p>Raises an exception if type is not <a class="reference internal" href="#awscrt.eventstream.HeaderType.INT16" title="awscrt.eventstream.HeaderType.INT16"><code class="xref py py-attr docutils literal notranslate"><span class="pre">INT16</span></code></a></p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.eventstream.Header.value_as_int32">
+<span class="sig-name descname"><span class="pre">value_as_int32</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></span><a class="headerlink" href="#awscrt.eventstream.Header.value_as_int32" title="Link to this definition">¶</a></dt>
+<dd><p>Return value of 32-bit signed int</p>
+<p>Raises an exception if type is not <a class="reference internal" href="#awscrt.eventstream.HeaderType.INT32" title="awscrt.eventstream.HeaderType.INT32"><code class="xref py py-attr docutils literal notranslate"><span class="pre">INT32</span></code></a></p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.eventstream.Header.value_as_int64">
+<span class="sig-name descname"><span class="pre">value_as_int64</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></span><a class="headerlink" href="#awscrt.eventstream.Header.value_as_int64" title="Link to this definition">¶</a></dt>
+<dd><p>Return value of 64-bit signed int</p>
+<p>Raises an exception if type is not <a class="reference internal" href="#awscrt.eventstream.HeaderType.INT64" title="awscrt.eventstream.HeaderType.INT64"><code class="xref py py-attr docutils literal notranslate"><span class="pre">INT64</span></code></a></p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.eventstream.Header.value_as_byte_buf">
+<span class="sig-name descname"><span class="pre">value_as_byte_buf</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.ByteString" title="(in Python v3.12)"><span class="pre">ByteString</span></a></span></span><a class="headerlink" href="#awscrt.eventstream.Header.value_as_byte_buf" title="Link to this definition">¶</a></dt>
+<dd><p>Return value of bytes</p>
+<p>Raises an exception if type is not <a class="reference internal" href="#awscrt.eventstream.HeaderType.BYTE_BUF" title="awscrt.eventstream.HeaderType.BYTE_BUF"><code class="xref py py-attr docutils literal notranslate"><span class="pre">BYTE_BUF</span></code></a></p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.eventstream.Header.value_as_string">
+<span class="sig-name descname"><span class="pre">value_as_string</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></span><a class="headerlink" href="#awscrt.eventstream.Header.value_as_string" title="Link to this definition">¶</a></dt>
+<dd><p>Return value of string</p>
+<p>Raises an exception if type is not <a class="reference internal" href="#awscrt.eventstream.HeaderType.STRING" title="awscrt.eventstream.HeaderType.STRING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">STRING</span></code></a></p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.eventstream.Header.value_as_timestamp">
+<span class="sig-name descname"><span class="pre">value_as_timestamp</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></span><a class="headerlink" href="#awscrt.eventstream.Header.value_as_timestamp" title="Link to this definition">¶</a></dt>
+<dd><p>Return value of timestamp (seconds since Unix epoch)</p>
+<p>Raises an exception if type is not <a class="reference internal" href="#awscrt.eventstream.HeaderType.TIMESTAMP" title="awscrt.eventstream.HeaderType.TIMESTAMP"><code class="xref py py-attr docutils literal notranslate"><span class="pre">TIMESTAMP</span></code></a></p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.eventstream.Header.value_as_uuid">
+<span class="sig-name descname"><span class="pre">value_as_uuid</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/uuid.html#uuid.UUID" title="(in Python v3.12)"><span class="pre">UUID</span></a></span></span><a class="headerlink" href="#awscrt.eventstream.Header.value_as_uuid" title="Link to this definition">¶</a></dt>
+<dd><p>Return value of UUID</p>
+<p>Raises an exception if type is not <a class="reference internal" href="#awscrt.eventstream.HeaderType.UUID" title="awscrt.eventstream.HeaderType.UUID"><code class="xref py py-attr docutils literal notranslate"><span class="pre">UUID</span></code></a></p>
+</dd></dl>
+
+</dd></dl>
+
+<p id="module-awscrt.eventstream.rpc">event-stream RPC (remote procedure call) protocol library for <cite>awscrt</cite>.</p>
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.eventstream.rpc.MessageType">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.eventstream.rpc.</span></span><span class="sig-name descname"><span class="pre">MessageType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.eventstream.rpc.MessageType" title="Link to this definition">¶</a></dt>
+<dd><p>Types of messages in the event-stream RPC protocol.</p>
+<p>The <a class="reference internal" href="#awscrt.eventstream.rpc.MessageType.APPLICATION_MESSAGE" title="awscrt.eventstream.rpc.MessageType.APPLICATION_MESSAGE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">APPLICATION_MESSAGE</span></code></a> and <a class="reference internal" href="#awscrt.eventstream.rpc.MessageType.APPLICATION_ERROR" title="awscrt.eventstream.rpc.MessageType.APPLICATION_ERROR"><code class="xref py py-attr docutils literal notranslate"><span class="pre">APPLICATION_ERROR</span></code></a> types may only be sent
+on streams, and will never arrive as a protocol message (stream-id 0).</p>
+<p>For all other message types, they may only be sent as protocol messages
+(stream-id 0), and will never arrive as a stream message.</p>
+<p>Different message types expect specific headers and flags, consult documentation.</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.eventstream.rpc.MessageType.APPLICATION_MESSAGE">
+<span class="sig-name descname"><span class="pre">APPLICATION_MESSAGE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#awscrt.eventstream.rpc.MessageType.APPLICATION_MESSAGE" title="Link to this definition">¶</a></dt>
+<dd><p>Application message</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.eventstream.rpc.MessageType.APPLICATION_ERROR">
+<span class="sig-name descname"><span class="pre">APPLICATION_ERROR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#awscrt.eventstream.rpc.MessageType.APPLICATION_ERROR" title="Link to this definition">¶</a></dt>
+<dd><p>Application error</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.eventstream.rpc.MessageType.PING">
+<span class="sig-name descname"><span class="pre">PING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#awscrt.eventstream.rpc.MessageType.PING" title="Link to this definition">¶</a></dt>
+<dd><p>Ping</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.eventstream.rpc.MessageType.PING_RESPONSE">
+<span class="sig-name descname"><span class="pre">PING_RESPONSE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">3</span></em><a class="headerlink" href="#awscrt.eventstream.rpc.MessageType.PING_RESPONSE" title="Link to this definition">¶</a></dt>
+<dd><p>Ping response</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.eventstream.rpc.MessageType.CONNECT">
+<span class="sig-name descname"><span class="pre">CONNECT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">4</span></em><a class="headerlink" href="#awscrt.eventstream.rpc.MessageType.CONNECT" title="Link to this definition">¶</a></dt>
+<dd><p>Connect</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.eventstream.rpc.MessageType.CONNECT_ACK">
+<span class="sig-name descname"><span class="pre">CONNECT_ACK</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">5</span></em><a class="headerlink" href="#awscrt.eventstream.rpc.MessageType.CONNECT_ACK" title="Link to this definition">¶</a></dt>
+<dd><p>Connect acknowledgement</p>
+<p>If the <a class="reference internal" href="#awscrt.eventstream.rpc.MessageFlag.CONNECTION_ACCEPTED" title="awscrt.eventstream.rpc.MessageFlag.CONNECTION_ACCEPTED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">MessageFlag.CONNECTION_ACCEPTED</span></code></a> flag is not present, the connection has been rejected.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.eventstream.rpc.MessageType.PROTOCOL_ERROR">
+<span class="sig-name descname"><span class="pre">PROTOCOL_ERROR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">6</span></em><a class="headerlink" href="#awscrt.eventstream.rpc.MessageType.PROTOCOL_ERROR" title="Link to this definition">¶</a></dt>
+<dd><p>Protocol error</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.eventstream.rpc.MessageType.INTERNAL_ERROR">
+<span class="sig-name descname"><span class="pre">INTERNAL_ERROR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">7</span></em><a class="headerlink" href="#awscrt.eventstream.rpc.MessageType.INTERNAL_ERROR" title="Link to this definition">¶</a></dt>
+<dd><p>Internal error</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.eventstream.rpc.MessageFlag">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.eventstream.rpc.</span></span><span class="sig-name descname"><span class="pre">MessageFlag</span></span><a class="headerlink" href="#awscrt.eventstream.rpc.MessageFlag" title="Link to this definition">¶</a></dt>
+<dd><p>Flags for messages in the event-stream RPC protocol.</p>
+<p>Flags may be XORed together.
+Not all flags can be used with all message types, consult documentation.</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.eventstream.rpc.MessageFlag.NONE">
+<span class="sig-name descname"><span class="pre">NONE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#awscrt.eventstream.rpc.MessageFlag.NONE" title="Link to this definition">¶</a></dt>
+<dd><p>No flags</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.eventstream.rpc.MessageFlag.CONNECTION_ACCEPTED">
+<span class="sig-name descname"><span class="pre">CONNECTION_ACCEPTED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#awscrt.eventstream.rpc.MessageFlag.CONNECTION_ACCEPTED" title="Link to this definition">¶</a></dt>
+<dd><p>Connection accepted</p>
+<p>If this flag is absent from a <a class="reference internal" href="#awscrt.eventstream.rpc.MessageType.CONNECT_ACK" title="awscrt.eventstream.rpc.MessageType.CONNECT_ACK"><code class="xref py py-attr docutils literal notranslate"><span class="pre">MessageType.CONNECT_ACK</span></code></a>, the connection has been rejected.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.eventstream.rpc.MessageFlag.TERMINATE_STREAM">
+<span class="sig-name descname"><span class="pre">TERMINATE_STREAM</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#awscrt.eventstream.rpc.MessageFlag.TERMINATE_STREAM" title="Link to this definition">¶</a></dt>
+<dd><p>Terminate stream</p>
+<p>This message may be used with any message type.
+The sender will close their connection after the message is written to the wire.
+The receiver will close their connection after delivering the message to the user.</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.eventstream.rpc.ClientConnectionHandler">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.eventstream.rpc.</span></span><span class="sig-name descname"><span class="pre">ClientConnectionHandler</span></span><a class="headerlink" href="#awscrt.eventstream.rpc.ClientConnectionHandler" title="Link to this definition">¶</a></dt>
+<dd><p>Base class for handling connection events.</p>
+<p>Inherit from this class and override methods to handle connection events.
+All callbacks for this connection will be invoked on the same thread,
+and <a class="reference internal" href="#awscrt.eventstream.rpc.ClientConnectionHandler.on_connection_setup" title="awscrt.eventstream.rpc.ClientConnectionHandler.on_connection_setup"><code class="xref py py-meth docutils literal notranslate"><span class="pre">on_connection_setup()</span></code></a> will always be the first callback invoked.</p>
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.eventstream.rpc.ClientConnectionHandler.on_connection_setup">
+<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_connection_setup</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">connection</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#awscrt.eventstream.rpc.ClientConnectionHandler.on_connection_setup" title="Link to this definition">¶</a></dt>
+<dd><p>Invoked upon completion of the setup attempt.</p>
+<p>If setup was successful, the connection is provided to the user.</p>
+<p>Note that the network connection stays alive until it is closed,
+even if no local references to the connection object remain.
+The user should store a reference to this connection, and call
+<cite>connection.close()</cite> when they are done with it to avoid leaking
+resources.</p>
+<p>Setup will always be the first callback invoked on the handler.
+If setup failed, no further callbacks will be invoked on this handler.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>connection</strong> – The connection, if setup was successful,
+or None if setup failed.</p></li>
+<li><p><strong>error</strong> – None, if setup was successful, or an Exception
+if setup failed.</p></li>
+<li><p><strong>**kwargs</strong> – Forward compatibility kwargs.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.eventstream.rpc.ClientConnectionHandler.on_connection_shutdown">
+<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_connection_shutdown</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">reason</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.12)"><span class="pre">Exception</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#awscrt.eventstream.rpc.ClientConnectionHandler.on_connection_shutdown" title="Link to this definition">¶</a></dt>
+<dd><p>Invoked when the connection finishes shutting down.</p>
+<p>This event will not be invoked if connection setup failed.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>reason</strong> – Reason will be None if the user initiated the shutdown,
+otherwise the reason will be an Exception.</p></li>
+<li><p><strong>**kwargs</strong> – Forward compatibility kwargs.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.eventstream.rpc.ClientConnectionHandler.on_protocol_message">
+<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_protocol_message</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">headers</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.12)"><span class="pre">Sequence</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#awscrt.eventstream.Header" title="awscrt.eventstream.Header"><span class="pre">Header</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">payload</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.12)"><span class="pre">bytes</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">message_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.eventstream.rpc.MessageType" title="awscrt.eventstream.rpc.MessageType"><span class="pre">MessageType</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">flags</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#awscrt.eventstream.rpc.ClientConnectionHandler.on_protocol_message" title="Link to this definition">¶</a></dt>
+<dd><p>Invoked when a message for the connection (stream-id 0) is received.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>headers</strong> – Message headers.</p></li>
+<li><p><strong>payload</strong> – Binary message payload.</p></li>
+<li><p><strong>message_type</strong> – Message type.</p></li>
+<li><p><strong>flags</strong> – Message flags. Values from <a class="reference internal" href="#awscrt.eventstream.rpc.MessageFlag" title="awscrt.eventstream.rpc.MessageFlag"><code class="xref py py-class docutils literal notranslate"><span class="pre">MessageFlag</span></code></a> may be
+XORed together. Not all flags can be used with all message
+types, consult documentation.</p></li>
+<li><p><strong>**kwargs</strong> – Forward compatibility kwargs.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.eventstream.rpc.ClientConnection">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.eventstream.rpc.</span></span><span class="sig-name descname"><span class="pre">ClientConnection</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">handler</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.eventstream.rpc.ClientConnection" title="Link to this definition">¶</a></dt>
+<dd><p>A client connection for the event-stream RPC protocol.</p>
+<p>Use <a class="reference internal" href="#awscrt.eventstream.rpc.ClientConnection.connect" title="awscrt.eventstream.rpc.ClientConnection.connect"><code class="xref py py-meth docutils literal notranslate"><span class="pre">ClientConnection.connect()</span></code></a> to establish a new
+connection.</p>
+<p>Note that the network connection stays alive until it is closed,
+even if no local references to the connection object remain.
+The user should store a reference to any connections, and call
+<a class="reference internal" href="#awscrt.eventstream.rpc.ClientConnection.close" title="awscrt.eventstream.rpc.ClientConnection.close"><code class="xref py py-meth docutils literal notranslate"><span class="pre">close()</span></code></a> when they are done with them to avoid leaking resources.</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.eventstream.rpc.ClientConnection.host_name">
+<span class="sig-name descname"><span class="pre">host_name</span></span><a class="headerlink" href="#awscrt.eventstream.rpc.ClientConnection.host_name" title="Link to this definition">¶</a></dt>
+<dd><p>Remote host name.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.eventstream.rpc.ClientConnection.port">
+<span class="sig-name descname"><span class="pre">port</span></span><a class="headerlink" href="#awscrt.eventstream.rpc.ClientConnection.port" title="Link to this definition">¶</a></dt>
+<dd><p>Remote port.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)">int</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.eventstream.rpc.ClientConnection.shutdown_future">
+<span class="sig-name descname"><span class="pre">shutdown_future</span></span><a class="headerlink" href="#awscrt.eventstream.rpc.ClientConnection.shutdown_future" title="Link to this definition">¶</a></dt>
+<dd><p>Completes when this
+connection has finished shutting down. Future will contain a
+result of None, or an exception indicating why shutdown occurred.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.Future" title="(in Python v3.12)">concurrent.futures.Future</a>[None]</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.eventstream.rpc.ClientConnection.connect">
+<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">connect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">handler</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.eventstream.rpc.ClientConnectionHandler" title="awscrt.eventstream.rpc.ClientConnectionHandler"><span class="pre">ClientConnectionHandler</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">host_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">bootstrap</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="io.html#awscrt.io.ClientBootstrap" title="awscrt.io.ClientBootstrap"><span class="pre">ClientBootstrap</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">socket_options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="io.html#awscrt.io.SocketOptions" title="awscrt.io.SocketOptions"><span class="pre">SocketOptions</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tls_connection_options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="io.html#awscrt.io.TlsConnectionOptions" title="awscrt.io.TlsConnectionOptions"><span class="pre">TlsConnectionOptions</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.Future" title="(in Python v3.12)"><span class="pre">concurrent.futures.Future</span></a></span></span><a class="headerlink" href="#awscrt.eventstream.rpc.ClientConnection.connect" title="Link to this definition">¶</a></dt>
+<dd><p>Asynchronously establish a new ClientConnection.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>handler</strong> – Handler for connection events.</p></li>
+<li><p><strong>host_name</strong> – Connect to host.</p></li>
+<li><p><strong>port</strong> – Connect to port.</p></li>
+<li><p><strong>bootstrap</strong> – Client bootstrap to use when initiating socket connection.
+If None is provided, the default singleton is used.</p></li>
+<li><p><strong>socket_options</strong> – Optional socket options.
+If None is provided, then default options are used.</p></li>
+<li><p><strong>tls_connection_options</strong> – Optional TLS
+connection options. If None is provided, then the connection will
+be attempted over plain-text.</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p><em>concurrent.futures.Future</em> – A Future which completes when the connection succeeds or fails.
+If successful, the Future will contain None.
+Otherwise it will contain an exception.
+If the connection is successful, it will be made available via
+the handler’s on_connection_setup callback.
+Note that this network connection stays alive until it is closed,
+even if no local references to the connection object remain.
+The user should store a reference to any connections, and call
+<a class="reference internal" href="#awscrt.eventstream.rpc.ClientConnection.close" title="awscrt.eventstream.rpc.ClientConnection.close"><code class="xref py py-meth docutils literal notranslate"><span class="pre">close()</span></code></a> when they are done with them to avoid leaking resources.</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.eventstream.rpc.ClientConnection.close">
+<span class="sig-name descname"><span class="pre">close</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.eventstream.rpc.ClientConnection.close" title="Link to this definition">¶</a></dt>
+<dd><p>Close the connection.</p>
+<p>Shutdown is asynchronous. This call has no effect if the connection is
+already closed or closing.</p>
+<p>Note that, if the network connection hasn’t already ended,
+<cite>close()</cite> MUST be called to avoid leaking resources. The network
+connection will not terminate simply because there are no references
+to the connection object.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p><em>concurrent.futures.Future</em> – This connection’s <a class="reference internal" href="#awscrt.eventstream.rpc.ClientConnection.shutdown_future" title="awscrt.eventstream.rpc.ClientConnection.shutdown_future"><code class="xref py py-attr docutils literal notranslate"><span class="pre">shutdown_future</span></code></a>,
+which completes when shutdown has finished.</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.eventstream.rpc.ClientConnection.is_open">
+<span class="sig-name descname"><span class="pre">is_open</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.eventstream.rpc.ClientConnection.is_open" title="Link to this definition">¶</a></dt>
+<dd><dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p><em>bool</em> – True if this connection is open and usable, False otherwise.
+Check <a class="reference internal" href="#awscrt.eventstream.rpc.ClientConnection.shutdown_future" title="awscrt.eventstream.rpc.ClientConnection.shutdown_future"><code class="xref py py-attr docutils literal notranslate"><span class="pre">shutdown_future</span></code></a> to know when the connection is completely
+finished shutting down.</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.eventstream.rpc.ClientConnection.send_protocol_message">
+<span class="sig-name descname"><span class="pre">send_protocol_message</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">headers</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.12)"><span class="pre">Sequence</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#awscrt.eventstream.Header" title="awscrt.eventstream.Header"><span class="pre">Header</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">payload</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.ByteString" title="(in Python v3.12)"><span class="pre">ByteString</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.eventstream.rpc.MessageType" title="awscrt.eventstream.rpc.MessageType"><span class="pre">MessageType</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">flags</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">on_flush</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.12)"><span class="pre">Callable</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.Future" title="(in Python v3.12)"><span class="pre">concurrent.futures.Future</span></a></span></span><a class="headerlink" href="#awscrt.eventstream.rpc.ClientConnection.send_protocol_message" title="Link to this definition">¶</a></dt>
+<dd><p>Send a protocol message.</p>
+<p>Protocol messages use stream-id 0.</p>
+<p>Use the returned future, or the <cite>on_flush</cite> callback, to be informed
+when the message is successfully written to the wire, or fails to send.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Keyword Arguments<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>headers</strong> – Message headers.</p></li>
+<li><p><strong>payload</strong> – Binary message payload.</p></li>
+<li><p><strong>message_type</strong> – Message type.</p></li>
+<li><p><strong>flags</strong> – Message flags. Values from <a class="reference internal" href="#awscrt.eventstream.rpc.MessageFlag" title="awscrt.eventstream.rpc.MessageFlag"><code class="xref py py-class docutils literal notranslate"><span class="pre">MessageFlag</span></code></a> may be
+XORed together. Not all flags can be used with all message
+types, consult documentation.</p></li>
+<li><p><strong>on_flush</strong> – <p>Callback invoked when the message is successfully written
+to the wire, or fails to send. The function should take the
+following arguments and return nothing:</p>
+<blockquote>
+<div><ul>
+<li><p><cite>error</cite> (Optional[Exception]): None if the message was
+successfully written to the wire, or an Exception
+if it failed to send.</p></li>
+<li><p><cite>**kwargs</cite> (dict): Forward compatibility kwargs.</p></li>
+</ul>
+</div></blockquote>
+<p>This callback is always invoked on the connection’s event-loop
+thread.</p>
+</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>A future which completes with a result of None if the
+message is successfully written to the wire,
+or an exception if the message fails to send.</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.eventstream.rpc.ClientConnection.new_stream">
+<span class="sig-name descname"><span class="pre">new_stream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">handler</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.eventstream.rpc.ClientContinuationHandler" title="awscrt.eventstream.rpc.ClientContinuationHandler"><span class="pre">ClientContinuationHandler</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#awscrt.eventstream.rpc.ClientContinuation" title="awscrt.eventstream.rpc.ClientContinuation"><span class="pre">ClientContinuation</span></a></span></span><a class="headerlink" href="#awscrt.eventstream.rpc.ClientConnection.new_stream" title="Link to this definition">¶</a></dt>
+<dd><p>Create a new stream.</p>
+<p>The stream will send no data until <a class="reference internal" href="#awscrt.eventstream.rpc.ClientContinuation.activate" title="awscrt.eventstream.rpc.ClientContinuation.activate"><code class="xref py py-meth docutils literal notranslate"><span class="pre">ClientContinuation.activate()</span></code></a>
+is called. Call activate() when you’re ready for callbacks and events to fire.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>handler</strong> – Handler to process continuation messages and state changes.</p>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>The new continuation object.</p>
+</dd>
+</dl>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.eventstream.rpc.ClientContinuation">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.eventstream.rpc.</span></span><span class="sig-name descname"><span class="pre">ClientContinuation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">handler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">connection</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.eventstream.rpc.ClientContinuation" title="Link to this definition">¶</a></dt>
+<dd><p>A continuation of messages on a given stream-id.</p>
+<p>Create with <a class="reference internal" href="#awscrt.eventstream.rpc.ClientConnection.new_stream" title="awscrt.eventstream.rpc.ClientConnection.new_stream"><code class="xref py py-meth docutils literal notranslate"><span class="pre">ClientConnection.new_stream()</span></code></a>.</p>
+<p>The stream will send no data until <a class="reference internal" href="#awscrt.eventstream.rpc.ClientContinuation.activate" title="awscrt.eventstream.rpc.ClientContinuation.activate"><code class="xref py py-meth docutils literal notranslate"><span class="pre">ClientContinuation.activate()</span></code></a>
+is called. Call activate() when you’re ready for callbacks and events to fire.</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.eventstream.rpc.ClientContinuation.connection">
+<span class="sig-name descname"><span class="pre">connection</span></span><a class="headerlink" href="#awscrt.eventstream.rpc.ClientContinuation.connection" title="Link to this definition">¶</a></dt>
+<dd><p>This stream’s connection.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference internal" href="#awscrt.eventstream.rpc.ClientConnection" title="awscrt.eventstream.rpc.ClientConnection">ClientConnection</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.eventstream.rpc.ClientContinuation.closed_future">
+<span class="sig-name descname"><span class="pre">closed_future</span></span><a class="headerlink" href="#awscrt.eventstream.rpc.ClientContinuation.closed_future" title="Link to this definition">¶</a></dt>
+<dd><p>Future which completes with a result of None
+when the continuation has closed.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.Future" title="(in Python v3.12)">concurrent.futures.Future</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.eventstream.rpc.ClientContinuation.activate">
+<span class="sig-name descname"><span class="pre">activate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">operation</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">headers</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.12)"><span class="pre">Sequence</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#awscrt.eventstream.Header" title="awscrt.eventstream.Header"><span class="pre">Header</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">payload</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.ByteString" title="(in Python v3.12)"><span class="pre">ByteString</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.eventstream.rpc.MessageType" title="awscrt.eventstream.rpc.MessageType"><span class="pre">MessageType</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">flags</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">on_flush</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.12)"><span class="pre">Callable</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.eventstream.rpc.ClientContinuation.activate" title="Link to this definition">¶</a></dt>
+<dd><p>Activate the stream by sending its first message.</p>
+<p>Use the returned future, or the <cite>on_flush</cite> callback, to be informed
+when the message is successfully written to the wire, or fails to send.</p>
+<p>activate() may only be called once, use send_message() to write further
+messages on this stream-id.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Keyword Arguments<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>operation</strong> – Operation name for this stream.</p></li>
+<li><p><strong>headers</strong> – Message headers.</p></li>
+<li><p><strong>payload</strong> – Binary message payload.</p></li>
+<li><p><strong>message_type</strong> – Message type.</p></li>
+<li><p><strong>flags</strong> – Message flags. Values from <a class="reference internal" href="#awscrt.eventstream.rpc.MessageFlag" title="awscrt.eventstream.rpc.MessageFlag"><code class="xref py py-class docutils literal notranslate"><span class="pre">MessageFlag</span></code></a> may be
+XORed together. Not all flags can be used with all message
+types, consult documentation.</p></li>
+<li><p><strong>on_flush</strong> – <p>Callback invoked when the message is successfully written
+to the wire, or fails to send. The function should take the
+following arguments and return nothing:</p>
+<blockquote>
+<div><ul>
+<li><p><cite>error</cite> (Optional[Exception]): None if the message was
+successfully written to the wire, or an Exception
+if it failed to send.</p></li>
+<li><p><cite>**kwargs</cite> (dict): Forward compatibility kwargs.</p></li>
+</ul>
+</div></blockquote>
+<p>This callback is always invoked on the connection’s event-loop
+thread.</p>
+</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>A future which completes with a result of None if the
+message is successfully written to the wire,
+or an exception if the message fails to send.</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.eventstream.rpc.ClientContinuation.send_message">
+<span class="sig-name descname"><span class="pre">send_message</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">headers</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.12)"><span class="pre">Sequence</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#awscrt.eventstream.Header" title="awscrt.eventstream.Header"><span class="pre">Header</span></a><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">payload</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.ByteString" title="(in Python v3.12)"><span class="pre">ByteString</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.eventstream.rpc.MessageType" title="awscrt.eventstream.rpc.MessageType"><span class="pre">MessageType</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">flags</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">on_flush</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.12)"><span class="pre">Callable</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.Future" title="(in Python v3.12)"><span class="pre">concurrent.futures.Future</span></a></span></span><a class="headerlink" href="#awscrt.eventstream.rpc.ClientContinuation.send_message" title="Link to this definition">¶</a></dt>
+<dd><p>Send a continuation message.</p>
+<p>Use the returned future, or the <cite>on_flush</cite> callback, to be informed
+when the message is successfully written to the wire, or fails to send.</p>
+<p>Note that the the first message on a stream-id must be sent with activate(),
+send_message() is for all messages that follow.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Keyword Arguments<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>operation</strong> – Operation name for this stream.</p></li>
+<li><p><strong>headers</strong> – Message headers.</p></li>
+<li><p><strong>payload</strong> – Binary message payload.</p></li>
+<li><p><strong>message_type</strong> – Message type.</p></li>
+<li><p><strong>flags</strong> – Message flags. Values from <a class="reference internal" href="#awscrt.eventstream.rpc.MessageFlag" title="awscrt.eventstream.rpc.MessageFlag"><code class="xref py py-class docutils literal notranslate"><span class="pre">MessageFlag</span></code></a> may be
+XORed together. Not all flags can be used with all message
+types, consult documentation.</p></li>
+<li><p><strong>on_flush</strong> – <p>Callback invoked when the message is successfully written
+to the wire, or fails to send. The function should take the
+following arguments and return nothing:</p>
+<blockquote>
+<div><ul>
+<li><p><cite>error</cite> (Optional[Exception]): None if the message was
+successfully written to the wire, or an Exception
+if it failed to send.</p></li>
+<li><p><cite>**kwargs</cite> (dict): Forward compatibility kwargs.</p></li>
+</ul>
+</div></blockquote>
+<p>This callback is always invoked on the connection’s event-loop
+thread.</p>
+</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>A future which completes with a result of None if the
+message is successfully written to the wire,
+or an exception if the message fails to send.</p>
+</dd>
+</dl>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.eventstream.rpc.ClientContinuationHandler">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.eventstream.rpc.</span></span><span class="sig-name descname"><span class="pre">ClientContinuationHandler</span></span><a class="headerlink" href="#awscrt.eventstream.rpc.ClientContinuationHandler" title="Link to this definition">¶</a></dt>
+<dd><p>Base class for handling stream continuation events.</p>
+<p>Inherit from this class and override methods to handle events.
+All callbacks will be invoked on the same thread (the same thread used by
+the connection).</p>
+<p>A common pattern is to store the continuation within its handler.
+Example:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">continuation_handler</span><span class="o">.</span><span class="n">continuation</span> <span class="o">=</span> <span class="n">connection</span><span class="o">.</span><span class="n">new_stream</span><span class="p">(</span><span class="n">continuation_handler</span><span class="p">)</span>
+</pre></div>
+</div>
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.eventstream.rpc.ClientContinuationHandler.on_continuation_message">
+<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_continuation_message</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">headers</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.12)"><span class="pre">Sequence</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#awscrt.eventstream.Header" title="awscrt.eventstream.Header"><span class="pre">Header</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">payload</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.12)"><span class="pre">bytes</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">message_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.eventstream.rpc.MessageType" title="awscrt.eventstream.rpc.MessageType"><span class="pre">MessageType</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">flags</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#awscrt.eventstream.rpc.ClientContinuationHandler.on_continuation_message" title="Link to this definition">¶</a></dt>
+<dd><p>Invoked when a message is received on this continuation.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>headers</strong> – Message headers.</p></li>
+<li><p><strong>payload</strong> – Binary message payload.</p></li>
+<li><p><strong>message_type</strong> – Message type.</p></li>
+<li><p><strong>flags</strong> – Message flags. Values from <a class="reference internal" href="#awscrt.eventstream.rpc.MessageFlag" title="awscrt.eventstream.rpc.MessageFlag"><code class="xref py py-class docutils literal notranslate"><span class="pre">MessageFlag</span></code></a> may be
+XORed together. Not all flags can be used with all message
+types, consult documentation.</p></li>
+<li><p><strong>**kwargs</strong> – Forward compatibility kwargs.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.eventstream.rpc.ClientContinuationHandler.on_continuation_closed">
+<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_continuation_closed</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#awscrt.eventstream.rpc.ClientContinuationHandler.on_continuation_closed" title="Link to this definition">¶</a></dt>
+<dd><p>Invoked when the continuation is closed.</p>
+<p>Once the continuation is closed, no more messages may be sent or received.
+The continuation is closed when a message is sent or received with
+the TERMINATE_STREAM flag, or when the connection shuts down.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>**kwargs</strong> – Forward compatibility kwargs.</p>
+</dd>
+</dl>
+</dd></dl>
+
+</dd></dl>
+
+</section>
+
+
+            <div class="clearer"></div>
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+  <div>
+    <h3><a href="../index.html">Table of Contents</a></h3>
+    <ul>
+<li><a class="reference internal" href="#">awscrt.eventstream</a><ul>
+<li><a class="reference internal" href="#awscrt.eventstream.HeaderType"><code class="docutils literal notranslate"><span class="pre">HeaderType</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.eventstream.HeaderType.BOOL_TRUE"><code class="docutils literal notranslate"><span class="pre">BOOL_TRUE</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.HeaderType.BOOL_FALSE"><code class="docutils literal notranslate"><span class="pre">BOOL_FALSE</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.HeaderType.BYTE"><code class="docutils literal notranslate"><span class="pre">BYTE</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.HeaderType.INT16"><code class="docutils literal notranslate"><span class="pre">INT16</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.HeaderType.INT32"><code class="docutils literal notranslate"><span class="pre">INT32</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.HeaderType.INT64"><code class="docutils literal notranslate"><span class="pre">INT64</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.HeaderType.BYTE_BUF"><code class="docutils literal notranslate"><span class="pre">BYTE_BUF</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.HeaderType.STRING"><code class="docutils literal notranslate"><span class="pre">STRING</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.HeaderType.TIMESTAMP"><code class="docutils literal notranslate"><span class="pre">TIMESTAMP</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.HeaderType.UUID"><code class="docutils literal notranslate"><span class="pre">UUID</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.eventstream.Header"><code class="docutils literal notranslate"><span class="pre">Header</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.eventstream.Header.from_bool"><code class="docutils literal notranslate"><span class="pre">from_bool()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.Header.from_byte"><code class="docutils literal notranslate"><span class="pre">from_byte()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.Header.from_int16"><code class="docutils literal notranslate"><span class="pre">from_int16()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.Header.from_int32"><code class="docutils literal notranslate"><span class="pre">from_int32()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.Header.from_int64"><code class="docutils literal notranslate"><span class="pre">from_int64()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.Header.from_byte_buf"><code class="docutils literal notranslate"><span class="pre">from_byte_buf()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.Header.from_string"><code class="docutils literal notranslate"><span class="pre">from_string()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.Header.from_timestamp"><code class="docutils literal notranslate"><span class="pre">from_timestamp()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.Header.from_uuid"><code class="docutils literal notranslate"><span class="pre">from_uuid()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.Header.name"><code class="docutils literal notranslate"><span class="pre">name</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.Header.type"><code class="docutils literal notranslate"><span class="pre">type</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.Header.value"><code class="docutils literal notranslate"><span class="pre">value</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.Header.value_as_bool"><code class="docutils literal notranslate"><span class="pre">value_as_bool()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.Header.value_as_byte"><code class="docutils literal notranslate"><span class="pre">value_as_byte()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.Header.value_as_int16"><code class="docutils literal notranslate"><span class="pre">value_as_int16()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.Header.value_as_int32"><code class="docutils literal notranslate"><span class="pre">value_as_int32()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.Header.value_as_int64"><code class="docutils literal notranslate"><span class="pre">value_as_int64()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.Header.value_as_byte_buf"><code class="docutils literal notranslate"><span class="pre">value_as_byte_buf()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.Header.value_as_string"><code class="docutils literal notranslate"><span class="pre">value_as_string()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.Header.value_as_timestamp"><code class="docutils literal notranslate"><span class="pre">value_as_timestamp()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.Header.value_as_uuid"><code class="docutils literal notranslate"><span class="pre">value_as_uuid()</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.eventstream.rpc.MessageType"><code class="docutils literal notranslate"><span class="pre">MessageType</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.eventstream.rpc.MessageType.APPLICATION_MESSAGE"><code class="docutils literal notranslate"><span class="pre">APPLICATION_MESSAGE</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.rpc.MessageType.APPLICATION_ERROR"><code class="docutils literal notranslate"><span class="pre">APPLICATION_ERROR</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.rpc.MessageType.PING"><code class="docutils literal notranslate"><span class="pre">PING</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.rpc.MessageType.PING_RESPONSE"><code class="docutils literal notranslate"><span class="pre">PING_RESPONSE</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.rpc.MessageType.CONNECT"><code class="docutils literal notranslate"><span class="pre">CONNECT</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.rpc.MessageType.CONNECT_ACK"><code class="docutils literal notranslate"><span class="pre">CONNECT_ACK</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.rpc.MessageType.PROTOCOL_ERROR"><code class="docutils literal notranslate"><span class="pre">PROTOCOL_ERROR</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.rpc.MessageType.INTERNAL_ERROR"><code class="docutils literal notranslate"><span class="pre">INTERNAL_ERROR</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.eventstream.rpc.MessageFlag"><code class="docutils literal notranslate"><span class="pre">MessageFlag</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.eventstream.rpc.MessageFlag.NONE"><code class="docutils literal notranslate"><span class="pre">NONE</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.rpc.MessageFlag.CONNECTION_ACCEPTED"><code class="docutils literal notranslate"><span class="pre">CONNECTION_ACCEPTED</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.rpc.MessageFlag.TERMINATE_STREAM"><code class="docutils literal notranslate"><span class="pre">TERMINATE_STREAM</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.eventstream.rpc.ClientConnectionHandler"><code class="docutils literal notranslate"><span class="pre">ClientConnectionHandler</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.eventstream.rpc.ClientConnectionHandler.on_connection_setup"><code class="docutils literal notranslate"><span class="pre">on_connection_setup()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.rpc.ClientConnectionHandler.on_connection_shutdown"><code class="docutils literal notranslate"><span class="pre">on_connection_shutdown()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.rpc.ClientConnectionHandler.on_protocol_message"><code class="docutils literal notranslate"><span class="pre">on_protocol_message()</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.eventstream.rpc.ClientConnection"><code class="docutils literal notranslate"><span class="pre">ClientConnection</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.eventstream.rpc.ClientConnection.host_name"><code class="docutils literal notranslate"><span class="pre">host_name</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.rpc.ClientConnection.port"><code class="docutils literal notranslate"><span class="pre">port</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.rpc.ClientConnection.shutdown_future"><code class="docutils literal notranslate"><span class="pre">shutdown_future</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.rpc.ClientConnection.connect"><code class="docutils literal notranslate"><span class="pre">connect()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.rpc.ClientConnection.close"><code class="docutils literal notranslate"><span class="pre">close()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.rpc.ClientConnection.is_open"><code class="docutils literal notranslate"><span class="pre">is_open()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.rpc.ClientConnection.send_protocol_message"><code class="docutils literal notranslate"><span class="pre">send_protocol_message()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.rpc.ClientConnection.new_stream"><code class="docutils literal notranslate"><span class="pre">new_stream()</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.eventstream.rpc.ClientContinuation"><code class="docutils literal notranslate"><span class="pre">ClientContinuation</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.eventstream.rpc.ClientContinuation.connection"><code class="docutils literal notranslate"><span class="pre">connection</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.rpc.ClientContinuation.closed_future"><code class="docutils literal notranslate"><span class="pre">closed_future</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.rpc.ClientContinuation.activate"><code class="docutils literal notranslate"><span class="pre">activate()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.rpc.ClientContinuation.send_message"><code class="docutils literal notranslate"><span class="pre">send_message()</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.eventstream.rpc.ClientContinuationHandler"><code class="docutils literal notranslate"><span class="pre">ClientContinuationHandler</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.eventstream.rpc.ClientContinuationHandler.on_continuation_message"><code class="docutils literal notranslate"><span class="pre">on_continuation_message()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.eventstream.rpc.ClientContinuationHandler.on_continuation_closed"><code class="docutils literal notranslate"><span class="pre">on_continuation_closed()</span></code></a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+
+  </div>
+  <div>
+    <h4>Previous topic</h4>
+    <p class="topless"><a href="exceptions.html"
+                          title="previous chapter">awscrt.exceptions</a></p>
+  </div>
+  <div>
+    <h4>Next topic</h4>
+    <p class="topless"><a href="http.html"
+                          title="next chapter">awscrt.http</a></p>
+  </div>
+  <div role="note" aria-label="source link">
+    <h3>This Page</h3>
+    <ul class="this-page-menu">
+      <li><a href="../_sources/api/eventstream.rst.txt"
+            rel="nofollow">Show Source</a></li>
+    </ul>
+   </div>
+<div id="searchbox" style="display: none" role="search">
+  <h3 id="searchlabel">Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="../search.html" method="get">
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+      <input type="submit" value="Go" />
+    </form>
+    </div>
+</div>
+<script>document.getElementById('searchbox').style.display = "block"</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../genindex.html" title="General Index"
+             >index</a></li>
+        <li class="right" >
+          <a href="../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="right" >
+          <a href="http.html" title="awscrt.http"
+             >next</a> |</li>
+        <li class="right" >
+          <a href="exceptions.html" title="awscrt.exceptions"
+             >previous</a> |</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">awscrt  documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">awscrt.eventstream</a></li> 
+      </ul>
+    </div>
+    <div class="footer" role="contentinfo">
+    &#169; Copyright 2020, Amazon Web Services, Inc.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
+    </div>
+  </body>
+</html>
\ No newline at end of file
diff --git a/docs/api/exceptions.html b/docs/api/exceptions.html
new file mode 100644
index 000000000..9ca6cad03
--- /dev/null
+++ b/docs/api/exceptions.html
@@ -0,0 +1,199 @@
+
+
+<!doctype html>
+
+<html lang="en" data-content_root="../">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+
+    <title>awscrt.exceptions &#8212; awscrt  documentation</title>
+    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=649a27d8" />
+    <link rel="stylesheet" type="text/css" href="../_static/css/custom.css?v=93be7416" />
+    
+    <script src="../_static/documentation_options.js?v=5929fcd5"></script>
+    <script src="../_static/doctools.js?v=888ff710"></script>
+    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script src="../_static/bizstyle.js"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" />
+    <link rel="next" title="awscrt.eventstream" href="eventstream.html" />
+    <link rel="prev" title="awscrt.crypto" href="crypto.html" />
+    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+    <!--[if lt IE 9]>
+    <script src="_static/css3-mediaqueries.js"></script>
+    <![endif]-->
+  </head><body>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../genindex.html" title="General Index"
+             accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="right" >
+          <a href="eventstream.html" title="awscrt.eventstream"
+             accesskey="N">next</a> |</li>
+        <li class="right" >
+          <a href="crypto.html" title="awscrt.crypto"
+             accesskey="P">previous</a> |</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">awscrt  documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">awscrt.exceptions</a></li> 
+      </ul>
+    </div>  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body" role="main">
+            
+  <section id="module-awscrt.exceptions">
+<span id="awscrt-exceptions"></span><h1>awscrt.exceptions<a class="headerlink" href="#module-awscrt.exceptions" title="Link to this heading">¶</a></h1>
+<dl class="py function">
+<dt class="sig sig-object py" id="awscrt.exceptions.from_code">
+<span class="sig-prename descclassname"><span class="pre">awscrt.exceptions.</span></span><span class="sig-name descname"><span class="pre">from_code</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">code</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.exceptions.from_code" title="Link to this definition">¶</a></dt>
+<dd><p>Given an AWS Common Runtime error code, return an exception.</p>
+<p>Returns a common Python exception type, if it’s appropriate.
+For example, <cite>code=1</cite> aka <cite>AWS_ERROR_OOM</cite> will result in <cite>MemoryError</cite>.
+Otherwise, an <a class="reference internal" href="#awscrt.exceptions.AwsCrtError" title="awscrt.exceptions.AwsCrtError"><code class="xref py py-class docutils literal notranslate"><span class="pre">AwsCrtError</span></code></a> is returned.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>code</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – error code.</p>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p><em>BaseException</em></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py exception">
+<dt class="sig sig-object py" id="awscrt.exceptions.AwsCrtError">
+<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.exceptions.</span></span><span class="sig-name descname"><span class="pre">AwsCrtError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">code</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.exceptions.AwsCrtError" title="Link to this definition">¶</a></dt>
+<dd><p>Base exception class for AWS Common Runtime exceptions.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>code</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – Int value of error.</p></li>
+<li><p><strong>name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Name of error.</p></li>
+<li><p><strong>message</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Message about error.</p></li>
+</ul>
+</dd>
+</dl>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.exceptions.AwsCrtError.code">
+<span class="sig-name descname"><span class="pre">code</span></span><a class="headerlink" href="#awscrt.exceptions.AwsCrtError.code" title="Link to this definition">¶</a></dt>
+<dd><p>Int value of error.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)">int</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.exceptions.AwsCrtError.name">
+<span class="sig-name descname"><span class="pre">name</span></span><a class="headerlink" href="#awscrt.exceptions.AwsCrtError.name" title="Link to this definition">¶</a></dt>
+<dd><p>Name of error.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.exceptions.AwsCrtError.message">
+<span class="sig-name descname"><span class="pre">message</span></span><a class="headerlink" href="#awscrt.exceptions.AwsCrtError.message" title="Link to this definition">¶</a></dt>
+<dd><p>Message about error.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+</dd></dl>
+
+</section>
+
+
+            <div class="clearer"></div>
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+  <div>
+    <h3><a href="../index.html">Table of Contents</a></h3>
+    <ul>
+<li><a class="reference internal" href="#">awscrt.exceptions</a><ul>
+<li><a class="reference internal" href="#awscrt.exceptions.from_code"><code class="docutils literal notranslate"><span class="pre">from_code()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.exceptions.AwsCrtError"><code class="docutils literal notranslate"><span class="pre">AwsCrtError</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.exceptions.AwsCrtError.code"><code class="docutils literal notranslate"><span class="pre">code</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.exceptions.AwsCrtError.name"><code class="docutils literal notranslate"><span class="pre">name</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.exceptions.AwsCrtError.message"><code class="docutils literal notranslate"><span class="pre">message</span></code></a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+
+  </div>
+  <div>
+    <h4>Previous topic</h4>
+    <p class="topless"><a href="crypto.html"
+                          title="previous chapter">awscrt.crypto</a></p>
+  </div>
+  <div>
+    <h4>Next topic</h4>
+    <p class="topless"><a href="eventstream.html"
+                          title="next chapter">awscrt.eventstream</a></p>
+  </div>
+  <div role="note" aria-label="source link">
+    <h3>This Page</h3>
+    <ul class="this-page-menu">
+      <li><a href="../_sources/api/exceptions.rst.txt"
+            rel="nofollow">Show Source</a></li>
+    </ul>
+   </div>
+<div id="searchbox" style="display: none" role="search">
+  <h3 id="searchlabel">Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="../search.html" method="get">
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+      <input type="submit" value="Go" />
+    </form>
+    </div>
+</div>
+<script>document.getElementById('searchbox').style.display = "block"</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../genindex.html" title="General Index"
+             >index</a></li>
+        <li class="right" >
+          <a href="../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="right" >
+          <a href="eventstream.html" title="awscrt.eventstream"
+             >next</a> |</li>
+        <li class="right" >
+          <a href="crypto.html" title="awscrt.crypto"
+             >previous</a> |</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">awscrt  documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">awscrt.exceptions</a></li> 
+      </ul>
+    </div>
+    <div class="footer" role="contentinfo">
+    &#169; Copyright 2020, Amazon Web Services, Inc.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
+    </div>
+  </body>
+</html>
\ No newline at end of file
diff --git a/docs/api/http.html b/docs/api/http.html
new file mode 100644
index 000000000..213bfd678
--- /dev/null
+++ b/docs/api/http.html
@@ -0,0 +1,746 @@
+
+
+<!doctype html>
+
+<html lang="en" data-content_root="../">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+
+    <title>awscrt.http &#8212; awscrt  documentation</title>
+    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=649a27d8" />
+    <link rel="stylesheet" type="text/css" href="../_static/css/custom.css?v=93be7416" />
+    
+    <script src="../_static/documentation_options.js?v=5929fcd5"></script>
+    <script src="../_static/doctools.js?v=888ff710"></script>
+    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script src="../_static/bizstyle.js"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" />
+    <link rel="next" title="awscrt.io" href="io.html" />
+    <link rel="prev" title="awscrt.eventstream" href="eventstream.html" />
+    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+    <!--[if lt IE 9]>
+    <script src="_static/css3-mediaqueries.js"></script>
+    <![endif]-->
+  </head><body>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../genindex.html" title="General Index"
+             accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="right" >
+          <a href="io.html" title="awscrt.io"
+             accesskey="N">next</a> |</li>
+        <li class="right" >
+          <a href="eventstream.html" title="awscrt.eventstream"
+             accesskey="P">previous</a> |</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">awscrt  documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">awscrt.http</a></li> 
+      </ul>
+    </div>  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body" role="main">
+            
+  <section id="module-awscrt.http">
+<span id="awscrt-http"></span><h1>awscrt.http<a class="headerlink" href="#module-awscrt.http" title="Link to this heading">¶</a></h1>
+<p>HTTP</p>
+<p>All network operations in <cite>awscrt.http</cite> are asynchronous.</p>
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.http.HttpVersion">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.http.</span></span><span class="sig-name descname"><span class="pre">HttpVersion</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.http.HttpVersion" title="Link to this definition">¶</a></dt>
+<dd><p>HTTP protocol version enumeration</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.http.HttpVersion.Unknown">
+<span class="sig-name descname"><span class="pre">Unknown</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#awscrt.http.HttpVersion.Unknown" title="Link to this definition">¶</a></dt>
+<dd><p>Unknown</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.http.HttpVersion.Http1_0">
+<span class="sig-name descname"><span class="pre">Http1_0</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#awscrt.http.HttpVersion.Http1_0" title="Link to this definition">¶</a></dt>
+<dd><p>HTTP/1.0</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.http.HttpVersion.Http1_1">
+<span class="sig-name descname"><span class="pre">Http1_1</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#awscrt.http.HttpVersion.Http1_1" title="Link to this definition">¶</a></dt>
+<dd><p>HTTP/1.1</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.http.HttpVersion.Http2">
+<span class="sig-name descname"><span class="pre">Http2</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">3</span></em><a class="headerlink" href="#awscrt.http.HttpVersion.Http2" title="Link to this definition">¶</a></dt>
+<dd><p>HTTP/2</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.http.HttpClientConnection">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.http.</span></span><span class="sig-name descname"><span class="pre">HttpClientConnection</span></span><a class="headerlink" href="#awscrt.http.HttpClientConnection" title="Link to this definition">¶</a></dt>
+<dd><p>An HTTP client connection.</p>
+<p>Use <a class="reference internal" href="#awscrt.http.HttpClientConnection.new" title="awscrt.http.HttpClientConnection.new"><code class="xref py py-meth docutils literal notranslate"><span class="pre">HttpClientConnection.new()</span></code></a> to establish a new connection.</p>
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.http.HttpClientConnection.new">
+<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">new</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bootstrap</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">socket_options</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tls_connection_options</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">proxy_options</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.http.HttpClientConnection.new" title="Link to this definition">¶</a></dt>
+<dd><p>Asynchronously establish a new HttpClientConnection.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>host_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Connect to host.</p></li>
+<li><p><strong>port</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – Connect to port.</p></li>
+<li><p><strong>bootstrap</strong> (<em>Optional</em><em> [</em><a class="reference internal" href="io.html#awscrt.io.ClientBootstrap" title="awscrt.io.ClientBootstrap"><em>ClientBootstrap</em></a><em>]</em>) – Client bootstrap to use when initiating socket connection.
+If None is provided, the default singleton is used.</p></li>
+<li><p><strong>socket_options</strong> (<em>Optional</em><em>[</em><a class="reference internal" href="io.html#awscrt.io.SocketOptions" title="awscrt.io.SocketOptions"><em>SocketOptions</em></a><em>]</em>) – Optional socket options.
+If None is provided, then default options are used.</p></li>
+<li><p><strong>tls_connection_options</strong> (<em>Optional</em><em>[</em><a class="reference internal" href="io.html#awscrt.io.TlsConnectionOptions" title="awscrt.io.TlsConnectionOptions"><em>TlsConnectionOptions</em></a><em>]</em>) – Optional TLS
+connection options. If None is provided, then the connection will
+be attempted over plain-text.</p></li>
+<li><p><strong>proxy_options</strong> (<em>Optional</em><em>[</em><a class="reference internal" href="#awscrt.http.HttpProxyOptions" title="awscrt.http.HttpProxyOptions"><em>HttpProxyOptions</em></a><em>]</em>) – Optional proxy options.
+If None is provided then a proxy is not used.</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p><em>concurrent.futures.Future</em> – A Future which completes when connection succeeds or fails.
+If successful, the Future will contain a new <a class="reference internal" href="#awscrt.http.HttpClientConnection" title="awscrt.http.HttpClientConnection"><code class="xref py py-class docutils literal notranslate"><span class="pre">HttpClientConnection</span></code></a>.
+Otherwise, it will contain an exception.</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py property">
+<dt class="sig sig-object py" id="awscrt.http.HttpClientConnection.host_name">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">host_name</span></span><a class="headerlink" href="#awscrt.http.HttpClientConnection.host_name" title="Link to this definition">¶</a></dt>
+<dd><p>Remote hostname</p>
+</dd></dl>
+
+<dl class="py property">
+<dt class="sig sig-object py" id="awscrt.http.HttpClientConnection.port">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">port</span></span><a class="headerlink" href="#awscrt.http.HttpClientConnection.port" title="Link to this definition">¶</a></dt>
+<dd><p>Remote port</p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.http.HttpClientConnection.request">
+<span class="sig-name descname"><span class="pre">request</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">on_response</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">on_body</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.http.HttpClientConnection.request" title="Link to this definition">¶</a></dt>
+<dd><p>Create <a class="reference internal" href="#awscrt.http.HttpClientStream" title="awscrt.http.HttpClientStream"><code class="xref py py-class docutils literal notranslate"><span class="pre">HttpClientStream</span></code></a> to carry out the request/response exchange.</p>
+<p>NOTE: The HTTP stream sends no data until <a class="reference internal" href="#awscrt.http.HttpClientStream.activate" title="awscrt.http.HttpClientStream.activate"><code class="xref py py-meth docutils literal notranslate"><span class="pre">HttpClientStream.activate()</span></code></a>
+is called. Call activate() when you’re ready for callbacks and events to fire.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>request</strong> (<a class="reference internal" href="#awscrt.http.HttpRequest" title="awscrt.http.HttpRequest"><em>HttpRequest</em></a>) – Definition for outgoing request.</p></li>
+<li><p><strong>on_response</strong> – <p>Optional callback invoked once main response headers are received.
+The function should take the following arguments and return nothing:</p>
+<blockquote>
+<div><ul>
+<li><p><cite>http_stream</cite> (<a class="reference internal" href="#awscrt.http.HttpClientStream" title="awscrt.http.HttpClientStream"><code class="xref py py-class docutils literal notranslate"><span class="pre">HttpClientStream</span></code></a>): HTTP stream carrying
+out this request/response exchange.</p></li>
+<li><p><cite>status_code</cite> (int): Response status code.</p></li>
+<li><p><cite>headers</cite> (List[Tuple[str, str]]): Response headers as a
+list of (name,value) pairs.</p></li>
+<li><p><cite>**kwargs</cite> (dict): Forward compatibility kwargs.</p></li>
+</ul>
+</div></blockquote>
+<p>An exception raise by this function will cause the HTTP stream to end in error.
+This callback is always invoked on the connection’s event-loop thread.</p>
+</p></li>
+<li><p><strong>on_body</strong> – <p>Optional callback invoked 0+ times as response body data is received.
+The function should take the following arguments and return nothing:</p>
+<blockquote>
+<div><ul>
+<li><p><cite>http_stream</cite> (<a class="reference internal" href="#awscrt.http.HttpClientStream" title="awscrt.http.HttpClientStream"><code class="xref py py-class docutils literal notranslate"><span class="pre">HttpClientStream</span></code></a>): HTTP stream carrying
+out this request/response exchange.</p></li>
+<li><p><cite>chunk</cite> (buffer): Response body data (not necessarily
+a whole “chunk” of chunked encoding).</p></li>
+<li><p><cite>**kwargs</cite> (dict): Forward-compatibility kwargs.</p></li>
+</ul>
+</div></blockquote>
+<p>An exception raise by this function will cause the HTTP stream to end in error.
+This callback is always invoked on the connection’s event-loop thread.</p>
+</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p><em>HttpClientStream</em></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.http.HttpClientConnection.close">
+<span class="sig-name descname"><span class="pre">close</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.http.HttpClientConnection.close" title="Link to this definition">¶</a></dt>
+<dd><p>Close the connection.</p>
+<p>Shutdown is asynchronous. This call has no effect if the connection is already
+closing.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p><em>concurrent.futures.Future</em> – This connection’s <a class="reference internal" href="#awscrt.http.HttpClientConnection.shutdown_future" title="awscrt.http.HttpClientConnection.shutdown_future"><code class="xref py py-attr docutils literal notranslate"><span class="pre">shutdown_future</span></code></a>,
+which completes when shutdown has finished.</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.http.HttpClientConnection.is_open">
+<span class="sig-name descname"><span class="pre">is_open</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.http.HttpClientConnection.is_open" title="Link to this definition">¶</a></dt>
+<dd><dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p><em>bool</em> – True if this connection is open and usable, False otherwise.
+Check <a class="reference internal" href="#awscrt.http.HttpClientConnection.shutdown_future" title="awscrt.http.HttpClientConnection.shutdown_future"><code class="xref py py-attr docutils literal notranslate"><span class="pre">shutdown_future</span></code></a> to know when the connection is completely
+finished shutting down.</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py property">
+<dt class="sig sig-object py" id="awscrt.http.HttpClientConnection.shutdown_future">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">shutdown_future</span></span><a class="headerlink" href="#awscrt.http.HttpClientConnection.shutdown_future" title="Link to this definition">¶</a></dt>
+<dd><p>Completes when this connection has finished shutting down.
+Future will contain a result of None, or an exception indicating why shutdown occurred.
+Note that the connection may have been garbage-collected before this future completes.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.Future" title="(in Python v3.12)">concurrent.futures.Future</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py property">
+<dt class="sig sig-object py" id="awscrt.http.HttpClientConnection.version">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">version</span></span><a class="headerlink" href="#awscrt.http.HttpClientConnection.version" title="Link to this definition">¶</a></dt>
+<dd><p>Protocol used by this connection</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference internal" href="#awscrt.http.HttpVersion" title="awscrt.http.HttpVersion">HttpVersion</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.http.HttpClientStream">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.http.</span></span><span class="sig-name descname"><span class="pre">HttpClientStream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">connection</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">request</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">on_response</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">on_body</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.http.HttpClientStream" title="Link to this definition">¶</a></dt>
+<dd><p>HTTP stream that sends a request and receives a response.</p>
+<p>Create an HttpClientStream with <a class="reference internal" href="#awscrt.http.HttpClientConnection.request" title="awscrt.http.HttpClientConnection.request"><code class="xref py py-meth docutils literal notranslate"><span class="pre">HttpClientConnection.request()</span></code></a>.</p>
+<p>NOTE: The HTTP stream sends no data until <a class="reference internal" href="#awscrt.http.HttpClientStream.activate" title="awscrt.http.HttpClientStream.activate"><code class="xref py py-meth docutils literal notranslate"><span class="pre">HttpClientStream.activate()</span></code></a>
+is called. Call activate() when you’re ready for callbacks and events to fire.</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.http.HttpClientStream.connection">
+<span class="sig-name descname"><span class="pre">connection</span></span><a class="headerlink" href="#awscrt.http.HttpClientStream.connection" title="Link to this definition">¶</a></dt>
+<dd><p>This stream’s connection.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference internal" href="#awscrt.http.HttpClientConnection" title="awscrt.http.HttpClientConnection">HttpClientConnection</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.http.HttpClientStream.completion_future">
+<span class="sig-name descname"><span class="pre">completion_future</span></span><a class="headerlink" href="#awscrt.http.HttpClientStream.completion_future" title="Link to this definition">¶</a></dt>
+<dd><p>Future that will contain
+the response status code (int) when the request/response exchange
+completes. If the exchange fails to complete, the Future will
+contain an exception indicating why it failed.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.Future" title="(in Python v3.12)">concurrent.futures.Future</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py property">
+<dt class="sig sig-object py" id="awscrt.http.HttpClientStream.response_status_code">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">response_status_code</span></span><a class="headerlink" href="#awscrt.http.HttpClientStream.response_status_code" title="Link to this definition">¶</a></dt>
+<dd><p>The response status code.</p>
+<p>This is None until a response arrives.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)">int</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.http.HttpClientStream.activate">
+<span class="sig-name descname"><span class="pre">activate</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.http.HttpClientStream.activate" title="Link to this definition">¶</a></dt>
+<dd><p>Begin sending the request.</p>
+<p>The HTTP stream does nothing until this is called. Call activate() when you
+are ready for its callbacks and events to fire.</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.http.HttpRequest">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.http.</span></span><span class="sig-name descname"><span class="pre">HttpRequest</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">method</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'GET'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'/'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">headers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">body_stream</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.http.HttpRequest" title="Link to this definition">¶</a></dt>
+<dd><p>Definition for an outgoing HTTP request.</p>
+<p>The request may be transformed (ex: signing the request) before its data is eventually sent.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>method</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – HTTP request method (verb). Default value is “GET”.</p></li>
+<li><p><strong>path</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – HTTP path-and-query value. Default value is “/”.</p></li>
+<li><p><strong>headers</strong> (<em>Optional</em><em>[</em><a class="reference internal" href="#awscrt.http.HttpHeaders" title="awscrt.http.HttpHeaders"><em>HttpHeaders</em></a><em>]</em>) – Optional headers. If None specified,
+an empty <a class="reference internal" href="#awscrt.http.HttpHeaders" title="awscrt.http.HttpHeaders"><code class="xref py py-class docutils literal notranslate"><span class="pre">HttpHeaders</span></code></a> is created.</p></li>
+<li><p><strong>body_stream</strong> (<em>Optional</em><em>[</em><em>Union</em><em>[</em><a class="reference internal" href="io.html#awscrt.io.InputStream" title="awscrt.io.InputStream"><em>InputStream</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/io.html#io.IOBase" title="(in Python v3.12)"><em>io.IOBase</em></a><em>]</em><em>]</em>) – Optional body as binary stream.</p></li>
+</ul>
+</dd>
+</dl>
+<dl class="py property">
+<dt class="sig sig-object py" id="awscrt.http.HttpRequest.method">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">method</span></span><a class="headerlink" href="#awscrt.http.HttpRequest.method" title="Link to this definition">¶</a></dt>
+<dd><p>HTTP request method (verb).</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py property">
+<dt class="sig sig-object py" id="awscrt.http.HttpRequest.path">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">path</span></span><a class="headerlink" href="#awscrt.http.HttpRequest.path" title="Link to this definition">¶</a></dt>
+<dd><p>HTTP path-and-query value.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py property">
+<dt class="sig sig-object py" id="awscrt.http.HttpRequest.headers">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">headers</span></span><a class="headerlink" href="#awscrt.http.HttpRequest.headers" title="Link to this definition">¶</a></dt>
+<dd><p>Headers to send.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference internal" href="#awscrt.http.HttpHeaders" title="awscrt.http.HttpHeaders">HttpHeaders</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.http.HttpHeaders">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.http.</span></span><span class="sig-name descname"><span class="pre">HttpHeaders</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name_value_pairs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.http.HttpHeaders" title="Link to this definition">¶</a></dt>
+<dd><p>Collection of HTTP headers.</p>
+<p>A given header name may have multiple values.
+Header names are always treated in a case-insensitive manner.
+HttpHeaders can be iterated over as (name,value) pairs.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>name_value_pairs</strong> (<em>Optional</em><em>[</em><em>List</em><em>[</em><em>Tuple</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>]</em><em>]</em><em>]</em>) – Construct from a
+collection of (name,value) pairs.</p>
+</dd>
+</dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.http.HttpHeaders.add">
+<span class="sig-name descname"><span class="pre">add</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.http.HttpHeaders.add" title="Link to this definition">¶</a></dt>
+<dd><p>Add a name-value pair.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Name.</p></li>
+<li><p><strong>value</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Value.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.http.HttpHeaders.add_pairs">
+<span class="sig-name descname"><span class="pre">add_pairs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name_value_pairs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.http.HttpHeaders.add_pairs" title="Link to this definition">¶</a></dt>
+<dd><p>Add list of (name,value) pairs.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>name_value_pairs</strong> (<em>List</em><em>[</em><em>Tuple</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>]</em><em>]</em>) – List of (name,value) pairs.</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.http.HttpHeaders.set">
+<span class="sig-name descname"><span class="pre">set</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.http.HttpHeaders.set" title="Link to this definition">¶</a></dt>
+<dd><p>Set a name-value pair, any existing values for the name are removed.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Name.</p></li>
+<li><p><strong>value</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Value.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.http.HttpHeaders.get_values">
+<span class="sig-name descname"><span class="pre">get_values</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.http.HttpHeaders.get_values" title="Link to this definition">¶</a></dt>
+<dd><p>Return an iterator over the values for this name.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Name.</p>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p><em>Iterator[Tuple[str, str]]</em></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.http.HttpHeaders.get">
+<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.http.HttpHeaders.get" title="Link to this definition">¶</a></dt>
+<dd><p>Get the first value for this name, ignoring any additional values.
+Returns <cite>default</cite> if no values exist.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Name.</p></li>
+<li><p><strong>default</strong> (<em>Optional</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>]</em>) – If <cite>name</cite> not found, this value is returned.
+Defaults to None.</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p><em>str</em></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.http.HttpHeaders.remove">
+<span class="sig-name descname"><span class="pre">remove</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.http.HttpHeaders.remove" title="Link to this definition">¶</a></dt>
+<dd><p>Remove all values for this name.
+Raises a KeyError if name not found.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Header name.</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.http.HttpHeaders.remove_value">
+<span class="sig-name descname"><span class="pre">remove_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.http.HttpHeaders.remove_value" title="Link to this definition">¶</a></dt>
+<dd><p>Remove a specific value for this name.
+Raises a ValueError if value not found.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Name.</p></li>
+<li><p><strong>value</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Value.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.http.HttpHeaders.clear">
+<span class="sig-name descname"><span class="pre">clear</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.http.HttpHeaders.clear" title="Link to this definition">¶</a></dt>
+<dd><p>Clear all headers.</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.http.HttpProxyConnectionType">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.http.</span></span><span class="sig-name descname"><span class="pre">HttpProxyConnectionType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.http.HttpProxyConnectionType" title="Link to this definition">¶</a></dt>
+<dd><p>Proxy connection type enumeration</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.http.HttpProxyConnectionType.Legacy">
+<span class="sig-name descname"><span class="pre">Legacy</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#awscrt.http.HttpProxyConnectionType.Legacy" title="Link to this definition">¶</a></dt>
+<dd><p>Use the old connection establishment logic that would use:</p>
+<ol class="arabic simple">
+<li><p>Forwarding if not using TLS</p></li>
+<li><p>Tunneling if using TLS</p></li>
+</ol>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.http.HttpProxyConnectionType.Forwarding">
+<span class="sig-name descname"><span class="pre">Forwarding</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#awscrt.http.HttpProxyConnectionType.Forwarding" title="Link to this definition">¶</a></dt>
+<dd><p>Establish a request forwarding connection to the proxy.</p>
+<p>In this case, TLS is not a valid option.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.http.HttpProxyConnectionType.Tunneling">
+<span class="sig-name descname"><span class="pre">Tunneling</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#awscrt.http.HttpProxyConnectionType.Tunneling" title="Link to this definition">¶</a></dt>
+<dd><p>Establish a tunneling connection through the proxy to the ultimate endpoint.</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.http.HttpProxyAuthenticationType">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.http.</span></span><span class="sig-name descname"><span class="pre">HttpProxyAuthenticationType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.http.HttpProxyAuthenticationType" title="Link to this definition">¶</a></dt>
+<dd><p>Proxy authentication type enumeration.</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.http.HttpProxyAuthenticationType.Nothing">
+<span class="sig-name descname"><span class="pre">Nothing</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#awscrt.http.HttpProxyAuthenticationType.Nothing" title="Link to this definition">¶</a></dt>
+<dd><p>No authentication</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.http.HttpProxyAuthenticationType.Basic">
+<span class="sig-name descname"><span class="pre">Basic</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#awscrt.http.HttpProxyAuthenticationType.Basic" title="Link to this definition">¶</a></dt>
+<dd><p>Username and password</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.http.HttpProxyOptions">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.http.</span></span><span class="sig-name descname"><span class="pre">HttpProxyOptions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tls_connection_options</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auth_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">HttpProxyAuthenticationType.Nothing</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auth_username</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auth_password</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">connection_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">HttpProxyConnectionType.Legacy</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.http.HttpProxyOptions" title="Link to this definition">¶</a></dt>
+<dd><p>Proxy options for HTTP clients.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>host_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Name of the proxy server to connect through.</p></li>
+<li><p><strong>port</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – Port number of the proxy server to connect through.</p></li>
+<li><p><strong>tls_connection_options</strong> (<em>Optional</em><em>[</em><a class="reference internal" href="io.html#awscrt.io.TlsConnectionOptions" title="awscrt.io.TlsConnectionOptions"><em>TlsConnectionOptions</em></a><em>]</em>) – Optional
+<cite>TlsConnectionOptions</cite> for the Local to Proxy connection.
+Must be distinct from the <cite>TlsConnectionOptions</cite>
+provided to the HTTP connection.</p></li>
+<li><p><strong>auth_type</strong> (<a class="reference internal" href="#awscrt.http.HttpProxyAuthenticationType" title="awscrt.http.HttpProxyAuthenticationType"><em>HttpProxyAuthenticationType</em></a>) – Type of proxy authentication to use.
+Default is <a class="reference internal" href="#awscrt.http.HttpProxyAuthenticationType.Nothing" title="awscrt.http.HttpProxyAuthenticationType.Nothing"><code class="xref py py-const docutils literal notranslate"><span class="pre">HttpProxyAuthenticationType.Nothing</span></code></a>.</p></li>
+<li><p><strong>auth_username</strong> (<em>Optional</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>]</em>) – Username to use when <cite>auth_type</cite> is
+<a class="reference internal" href="#awscrt.http.HttpProxyAuthenticationType.Basic" title="awscrt.http.HttpProxyAuthenticationType.Basic"><code class="xref py py-const docutils literal notranslate"><span class="pre">HttpProxyAuthenticationType.Basic</span></code></a>.</p></li>
+<li><p><strong>auth_password</strong> (<em>Optional</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>]</em>) – Username to use when <cite>auth_type</cite> is
+<a class="reference internal" href="#awscrt.http.HttpProxyAuthenticationType.Basic" title="awscrt.http.HttpProxyAuthenticationType.Basic"><code class="xref py py-const docutils literal notranslate"><span class="pre">HttpProxyAuthenticationType.Basic</span></code></a>.</p></li>
+<li><p><strong>connection_type</strong> (<em>Optional</em><em>[</em><a class="reference internal" href="#awscrt.http.HttpProxyConnectionType" title="awscrt.http.HttpProxyConnectionType"><em>HttpProxyConnectionType</em></a>) – Type of proxy connection to make.
+Default is <a class="reference internal" href="#awscrt.http.HttpProxyConnectionType.Legacy" title="awscrt.http.HttpProxyConnectionType.Legacy"><code class="xref py py-const docutils literal notranslate"><span class="pre">HttpProxyConnectionType.Legacy</span></code></a>.</p></li>
+</ul>
+</dd>
+</dl>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.http.HttpProxyOptions.host_name">
+<span class="sig-name descname"><span class="pre">host_name</span></span><a class="headerlink" href="#awscrt.http.HttpProxyOptions.host_name" title="Link to this definition">¶</a></dt>
+<dd><p>Name of the proxy server to connect through.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.http.HttpProxyOptions.port">
+<span class="sig-name descname"><span class="pre">port</span></span><a class="headerlink" href="#awscrt.http.HttpProxyOptions.port" title="Link to this definition">¶</a></dt>
+<dd><p>Port number of the proxy server to connect through.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)">int</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.http.HttpProxyOptions.tls_connection_options">
+<span class="sig-name descname"><span class="pre">tls_connection_options</span></span><a class="headerlink" href="#awscrt.http.HttpProxyOptions.tls_connection_options" title="Link to this definition">¶</a></dt>
+<dd><p>Optional
+<cite>TlsConnectionOptions</cite> for the Local to Proxy connection.
+Must be distinct from the <cite>TlsConnectionOptions</cite>
+provided to the HTTP connection.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>Optional[<a class="reference internal" href="io.html#awscrt.io.TlsConnectionOptions" title="awscrt.io.TlsConnectionOptions">TlsConnectionOptions</a>]</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.http.HttpProxyOptions.auth_type">
+<span class="sig-name descname"><span class="pre">auth_type</span></span><a class="headerlink" href="#awscrt.http.HttpProxyOptions.auth_type" title="Link to this definition">¶</a></dt>
+<dd><p>Type of proxy authentication to use.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference internal" href="#awscrt.http.HttpProxyAuthenticationType" title="awscrt.http.HttpProxyAuthenticationType">HttpProxyAuthenticationType</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.http.HttpProxyOptions.auth_username">
+<span class="sig-name descname"><span class="pre">auth_username</span></span><a class="headerlink" href="#awscrt.http.HttpProxyOptions.auth_username" title="Link to this definition">¶</a></dt>
+<dd><p>Username to use when <cite>auth_type</cite> is
+<a class="reference internal" href="#awscrt.http.HttpProxyAuthenticationType.Basic" title="awscrt.http.HttpProxyAuthenticationType.Basic"><code class="xref py py-const docutils literal notranslate"><span class="pre">HttpProxyAuthenticationType.Basic</span></code></a>.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>Optional[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a>]</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.http.HttpProxyOptions.auth_password">
+<span class="sig-name descname"><span class="pre">auth_password</span></span><a class="headerlink" href="#awscrt.http.HttpProxyOptions.auth_password" title="Link to this definition">¶</a></dt>
+<dd><p>Username to use when <cite>auth_type</cite> is
+<a class="reference internal" href="#awscrt.http.HttpProxyAuthenticationType.Basic" title="awscrt.http.HttpProxyAuthenticationType.Basic"><code class="xref py py-const docutils literal notranslate"><span class="pre">HttpProxyAuthenticationType.Basic</span></code></a>.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>Optional[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a>]</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.http.HttpProxyOptions.connection_type">
+<span class="sig-name descname"><span class="pre">connection_type</span></span><a class="headerlink" href="#awscrt.http.HttpProxyOptions.connection_type" title="Link to this definition">¶</a></dt>
+<dd><p>Type of proxy connection to make.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference internal" href="#awscrt.http.HttpProxyConnectionType" title="awscrt.http.HttpProxyConnectionType">HttpProxyConnectionType</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+</dd></dl>
+
+</section>
+
+
+            <div class="clearer"></div>
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+  <div>
+    <h3><a href="../index.html">Table of Contents</a></h3>
+    <ul>
+<li><a class="reference internal" href="#">awscrt.http</a><ul>
+<li><a class="reference internal" href="#awscrt.http.HttpVersion"><code class="docutils literal notranslate"><span class="pre">HttpVersion</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.http.HttpVersion.Unknown"><code class="docutils literal notranslate"><span class="pre">Unknown</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.http.HttpVersion.Http1_0"><code class="docutils literal notranslate"><span class="pre">Http1_0</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.http.HttpVersion.Http1_1"><code class="docutils literal notranslate"><span class="pre">Http1_1</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.http.HttpVersion.Http2"><code class="docutils literal notranslate"><span class="pre">Http2</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.http.HttpClientConnection"><code class="docutils literal notranslate"><span class="pre">HttpClientConnection</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.http.HttpClientConnection.new"><code class="docutils literal notranslate"><span class="pre">new()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.http.HttpClientConnection.host_name"><code class="docutils literal notranslate"><span class="pre">host_name</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.http.HttpClientConnection.port"><code class="docutils literal notranslate"><span class="pre">port</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.http.HttpClientConnection.request"><code class="docutils literal notranslate"><span class="pre">request()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.http.HttpClientConnection.close"><code class="docutils literal notranslate"><span class="pre">close()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.http.HttpClientConnection.is_open"><code class="docutils literal notranslate"><span class="pre">is_open()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.http.HttpClientConnection.shutdown_future"><code class="docutils literal notranslate"><span class="pre">shutdown_future</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.http.HttpClientConnection.version"><code class="docutils literal notranslate"><span class="pre">version</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.http.HttpClientStream"><code class="docutils literal notranslate"><span class="pre">HttpClientStream</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.http.HttpClientStream.connection"><code class="docutils literal notranslate"><span class="pre">connection</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.http.HttpClientStream.completion_future"><code class="docutils literal notranslate"><span class="pre">completion_future</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.http.HttpClientStream.response_status_code"><code class="docutils literal notranslate"><span class="pre">response_status_code</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.http.HttpClientStream.activate"><code class="docutils literal notranslate"><span class="pre">activate()</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.http.HttpRequest"><code class="docutils literal notranslate"><span class="pre">HttpRequest</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.http.HttpRequest.method"><code class="docutils literal notranslate"><span class="pre">method</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.http.HttpRequest.path"><code class="docutils literal notranslate"><span class="pre">path</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.http.HttpRequest.headers"><code class="docutils literal notranslate"><span class="pre">headers</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.http.HttpHeaders"><code class="docutils literal notranslate"><span class="pre">HttpHeaders</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.http.HttpHeaders.add"><code class="docutils literal notranslate"><span class="pre">add()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.http.HttpHeaders.add_pairs"><code class="docutils literal notranslate"><span class="pre">add_pairs()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.http.HttpHeaders.set"><code class="docutils literal notranslate"><span class="pre">set()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.http.HttpHeaders.get_values"><code class="docutils literal notranslate"><span class="pre">get_values()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.http.HttpHeaders.get"><code class="docutils literal notranslate"><span class="pre">get()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.http.HttpHeaders.remove"><code class="docutils literal notranslate"><span class="pre">remove()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.http.HttpHeaders.remove_value"><code class="docutils literal notranslate"><span class="pre">remove_value()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.http.HttpHeaders.clear"><code class="docutils literal notranslate"><span class="pre">clear()</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.http.HttpProxyConnectionType"><code class="docutils literal notranslate"><span class="pre">HttpProxyConnectionType</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.http.HttpProxyConnectionType.Legacy"><code class="docutils literal notranslate"><span class="pre">Legacy</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.http.HttpProxyConnectionType.Forwarding"><code class="docutils literal notranslate"><span class="pre">Forwarding</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.http.HttpProxyConnectionType.Tunneling"><code class="docutils literal notranslate"><span class="pre">Tunneling</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.http.HttpProxyAuthenticationType"><code class="docutils literal notranslate"><span class="pre">HttpProxyAuthenticationType</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.http.HttpProxyAuthenticationType.Nothing"><code class="docutils literal notranslate"><span class="pre">Nothing</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.http.HttpProxyAuthenticationType.Basic"><code class="docutils literal notranslate"><span class="pre">Basic</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.http.HttpProxyOptions"><code class="docutils literal notranslate"><span class="pre">HttpProxyOptions</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.http.HttpProxyOptions.host_name"><code class="docutils literal notranslate"><span class="pre">host_name</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.http.HttpProxyOptions.port"><code class="docutils literal notranslate"><span class="pre">port</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.http.HttpProxyOptions.tls_connection_options"><code class="docutils literal notranslate"><span class="pre">tls_connection_options</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.http.HttpProxyOptions.auth_type"><code class="docutils literal notranslate"><span class="pre">auth_type</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.http.HttpProxyOptions.auth_username"><code class="docutils literal notranslate"><span class="pre">auth_username</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.http.HttpProxyOptions.auth_password"><code class="docutils literal notranslate"><span class="pre">auth_password</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.http.HttpProxyOptions.connection_type"><code class="docutils literal notranslate"><span class="pre">connection_type</span></code></a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+
+  </div>
+  <div>
+    <h4>Previous topic</h4>
+    <p class="topless"><a href="eventstream.html"
+                          title="previous chapter">awscrt.eventstream</a></p>
+  </div>
+  <div>
+    <h4>Next topic</h4>
+    <p class="topless"><a href="io.html"
+                          title="next chapter">awscrt.io</a></p>
+  </div>
+  <div role="note" aria-label="source link">
+    <h3>This Page</h3>
+    <ul class="this-page-menu">
+      <li><a href="../_sources/api/http.rst.txt"
+            rel="nofollow">Show Source</a></li>
+    </ul>
+   </div>
+<div id="searchbox" style="display: none" role="search">
+  <h3 id="searchlabel">Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="../search.html" method="get">
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+      <input type="submit" value="Go" />
+    </form>
+    </div>
+</div>
+<script>document.getElementById('searchbox').style.display = "block"</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../genindex.html" title="General Index"
+             >index</a></li>
+        <li class="right" >
+          <a href="../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="right" >
+          <a href="io.html" title="awscrt.io"
+             >next</a> |</li>
+        <li class="right" >
+          <a href="eventstream.html" title="awscrt.eventstream"
+             >previous</a> |</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">awscrt  documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">awscrt.http</a></li> 
+      </ul>
+    </div>
+    <div class="footer" role="contentinfo">
+    &#169; Copyright 2020, Amazon Web Services, Inc.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
+    </div>
+  </body>
+</html>
\ No newline at end of file
diff --git a/docs/api/io.html b/docs/api/io.html
new file mode 100644
index 000000000..1a64ce75f
--- /dev/null
+++ b/docs/api/io.html
@@ -0,0 +1,974 @@
+
+
+<!doctype html>
+
+<html lang="en" data-content_root="../">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+
+    <title>awscrt.io &#8212; awscrt  documentation</title>
+    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=649a27d8" />
+    <link rel="stylesheet" type="text/css" href="../_static/css/custom.css?v=93be7416" />
+    
+    <script src="../_static/documentation_options.js?v=5929fcd5"></script>
+    <script src="../_static/doctools.js?v=888ff710"></script>
+    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script src="../_static/bizstyle.js"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" />
+    <link rel="next" title="awscrt.mqtt" href="mqtt.html" />
+    <link rel="prev" title="awscrt.http" href="http.html" />
+    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+    <!--[if lt IE 9]>
+    <script src="_static/css3-mediaqueries.js"></script>
+    <![endif]-->
+  </head><body>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../genindex.html" title="General Index"
+             accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="right" >
+          <a href="mqtt.html" title="awscrt.mqtt"
+             accesskey="N">next</a> |</li>
+        <li class="right" >
+          <a href="http.html" title="awscrt.http"
+             accesskey="P">previous</a> |</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">awscrt  documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">awscrt.io</a></li> 
+      </ul>
+    </div>  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body" role="main">
+            
+  <section id="module-awscrt.io">
+<span id="awscrt-io"></span><h1>awscrt.io<a class="headerlink" href="#module-awscrt.io" title="Link to this heading">¶</a></h1>
+<p>I/O library for <cite>awscrt</cite>.</p>
+<p>All networking in <cite>awscrt</cite> is asynchronous.
+Long-running event-loop threads are used for concurrency.</p>
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.io.LogLevel">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.io.</span></span><span class="sig-name descname"><span class="pre">LogLevel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.io.LogLevel" title="Link to this definition">¶</a></dt>
+<dd><p>An enumeration.</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.io.LogLevel.NoLogs">
+<span class="sig-name descname"><span class="pre">NoLogs</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#awscrt.io.LogLevel.NoLogs" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.io.LogLevel.Fatal">
+<span class="sig-name descname"><span class="pre">Fatal</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#awscrt.io.LogLevel.Fatal" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.io.LogLevel.Error">
+<span class="sig-name descname"><span class="pre">Error</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#awscrt.io.LogLevel.Error" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.io.LogLevel.Warn">
+<span class="sig-name descname"><span class="pre">Warn</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">3</span></em><a class="headerlink" href="#awscrt.io.LogLevel.Warn" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.io.LogLevel.Info">
+<span class="sig-name descname"><span class="pre">Info</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">4</span></em><a class="headerlink" href="#awscrt.io.LogLevel.Info" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.io.LogLevel.Debug">
+<span class="sig-name descname"><span class="pre">Debug</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">5</span></em><a class="headerlink" href="#awscrt.io.LogLevel.Debug" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.io.LogLevel.Trace">
+<span class="sig-name descname"><span class="pre">Trace</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">6</span></em><a class="headerlink" href="#awscrt.io.LogLevel.Trace" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="awscrt.io.init_logging">
+<span class="sig-prename descclassname"><span class="pre">awscrt.io.</span></span><span class="sig-name descname"><span class="pre">init_logging</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">log_level</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.io.init_logging" title="Link to this definition">¶</a></dt>
+<dd><p>Initialize logging in <cite>awscrt</cite>.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>log_level</strong> (<a class="reference internal" href="#awscrt.io.LogLevel" title="awscrt.io.LogLevel"><em>LogLevel</em></a>) – Display messages of this importance and higher.
+<cite>LogLevel.NoLogs</cite> will disable logging.</p></li>
+<li><p><strong>file_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Logging destination. To write to stdout or stderr pass
+‘stdout’ or ‘stderr’ as strings. Otherwise, a file path is assumed.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.io.EventLoopGroup">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.io.</span></span><span class="sig-name descname"><span class="pre">EventLoopGroup</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">num_threads</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cpu_group</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.io.EventLoopGroup" title="Link to this definition">¶</a></dt>
+<dd><p>A collection of event-loops.</p>
+<p>An event-loop is a thread for doing async work, such as I/O. Classes that
+need to do async work will ask the EventLoopGroup for an event-loop to use.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>num_threads</strong> (<em>Optional</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a><em>]</em>) – Maximum number of event-loops to create.
+If unspecified, one is created for each processor on the machine.</p></li>
+<li><p><strong>cpu_group</strong> (<em>Optional</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a><em>]</em>) – Optional processor group to which all
+threads will be pinned. Useful for systems with non-uniform
+memory access (NUMA) nodes. If specified, the number of threads
+will be capped at the number of processors in the group.</p></li>
+</ul>
+</dd>
+</dl>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.io.EventLoopGroup.shutdown_event">
+<span class="sig-name descname"><span class="pre">shutdown_event</span></span><a class="headerlink" href="#awscrt.io.EventLoopGroup.shutdown_event" title="Link to this definition">¶</a></dt>
+<dd><p>Signals when EventLoopGroup’s threads
+have all finished shutting down. Shutdown begins when the
+EventLoopGroup object is destroyed.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/threading.html#threading.Event" title="(in Python v3.12)">threading.Event</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.io.HostResolverBase">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.io.</span></span><span class="sig-name descname"><span class="pre">HostResolverBase</span></span><a class="headerlink" href="#awscrt.io.HostResolverBase" title="Link to this definition">¶</a></dt>
+<dd><p>DNS host resolver.</p>
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.io.DefaultHostResolver">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.io.</span></span><span class="sig-name descname"><span class="pre">DefaultHostResolver</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">event_loop_group</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_hosts</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">16</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.io.DefaultHostResolver" title="Link to this definition">¶</a></dt>
+<dd><p>Default DNS host resolver.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>event_loop_group</strong> (<a class="reference internal" href="#awscrt.io.EventLoopGroup" title="awscrt.io.EventLoopGroup"><em>EventLoopGroup</em></a>) – EventLoopGroup to use.</p></li>
+<li><p><strong>max_hosts</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – Max host names to cache.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.io.ClientBootstrap">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.io.</span></span><span class="sig-name descname"><span class="pre">ClientBootstrap</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">event_loop_group</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host_resolver</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.io.ClientBootstrap" title="Link to this definition">¶</a></dt>
+<dd><p>Handles creation and setup of client socket connections.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>event_loop_group</strong> (<a class="reference internal" href="#awscrt.io.EventLoopGroup" title="awscrt.io.EventLoopGroup"><em>EventLoopGroup</em></a>) – EventLoopGroup to use.</p></li>
+<li><p><strong>host_resolver</strong> (<a class="reference internal" href="#awscrt.io.HostResolverBase" title="awscrt.io.HostResolverBase"><em>HostResolverBase</em></a>) – DNS host resolver to use.</p></li>
+</ul>
+</dd>
+</dl>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.io.ClientBootstrap.shutdown_event">
+<span class="sig-name descname"><span class="pre">shutdown_event</span></span><a class="headerlink" href="#awscrt.io.ClientBootstrap.shutdown_event" title="Link to this definition">¶</a></dt>
+<dd><p>Signals when the ClientBootstrap’s
+internal resources finish shutting down.
+Shutdown begins when the ClientBootstrap object is destroyed.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/threading.html#threading.Event" title="(in Python v3.12)">threading.Event</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.io.SocketDomain">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.io.</span></span><span class="sig-name descname"><span class="pre">SocketDomain</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.io.SocketDomain" title="Link to this definition">¶</a></dt>
+<dd><p>An enumeration.</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.io.SocketDomain.IPv4">
+<span class="sig-name descname"><span class="pre">IPv4</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#awscrt.io.SocketDomain.IPv4" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.io.SocketDomain.IPv6">
+<span class="sig-name descname"><span class="pre">IPv6</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#awscrt.io.SocketDomain.IPv6" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.io.SocketDomain.Local">
+<span class="sig-name descname"><span class="pre">Local</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#awscrt.io.SocketDomain.Local" title="Link to this definition">¶</a></dt>
+<dd><p>Unix domain sockets (at at least something like them)</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.io.SocketType">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.io.</span></span><span class="sig-name descname"><span class="pre">SocketType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.io.SocketType" title="Link to this definition">¶</a></dt>
+<dd><p>An enumeration.</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.io.SocketType.Stream">
+<span class="sig-name descname"><span class="pre">Stream</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#awscrt.io.SocketType.Stream" title="Link to this definition">¶</a></dt>
+<dd><p>A streaming socket sends reliable messages over a two-way connection.
+This means TCP when used with <cite>SocketDomain.IPv4/6</cite>,
+and Unix domain sockets when used with <cite>SocketDomain.Local</cite></p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.io.SocketType.DGram">
+<span class="sig-name descname"><span class="pre">DGram</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#awscrt.io.SocketType.DGram" title="Link to this definition">¶</a></dt>
+<dd><p>A datagram socket is connectionless and sends unreliable messages.
+This means UDP when used with <cite>SocketDomain.IPv4/6</cite>.
+<cite>SocketDomain.Local</cite> is not compatible with <cite>DGram</cite></p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.io.SocketOptions">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.io.</span></span><span class="sig-name descname"><span class="pre">SocketOptions</span></span><a class="headerlink" href="#awscrt.io.SocketOptions" title="Link to this definition">¶</a></dt>
+<dd><p>Socket options.</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.io.SocketOptions.domain">
+<span class="sig-name descname"><span class="pre">domain</span></span><a class="headerlink" href="#awscrt.io.SocketOptions.domain" title="Link to this definition">¶</a></dt>
+<dd><p>Socket domain.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference internal" href="#awscrt.io.SocketDomain" title="awscrt.io.SocketDomain">SocketDomain</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.io.SocketOptions.type">
+<span class="sig-name descname"><span class="pre">type</span></span><a class="headerlink" href="#awscrt.io.SocketOptions.type" title="Link to this definition">¶</a></dt>
+<dd><p>Socket type.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference internal" href="#awscrt.io.SocketType" title="awscrt.io.SocketType">SocketType</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.io.SocketOptions.connect_timeout_ms">
+<span class="sig-name descname"><span class="pre">connect_timeout_ms</span></span><a class="headerlink" href="#awscrt.io.SocketOptions.connect_timeout_ms" title="Link to this definition">¶</a></dt>
+<dd><p>Connection timeout, in milliseconds.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)">int</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.io.SocketOptions.keep_alive">
+<span class="sig-name descname"><span class="pre">keep_alive</span></span><a class="headerlink" href="#awscrt.io.SocketOptions.keep_alive" title="Link to this definition">¶</a></dt>
+<dd><p>If set True, periodically transmit keepalive messages
+for detecting a disconnected peer.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)">bool</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.io.SocketOptions.keep_alive_timeout_secs">
+<span class="sig-name descname"><span class="pre">keep_alive_timeout_secs</span></span><a class="headerlink" href="#awscrt.io.SocketOptions.keep_alive_timeout_secs" title="Link to this definition">¶</a></dt>
+<dd><p>Duration, in seconds, between keepalive
+transmissions in idle condition. If 0, then a default value is used.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)">int</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.io.SocketOptions.keep_alive_interval_secs">
+<span class="sig-name descname"><span class="pre">keep_alive_interval_secs</span></span><a class="headerlink" href="#awscrt.io.SocketOptions.keep_alive_interval_secs" title="Link to this definition">¶</a></dt>
+<dd><p>Duration, in seconds, between keepalive
+retransmissions, if acknowledgement of previous keepalive transmission
+is not received. If 0, then a default value is used.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)">int</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.io.SocketOptions.keep_alive_max_probes">
+<span class="sig-name descname"><span class="pre">keep_alive_max_probes</span></span><a class="headerlink" href="#awscrt.io.SocketOptions.keep_alive_max_probes" title="Link to this definition">¶</a></dt>
+<dd><p>If set, sets the number of keepalive probes
+allowed to fail before a connection is considered lost.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)">int</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.io.TlsVersion">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.io.</span></span><span class="sig-name descname"><span class="pre">TlsVersion</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.io.TlsVersion" title="Link to this definition">¶</a></dt>
+<dd><p>An enumeration.</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.io.TlsVersion.SSLv3">
+<span class="sig-name descname"><span class="pre">SSLv3</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#awscrt.io.TlsVersion.SSLv3" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.io.TlsVersion.TLSv1">
+<span class="sig-name descname"><span class="pre">TLSv1</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#awscrt.io.TlsVersion.TLSv1" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.io.TlsVersion.TLSv1_1">
+<span class="sig-name descname"><span class="pre">TLSv1_1</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#awscrt.io.TlsVersion.TLSv1_1" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.io.TlsVersion.TLSv1_2">
+<span class="sig-name descname"><span class="pre">TLSv1_2</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">3</span></em><a class="headerlink" href="#awscrt.io.TlsVersion.TLSv1_2" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.io.TlsVersion.TLSv1_3">
+<span class="sig-name descname"><span class="pre">TLSv1_3</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">4</span></em><a class="headerlink" href="#awscrt.io.TlsVersion.TLSv1_3" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.io.TlsVersion.DEFAULT">
+<span class="sig-name descname"><span class="pre">DEFAULT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">128</span></em><a class="headerlink" href="#awscrt.io.TlsVersion.DEFAULT" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.io.TlsCipherPref">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.io.</span></span><span class="sig-name descname"><span class="pre">TlsCipherPref</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.io.TlsCipherPref" title="Link to this definition">¶</a></dt>
+<dd><p>TLS Cipher Preference.</p>
+<p>Each TlsCipherPref represents an ordered list of TLS Ciphers to use when negotiating a TLS Connection. At
+present, the ability to configure arbitrary orderings of TLS Ciphers is not allowed, and only a curated list of
+vetted TlsCipherPref’s are exposed.</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.io.TlsCipherPref.DEFAULT">
+<span class="sig-name descname"><span class="pre">DEFAULT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#awscrt.io.TlsCipherPref.DEFAULT" title="Link to this definition">¶</a></dt>
+<dd><p>The underlying platform’s default TLS Cipher Preference ordering. This is usually the best option, as it will be
+automatically updated as the underlying OS or platform changes, and will always be supported on all platforms.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.io.TlsCipherPref.PQ_TLSv1_0_2021_05">
+<span class="sig-name descname"><span class="pre">PQ_TLSv1_0_2021_05</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">6</span></em><a class="headerlink" href="#awscrt.io.TlsCipherPref.PQ_TLSv1_0_2021_05" title="Link to this definition">¶</a></dt>
+<dd><p>A TLS Cipher Preference ordering that supports TLS 1.0 through TLS 1.3, and has Kyber Round 3 as its highest
+priority post-quantum key exchange algorithm. PQ algorithms in this preference list will always be used in hybrid
+mode, and will be combined with a classical ECDHE key exchange that is performed in addition to the PQ key
+exchange. This preference makes a best-effort to negotiate a PQ algorithm, but if the peer does not support any
+PQ algorithms the TLS connection will fall back to a single classical algorithm for key exchange (such as ECDHE
+or RSA).</p>
+<p>NIST has announced that they plan to eventually standardize Kyber. However, the NIST standardization process might
+introduce minor changes that could cause the final Kyber standard to differ from the Kyber Round 3 implementation
+available in this preference list.</p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.io.TlsCipherPref.is_supported">
+<span class="sig-name descname"><span class="pre">is_supported</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.io.TlsCipherPref.is_supported" title="Link to this definition">¶</a></dt>
+<dd><p>Return whether this Cipher Preference is available in the underlying platform’s TLS implementation</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.io.TlsContextOptions">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.io.</span></span><span class="sig-name descname"><span class="pre">TlsContextOptions</span></span><a class="headerlink" href="#awscrt.io.TlsContextOptions" title="Link to this definition">¶</a></dt>
+<dd><p>Options to create a TLS context.</p>
+<p>The static <cite>TlsContextOptions.create_X()</cite> methods provide common TLS configurations.
+A default-initialized TlsContextOptions has <cite>verify_peer</cite> set True.</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.io.TlsContextOptions.min_tls_ver">
+<span class="sig-name descname"><span class="pre">min_tls_ver</span></span><a class="headerlink" href="#awscrt.io.TlsContextOptions.min_tls_ver" title="Link to this definition">¶</a></dt>
+<dd><p>Minimum TLS version to use.
+System defaults are used by default.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference internal" href="#awscrt.io.TlsVersion" title="awscrt.io.TlsVersion">TlsVersion</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.io.TlsContextOptions.cipher_pref">
+<span class="sig-name descname"><span class="pre">cipher_pref</span></span><a class="headerlink" href="#awscrt.io.TlsContextOptions.cipher_pref" title="Link to this definition">¶</a></dt>
+<dd><p>The TLS Cipher Preference to use. System defaults are used by default.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference internal" href="#awscrt.io.TlsCipherPref" title="awscrt.io.TlsCipherPref">TlsCipherPref</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.io.TlsContextOptions.verify_peer">
+<span class="sig-name descname"><span class="pre">verify_peer</span></span><a class="headerlink" href="#awscrt.io.TlsContextOptions.verify_peer" title="Link to this definition">¶</a></dt>
+<dd><p>Whether to validate the peer’s x.509 certificate.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)">bool</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.io.TlsContextOptions.alpn_list">
+<span class="sig-name descname"><span class="pre">alpn_list</span></span><a class="headerlink" href="#awscrt.io.TlsContextOptions.alpn_list" title="Link to this definition">¶</a></dt>
+<dd><p>If set, names to use in Application Layer
+Protocol Negotiation (ALPN). ALPN is not supported on all systems,
+see <a class="reference internal" href="#awscrt.io.is_alpn_available" title="awscrt.io.is_alpn_available"><code class="xref py py-meth docutils literal notranslate"><span class="pre">is_alpn_available()</span></code></a>. This can be customized per connection,
+via <a class="reference internal" href="#awscrt.io.TlsConnectionOptions.set_alpn_list" title="awscrt.io.TlsConnectionOptions.set_alpn_list"><code class="xref py py-meth docutils literal notranslate"><span class="pre">TlsConnectionOptions.set_alpn_list()</span></code></a>.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>Optional[List[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a>]]</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.io.TlsContextOptions.create_client_with_mtls_from_path">
+<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_client_with_mtls_from_path</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cert_filepath</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pk_filepath</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.io.TlsContextOptions.create_client_with_mtls_from_path" title="Link to this definition">¶</a></dt>
+<dd><p>Create options configured for use with mutual TLS in client mode.</p>
+<p>Both files are treated as PKCS #7 PEM armored.
+They are loaded from disk and stored in buffers internally.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>cert_filepath</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Path to certificate file.</p></li>
+<li><p><strong>pk_filepath</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Path to private key file.</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p><em>TlsContextOptions</em></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.io.TlsContextOptions.create_client_with_mtls">
+<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_client_with_mtls</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cert_buffer</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">key_buffer</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.io.TlsContextOptions.create_client_with_mtls" title="Link to this definition">¶</a></dt>
+<dd><p>Create options configured for use with mutual TLS in client mode.</p>
+<p>Both buffers are treated as PKCS #7 PEM armored.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>cert_buffer</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.12)"><em>bytes</em></a>) – Certificate contents</p></li>
+<li><p><strong>key_buffer</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.12)"><em>bytes</em></a>) – Private key contents.</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p><em>TlsContextOptions</em></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.io.TlsContextOptions.create_client_with_mtls_pkcs11">
+<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_client_with_mtls_pkcs11</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pkcs11_lib</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.io.Pkcs11Lib" title="awscrt.io.Pkcs11Lib"><span class="pre">Pkcs11Lib</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_pin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">slot_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">token_label</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">private_key_label</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cert_file_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cert_file_contents</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.io.TlsContextOptions.create_client_with_mtls_pkcs11" title="Link to this definition">¶</a></dt>
+<dd><p>Create options configured for use with mutual TLS in client mode,
+using a PKCS#11 library for private key operations.</p>
+<p>NOTE: This configuration only works on Unix devices.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Keyword Arguments<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>pkcs11_lib</strong> (<a class="reference internal" href="#awscrt.io.Pkcs11Lib" title="awscrt.io.Pkcs11Lib"><em>Pkcs11Lib</em></a>) – Use this PKCS#11 library</p></li>
+<li><p><strong>user_pin</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – User PIN, for logging into the PKCS#11 token.
+Pass <cite>None</cite> to log into a token with a “protected authentication path”.</p></li>
+<li><p><strong>slot_id</strong> (<em>Optional</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a><em>]</em>) – ID of slot containing PKCS#11 token.
+If not specified, the token will be chosen based on other criteria (such as token label).</p></li>
+<li><p><strong>token_label</strong> (<em>Optional</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>]</em>) – Label of the PKCS#11 token to use.
+If not specified, the token will be chosen based on other criteria (such as slot ID).</p></li>
+<li><p><strong>private_key_label</strong> (<em>Optional</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>]</em>) – Label of private key object on PKCS#11 token.
+If not specified, the key will be chosen based on other criteria
+(such as being the only available private key on the token).</p></li>
+<li><p><strong>cert_file_path</strong> (<em>Optional</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>]</em>) – Use this X.509 certificate (path to file on disk).
+The certificate must be PEM-formatted. The certificate may be
+specified by other means instead (ex: <cite>cert_file_contents</cite>)</p></li>
+<li><p><strong>cert_file_contents</strong> (<em>Optional</em><em>[</em><em>Union</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.12)"><em>bytes</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytearray" title="(in Python v3.12)"><em>bytearray</em></a><em>]</em><em>]</em>) – Use this X.509 certificate (contents in memory).
+The certificate must be PEM-formatted. The certificate may be
+specified by other means instead (ex: <cite>cert_file_path</cite>)</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.io.TlsContextOptions.create_client_with_mtls_pkcs12">
+<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_client_with_mtls_pkcs12</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pkcs12_filepath</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pkcs12_password</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.io.TlsContextOptions.create_client_with_mtls_pkcs12" title="Link to this definition">¶</a></dt>
+<dd><p>Create options configured for use with mutual TLS in client mode.</p>
+<p>NOTE: This configuration only works on Apple devices.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>pkcs12_filepath</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Path to PKCS #12 file.
+The file is loaded from disk and stored internally.</p></li>
+<li><p><strong>pkcs12_password</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Password to PKCS #12 file.</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p><em>TlsContextOptions</em></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.io.TlsContextOptions.create_client_with_mtls_windows_cert_store_path">
+<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_client_with_mtls_windows_cert_store_path</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cert_path</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.io.TlsContextOptions.create_client_with_mtls_windows_cert_store_path" title="Link to this definition">¶</a></dt>
+<dd><p>Create options configured for use with mutual TLS in client mode,
+using a certificate in a Windows certificate store.</p>
+<p>NOTE: This configuration only works on Windows devices.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>cert_path</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Path to certificate in a Windows certificate store.
+The path must use backslashes and end with the certificate’s thumbprint.
+Example: <code class="docutils literal notranslate"><span class="pre">CurrentUser\MY\A11F8A9B5DF5B98BA3508FBCA575D09570E0D2C6</span></code></p>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>TlsContextOptions</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.io.TlsContextOptions.create_server_from_path">
+<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_server_from_path</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cert_filepath</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pk_filepath</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.io.TlsContextOptions.create_server_from_path" title="Link to this definition">¶</a></dt>
+<dd><p>Create options configured for use in server mode.</p>
+<p>Both files are treated as PKCS #7 PEM armored.
+They are loaded from disk and stored in buffers internally.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>cert_filepath</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Path to certificate file.</p></li>
+<li><p><strong>pk_filepath</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Path to private key file.</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p><em>TlsContextOptions</em></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.io.TlsContextOptions.create_server">
+<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_server</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cert_buffer</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">key_buffer</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.io.TlsContextOptions.create_server" title="Link to this definition">¶</a></dt>
+<dd><p>Create options configured for use in server mode.</p>
+<p>Both buffers are treated as PKCS #7 PEM armored.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>cert_buffer</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.12)"><em>bytes</em></a>) – Certificate contents.</p></li>
+<li><p><strong>key_buffer</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.12)"><em>bytes</em></a>) – Private key contents.</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p><em>TlsContextOptions</em></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.io.TlsContextOptions.create_server_pkcs12">
+<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_server_pkcs12</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pkcs12_filepath</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pkcs12_password</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.io.TlsContextOptions.create_server_pkcs12" title="Link to this definition">¶</a></dt>
+<dd><p>Create options configured for use in server mode.</p>
+<p>NOTE: This configuration only works on Apple devices.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>pkcs12_filepath</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Path to PKCS #12 file.</p></li>
+<li><p><strong>pkcs12_password</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Password to PKCS #12 file.</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p><em>TlsContextOptions</em></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.io.TlsContextOptions.override_default_trust_store_from_path">
+<span class="sig-name descname"><span class="pre">override_default_trust_store_from_path</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ca_dirpath</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ca_filepath</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.io.TlsContextOptions.override_default_trust_store_from_path" title="Link to this definition">¶</a></dt>
+<dd><p>Override default trust store.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>ca_dirpath</strong> (<em>Optional</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>]</em>) – Path to directory containing
+trusted certificates, which will overrides the default trust store.
+Only supported on Unix.</p></li>
+<li><p><strong>ca_filepath</strong> (<em>Optional</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>]</em>) – Path to file containing PEM armored chain
+of trusted CA certificates.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.io.TlsContextOptions.override_default_trust_store">
+<span class="sig-name descname"><span class="pre">override_default_trust_store</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rootca_buffer</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.io.TlsContextOptions.override_default_trust_store" title="Link to this definition">¶</a></dt>
+<dd><p>Override default trust store.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>rootca_buffer</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.12)"><em>bytes</em></a>) – PEM armored chain of trusted CA certificates.</p>
+</dd>
+</dl>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.io.ClientTlsContext">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.io.</span></span><span class="sig-name descname"><span class="pre">ClientTlsContext</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">options</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.io.ClientTlsContext" title="Link to this definition">¶</a></dt>
+<dd><p>Client TLS context.</p>
+<p>A context is expensive, but can be used for the lifetime of the application
+by all outgoing connections that wish to use the same TLS configuration.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>options</strong> (<a class="reference internal" href="#awscrt.io.TlsContextOptions" title="awscrt.io.TlsContextOptions"><em>TlsContextOptions</em></a>) – Configuration options.</p>
+</dd>
+</dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.io.ClientTlsContext.new_connection_options">
+<span class="sig-name descname"><span class="pre">new_connection_options</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.io.ClientTlsContext.new_connection_options" title="Link to this definition">¶</a></dt>
+<dd><p>Create a <a class="reference internal" href="#awscrt.io.TlsConnectionOptions" title="awscrt.io.TlsConnectionOptions"><code class="xref py py-class docutils literal notranslate"><span class="pre">TlsConnectionOptions</span></code></a> that makes use of this TLS context.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p><em>TlsConnectionOptions</em></p>
+</dd>
+</dl>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.io.TlsConnectionOptions">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.io.</span></span><span class="sig-name descname"><span class="pre">TlsConnectionOptions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tls_ctx</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.io.TlsConnectionOptions" title="Link to this definition">¶</a></dt>
+<dd><p>Connection-specific TLS options.</p>
+<p>Note that, while a TLS context is an expensive object, a <a class="reference internal" href="#awscrt.io.TlsConnectionOptions" title="awscrt.io.TlsConnectionOptions"><code class="xref py py-class docutils literal notranslate"><span class="pre">TlsConnectionOptions</span></code></a> is cheap.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>tls_ctx</strong> (<a class="reference internal" href="#awscrt.io.ClientTlsContext" title="awscrt.io.ClientTlsContext"><em>ClientTlsContext</em></a>) – TLS context. A context can be shared by many connections.</p>
+</dd>
+</dl>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.io.TlsConnectionOptions.tls_ctx">
+<span class="sig-name descname"><span class="pre">tls_ctx</span></span><a class="headerlink" href="#awscrt.io.TlsConnectionOptions.tls_ctx" title="Link to this definition">¶</a></dt>
+<dd><p>TLS context.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference internal" href="#awscrt.io.ClientTlsContext" title="awscrt.io.ClientTlsContext">ClientTlsContext</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.io.TlsConnectionOptions.set_alpn_list">
+<span class="sig-name descname"><span class="pre">set_alpn_list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">alpn_list</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.io.TlsConnectionOptions.set_alpn_list" title="Link to this definition">¶</a></dt>
+<dd><p>Set names to use in Application Layer Protocol Negotiation (ALPN).</p>
+<p>This overrides any ALPN list on the TLS context, see <a class="reference internal" href="#awscrt.io.TlsContextOptions.alpn_list" title="awscrt.io.TlsContextOptions.alpn_list"><code class="xref py py-attr docutils literal notranslate"><span class="pre">TlsContextOptions.alpn_list</span></code></a>.
+ALPN is not supported on all systems, see <a class="reference internal" href="#awscrt.io.is_alpn_available" title="awscrt.io.is_alpn_available"><code class="xref py py-meth docutils literal notranslate"><span class="pre">is_alpn_available()</span></code></a>.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>alpn_list</strong> (<em>List</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>]</em>) – List of protocol names.</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.io.TlsConnectionOptions.set_server_name">
+<span class="sig-name descname"><span class="pre">set_server_name</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">server_name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.io.TlsConnectionOptions.set_server_name" title="Link to this definition">¶</a></dt>
+<dd><p>Set server name.</p>
+<p>Sets name for TLS Server Name Indication (SNI).
+Name is also used for x.509 validation.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>server_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Server name.</p>
+</dd>
+</dl>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="awscrt.io.is_alpn_available">
+<span class="sig-prename descclassname"><span class="pre">awscrt.io.</span></span><span class="sig-name descname"><span class="pre">is_alpn_available</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.io.is_alpn_available" title="Link to this definition">¶</a></dt>
+<dd><p>Returns True if Application Layer Protocol Negotiation (ALPN)
+is supported on this system.</p>
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.io.InputStream">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.io.</span></span><span class="sig-name descname"><span class="pre">InputStream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stream</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.io.InputStream" title="Link to this definition">¶</a></dt>
+<dd><p>InputStream allows <cite>awscrt</cite> native code to read from Python binary I/O classes.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>stream</strong> (<a class="reference external" href="https://docs.python.org/3/library/io.html#io.IOBase" title="(in Python v3.12)"><em>io.IOBase</em></a>) – Python binary I/O stream to wrap.</p>
+</dd>
+</dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.io.InputStream.wrap">
+<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">wrap</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stream</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allow_none</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.io.InputStream.wrap" title="Link to this definition">¶</a></dt>
+<dd><p>Given some stream type, returns an <a class="reference internal" href="#awscrt.io.InputStream" title="awscrt.io.InputStream"><code class="xref py py-class docutils literal notranslate"><span class="pre">InputStream</span></code></a>.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>stream</strong> (<em>Union</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/io.html#io.IOBase" title="(in Python v3.12)"><em>io.IOBase</em></a><em>, </em><a class="reference internal" href="#awscrt.io.InputStream" title="awscrt.io.InputStream"><em>InputStream</em></a><em>, </em><em>None</em><em>]</em>) – Binary I/O stream to wrap.</p></li>
+<li><p><strong>allow_none</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – Whether to allow <cite>stream</cite> to be None.
+If False (default), and <cite>stream</cite> is None, an exception is raised.</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p><em>Union[InputStream, None]</em> – If <cite>stream</cite> is already an <a class="reference internal" href="#awscrt.io.InputStream" title="awscrt.io.InputStream"><code class="xref py py-class docutils literal notranslate"><span class="pre">InputStream</span></code></a>, it is returned.
+Otherwise, an <a class="reference internal" href="#awscrt.io.InputStream" title="awscrt.io.InputStream"><code class="xref py py-class docutils literal notranslate"><span class="pre">InputStream</span></code></a> which wraps the <cite>stream</cite> is returned.
+If <cite>allow_none</cite> is True, and <cite>stream</cite> is None, then None is returned.</p>
+</dd>
+</dl>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.io.Pkcs11Lib">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.io.</span></span><span class="sig-name descname"><span class="pre">Pkcs11Lib</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">behavior</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.io.Pkcs11Lib.InitializeFinalizeBehavior" title="awscrt.io.Pkcs11Lib.InitializeFinalizeBehavior"><span class="pre">InitializeFinalizeBehavior</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.io.Pkcs11Lib" title="Link to this definition">¶</a></dt>
+<dd><p>Handle to a loaded PKCS#11 library.</p>
+<p>For most use cases, a single instance of <a class="reference internal" href="#awscrt.io.Pkcs11Lib" title="awscrt.io.Pkcs11Lib"><code class="xref py py-class docutils literal notranslate"><span class="pre">Pkcs11Lib</span></code></a> should be used for the
+lifetime of your application.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Keyword Arguments<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>file</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Path to PKCS#11 library.</p></li>
+<li><p><strong>behavior</strong> (<em>Optional</em><em>[</em><a class="reference internal" href="#awscrt.io.Pkcs11Lib.InitializeFinalizeBehavior" title="awscrt.io.Pkcs11Lib.InitializeFinalizeBehavior"><em>InitializeFinalizeBehavior</em></a><em>]</em>) – Specifies how <cite>C_Initialize()</cite> and <cite>C_Finalize()</cite> will be called
+on the PKCS#11 library (default is <a class="reference internal" href="#awscrt.io.Pkcs11Lib.InitializeFinalizeBehavior.DEFAULT" title="awscrt.io.Pkcs11Lib.InitializeFinalizeBehavior.DEFAULT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">InitializeFinalizeBehavior.DEFAULT</span></code></a>)</p></li>
+</ul>
+</dd>
+</dl>
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.io.Pkcs11Lib.InitializeFinalizeBehavior">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">InitializeFinalizeBehavior</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.io.Pkcs11Lib.InitializeFinalizeBehavior" title="Link to this definition">¶</a></dt>
+<dd><p>An enumeration.</p>
+<p>Controls how <cite>C_Initialize()</cite> and <cite>C_Finalize()</cite> are called on the PKCS#11 library.</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.io.Pkcs11Lib.InitializeFinalizeBehavior.DEFAULT">
+<span class="sig-name descname"><span class="pre">DEFAULT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#awscrt.io.Pkcs11Lib.InitializeFinalizeBehavior.DEFAULT" title="Link to this definition">¶</a></dt>
+<dd><p>Relaxed behavior that accommodates most use cases.</p>
+<p><cite>C_Initialize()</cite> is called on creation, and “already-initialized”
+errors are ignored. <cite>C_Finalize()</cite> is never called, just in case
+another part of your application is still using the PKCS#11 library.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.io.Pkcs11Lib.InitializeFinalizeBehavior.OMIT">
+<span class="sig-name descname"><span class="pre">OMIT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#awscrt.io.Pkcs11Lib.InitializeFinalizeBehavior.OMIT" title="Link to this definition">¶</a></dt>
+<dd><p>Skip calling <cite>C_Initialize()</cite> and <cite>C_Finalize()</cite>.</p>
+<p>Use this if your application has already initialized the PKCS#11 library, and
+you do not want <cite>C_Initialize()</cite> called again.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.io.Pkcs11Lib.InitializeFinalizeBehavior.STRICT">
+<span class="sig-name descname"><span class="pre">STRICT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#awscrt.io.Pkcs11Lib.InitializeFinalizeBehavior.STRICT" title="Link to this definition">¶</a></dt>
+<dd><p><cite>C_Initialize()</cite> is called on creation and <cite>C_Finalize()</cite> is
+called on cleanup.</p>
+<p>If <cite>C_Initialize()</cite> reports that’s it’s already initialized, this is
+treated as an error. Use this if you need perfect cleanup (ex: running
+valgrind with –leak-check).</p>
+</dd></dl>
+
+</dd></dl>
+
+</dd></dl>
+
+</section>
+
+
+            <div class="clearer"></div>
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+  <div>
+    <h3><a href="../index.html">Table of Contents</a></h3>
+    <ul>
+<li><a class="reference internal" href="#">awscrt.io</a><ul>
+<li><a class="reference internal" href="#awscrt.io.LogLevel"><code class="docutils literal notranslate"><span class="pre">LogLevel</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.io.LogLevel.NoLogs"><code class="docutils literal notranslate"><span class="pre">NoLogs</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.io.LogLevel.Fatal"><code class="docutils literal notranslate"><span class="pre">Fatal</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.io.LogLevel.Error"><code class="docutils literal notranslate"><span class="pre">Error</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.io.LogLevel.Warn"><code class="docutils literal notranslate"><span class="pre">Warn</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.io.LogLevel.Info"><code class="docutils literal notranslate"><span class="pre">Info</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.io.LogLevel.Debug"><code class="docutils literal notranslate"><span class="pre">Debug</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.io.LogLevel.Trace"><code class="docutils literal notranslate"><span class="pre">Trace</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.io.init_logging"><code class="docutils literal notranslate"><span class="pre">init_logging()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.io.EventLoopGroup"><code class="docutils literal notranslate"><span class="pre">EventLoopGroup</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.io.EventLoopGroup.shutdown_event"><code class="docutils literal notranslate"><span class="pre">shutdown_event</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.io.HostResolverBase"><code class="docutils literal notranslate"><span class="pre">HostResolverBase</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.io.DefaultHostResolver"><code class="docutils literal notranslate"><span class="pre">DefaultHostResolver</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.io.ClientBootstrap"><code class="docutils literal notranslate"><span class="pre">ClientBootstrap</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.io.ClientBootstrap.shutdown_event"><code class="docutils literal notranslate"><span class="pre">shutdown_event</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.io.SocketDomain"><code class="docutils literal notranslate"><span class="pre">SocketDomain</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.io.SocketDomain.IPv4"><code class="docutils literal notranslate"><span class="pre">IPv4</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.io.SocketDomain.IPv6"><code class="docutils literal notranslate"><span class="pre">IPv6</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.io.SocketDomain.Local"><code class="docutils literal notranslate"><span class="pre">Local</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.io.SocketType"><code class="docutils literal notranslate"><span class="pre">SocketType</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.io.SocketType.Stream"><code class="docutils literal notranslate"><span class="pre">Stream</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.io.SocketType.DGram"><code class="docutils literal notranslate"><span class="pre">DGram</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.io.SocketOptions"><code class="docutils literal notranslate"><span class="pre">SocketOptions</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.io.SocketOptions.domain"><code class="docutils literal notranslate"><span class="pre">domain</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.io.SocketOptions.type"><code class="docutils literal notranslate"><span class="pre">type</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.io.SocketOptions.connect_timeout_ms"><code class="docutils literal notranslate"><span class="pre">connect_timeout_ms</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.io.SocketOptions.keep_alive"><code class="docutils literal notranslate"><span class="pre">keep_alive</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.io.SocketOptions.keep_alive_timeout_secs"><code class="docutils literal notranslate"><span class="pre">keep_alive_timeout_secs</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.io.SocketOptions.keep_alive_interval_secs"><code class="docutils literal notranslate"><span class="pre">keep_alive_interval_secs</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.io.SocketOptions.keep_alive_max_probes"><code class="docutils literal notranslate"><span class="pre">keep_alive_max_probes</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.io.TlsVersion"><code class="docutils literal notranslate"><span class="pre">TlsVersion</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.io.TlsVersion.SSLv3"><code class="docutils literal notranslate"><span class="pre">SSLv3</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.io.TlsVersion.TLSv1"><code class="docutils literal notranslate"><span class="pre">TLSv1</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.io.TlsVersion.TLSv1_1"><code class="docutils literal notranslate"><span class="pre">TLSv1_1</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.io.TlsVersion.TLSv1_2"><code class="docutils literal notranslate"><span class="pre">TLSv1_2</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.io.TlsVersion.TLSv1_3"><code class="docutils literal notranslate"><span class="pre">TLSv1_3</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.io.TlsVersion.DEFAULT"><code class="docutils literal notranslate"><span class="pre">DEFAULT</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.io.TlsCipherPref"><code class="docutils literal notranslate"><span class="pre">TlsCipherPref</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.io.TlsCipherPref.DEFAULT"><code class="docutils literal notranslate"><span class="pre">DEFAULT</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.io.TlsCipherPref.PQ_TLSv1_0_2021_05"><code class="docutils literal notranslate"><span class="pre">PQ_TLSv1_0_2021_05</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.io.TlsCipherPref.is_supported"><code class="docutils literal notranslate"><span class="pre">is_supported()</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.io.TlsContextOptions"><code class="docutils literal notranslate"><span class="pre">TlsContextOptions</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.io.TlsContextOptions.min_tls_ver"><code class="docutils literal notranslate"><span class="pre">min_tls_ver</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.io.TlsContextOptions.cipher_pref"><code class="docutils literal notranslate"><span class="pre">cipher_pref</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.io.TlsContextOptions.verify_peer"><code class="docutils literal notranslate"><span class="pre">verify_peer</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.io.TlsContextOptions.alpn_list"><code class="docutils literal notranslate"><span class="pre">alpn_list</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.io.TlsContextOptions.create_client_with_mtls_from_path"><code class="docutils literal notranslate"><span class="pre">create_client_with_mtls_from_path()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.io.TlsContextOptions.create_client_with_mtls"><code class="docutils literal notranslate"><span class="pre">create_client_with_mtls()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.io.TlsContextOptions.create_client_with_mtls_pkcs11"><code class="docutils literal notranslate"><span class="pre">create_client_with_mtls_pkcs11()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.io.TlsContextOptions.create_client_with_mtls_pkcs12"><code class="docutils literal notranslate"><span class="pre">create_client_with_mtls_pkcs12()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.io.TlsContextOptions.create_client_with_mtls_windows_cert_store_path"><code class="docutils literal notranslate"><span class="pre">create_client_with_mtls_windows_cert_store_path()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.io.TlsContextOptions.create_server_from_path"><code class="docutils literal notranslate"><span class="pre">create_server_from_path()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.io.TlsContextOptions.create_server"><code class="docutils literal notranslate"><span class="pre">create_server()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.io.TlsContextOptions.create_server_pkcs12"><code class="docutils literal notranslate"><span class="pre">create_server_pkcs12()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.io.TlsContextOptions.override_default_trust_store_from_path"><code class="docutils literal notranslate"><span class="pre">override_default_trust_store_from_path()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.io.TlsContextOptions.override_default_trust_store"><code class="docutils literal notranslate"><span class="pre">override_default_trust_store()</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.io.ClientTlsContext"><code class="docutils literal notranslate"><span class="pre">ClientTlsContext</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.io.ClientTlsContext.new_connection_options"><code class="docutils literal notranslate"><span class="pre">new_connection_options()</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.io.TlsConnectionOptions"><code class="docutils literal notranslate"><span class="pre">TlsConnectionOptions</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.io.TlsConnectionOptions.tls_ctx"><code class="docutils literal notranslate"><span class="pre">tls_ctx</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.io.TlsConnectionOptions.set_alpn_list"><code class="docutils literal notranslate"><span class="pre">set_alpn_list()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.io.TlsConnectionOptions.set_server_name"><code class="docutils literal notranslate"><span class="pre">set_server_name()</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.io.is_alpn_available"><code class="docutils literal notranslate"><span class="pre">is_alpn_available()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.io.InputStream"><code class="docutils literal notranslate"><span class="pre">InputStream</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.io.InputStream.wrap"><code class="docutils literal notranslate"><span class="pre">wrap()</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.io.Pkcs11Lib"><code class="docutils literal notranslate"><span class="pre">Pkcs11Lib</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.io.Pkcs11Lib.InitializeFinalizeBehavior"><code class="docutils literal notranslate"><span class="pre">InitializeFinalizeBehavior</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.io.Pkcs11Lib.InitializeFinalizeBehavior.DEFAULT"><code class="docutils literal notranslate"><span class="pre">DEFAULT</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.io.Pkcs11Lib.InitializeFinalizeBehavior.OMIT"><code class="docutils literal notranslate"><span class="pre">OMIT</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.io.Pkcs11Lib.InitializeFinalizeBehavior.STRICT"><code class="docutils literal notranslate"><span class="pre">STRICT</span></code></a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+
+  </div>
+  <div>
+    <h4>Previous topic</h4>
+    <p class="topless"><a href="http.html"
+                          title="previous chapter">awscrt.http</a></p>
+  </div>
+  <div>
+    <h4>Next topic</h4>
+    <p class="topless"><a href="mqtt.html"
+                          title="next chapter">awscrt.mqtt</a></p>
+  </div>
+  <div role="note" aria-label="source link">
+    <h3>This Page</h3>
+    <ul class="this-page-menu">
+      <li><a href="../_sources/api/io.rst.txt"
+            rel="nofollow">Show Source</a></li>
+    </ul>
+   </div>
+<div id="searchbox" style="display: none" role="search">
+  <h3 id="searchlabel">Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="../search.html" method="get">
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+      <input type="submit" value="Go" />
+    </form>
+    </div>
+</div>
+<script>document.getElementById('searchbox').style.display = "block"</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../genindex.html" title="General Index"
+             >index</a></li>
+        <li class="right" >
+          <a href="../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="right" >
+          <a href="mqtt.html" title="awscrt.mqtt"
+             >next</a> |</li>
+        <li class="right" >
+          <a href="http.html" title="awscrt.http"
+             >previous</a> |</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">awscrt  documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">awscrt.io</a></li> 
+      </ul>
+    </div>
+    <div class="footer" role="contentinfo">
+    &#169; Copyright 2020, Amazon Web Services, Inc.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
+    </div>
+  </body>
+</html>
\ No newline at end of file
diff --git a/docs/api/mqtt.html b/docs/api/mqtt.html
new file mode 100644
index 000000000..38656232a
--- /dev/null
+++ b/docs/api/mqtt.html
@@ -0,0 +1,773 @@
+
+
+<!doctype html>
+
+<html lang="en" data-content_root="../">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+
+    <title>awscrt.mqtt &#8212; awscrt  documentation</title>
+    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=649a27d8" />
+    <link rel="stylesheet" type="text/css" href="../_static/css/custom.css?v=93be7416" />
+    
+    <script src="../_static/documentation_options.js?v=5929fcd5"></script>
+    <script src="../_static/doctools.js?v=888ff710"></script>
+    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script src="../_static/bizstyle.js"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" />
+    <link rel="next" title="awscrt.mqtt5" href="mqtt5.html" />
+    <link rel="prev" title="awscrt.io" href="io.html" />
+    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+    <!--[if lt IE 9]>
+    <script src="_static/css3-mediaqueries.js"></script>
+    <![endif]-->
+  </head><body>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../genindex.html" title="General Index"
+             accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="right" >
+          <a href="mqtt5.html" title="awscrt.mqtt5"
+             accesskey="N">next</a> |</li>
+        <li class="right" >
+          <a href="io.html" title="awscrt.io"
+             accesskey="P">previous</a> |</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">awscrt  documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">awscrt.mqtt</a></li> 
+      </ul>
+    </div>  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body" role="main">
+            
+  <section id="module-awscrt.mqtt">
+<span id="awscrt-mqtt"></span><h1>awscrt.mqtt<a class="headerlink" href="#module-awscrt.mqtt" title="Link to this heading">¶</a></h1>
+<p>MQTT</p>
+<p>All network operations in <cite>awscrt.mqtt</cite> are asynchronous.</p>
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt.QoS">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt.</span></span><span class="sig-name descname"><span class="pre">QoS</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt.QoS" title="Link to this definition">¶</a></dt>
+<dd><p>Quality of Service enumeration</p>
+<p>[MQTT-4.3]</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt.QoS.AT_MOST_ONCE">
+<span class="sig-name descname"><span class="pre">AT_MOST_ONCE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#awscrt.mqtt.QoS.AT_MOST_ONCE" title="Link to this definition">¶</a></dt>
+<dd><p>QoS 0 - At most once delivery</p>
+<p>The message is delivered according to the capabilities of the underlying network.
+No response is sent by the receiver and no retry is performed by the sender.
+The message arrives at the receiver either once or not at all.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt.QoS.AT_LEAST_ONCE">
+<span class="sig-name descname"><span class="pre">AT_LEAST_ONCE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#awscrt.mqtt.QoS.AT_LEAST_ONCE" title="Link to this definition">¶</a></dt>
+<dd><p>QoS 1 - At least once delivery</p>
+<p>This quality of service ensures that the message arrives at the receiver at least once.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt.QoS.EXACTLY_ONCE">
+<span class="sig-name descname"><span class="pre">EXACTLY_ONCE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#awscrt.mqtt.QoS.EXACTLY_ONCE" title="Link to this definition">¶</a></dt>
+<dd><p>QoS 2 - Exactly once delivery</p>
+<p>This is the highest quality of service, for use when neither loss nor
+duplication of messages are acceptable. There is an increased overhead
+associated with this quality of service.</p>
+<p>Note that, while this client supports QoS 2, the AWS IoT Core server
+does not support QoS 2 at time of writing (May 2020).</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt.ConnectReturnCode">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt.</span></span><span class="sig-name descname"><span class="pre">ConnectReturnCode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt.ConnectReturnCode" title="Link to this definition">¶</a></dt>
+<dd><p>Connect return code enumeration.</p>
+<p>[MQTT-3.2.2.3]</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt.ConnectReturnCode.ACCEPTED">
+<span class="sig-name descname"><span class="pre">ACCEPTED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#awscrt.mqtt.ConnectReturnCode.ACCEPTED" title="Link to this definition">¶</a></dt>
+<dd><p>Connection Accepted.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt.ConnectReturnCode.UNACCEPTABLE_PROTOCOL_VERSION">
+<span class="sig-name descname"><span class="pre">UNACCEPTABLE_PROTOCOL_VERSION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#awscrt.mqtt.ConnectReturnCode.UNACCEPTABLE_PROTOCOL_VERSION" title="Link to this definition">¶</a></dt>
+<dd><p>Connection Refused, unacceptable protocol version.</p>
+<p>The Server does not support the level of the MQTT protocol requested by the Client.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt.ConnectReturnCode.IDENTIFIER_REJECTED">
+<span class="sig-name descname"><span class="pre">IDENTIFIER_REJECTED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#awscrt.mqtt.ConnectReturnCode.IDENTIFIER_REJECTED" title="Link to this definition">¶</a></dt>
+<dd><p>Connection Refused, identifier rejected.</p>
+<p>The Client identifier is correct UTF-8 but not allowed by the Server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt.ConnectReturnCode.SERVER_UNAVAILABLE">
+<span class="sig-name descname"><span class="pre">SERVER_UNAVAILABLE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">3</span></em><a class="headerlink" href="#awscrt.mqtt.ConnectReturnCode.SERVER_UNAVAILABLE" title="Link to this definition">¶</a></dt>
+<dd><p>Connection Refused, Server unavailable.</p>
+<p>The Network Connection has been made but the MQTT service is unavailable.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt.ConnectReturnCode.BAD_USERNAME_OR_PASSWORD">
+<span class="sig-name descname"><span class="pre">BAD_USERNAME_OR_PASSWORD</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">4</span></em><a class="headerlink" href="#awscrt.mqtt.ConnectReturnCode.BAD_USERNAME_OR_PASSWORD" title="Link to this definition">¶</a></dt>
+<dd><p>Connection Refused, bad user name or password.</p>
+<p>The data in the user name or password is malformed.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt.ConnectReturnCode.NOT_AUTHORIZED">
+<span class="sig-name descname"><span class="pre">NOT_AUTHORIZED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">5</span></em><a class="headerlink" href="#awscrt.mqtt.ConnectReturnCode.NOT_AUTHORIZED" title="Link to this definition">¶</a></dt>
+<dd><p>Connection Refused, not authorized.</p>
+<p>The Client is not authorized to connect.</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt.Will">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt.</span></span><span class="sig-name descname"><span class="pre">Will</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">topic</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">qos</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">payload</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">retain</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt.Will" title="Link to this definition">¶</a></dt>
+<dd><p>A Will message is published by the server if a client is lost unexpectedly.</p>
+<p>The Will message is stored on the server when a client connects.
+It is published if the client connection is lost without the server
+receiving a DISCONNECT packet.</p>
+<p>[MQTT-3.1.2-8]</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>topic</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Topic to publish Will message on.</p></li>
+<li><p><strong>qos</strong> (<a class="reference internal" href="#awscrt.mqtt.QoS" title="awscrt.mqtt.QoS"><em>QoS</em></a>) – QoS used when publishing the Will message.</p></li>
+<li><p><strong>payload</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.12)"><em>bytes</em></a>) – Content of Will message.</p></li>
+<li><p><strong>retain</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – Whether the Will message is to be retained when it is published.</p></li>
+</ul>
+</dd>
+</dl>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt.Will.topic">
+<span class="sig-name descname"><span class="pre">topic</span></span><a class="headerlink" href="#awscrt.mqtt.Will.topic" title="Link to this definition">¶</a></dt>
+<dd><p>Topic to publish Will message on.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt.Will.qos">
+<span class="sig-name descname"><span class="pre">qos</span></span><a class="headerlink" href="#awscrt.mqtt.Will.qos" title="Link to this definition">¶</a></dt>
+<dd><p>QoS used when publishing the Will message.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference internal" href="#awscrt.mqtt.QoS" title="awscrt.mqtt.QoS">QoS</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt.Will.payload">
+<span class="sig-name descname"><span class="pre">payload</span></span><a class="headerlink" href="#awscrt.mqtt.Will.payload" title="Link to this definition">¶</a></dt>
+<dd><p>Content of Will message.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.12)">bytes</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt.Will.retain">
+<span class="sig-name descname"><span class="pre">retain</span></span><a class="headerlink" href="#awscrt.mqtt.Will.retain" title="Link to this definition">¶</a></dt>
+<dd><p>Whether the Will message is to be retained when it is published.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)">bool</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt.OnConnectionSuccessData">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt.</span></span><span class="sig-name descname"><span class="pre">OnConnectionSuccessData</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">return_code</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.mqtt.ConnectReturnCode" title="awscrt.mqtt.ConnectReturnCode"><span class="pre">ConnectReturnCode</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session_present</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt.OnConnectionSuccessData" title="Link to this definition">¶</a></dt>
+<dd><p>Dataclass containing data related to a on_connection_success Callback</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>return_code</strong> (<a class="reference internal" href="#awscrt.mqtt.ConnectReturnCode" title="awscrt.mqtt.ConnectReturnCode"><em>ConnectReturnCode</em></a>) – Connect return. code received from the server.</p></li>
+<li><p><strong>session_present</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – True if the connection resumes an existing session.
+False if new session. Note that the server has forgotten all previous subscriptions
+if this is False.
+Subscriptions can be re-established via resubscribe_existing_topics() if the connection was a reconnection.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt.OnConnectionFailureData">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt.</span></span><span class="sig-name descname"><span class="pre">OnConnectionFailureData</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="exceptions.html#awscrt.exceptions.AwsCrtError" title="awscrt.exceptions.AwsCrtError"><span class="pre">AwsCrtError</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt.OnConnectionFailureData" title="Link to this definition">¶</a></dt>
+<dd><p>Dataclass containing data related to a on_connection_failure Callback</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>error</strong> (<a class="reference internal" href="#awscrt.mqtt.ConnectReturnCode" title="awscrt.mqtt.ConnectReturnCode"><em>ConnectReturnCode</em></a>) – Error code with reason for connection failure</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt.OnConnectionClosedData">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt.</span></span><span class="sig-name descname"><span class="pre">OnConnectionClosedData</span></span><a class="headerlink" href="#awscrt.mqtt.OnConnectionClosedData" title="Link to this definition">¶</a></dt>
+<dd><p>Dataclass containing data related to a on_connection_closed Callback.
+Currently unused.</p>
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt.Client">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt.</span></span><span class="sig-name descname"><span class="pre">Client</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bootstrap</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tls_ctx</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt.Client" title="Link to this definition">¶</a></dt>
+<dd><p>MQTT client.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>bootstrap</strong> (<em>Optional</em><em> [</em><a class="reference internal" href="io.html#awscrt.io.ClientBootstrap" title="awscrt.io.ClientBootstrap"><em>ClientBootstrap</em></a><em>]</em>) – Client bootstrap to use when initiating new socket connections.
+If None is provided, the default singleton is used.</p></li>
+<li><p><strong>tls_ctx</strong> (<em>Optional</em><em>[</em><a class="reference internal" href="io.html#awscrt.io.ClientTlsContext" title="awscrt.io.ClientTlsContext"><em>ClientTlsContext</em></a><em>]</em>) – TLS context for secure socket connections.
+If None is provided, then an unencrypted connection is used.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt.OperationStatisticsData">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt.</span></span><span class="sig-name descname"><span class="pre">OperationStatisticsData</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">incomplete_operation_count</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">incomplete_operation_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">unacked_operation_count</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">unacked_operation_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt.OperationStatisticsData" title="Link to this definition">¶</a></dt>
+<dd><p>Dataclass containing some simple statistics about the current state of the connection’s queue of operations</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>incomplete_operation_count</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – total number of operations submitted to the connection that have not yet been completed.  Unacked operations are a subset of this.</p></li>
+<li><p><strong>incomplete_operation_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – total packet size of operations submitted to the connection that have not yet been completed.  Unacked operations are a subset of this.</p></li>
+<li><p><strong>unacked_operation_count</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – total number of operations that have been sent to the server and are waiting for a corresponding ACK before they can be completed.</p></li>
+<li><p><strong>unacked_operation_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – total packet size of operations that have been sent to the server and are waiting for a corresponding ACK before they can be completed.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt.Connection">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt.</span></span><span class="sig-name descname"><span class="pre">Connection</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">clean_session</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">on_connection_interrupted</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">on_connection_resumed</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reconnect_min_timeout_secs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reconnect_max_timeout_secs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">60</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">keep_alive_secs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1200</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ping_timeout_ms</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">3000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">protocol_operation_timeout_ms</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">will</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">username</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">password</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">socket_options</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_websockets</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">websocket_proxy_options</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">websocket_handshake_transform</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">proxy_options</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">on_connection_success</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">on_connection_failure</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">on_connection_closed</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt.Connection" title="Link to this definition">¶</a></dt>
+<dd><p>MQTT client connection.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>client</strong> (<a class="reference internal" href="#awscrt.mqtt.Client" title="awscrt.mqtt.Client"><em>Client</em></a>) – MQTT client to spawn connection from.</p></li>
+<li><p><strong>host_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Server name to connect to.</p></li>
+<li><p><strong>port</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – Server port to connect to.</p></li>
+<li><p><strong>client_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – ID to place in CONNECT packet. Must be unique across all devices/clients.
+If an ID is already in use, the other client will be disconnected.</p></li>
+<li><p><strong>clean_session</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – Whether or not to start a clean session with each reconnect.
+If True, the server will forget all subscriptions with each reconnect.
+Set False to request that the server resume an existing session
+or start a new session that may be resumed after a connection loss.
+The <cite>session_present</cite> bool in the connection callback informs
+whether an existing session was successfully resumed.
+If an existing session is resumed, the server remembers previous subscriptions
+and sends messages (with QoS1 or higher) that were published while the client was offline.</p></li>
+<li><p><strong>on_connection_interrupted</strong> – <p>Optional callback invoked whenever the MQTT connection is lost.
+The MQTT client will automatically attempt to reconnect.
+The function should take the following arguments return nothing:</p>
+<blockquote>
+<div><ul>
+<li><p><cite>connection</cite> (<a class="reference internal" href="#awscrt.mqtt.Connection" title="awscrt.mqtt.Connection"><code class="xref py py-class docutils literal notranslate"><span class="pre">Connection</span></code></a>): This MQTT Connection.</p></li>
+<li><p><cite>error</cite> (<a class="reference internal" href="exceptions.html#awscrt.exceptions.AwsCrtError" title="awscrt.exceptions.AwsCrtError"><code class="xref py py-class docutils literal notranslate"><span class="pre">awscrt.exceptions.AwsCrtError</span></code></a>): Exception which caused connection loss.</p></li>
+<li><p><cite>**kwargs</cite> (dict): Forward-compatibility kwargs.</p></li>
+</ul>
+</div></blockquote>
+</p></li>
+<li><p><strong>on_connection_resumed</strong> – <p>Optional callback invoked whenever the MQTT connection
+is automatically resumed. Function should take the following arguments and return nothing:</p>
+<blockquote>
+<div><ul>
+<li><p><cite>connection</cite> (<a class="reference internal" href="#awscrt.mqtt.Connection" title="awscrt.mqtt.Connection"><code class="xref py py-class docutils literal notranslate"><span class="pre">Connection</span></code></a>): This MQTT Connection</p></li>
+<li><p><cite>return_code</cite> (<a class="reference internal" href="#awscrt.mqtt.ConnectReturnCode" title="awscrt.mqtt.ConnectReturnCode"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConnectReturnCode</span></code></a>): Connect return
+code received from the server.</p></li>
+<li><p><cite>session_present</cite> (bool): True if resuming existing session. False if new session.
+Note that the server has forgotten all previous subscriptions if this is False.
+Subscriptions can be re-established via resubscribe_existing_topics().</p></li>
+<li><p><cite>**kwargs</cite> (dict): Forward-compatibility kwargs.</p></li>
+</ul>
+</div></blockquote>
+</p></li>
+<li><p><strong>on_connection_success</strong> – <p>Optional callback invoked whenever the connection successfully connects.
+This callback is invoked for every successful connect and every successful reconnect.</p>
+<p>Function should take the following arguments and return nothing:</p>
+<blockquote>
+<div><ul>
+<li><p><cite>connection</cite> (<a class="reference internal" href="#awscrt.mqtt.Connection" title="awscrt.mqtt.Connection"><code class="xref py py-class docutils literal notranslate"><span class="pre">Connection</span></code></a>): This MQTT Connection</p></li>
+<li><p><cite>callback_data</cite> (<a class="reference internal" href="#awscrt.mqtt.OnConnectionSuccessData" title="awscrt.mqtt.OnConnectionSuccessData"><code class="xref py py-class docutils literal notranslate"><span class="pre">OnConnectionSuccessData</span></code></a>): The data returned from the connection success.</p></li>
+</ul>
+</div></blockquote>
+</p></li>
+<li><p><strong>on_connection_failure</strong> – <p>Optional callback invoked whenever the connection fails to connect.
+This callback is invoked for every failed connect and every failed reconnect.</p>
+<p>Function should take the following arguments and return nothing:</p>
+<blockquote>
+<div><ul>
+<li><p><cite>connection</cite> (<a class="reference internal" href="#awscrt.mqtt.Connection" title="awscrt.mqtt.Connection"><code class="xref py py-class docutils literal notranslate"><span class="pre">Connection</span></code></a>): This MQTT Connection</p></li>
+<li><p><cite>callback_data</cite> (<a class="reference internal" href="#awscrt.mqtt.OnConnectionFailureData" title="awscrt.mqtt.OnConnectionFailureData"><code class="xref py py-class docutils literal notranslate"><span class="pre">OnConnectionFailureData</span></code></a>): The data returned from the connection failure.</p></li>
+</ul>
+</div></blockquote>
+</p></li>
+<li><p><strong>on_connection_closed</strong> – <p>Optional callback invoked whenever the connection has been disconnected and shutdown successfully.
+Function should take the following arguments and return nothing:</p>
+<blockquote>
+<div><ul>
+<li><p><cite>connection</cite> (<a class="reference internal" href="#awscrt.mqtt.Connection" title="awscrt.mqtt.Connection"><code class="xref py py-class docutils literal notranslate"><span class="pre">Connection</span></code></a>): This MQTT Connection</p></li>
+<li><p><cite>callback_data</cite> (<a class="reference internal" href="#awscrt.mqtt.OnConnectionClosedData" title="awscrt.mqtt.OnConnectionClosedData"><code class="xref py py-class docutils literal notranslate"><span class="pre">OnConnectionClosedData</span></code></a>): The data returned from the connection close.</p></li>
+</ul>
+</div></blockquote>
+</p></li>
+<li><p><strong>reconnect_min_timeout_secs</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – Minimum time to wait between reconnect attempts.
+Must be &lt;= <cite>reconnect_max_timeout_secs</cite>.
+Wait starts at min and doubles with each attempt until max is reached.</p></li>
+<li><p><strong>reconnect_max_timeout_secs</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – Maximum time to wait between reconnect attempts.
+Must be &gt;= <cite>reconnect_min_timeout_secs</cite>.
+Wait starts at min and doubles with each attempt until max is reached.</p></li>
+<li><p><strong>keep_alive_secs</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – The keep alive value, in seconds, to send in CONNECT packet.
+A PING will automatically be sent at this interval.
+The server will assume the connection is lost if no PING is received after 1.5X this value.
+This duration must be longer than ping_timeout_ms.</p></li>
+<li><p><strong>ping_timeout_ms</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – Milliseconds to wait for ping response before client assumes
+the connection is invalid and attempts to reconnect.
+This duration must be shorter than <cite>keep_alive_secs</cite>.</p></li>
+<li><p><strong>protocol_operation_timeout_ms</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – Milliseconds to wait for the response to the operation
+requires response by protocol. Set to zero to disable timeout. Otherwise,
+the operation will fail if no response is received within this amount of time after
+the packet is written to the socket
+It applied to PUBLISH (QoS&gt;0) and UNSUBSCRIBE now.</p></li>
+<li><p><strong>will</strong> (<a class="reference internal" href="#awscrt.mqtt.Will" title="awscrt.mqtt.Will"><em>Will</em></a>) – Will to send with CONNECT packet. The will is
+published by the server when its connection to the client is unexpectedly lost.</p></li>
+<li><p><strong>username</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Username to connect with.</p></li>
+<li><p><strong>password</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Password to connect with.</p></li>
+<li><p><strong>socket_options</strong> (<em>Optional</em><em>[</em><a class="reference internal" href="io.html#awscrt.io.SocketOptions" title="awscrt.io.SocketOptions"><em>awscrt.io.SocketOptions</em></a><em>]</em>) – Optional socket options.</p></li>
+<li><p><strong>use_websocket</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – If true, connect to MQTT over websockets.</p></li>
+<li><p><strong>websocket_proxy_options</strong> (<em>Optional</em><em>[</em><a class="reference internal" href="http.html#awscrt.http.HttpProxyOptions" title="awscrt.http.HttpProxyOptions"><em>awscrt.http.HttpProxyOptions</em></a><em>]</em>) – Optional proxy options for websocket connections.  Deprecated, use <cite>proxy_options</cite> instead.</p></li>
+<li><p><strong>websocket_handshake_transform</strong> – <p>Optional function to transform websocket handshake request.
+If provided, function is called each time a websocket connection is attempted.
+The function may modify the HTTP request before it is sent to the server.
+See <a class="reference internal" href="#awscrt.mqtt.WebsocketHandshakeTransformArgs" title="awscrt.mqtt.WebsocketHandshakeTransformArgs"><code class="xref py py-class docutils literal notranslate"><span class="pre">WebsocketHandshakeTransformArgs</span></code></a> for more info.
+Function should take the following arguments and return nothing:</p>
+<blockquote>
+<div><ul>
+<li><p><cite>transform_args</cite> (<a class="reference internal" href="#awscrt.mqtt.WebsocketHandshakeTransformArgs" title="awscrt.mqtt.WebsocketHandshakeTransformArgs"><code class="xref py py-class docutils literal notranslate"><span class="pre">WebsocketHandshakeTransformArgs</span></code></a>):
+Contains HTTP request to be transformed. Function must call
+<cite>transform_args.done()</cite> when complete.</p></li>
+<li><p><cite>**kwargs</cite> (dict): Forward-compatibility kwargs.</p></li>
+</ul>
+</div></blockquote>
+</p></li>
+<li><p><strong>proxy_options</strong> (<em>Optional</em><em>[</em><a class="reference internal" href="http.html#awscrt.http.HttpProxyOptions" title="awscrt.http.HttpProxyOptions"><em>awscrt.http.HttpProxyOptions</em></a><em>]</em>) – Optional proxy options for all connections.</p></li>
+</ul>
+</dd>
+</dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.mqtt.Connection.connect">
+<span class="sig-name descname"><span class="pre">connect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt.Connection.connect" title="Link to this definition">¶</a></dt>
+<dd><p>Open the actual connection to the server (async).</p>
+<dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p><p><em>concurrent.futures.Future</em> – Future which completes when connection succeeds or fails.
+If connection fails, Future will contain an exception.
+If connection succeeds, Future will contain a dict with the following members:</p>
+<ul class="simple">
+<li><p>[‘session_present’] (bool): is True if resuming existing session and False if new session.</p></li>
+</ul>
+</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.mqtt.Connection.disconnect">
+<span class="sig-name descname"><span class="pre">disconnect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt.Connection.disconnect" title="Link to this definition">¶</a></dt>
+<dd><p>Close the connection (async).</p>
+<dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p><em>concurrent.futures.Future</em> – Future which completes when the connection is closed.
+The future will contain an empty dict.</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.mqtt.Connection.subscribe">
+<span class="sig-name descname"><span class="pre">subscribe</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">topic</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">qos</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">callback</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt.Connection.subscribe" title="Link to this definition">¶</a></dt>
+<dd><p>Subscribe to a topic filter (async).</p>
+<p>The client sends a SUBSCRIBE packet and the server responds with a SUBACK.</p>
+<p>subscribe() may be called while the device is offline, though the async
+operation cannot complete successfully until the connection resumes.</p>
+<p>Once subscribed, <cite>callback</cite> is invoked each time a message matching
+the <cite>topic</cite> is received. It is possible for such messages to arrive before
+the SUBACK is received.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>topic</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Subscribe to this topic filter, which may include wildcards.</p></li>
+<li><p><strong>qos</strong> (<a class="reference internal" href="#awscrt.mqtt.QoS" title="awscrt.mqtt.QoS"><em>QoS</em></a>) – Maximum requested QoS that server may use when sending messages to the client.
+The server may grant a lower QoS in the SUBACK (see returned Future)</p></li>
+<li><p><strong>callback</strong> – <p>Optional callback invoked when message received.
+Function should take the following arguments and return nothing:</p>
+<blockquote>
+<div><ul>
+<li><p><cite>topic</cite> (str): Topic receiving message.</p></li>
+<li><p><cite>payload</cite> (bytes): Payload of message.</p></li>
+<li><p><cite>dup</cite> (bool): DUP flag. If True, this might be re-delivery
+of an earlier attempt to send the message.</p></li>
+<li><p><cite>qos</cite> (<a class="reference internal" href="#awscrt.mqtt.QoS" title="awscrt.mqtt.QoS"><code class="xref py py-class docutils literal notranslate"><span class="pre">QoS</span></code></a>): Quality of Service used to deliver the message.</p></li>
+<li><p><cite>retain</cite> (bool): Retain flag. If True, the message was sent
+as a result of a new subscription being made by the client.</p></li>
+<li><p><cite>**kwargs</cite> (dict): Forward-compatibility kwargs.</p></li>
+</ul>
+</div></blockquote>
+</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p><p><em>Tuple[concurrent.futures.Future, int]</em> – Tuple containing a Future and
+the ID of the SUBSCRIBE packet. The Future completes when a
+SUBACK is received from the server. If successful, the Future will
+contain a dict with the following members:</p>
+<blockquote>
+<div><ul class="simple">
+<li><p>[‘packet_id’] (int): ID of the SUBSCRIBE packet being acknowledged.</p></li>
+<li><p>[‘topic’] (str): Topic filter of the SUBSCRIBE packet being acknowledged.</p></li>
+<li><p>[‘qos’] (<a class="reference internal" href="#awscrt.mqtt.QoS" title="awscrt.mqtt.QoS"><code class="xref py py-class docutils literal notranslate"><span class="pre">QoS</span></code></a>): Maximum QoS that was granted by the server.
+This may be lower than the requested QoS.</p></li>
+</ul>
+</div></blockquote>
+<p>If unsuccessful, the Future contains an exception. The exception
+will be a <a class="reference internal" href="#awscrt.mqtt.SubscribeError" title="awscrt.mqtt.SubscribeError"><code class="xref py py-class docutils literal notranslate"><span class="pre">SubscribeError</span></code></a> if a SUBACK was received
+in which the server rejected the subscription. Other exception
+types indicate other errors with the operation.</p>
+</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.mqtt.Connection.on_message">
+<span class="sig-name descname"><span class="pre">on_message</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">callback</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt.Connection.on_message" title="Link to this definition">¶</a></dt>
+<dd><p>Set callback to be invoked when ANY message is received.</p>
+<dl>
+<dt>callback: Callback to invoke when message received, or None to disable.</dt><dd><p>Function should take the following arguments and return nothing:</p>
+<blockquote>
+<div><ul class="simple">
+<li><p><cite>topic</cite> (str): Topic receiving message.</p></li>
+<li><p><cite>payload</cite> (bytes): Payload of message.</p></li>
+<li><p><cite>dup</cite> (bool): DUP flag. If True, this might be re-delivery
+of an earlier attempt to send the message.</p></li>
+<li><p><cite>qos</cite> (<a class="reference internal" href="#awscrt.mqtt.QoS" title="awscrt.mqtt.QoS"><code class="xref py py-class docutils literal notranslate"><span class="pre">QoS</span></code></a>): Quality of Service used to deliver the message.</p></li>
+<li><p><cite>retain</cite> (bool): Retain flag. If True, the message was sent
+as a result of a new subscription being made by the client.</p></li>
+<li><p><cite>**kwargs</cite> (dict): Forward-compatibility kwargs.</p></li>
+</ul>
+</div></blockquote>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.mqtt.Connection.unsubscribe">
+<span class="sig-name descname"><span class="pre">unsubscribe</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">topic</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt.Connection.unsubscribe" title="Link to this definition">¶</a></dt>
+<dd><p>Unsubscribe from a topic filter (async).</p>
+<p>The client sends an UNSUBSCRIBE packet, and the server responds with an UNSUBACK.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>topic</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Unsubscribe from this topic filter.</p>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p><p><em>Tuple[concurrent.futures.Future, int]</em> – Tuple containing a Future and
+the ID of the UNSUBSCRIBE packet. The Future completes when an
+UNSUBACK is received from the server. If successful, the Future
+will contain a dict with the following members:</p>
+<ul class="simple">
+<li><p>[‘packet_id’] (int): ID of the UNSUBSCRIBE packet being acknowledged.</p></li>
+</ul>
+</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.mqtt.Connection.resubscribe_existing_topics">
+<span class="sig-name descname"><span class="pre">resubscribe_existing_topics</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt.Connection.resubscribe_existing_topics" title="Link to this definition">¶</a></dt>
+<dd><p>Subscribe again to all current topics.</p>
+<p>This is to help when resuming a connection with a clean session.</p>
+<p><strong>Important</strong>: Currently the resubscribe function does not take the AWS IoT Core maximum subscriptions
+per subscribe request quota into account. If the client has more subscriptions than the maximum,
+resubscribing must be done manually using the <cite>subscribe()</cite> function for each desired topic
+filter. The client will be disconnected by AWS IoT Core if the resubscribe exceeds the subscriptions
+per subscribe request quota.</p>
+<p>The AWS IoT Core maximum subscriptions per subscribe request quota is listed at the following URL:
+<a class="reference external" href="https://docs.aws.amazon.com/general/latest/gr/iot-core.html#genref_max_subscriptions_per_subscribe_request">https://docs.aws.amazon.com/general/latest/gr/iot-core.html#genref_max_subscriptions_per_subscribe_request</a></p>
+<dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p><p><em>Tuple[concurrent.futures.Future, int]</em> – Tuple containing a Future and
+the ID of the SUBSCRIBE packet. The Future completes when a SUBACK
+is received from the server. If successful, the Future will contain
+a dict with the following members:</p>
+<ul class="simple">
+<li><p>[‘packet_id’]: ID of the SUBSCRIBE packet being acknowledged,
+or None if there were no topics to resubscribe to.</p></li>
+<li><p>[‘topics’]: A list of (topic, qos) tuples, where qos will be
+None if the topic failed to resubscribe. If there were no topics
+to resubscribe to, then the list will be empty.</p></li>
+</ul>
+</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.mqtt.Connection.publish">
+<span class="sig-name descname"><span class="pre">publish</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">topic</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">payload</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">qos</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">retain</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt.Connection.publish" title="Link to this definition">¶</a></dt>
+<dd><p>Publish message (async).</p>
+<p>If the device is offline, the PUBLISH packet will be sent once the connection resumes.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>topic</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Topic name.</p></li>
+<li><p><strong>payload</strong> (<em>Union</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.12)"><em>bytes</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytearray" title="(in Python v3.12)"><em>bytearray</em></a><em>]</em>) – Contents of message.</p></li>
+<li><p><strong>qos</strong> (<a class="reference internal" href="#awscrt.mqtt.QoS" title="awscrt.mqtt.QoS"><em>QoS</em></a>) – Quality of Service for delivering this message.</p></li>
+<li><p><strong>retain</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – If True, the server will store the message and its QoS
+so that it can be delivered to future subscribers whose subscriptions
+match its topic name.</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p><p><em>Tuple[concurrent.futures.Future, int]</em> – Tuple containing a Future and
+the ID of the PUBLISH packet. The QoS determines when the Future completes:</p>
+<ul class="simple">
+<li><p>For QoS 0, completes as soon as the packet is sent.</p></li>
+<li><p>For QoS 1, completes when PUBACK is received.</p></li>
+<li><p>For QoS 2, completes when PUBCOMP is received.</p></li>
+</ul>
+<p>If successful, the Future will contain a dict with the following members:</p>
+<ul class="simple">
+<li><p>[‘packet_id’] (int): ID of the PUBLISH packet that is complete.</p></li>
+</ul>
+</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.mqtt.Connection.get_stats">
+<span class="sig-name descname"><span class="pre">get_stats</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt.Connection.get_stats" title="Link to this definition">¶</a></dt>
+<dd><p>Queries the connection’s internal statistics for incomplete operations.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p>The (<a class="reference internal" href="#awscrt.mqtt.OperationStatisticsData" title="awscrt.mqtt.OperationStatisticsData"><code class="xref py py-class docutils literal notranslate"><span class="pre">OperationStatisticsData</span></code></a>) containing the statistics</p>
+</dd>
+</dl>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt.WebsocketHandshakeTransformArgs">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt.</span></span><span class="sig-name descname"><span class="pre">WebsocketHandshakeTransformArgs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mqtt_connection</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">http_request</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">done_future</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt.WebsocketHandshakeTransformArgs" title="Link to this definition">¶</a></dt>
+<dd><p>Argument to a “websocket_handshake_transform” function.</p>
+<p>A websocket_handshake_transform function has signature:
+<code class="docutils literal notranslate"><span class="pre">fn(transform_args:</span> <span class="pre">WebsocketHandshakeTransformArgs,</span> <span class="pre">**kwargs)</span> <span class="pre">-&gt;</span> <span class="pre">None</span></code></p>
+<p>The function implementer may modify <cite>transform_args.http_request</cite> as desired.
+They MUST call <cite>transform_args.set_done()</cite> when complete, passing an
+exception if something went wrong. Failure to call <cite>set_done()</cite>
+will hang the application.</p>
+<p>The implementer may do asynchronous work before calling <cite>transform_args.set_done()</cite>,
+they are not required to call <cite>set_done()</cite> within the scope of the transform function.
+An example of async work would be to fetch credentials from another service,
+sign the request headers, and finally call <cite>set_done()</cite> to mark the transform complete.</p>
+<p>The default websocket handshake request uses path “/mqtt”.
+All required headers are present,
+plus the optional header “Sec-WebSocket-Protocol: mqtt”.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>mqtt_connection</strong> (<a class="reference internal" href="#awscrt.mqtt.Connection" title="awscrt.mqtt.Connection"><em>Connection</em></a>) – Connection this handshake is for.</p></li>
+<li><p><strong>http_request</strong> (<a class="reference internal" href="http.html#awscrt.http.HttpRequest" title="awscrt.http.HttpRequest"><em>awscrt.http.HttpRequest</em></a>) – HTTP request for this handshake.</p></li>
+<li><p><strong>done_future</strong> (<a class="reference external" href="https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.Future" title="(in Python v3.12)"><em>concurrent.futures.Future</em></a>) – Future to complete when the
+<a class="reference internal" href="#awscrt.mqtt.WebsocketHandshakeTransformArgs.set_done" title="awscrt.mqtt.WebsocketHandshakeTransformArgs.set_done"><code class="xref py py-meth docutils literal notranslate"><span class="pre">set_done()</span></code></a> is called. It will contain None if successful,
+or an exception will be set.</p></li>
+</ul>
+</dd>
+</dl>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt.WebsocketHandshakeTransformArgs.mqtt_connection">
+<span class="sig-name descname"><span class="pre">mqtt_connection</span></span><a class="headerlink" href="#awscrt.mqtt.WebsocketHandshakeTransformArgs.mqtt_connection" title="Link to this definition">¶</a></dt>
+<dd><p>Connection this handshake is for.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference internal" href="#awscrt.mqtt.Connection" title="awscrt.mqtt.Connection">Connection</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt.WebsocketHandshakeTransformArgs.http_request">
+<span class="sig-name descname"><span class="pre">http_request</span></span><a class="headerlink" href="#awscrt.mqtt.WebsocketHandshakeTransformArgs.http_request" title="Link to this definition">¶</a></dt>
+<dd><p>HTTP request for this handshake.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference internal" href="http.html#awscrt.http.HttpRequest" title="awscrt.http.HttpRequest">awscrt.http.HttpRequest</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.mqtt.WebsocketHandshakeTransformArgs.set_done">
+<span class="sig-name descname"><span class="pre">set_done</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">exception</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt.WebsocketHandshakeTransformArgs.set_done" title="Link to this definition">¶</a></dt>
+<dd><p>Mark the transformation complete.
+If exception is passed in, the handshake is canceled.</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py exception">
+<dt class="sig sig-object py" id="awscrt.mqtt.SubscribeError">
+<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt.</span></span><span class="sig-name descname"><span class="pre">SubscribeError</span></span><a class="headerlink" href="#awscrt.mqtt.SubscribeError" title="Link to this definition">¶</a></dt>
+<dd><p>Subscription rejected by server.</p>
+</dd></dl>
+
+</section>
+
+
+            <div class="clearer"></div>
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+  <div>
+    <h3><a href="../index.html">Table of Contents</a></h3>
+    <ul>
+<li><a class="reference internal" href="#">awscrt.mqtt</a><ul>
+<li><a class="reference internal" href="#awscrt.mqtt.QoS"><code class="docutils literal notranslate"><span class="pre">QoS</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.mqtt.QoS.AT_MOST_ONCE"><code class="docutils literal notranslate"><span class="pre">AT_MOST_ONCE</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt.QoS.AT_LEAST_ONCE"><code class="docutils literal notranslate"><span class="pre">AT_LEAST_ONCE</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt.QoS.EXACTLY_ONCE"><code class="docutils literal notranslate"><span class="pre">EXACTLY_ONCE</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.mqtt.ConnectReturnCode"><code class="docutils literal notranslate"><span class="pre">ConnectReturnCode</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.mqtt.ConnectReturnCode.ACCEPTED"><code class="docutils literal notranslate"><span class="pre">ACCEPTED</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt.ConnectReturnCode.UNACCEPTABLE_PROTOCOL_VERSION"><code class="docutils literal notranslate"><span class="pre">UNACCEPTABLE_PROTOCOL_VERSION</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt.ConnectReturnCode.IDENTIFIER_REJECTED"><code class="docutils literal notranslate"><span class="pre">IDENTIFIER_REJECTED</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt.ConnectReturnCode.SERVER_UNAVAILABLE"><code class="docutils literal notranslate"><span class="pre">SERVER_UNAVAILABLE</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt.ConnectReturnCode.BAD_USERNAME_OR_PASSWORD"><code class="docutils literal notranslate"><span class="pre">BAD_USERNAME_OR_PASSWORD</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt.ConnectReturnCode.NOT_AUTHORIZED"><code class="docutils literal notranslate"><span class="pre">NOT_AUTHORIZED</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.mqtt.Will"><code class="docutils literal notranslate"><span class="pre">Will</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.mqtt.Will.topic"><code class="docutils literal notranslate"><span class="pre">topic</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt.Will.qos"><code class="docutils literal notranslate"><span class="pre">qos</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt.Will.payload"><code class="docutils literal notranslate"><span class="pre">payload</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt.Will.retain"><code class="docutils literal notranslate"><span class="pre">retain</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.mqtt.OnConnectionSuccessData"><code class="docutils literal notranslate"><span class="pre">OnConnectionSuccessData</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt.OnConnectionFailureData"><code class="docutils literal notranslate"><span class="pre">OnConnectionFailureData</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt.OnConnectionClosedData"><code class="docutils literal notranslate"><span class="pre">OnConnectionClosedData</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt.Client"><code class="docutils literal notranslate"><span class="pre">Client</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt.OperationStatisticsData"><code class="docutils literal notranslate"><span class="pre">OperationStatisticsData</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt.Connection"><code class="docutils literal notranslate"><span class="pre">Connection</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.mqtt.Connection.connect"><code class="docutils literal notranslate"><span class="pre">connect()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt.Connection.disconnect"><code class="docutils literal notranslate"><span class="pre">disconnect()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt.Connection.subscribe"><code class="docutils literal notranslate"><span class="pre">subscribe()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt.Connection.on_message"><code class="docutils literal notranslate"><span class="pre">on_message()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt.Connection.unsubscribe"><code class="docutils literal notranslate"><span class="pre">unsubscribe()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt.Connection.resubscribe_existing_topics"><code class="docutils literal notranslate"><span class="pre">resubscribe_existing_topics()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt.Connection.publish"><code class="docutils literal notranslate"><span class="pre">publish()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt.Connection.get_stats"><code class="docutils literal notranslate"><span class="pre">get_stats()</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.mqtt.WebsocketHandshakeTransformArgs"><code class="docutils literal notranslate"><span class="pre">WebsocketHandshakeTransformArgs</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.mqtt.WebsocketHandshakeTransformArgs.mqtt_connection"><code class="docutils literal notranslate"><span class="pre">mqtt_connection</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt.WebsocketHandshakeTransformArgs.http_request"><code class="docutils literal notranslate"><span class="pre">http_request</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt.WebsocketHandshakeTransformArgs.set_done"><code class="docutils literal notranslate"><span class="pre">set_done()</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.mqtt.SubscribeError"><code class="docutils literal notranslate"><span class="pre">SubscribeError</span></code></a></li>
+</ul>
+</li>
+</ul>
+
+  </div>
+  <div>
+    <h4>Previous topic</h4>
+    <p class="topless"><a href="io.html"
+                          title="previous chapter">awscrt.io</a></p>
+  </div>
+  <div>
+    <h4>Next topic</h4>
+    <p class="topless"><a href="mqtt5.html"
+                          title="next chapter">awscrt.mqtt5</a></p>
+  </div>
+  <div role="note" aria-label="source link">
+    <h3>This Page</h3>
+    <ul class="this-page-menu">
+      <li><a href="../_sources/api/mqtt.rst.txt"
+            rel="nofollow">Show Source</a></li>
+    </ul>
+   </div>
+<div id="searchbox" style="display: none" role="search">
+  <h3 id="searchlabel">Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="../search.html" method="get">
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+      <input type="submit" value="Go" />
+    </form>
+    </div>
+</div>
+<script>document.getElementById('searchbox').style.display = "block"</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../genindex.html" title="General Index"
+             >index</a></li>
+        <li class="right" >
+          <a href="../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="right" >
+          <a href="mqtt5.html" title="awscrt.mqtt5"
+             >next</a> |</li>
+        <li class="right" >
+          <a href="io.html" title="awscrt.io"
+             >previous</a> |</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">awscrt  documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">awscrt.mqtt</a></li> 
+      </ul>
+    </div>
+    <div class="footer" role="contentinfo">
+    &#169; Copyright 2020, Amazon Web Services, Inc.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
+    </div>
+  </body>
+</html>
\ No newline at end of file
diff --git a/docs/api/mqtt5.html b/docs/api/mqtt5.html
new file mode 100644
index 000000000..6df49df28
--- /dev/null
+++ b/docs/api/mqtt5.html
@@ -0,0 +1,1726 @@
+
+
+<!doctype html>
+
+<html lang="en" data-content_root="../">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+
+    <title>awscrt.mqtt5 &#8212; awscrt  documentation</title>
+    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=649a27d8" />
+    <link rel="stylesheet" type="text/css" href="../_static/css/custom.css?v=93be7416" />
+    
+    <script src="../_static/documentation_options.js?v=5929fcd5"></script>
+    <script src="../_static/doctools.js?v=888ff710"></script>
+    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script src="../_static/bizstyle.js"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" />
+    <link rel="next" title="awscrt.s3" href="s3.html" />
+    <link rel="prev" title="awscrt.mqtt" href="mqtt.html" />
+    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+    <!--[if lt IE 9]>
+    <script src="_static/css3-mediaqueries.js"></script>
+    <![endif]-->
+  </head><body>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../genindex.html" title="General Index"
+             accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="right" >
+          <a href="s3.html" title="awscrt.s3"
+             accesskey="N">next</a> |</li>
+        <li class="right" >
+          <a href="mqtt.html" title="awscrt.mqtt"
+             accesskey="P">previous</a> |</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">awscrt  documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">awscrt.mqtt5</a></li> 
+      </ul>
+    </div>  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body" role="main">
+            
+  <section id="module-awscrt.mqtt5">
+<span id="awscrt-mqtt5"></span><h1>awscrt.mqtt5<a class="headerlink" href="#module-awscrt.mqtt5" title="Link to this heading">¶</a></h1>
+<p>MQTT5</p>
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt5.QoS">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt5.</span></span><span class="sig-name descname"><span class="pre">QoS</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt5.QoS" title="Link to this definition">¶</a></dt>
+<dd><p>MQTT message delivery quality of service.</p>
+<p>Enum values match <a class="reference external" href="https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901234">MQTT5 spec</a> encoding values.</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.QoS.AT_MOST_ONCE">
+<span class="sig-name descname"><span class="pre">AT_MOST_ONCE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#awscrt.mqtt5.QoS.AT_MOST_ONCE" title="Link to this definition">¶</a></dt>
+<dd><p>The message is delivered according to the capabilities of the underlying network. No response is sent by the
+receiver and no retry is performed by the sender. The message arrives at the receiver either once or not at all.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.QoS.AT_LEAST_ONCE">
+<span class="sig-name descname"><span class="pre">AT_LEAST_ONCE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#awscrt.mqtt5.QoS.AT_LEAST_ONCE" title="Link to this definition">¶</a></dt>
+<dd><p>A level of service that ensures that the message arrives at the receiver at least once.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.QoS.EXACTLY_ONCE">
+<span class="sig-name descname"><span class="pre">EXACTLY_ONCE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#awscrt.mqtt5.QoS.EXACTLY_ONCE" title="Link to this definition">¶</a></dt>
+<dd><p>A level of service that ensures that the message arrives at the receiver exactly once.</p>
+<p>Note that this client does not currently support QoS 2 as of (August 2022)</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt5.ConnectReasonCode">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt5.</span></span><span class="sig-name descname"><span class="pre">ConnectReasonCode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt5.ConnectReasonCode" title="Link to this definition">¶</a></dt>
+<dd><p>Server return code for connect attempts.</p>
+<p>Enum values match <a class="reference external" href="https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901079">MQTT5 spec</a> encoding values.</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.ConnectReasonCode.SUCCESS">
+<span class="sig-name descname"><span class="pre">SUCCESS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#awscrt.mqtt5.ConnectReasonCode.SUCCESS" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the connection is accepted.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.ConnectReasonCode.UNSPECIFIED_ERROR">
+<span class="sig-name descname"><span class="pre">UNSPECIFIED_ERROR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">128</span></em><a class="headerlink" href="#awscrt.mqtt5.ConnectReasonCode.UNSPECIFIED_ERROR" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the server has a failure but does not want to specify a reason or none
+of the other reason codes apply.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.ConnectReasonCode.MALFORMED_PACKET">
+<span class="sig-name descname"><span class="pre">MALFORMED_PACKET</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">129</span></em><a class="headerlink" href="#awscrt.mqtt5.ConnectReasonCode.MALFORMED_PACKET" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when data in the CONNECT packet could not be correctly parsed by the server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.ConnectReasonCode.PROTOCOL_ERROR">
+<span class="sig-name descname"><span class="pre">PROTOCOL_ERROR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">130</span></em><a class="headerlink" href="#awscrt.mqtt5.ConnectReasonCode.PROTOCOL_ERROR" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when data in the CONNECT packet does not conform to the MQTT5 specification requirements.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.ConnectReasonCode.IMPLEMENTATION_SPECIFIC_ERROR">
+<span class="sig-name descname"><span class="pre">IMPLEMENTATION_SPECIFIC_ERROR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">131</span></em><a class="headerlink" href="#awscrt.mqtt5.ConnectReasonCode.IMPLEMENTATION_SPECIFIC_ERROR" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the CONNECT packet is valid but was not accepted by the server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.ConnectReasonCode.UNSUPPORTED_PROTOCOL_VERSION">
+<span class="sig-name descname"><span class="pre">UNSUPPORTED_PROTOCOL_VERSION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">132</span></em><a class="headerlink" href="#awscrt.mqtt5.ConnectReasonCode.UNSUPPORTED_PROTOCOL_VERSION" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the server does not support MQTT5 protocol version specified in the connection.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.ConnectReasonCode.CLIENT_IDENTIFIER_NOT_VALID">
+<span class="sig-name descname"><span class="pre">CLIENT_IDENTIFIER_NOT_VALID</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">133</span></em><a class="headerlink" href="#awscrt.mqtt5.ConnectReasonCode.CLIENT_IDENTIFIER_NOT_VALID" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the client identifier in the CONNECT packet is a valid string but not one that
+is allowed on the server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.ConnectReasonCode.BAD_USERNAME_OR_PASSWORD">
+<span class="sig-name descname"><span class="pre">BAD_USERNAME_OR_PASSWORD</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">134</span></em><a class="headerlink" href="#awscrt.mqtt5.ConnectReasonCode.BAD_USERNAME_OR_PASSWORD" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the server does not accept the username and/or password specified by the client
+in the connection packet.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.ConnectReasonCode.NOT_AUTHORIZED">
+<span class="sig-name descname"><span class="pre">NOT_AUTHORIZED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">135</span></em><a class="headerlink" href="#awscrt.mqtt5.ConnectReasonCode.NOT_AUTHORIZED" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the client is not authorized to connect to the server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.ConnectReasonCode.SERVER_UNAVAILABLE">
+<span class="sig-name descname"><span class="pre">SERVER_UNAVAILABLE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">136</span></em><a class="headerlink" href="#awscrt.mqtt5.ConnectReasonCode.SERVER_UNAVAILABLE" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the MQTT5 server is not available.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.ConnectReasonCode.SERVER_BUSY">
+<span class="sig-name descname"><span class="pre">SERVER_BUSY</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">137</span></em><a class="headerlink" href="#awscrt.mqtt5.ConnectReasonCode.SERVER_BUSY" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the server is too busy to make a connection. It is recommended that the client try again later.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.ConnectReasonCode.BANNED">
+<span class="sig-name descname"><span class="pre">BANNED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">138</span></em><a class="headerlink" href="#awscrt.mqtt5.ConnectReasonCode.BANNED" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the client has been banned by the server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.ConnectReasonCode.BAD_AUTHENTICATION_METHOD">
+<span class="sig-name descname"><span class="pre">BAD_AUTHENTICATION_METHOD</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">140</span></em><a class="headerlink" href="#awscrt.mqtt5.ConnectReasonCode.BAD_AUTHENTICATION_METHOD" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the authentication method used in the connection is either not supported on the server or it does
+not match the authentication method currently in use in the CONNECT packet.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.ConnectReasonCode.TOPIC_NAME_INVALID">
+<span class="sig-name descname"><span class="pre">TOPIC_NAME_INVALID</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">144</span></em><a class="headerlink" href="#awscrt.mqtt5.ConnectReasonCode.TOPIC_NAME_INVALID" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the Will topic name sent in the CONNECT packet is correctly formed, but is not accepted by
+the server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.ConnectReasonCode.PACKET_TOO_LARGE">
+<span class="sig-name descname"><span class="pre">PACKET_TOO_LARGE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">149</span></em><a class="headerlink" href="#awscrt.mqtt5.ConnectReasonCode.PACKET_TOO_LARGE" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the CONNECT packet exceeded the maximum permissible size on the server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.ConnectReasonCode.QUOTA_EXCEEDED">
+<span class="sig-name descname"><span class="pre">QUOTA_EXCEEDED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">151</span></em><a class="headerlink" href="#awscrt.mqtt5.ConnectReasonCode.QUOTA_EXCEEDED" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the quota limits set on the server have been met and/or exceeded.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.ConnectReasonCode.PAYLOAD_FORMAT_INVALID">
+<span class="sig-name descname"><span class="pre">PAYLOAD_FORMAT_INVALID</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">153</span></em><a class="headerlink" href="#awscrt.mqtt5.ConnectReasonCode.PAYLOAD_FORMAT_INVALID" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the Will payload in the CONNECT packet does not match the specified payload format indicator.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.ConnectReasonCode.RETAIN_NOT_SUPPORTED">
+<span class="sig-name descname"><span class="pre">RETAIN_NOT_SUPPORTED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">154</span></em><a class="headerlink" href="#awscrt.mqtt5.ConnectReasonCode.RETAIN_NOT_SUPPORTED" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the server does not retain messages but the CONNECT packet on the client had Will retain enabled.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.ConnectReasonCode.QOS_NOT_SUPPORTED">
+<span class="sig-name descname"><span class="pre">QOS_NOT_SUPPORTED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">155</span></em><a class="headerlink" href="#awscrt.mqtt5.ConnectReasonCode.QOS_NOT_SUPPORTED" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the server does not support the QOS setting set in the Will QOS in the CONNECT packet.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.ConnectReasonCode.USE_ANOTHER_SERVER">
+<span class="sig-name descname"><span class="pre">USE_ANOTHER_SERVER</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">156</span></em><a class="headerlink" href="#awscrt.mqtt5.ConnectReasonCode.USE_ANOTHER_SERVER" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the server is telling the client to temporarily use another server instead of the one they
+are trying to connect to.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.ConnectReasonCode.SERVER_MOVED">
+<span class="sig-name descname"><span class="pre">SERVER_MOVED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">157</span></em><a class="headerlink" href="#awscrt.mqtt5.ConnectReasonCode.SERVER_MOVED" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the server is telling the client to permanently use another server instead of the one they
+are trying to connect to.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.ConnectReasonCode.CONNECTION_RATE_EXCEEDED">
+<span class="sig-name descname"><span class="pre">CONNECTION_RATE_EXCEEDED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">159</span></em><a class="headerlink" href="#awscrt.mqtt5.ConnectReasonCode.CONNECTION_RATE_EXCEEDED" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the server connection rate limit has been exceeded.</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt5.DisconnectReasonCode">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt5.</span></span><span class="sig-name descname"><span class="pre">DisconnectReasonCode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt5.DisconnectReasonCode" title="Link to this definition">¶</a></dt>
+<dd><p>Reason code inside DISCONNECT packets.  Helps determine why a connection was terminated.</p>
+<p>Enum values match <a class="reference external" href="https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901208">MQTT5 spec</a> encoding values.</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.DisconnectReasonCode.NORMAL_DISCONNECTION">
+<span class="sig-name descname"><span class="pre">NORMAL_DISCONNECTION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#awscrt.mqtt5.DisconnectReasonCode.NORMAL_DISCONNECTION" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the remote endpoint wishes to disconnect normally. Will not trigger the publish of a Will message if a
+Will message was configured on the connection.</p>
+<p>May be sent by the client or server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.DisconnectReasonCode.DISCONNECT_WITH_WILL_MESSAGE">
+<span class="sig-name descname"><span class="pre">DISCONNECT_WITH_WILL_MESSAGE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">4</span></em><a class="headerlink" href="#awscrt.mqtt5.DisconnectReasonCode.DISCONNECT_WITH_WILL_MESSAGE" title="Link to this definition">¶</a></dt>
+<dd><p>Returns when the client wants to disconnect but requires that the server publish the Will message configured
+on the connection.</p>
+<p>May only be sent by the client.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.DisconnectReasonCode.UNSPECIFIED_ERROR">
+<span class="sig-name descname"><span class="pre">UNSPECIFIED_ERROR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">128</span></em><a class="headerlink" href="#awscrt.mqtt5.DisconnectReasonCode.UNSPECIFIED_ERROR" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the connection was closed but the sender does not want to specify a reason or none
+of the other reason codes apply.</p>
+<p>May be sent by the client or the server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.DisconnectReasonCode.MALFORMED_PACKET">
+<span class="sig-name descname"><span class="pre">MALFORMED_PACKET</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">129</span></em><a class="headerlink" href="#awscrt.mqtt5.DisconnectReasonCode.MALFORMED_PACKET" title="Link to this definition">¶</a></dt>
+<dd><p>Indicates the remote endpoint received a packet that does not conform to the MQTT specification.</p>
+<p>May be sent by the client or the server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.DisconnectReasonCode.PROTOCOL_ERROR">
+<span class="sig-name descname"><span class="pre">PROTOCOL_ERROR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">130</span></em><a class="headerlink" href="#awscrt.mqtt5.DisconnectReasonCode.PROTOCOL_ERROR" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when an unexpected or out-of-order packet was received by the remote endpoint.</p>
+<p>May be sent by the client or the server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.DisconnectReasonCode.IMPLEMENTATION_SPECIFIC_ERROR">
+<span class="sig-name descname"><span class="pre">IMPLEMENTATION_SPECIFIC_ERROR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">131</span></em><a class="headerlink" href="#awscrt.mqtt5.DisconnectReasonCode.IMPLEMENTATION_SPECIFIC_ERROR" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when a valid packet was received by the remote endpoint, but could not be processed by the current implementation.</p>
+<p>May be sent by the client or the server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.DisconnectReasonCode.NOT_AUTHORIZED">
+<span class="sig-name descname"><span class="pre">NOT_AUTHORIZED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">135</span></em><a class="headerlink" href="#awscrt.mqtt5.DisconnectReasonCode.NOT_AUTHORIZED" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the remote endpoint received a packet that represented an operation that was not authorized within
+the current connection.</p>
+<p>May only be sent by the server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.DisconnectReasonCode.SERVER_BUSY">
+<span class="sig-name descname"><span class="pre">SERVER_BUSY</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">137</span></em><a class="headerlink" href="#awscrt.mqtt5.DisconnectReasonCode.SERVER_BUSY" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the server is busy and cannot continue processing packets from the client.</p>
+<p>May only be sent by the server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.DisconnectReasonCode.SERVER_SHUTTING_DOWN">
+<span class="sig-name descname"><span class="pre">SERVER_SHUTTING_DOWN</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">139</span></em><a class="headerlink" href="#awscrt.mqtt5.DisconnectReasonCode.SERVER_SHUTTING_DOWN" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the server is shutting down.</p>
+<p>May only be sent by the server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.DisconnectReasonCode.KEEP_ALIVE_TIMEOUT">
+<span class="sig-name descname"><span class="pre">KEEP_ALIVE_TIMEOUT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">141</span></em><a class="headerlink" href="#awscrt.mqtt5.DisconnectReasonCode.KEEP_ALIVE_TIMEOUT" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the server closes the connection because no packet from the client has been received in
+1.5 times the KeepAlive time set when the connection was established.</p>
+<p>May only be sent by the server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.DisconnectReasonCode.SESSION_TAKEN_OVER">
+<span class="sig-name descname"><span class="pre">SESSION_TAKEN_OVER</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">142</span></em><a class="headerlink" href="#awscrt.mqtt5.DisconnectReasonCode.SESSION_TAKEN_OVER" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the server has established another connection with the same client ID as a client’s current
+connection, causing the current client to become disconnected.</p>
+<p>May only be sent by the server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.DisconnectReasonCode.TOPIC_FILTER_INVALID">
+<span class="sig-name descname"><span class="pre">TOPIC_FILTER_INVALID</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">143</span></em><a class="headerlink" href="#awscrt.mqtt5.DisconnectReasonCode.TOPIC_FILTER_INVALID" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the topic filter name is correctly formed but not accepted by the server.</p>
+<p>May only be sent by the server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.DisconnectReasonCode.TOPIC_NAME_INVALID">
+<span class="sig-name descname"><span class="pre">TOPIC_NAME_INVALID</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">144</span></em><a class="headerlink" href="#awscrt.mqtt5.DisconnectReasonCode.TOPIC_NAME_INVALID" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when topic name is correctly formed, but is not accepted.</p>
+<p>May be sent by the client or the server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.DisconnectReasonCode.RECEIVE_MAXIMUM_EXCEEDED">
+<span class="sig-name descname"><span class="pre">RECEIVE_MAXIMUM_EXCEEDED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">147</span></em><a class="headerlink" href="#awscrt.mqtt5.DisconnectReasonCode.RECEIVE_MAXIMUM_EXCEEDED" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the remote endpoint reached a state where there were more in-progress QoS1+ publishes then the
+limit it established for itself when the connection was opened.</p>
+<p>May be sent by the client or the server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.DisconnectReasonCode.TOPIC_ALIAS_INVALID">
+<span class="sig-name descname"><span class="pre">TOPIC_ALIAS_INVALID</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">148</span></em><a class="headerlink" href="#awscrt.mqtt5.DisconnectReasonCode.TOPIC_ALIAS_INVALID" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the remote endpoint receives a PUBLISH packet that contained a topic alias greater than the
+maximum topic alias limit that it established for itself when the connection was opened.</p>
+<p>May be sent by the client or the server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.DisconnectReasonCode.PACKET_TOO_LARGE">
+<span class="sig-name descname"><span class="pre">PACKET_TOO_LARGE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">149</span></em><a class="headerlink" href="#awscrt.mqtt5.DisconnectReasonCode.PACKET_TOO_LARGE" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the remote endpoint received a packet whose size was greater than the maximum packet size limit
+it established for itself when the connection was opened.</p>
+<p>May be sent by the client or the server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.DisconnectReasonCode.MESSAGE_RATE_TOO_HIGH">
+<span class="sig-name descname"><span class="pre">MESSAGE_RATE_TOO_HIGH</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">150</span></em><a class="headerlink" href="#awscrt.mqtt5.DisconnectReasonCode.MESSAGE_RATE_TOO_HIGH" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the remote endpoint’s incoming data rate was too high.</p>
+<p>May be sent by the client or the server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.DisconnectReasonCode.QUOTA_EXCEEDED">
+<span class="sig-name descname"><span class="pre">QUOTA_EXCEEDED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">151</span></em><a class="headerlink" href="#awscrt.mqtt5.DisconnectReasonCode.QUOTA_EXCEEDED" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when an internal quota of the remote endpoint was exceeded.</p>
+<p>May be sent by the client or the server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.DisconnectReasonCode.ADMINISTRATIVE_ACTION">
+<span class="sig-name descname"><span class="pre">ADMINISTRATIVE_ACTION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">152</span></em><a class="headerlink" href="#awscrt.mqtt5.DisconnectReasonCode.ADMINISTRATIVE_ACTION" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the connection was closed due to an administrative action.</p>
+<p>May be sent by the client or the server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.DisconnectReasonCode.PAYLOAD_FORMAT_INVALID">
+<span class="sig-name descname"><span class="pre">PAYLOAD_FORMAT_INVALID</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">153</span></em><a class="headerlink" href="#awscrt.mqtt5.DisconnectReasonCode.PAYLOAD_FORMAT_INVALID" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the remote endpoint received a packet where payload format did not match the format specified
+by the payload format indicator.</p>
+<p>May be sent by the client or the server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.DisconnectReasonCode.RETAIN_NOT_SUPPORTED">
+<span class="sig-name descname"><span class="pre">RETAIN_NOT_SUPPORTED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">154</span></em><a class="headerlink" href="#awscrt.mqtt5.DisconnectReasonCode.RETAIN_NOT_SUPPORTED" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the server does not support retained messages.</p>
+<p>May only be sent by the server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.DisconnectReasonCode.QOS_NOT_SUPPORTED">
+<span class="sig-name descname"><span class="pre">QOS_NOT_SUPPORTED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">155</span></em><a class="headerlink" href="#awscrt.mqtt5.DisconnectReasonCode.QOS_NOT_SUPPORTED" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the client sends a QoS that is greater than the maximum QoS established when the connection was
+opened.</p>
+<p>May only be sent by the server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.DisconnectReasonCode.USE_ANOTHER_SERVER">
+<span class="sig-name descname"><span class="pre">USE_ANOTHER_SERVER</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">156</span></em><a class="headerlink" href="#awscrt.mqtt5.DisconnectReasonCode.USE_ANOTHER_SERVER" title="Link to this definition">¶</a></dt>
+<dd><p>Returned by the server to tell the client to temporarily use a different server.</p>
+<p>May only be sent by the server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.DisconnectReasonCode.SERVER_MOVED">
+<span class="sig-name descname"><span class="pre">SERVER_MOVED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">157</span></em><a class="headerlink" href="#awscrt.mqtt5.DisconnectReasonCode.SERVER_MOVED" title="Link to this definition">¶</a></dt>
+<dd><p>Returned by the server to tell the client to permanently use a different server.</p>
+<p>May only be sent by the server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.DisconnectReasonCode.SHARED_SUBSCRIPTIONS_NOT_SUPPORTED">
+<span class="sig-name descname"><span class="pre">SHARED_SUBSCRIPTIONS_NOT_SUPPORTED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">158</span></em><a class="headerlink" href="#awscrt.mqtt5.DisconnectReasonCode.SHARED_SUBSCRIPTIONS_NOT_SUPPORTED" title="Link to this definition">¶</a></dt>
+<dd><p>Returned by the server to tell the client that shared subscriptions are not supported on the server.</p>
+<p>May only be sent by the server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.DisconnectReasonCode.CONNECTION_RATE_EXCEEDED">
+<span class="sig-name descname"><span class="pre">CONNECTION_RATE_EXCEEDED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">159</span></em><a class="headerlink" href="#awscrt.mqtt5.DisconnectReasonCode.CONNECTION_RATE_EXCEEDED" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the server disconnects the client due to the connection rate being too high.</p>
+<p>May only be sent by the server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.DisconnectReasonCode.MAXIMUM_CONNECT_TIME">
+<span class="sig-name descname"><span class="pre">MAXIMUM_CONNECT_TIME</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">160</span></em><a class="headerlink" href="#awscrt.mqtt5.DisconnectReasonCode.MAXIMUM_CONNECT_TIME" title="Link to this definition">¶</a></dt>
+<dd><p>Returned by the server when the maximum connection time authorized for the connection was exceeded.</p>
+<p>May only be sent by the server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.DisconnectReasonCode.SUBSCRIPTION_IDENTIFIERS_NOT_SUPPORTED">
+<span class="sig-name descname"><span class="pre">SUBSCRIPTION_IDENTIFIERS_NOT_SUPPORTED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">161</span></em><a class="headerlink" href="#awscrt.mqtt5.DisconnectReasonCode.SUBSCRIPTION_IDENTIFIERS_NOT_SUPPORTED" title="Link to this definition">¶</a></dt>
+<dd><p>Returned by the server when it received a SUBSCRIBE packet with a subscription identifier, but the server does
+not support subscription identifiers.</p>
+<p>May only be sent by the server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.DisconnectReasonCode.WILDCARD_SUBSCRIPTIONS_NOT_SUPPORTED">
+<span class="sig-name descname"><span class="pre">WILDCARD_SUBSCRIPTIONS_NOT_SUPPORTED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">162</span></em><a class="headerlink" href="#awscrt.mqtt5.DisconnectReasonCode.WILDCARD_SUBSCRIPTIONS_NOT_SUPPORTED" title="Link to this definition">¶</a></dt>
+<dd><p>Returned by the server when it received a SUBSCRIBE packet with a wildcard topic filter, but the server does
+not support wildcard topic filters.</p>
+<p>May only be sent by the server.</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt5.PubackReasonCode">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt5.</span></span><span class="sig-name descname"><span class="pre">PubackReasonCode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt5.PubackReasonCode" title="Link to this definition">¶</a></dt>
+<dd><p>Reason code inside PUBACK packets that indicates the result of the associated PUBLISH request.</p>
+<p>Enum values match <a class="reference external" href="https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901124">MQTT5 spec</a> encoding values.</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.PubackReasonCode.SUCCESS">
+<span class="sig-name descname"><span class="pre">SUCCESS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#awscrt.mqtt5.PubackReasonCode.SUCCESS" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the (QoS 1) publish was accepted by the recipient.</p>
+<p>May be sent by the client or the server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.PubackReasonCode.NO_MATCHING_SUBSCRIBERS">
+<span class="sig-name descname"><span class="pre">NO_MATCHING_SUBSCRIBERS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">16</span></em><a class="headerlink" href="#awscrt.mqtt5.PubackReasonCode.NO_MATCHING_SUBSCRIBERS" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the (QoS 1) publish was accepted but there were no matching subscribers.</p>
+<p>May only be sent by the server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.PubackReasonCode.UNSPECIFIED_ERROR">
+<span class="sig-name descname"><span class="pre">UNSPECIFIED_ERROR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">128</span></em><a class="headerlink" href="#awscrt.mqtt5.PubackReasonCode.UNSPECIFIED_ERROR" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the (QoS 1) publish was not accepted and the receiver does not want to specify a reason or none
+of the other reason codes apply.</p>
+<p>May be sent by the client or the server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.PubackReasonCode.IMPLEMENTATION_SPECIFIC_ERROR">
+<span class="sig-name descname"><span class="pre">IMPLEMENTATION_SPECIFIC_ERROR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">131</span></em><a class="headerlink" href="#awscrt.mqtt5.PubackReasonCode.IMPLEMENTATION_SPECIFIC_ERROR" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the (QoS 1) publish was valid but the receiver was not willing to accept it.</p>
+<p>May be sent by the client or the server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.PubackReasonCode.NOT_AUTHORIZED">
+<span class="sig-name descname"><span class="pre">NOT_AUTHORIZED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">135</span></em><a class="headerlink" href="#awscrt.mqtt5.PubackReasonCode.NOT_AUTHORIZED" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the (QoS 1) publish was not authorized by the receiver.</p>
+<p>May be sent by the client or the server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.PubackReasonCode.TOPIC_NAME_INVALID">
+<span class="sig-name descname"><span class="pre">TOPIC_NAME_INVALID</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">144</span></em><a class="headerlink" href="#awscrt.mqtt5.PubackReasonCode.TOPIC_NAME_INVALID" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the topic name was valid but the receiver was not willing to accept it.</p>
+<p>May be sent by the client or the server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.PubackReasonCode.PACKET_IDENTIFIER_IN_USE">
+<span class="sig-name descname"><span class="pre">PACKET_IDENTIFIER_IN_USE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">145</span></em><a class="headerlink" href="#awscrt.mqtt5.PubackReasonCode.PACKET_IDENTIFIER_IN_USE" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the packet identifier used in the associated PUBLISH was already in use.
+This can indicate a mismatch in the session state between client and server.</p>
+<p>May be sent by the client or the server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.PubackReasonCode.QUOTA_EXCEEDED">
+<span class="sig-name descname"><span class="pre">QUOTA_EXCEEDED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">151</span></em><a class="headerlink" href="#awscrt.mqtt5.PubackReasonCode.QUOTA_EXCEEDED" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the associated PUBLISH failed because an internal quota on the recipient was exceeded.</p>
+<p>May be sent by the client or the server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.PubackReasonCode.PAYLOAD_FORMAT_INVALID">
+<span class="sig-name descname"><span class="pre">PAYLOAD_FORMAT_INVALID</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">153</span></em><a class="headerlink" href="#awscrt.mqtt5.PubackReasonCode.PAYLOAD_FORMAT_INVALID" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the PUBLISH packet’s payload format did not match its payload format indicator property.</p>
+<p>May be sent by the client or the server.</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt5.SubackReasonCode">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt5.</span></span><span class="sig-name descname"><span class="pre">SubackReasonCode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt5.SubackReasonCode" title="Link to this definition">¶</a></dt>
+<dd><p>Reason code inside SUBACK packet payloads.</p>
+<p>Enum values match <a class="reference external" href="https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901178">MQTT5 spec</a> encoding values.</p>
+<p>This will only be sent by the server and not the client.</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.SubackReasonCode.GRANTED_QOS_0">
+<span class="sig-name descname"><span class="pre">GRANTED_QOS_0</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#awscrt.mqtt5.SubackReasonCode.GRANTED_QOS_0" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the subscription was accepted and the maximum QoS sent will be QoS 0.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.SubackReasonCode.GRANTED_QOS_1">
+<span class="sig-name descname"><span class="pre">GRANTED_QOS_1</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#awscrt.mqtt5.SubackReasonCode.GRANTED_QOS_1" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the subscription was accepted and the maximum QoS sent will be QoS 1.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.SubackReasonCode.GRANTED_QOS_2">
+<span class="sig-name descname"><span class="pre">GRANTED_QOS_2</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#awscrt.mqtt5.SubackReasonCode.GRANTED_QOS_2" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the subscription was accepted and the maximum QoS sent will be QoS 2.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.SubackReasonCode.UNSPECIFIED_ERROR">
+<span class="sig-name descname"><span class="pre">UNSPECIFIED_ERROR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">128</span></em><a class="headerlink" href="#awscrt.mqtt5.SubackReasonCode.UNSPECIFIED_ERROR" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the connection was closed but the sender does not want to specify a reason or none
+of the other reason codes apply.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.SubackReasonCode.IMPLEMENTATION_SPECIFIC_ERROR">
+<span class="sig-name descname"><span class="pre">IMPLEMENTATION_SPECIFIC_ERROR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">131</span></em><a class="headerlink" href="#awscrt.mqtt5.SubackReasonCode.IMPLEMENTATION_SPECIFIC_ERROR" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the subscription was valid but the server did not accept it.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.SubackReasonCode.NOT_AUTHORIZED">
+<span class="sig-name descname"><span class="pre">NOT_AUTHORIZED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">135</span></em><a class="headerlink" href="#awscrt.mqtt5.SubackReasonCode.NOT_AUTHORIZED" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the client was not authorized to make the subscription on the server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.SubackReasonCode.TOPIC_FILTER_INVALID">
+<span class="sig-name descname"><span class="pre">TOPIC_FILTER_INVALID</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">143</span></em><a class="headerlink" href="#awscrt.mqtt5.SubackReasonCode.TOPIC_FILTER_INVALID" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the subscription topic filter was correctly formed but not allowed for the client.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.SubackReasonCode.PACKET_IDENTIFIER_IN_USE">
+<span class="sig-name descname"><span class="pre">PACKET_IDENTIFIER_IN_USE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">145</span></em><a class="headerlink" href="#awscrt.mqtt5.SubackReasonCode.PACKET_IDENTIFIER_IN_USE" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the packet identifier was already in use on the server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.SubackReasonCode.QUOTA_EXCEEDED">
+<span class="sig-name descname"><span class="pre">QUOTA_EXCEEDED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">151</span></em><a class="headerlink" href="#awscrt.mqtt5.SubackReasonCode.QUOTA_EXCEEDED" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when a subscribe-related quota set on the server was exceeded.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.SubackReasonCode.SHARED_SUBSCRIPTIONS_NOT_SUPPORTED">
+<span class="sig-name descname"><span class="pre">SHARED_SUBSCRIPTIONS_NOT_SUPPORTED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">158</span></em><a class="headerlink" href="#awscrt.mqtt5.SubackReasonCode.SHARED_SUBSCRIPTIONS_NOT_SUPPORTED" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the subscription’s topic filter was a shared subscription and the server does not support
+shared subscriptions.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.SubackReasonCode.SUBSCRIPTION_IDENTIFIERS_NOT_SUPPORTED">
+<span class="sig-name descname"><span class="pre">SUBSCRIPTION_IDENTIFIERS_NOT_SUPPORTED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">161</span></em><a class="headerlink" href="#awscrt.mqtt5.SubackReasonCode.SUBSCRIPTION_IDENTIFIERS_NOT_SUPPORTED" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the SUBSCRIBE packet contained a subscription identifier and the server does not support
+subscription identifiers.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.SubackReasonCode.WILDCARD_SUBSCRIPTIONS_NOT_SUPPORTED">
+<span class="sig-name descname"><span class="pre">WILDCARD_SUBSCRIPTIONS_NOT_SUPPORTED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">162</span></em><a class="headerlink" href="#awscrt.mqtt5.SubackReasonCode.WILDCARD_SUBSCRIPTIONS_NOT_SUPPORTED" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the subscription’s topic filter contains a wildcard but the server does not support
+wildcard subscriptions.</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt5.UnsubackReasonCode">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt5.</span></span><span class="sig-name descname"><span class="pre">UnsubackReasonCode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt5.UnsubackReasonCode" title="Link to this definition">¶</a></dt>
+<dd><p>Reason codes inside UNSUBACK packet payloads that specify the results for each topic filter in the associated
+UNSUBSCRIBE packet.</p>
+<p>Enum values match <a class="reference external" href="https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901194">MQTT5 spec</a> encoding values.</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.UnsubackReasonCode.SUCCESS">
+<span class="sig-name descname"><span class="pre">SUCCESS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#awscrt.mqtt5.UnsubackReasonCode.SUCCESS" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the unsubscribe was successful and the client is no longer subscribed to the topic filter on the server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.UnsubackReasonCode.NO_SUBSCRIPTION_EXISTED">
+<span class="sig-name descname"><span class="pre">NO_SUBSCRIPTION_EXISTED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">17</span></em><a class="headerlink" href="#awscrt.mqtt5.UnsubackReasonCode.NO_SUBSCRIPTION_EXISTED" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the topic filter did not match one of the client’s existing topic filters on the server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.UnsubackReasonCode.UNSPECIFIED_ERROR">
+<span class="sig-name descname"><span class="pre">UNSPECIFIED_ERROR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">128</span></em><a class="headerlink" href="#awscrt.mqtt5.UnsubackReasonCode.UNSPECIFIED_ERROR" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the unsubscribe of the topic filter was not accepted and the server does not want to specify a
+reason or none of the other reason codes apply.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.UnsubackReasonCode.IMPLEMENTATION_SPECIFIC_ERROR">
+<span class="sig-name descname"><span class="pre">IMPLEMENTATION_SPECIFIC_ERROR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">131</span></em><a class="headerlink" href="#awscrt.mqtt5.UnsubackReasonCode.IMPLEMENTATION_SPECIFIC_ERROR" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the topic filter was valid but the server does not accept an unsubscribe for it.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.UnsubackReasonCode.NOT_AUTHORIZED">
+<span class="sig-name descname"><span class="pre">NOT_AUTHORIZED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">135</span></em><a class="headerlink" href="#awscrt.mqtt5.UnsubackReasonCode.NOT_AUTHORIZED" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the client was not authorized to unsubscribe from that topic filter on the server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.UnsubackReasonCode.TOPIC_FILTER_INVALID">
+<span class="sig-name descname"><span class="pre">TOPIC_FILTER_INVALID</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">143</span></em><a class="headerlink" href="#awscrt.mqtt5.UnsubackReasonCode.TOPIC_FILTER_INVALID" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the topic filter was correctly formed but is not allowed for the client on the server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.UnsubackReasonCode.PACKET_IDENTIFIER_IN_USE">
+<span class="sig-name descname"><span class="pre">PACKET_IDENTIFIER_IN_USE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">145</span></em><a class="headerlink" href="#awscrt.mqtt5.UnsubackReasonCode.PACKET_IDENTIFIER_IN_USE" title="Link to this definition">¶</a></dt>
+<dd><p>Returned when the packet identifier was already in use on the server.</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt5.ClientSessionBehaviorType">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt5.</span></span><span class="sig-name descname"><span class="pre">ClientSessionBehaviorType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt5.ClientSessionBehaviorType" title="Link to this definition">¶</a></dt>
+<dd><p>Controls how the mqtt client should behave with respect to MQTT sessions.</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.ClientSessionBehaviorType.DEFAULT">
+<span class="sig-name descname"><span class="pre">DEFAULT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#awscrt.mqtt5.ClientSessionBehaviorType.DEFAULT" title="Link to this definition">¶</a></dt>
+<dd><p>Default client session behavior. Maps to CLEAN.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.ClientSessionBehaviorType.CLEAN">
+<span class="sig-name descname"><span class="pre">CLEAN</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#awscrt.mqtt5.ClientSessionBehaviorType.CLEAN" title="Link to this definition">¶</a></dt>
+<dd><p>Always ask for a clean session when connecting</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.ClientSessionBehaviorType.REJOIN_POST_SUCCESS">
+<span class="sig-name descname"><span class="pre">REJOIN_POST_SUCCESS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#awscrt.mqtt5.ClientSessionBehaviorType.REJOIN_POST_SUCCESS" title="Link to this definition">¶</a></dt>
+<dd><p>Always attempt to rejoin an existing session after an initial connection success.</p>
+<p>Session rejoin requires an appropriate non-zero session expiry interval in the client’s CONNECT options.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.ClientSessionBehaviorType.REJOIN_ALWAYS">
+<span class="sig-name descname"><span class="pre">REJOIN_ALWAYS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">3</span></em><a class="headerlink" href="#awscrt.mqtt5.ClientSessionBehaviorType.REJOIN_ALWAYS" title="Link to this definition">¶</a></dt>
+<dd><p>Always attempt to rejoin an existing session.  Since the client does not support durable session persistence,
+this option is not guaranteed to be spec compliant because any unacknowledged qos1 publishes (which are
+part of the client session state) will not be present on the initial connection.  Until we support
+durable session resumption, this option is technically spec-breaking, but useful.</p>
+<p>Always rejoin requires an appropriate non-zero session expiry interval in the client’s CONNECT options.</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt5.PayloadFormatIndicator">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt5.</span></span><span class="sig-name descname"><span class="pre">PayloadFormatIndicator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt5.PayloadFormatIndicator" title="Link to this definition">¶</a></dt>
+<dd><p>Optional property describing a PUBLISH payload’s format.</p>
+<p>Enum values match <a class="reference external" href="https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901111">MQTT5 spec</a> encoding values.</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.PayloadFormatIndicator.AWS_MQTT5_PFI_BYTES">
+<span class="sig-name descname"><span class="pre">AWS_MQTT5_PFI_BYTES</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#awscrt.mqtt5.PayloadFormatIndicator.AWS_MQTT5_PFI_BYTES" title="Link to this definition">¶</a></dt>
+<dd><p>The payload is arbitrary binary data</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.PayloadFormatIndicator.AWS_MQTT5_PFI_UTF8">
+<span class="sig-name descname"><span class="pre">AWS_MQTT5_PFI_UTF8</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#awscrt.mqtt5.PayloadFormatIndicator.AWS_MQTT5_PFI_UTF8" title="Link to this definition">¶</a></dt>
+<dd><p>The payload is a well-formed utf-8 string value.</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt5.RetainHandlingType">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt5.</span></span><span class="sig-name descname"><span class="pre">RetainHandlingType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt5.RetainHandlingType" title="Link to this definition">¶</a></dt>
+<dd><p>Configures how retained messages should be handled when subscribing with a topic filter that matches topics with
+associated retained messages.</p>
+<p>Enum values match <a class="reference external" href="https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901169">MQTT5 spec</a> encoding values.</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.RetainHandlingType.SEND_ON_SUBSCRIBE">
+<span class="sig-name descname"><span class="pre">SEND_ON_SUBSCRIBE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#awscrt.mqtt5.RetainHandlingType.SEND_ON_SUBSCRIBE" title="Link to this definition">¶</a></dt>
+<dd><p>The server should always send all retained messages on topics that match a subscription’s filter.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.RetainHandlingType.SEND_ON_SUBSCRIBE_IF_NEW">
+<span class="sig-name descname"><span class="pre">SEND_ON_SUBSCRIBE_IF_NEW</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#awscrt.mqtt5.RetainHandlingType.SEND_ON_SUBSCRIBE_IF_NEW" title="Link to this definition">¶</a></dt>
+<dd><p>The server should send retained messages on topics that match the subscription’s filter, but only for the
+first matching subscription, per session.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.RetainHandlingType.DONT_SEND">
+<span class="sig-name descname"><span class="pre">DONT_SEND</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#awscrt.mqtt5.RetainHandlingType.DONT_SEND" title="Link to this definition">¶</a></dt>
+<dd><p>Subscriptions must not trigger any retained message publishes from the server.</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt5.RetainAndHandlingType">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt5.</span></span><span class="sig-name descname"><span class="pre">RetainAndHandlingType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt5.RetainAndHandlingType" title="Link to this definition">¶</a></dt>
+<dd><p>DEPRECATED.</p>
+<p><cite>RetainAndHandlingType</cite> is deprecated, please use <cite>RetainHandlingType</cite></p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.RetainAndHandlingType.SEND_ON_SUBSCRIBE">
+<span class="sig-name descname"><span class="pre">SEND_ON_SUBSCRIBE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#awscrt.mqtt5.RetainAndHandlingType.SEND_ON_SUBSCRIBE" title="Link to this definition">¶</a></dt>
+<dd><p>The server should always send all retained messages on topics that match a subscription’s filter.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.RetainAndHandlingType.SEND_ON_SUBSCRIBE_IF_NEW">
+<span class="sig-name descname"><span class="pre">SEND_ON_SUBSCRIBE_IF_NEW</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#awscrt.mqtt5.RetainAndHandlingType.SEND_ON_SUBSCRIBE_IF_NEW" title="Link to this definition">¶</a></dt>
+<dd><p>The server should send retained messages on topics that match the subscription’s filter, but only for the
+first matching subscription, per session.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.RetainAndHandlingType.DONT_SEND">
+<span class="sig-name descname"><span class="pre">DONT_SEND</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#awscrt.mqtt5.RetainAndHandlingType.DONT_SEND" title="Link to this definition">¶</a></dt>
+<dd><p>Subscriptions must not trigger any retained message publishes from the server.</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt5.ExtendedValidationAndFlowControlOptions">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt5.</span></span><span class="sig-name descname"><span class="pre">ExtendedValidationAndFlowControlOptions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt5.ExtendedValidationAndFlowControlOptions" title="Link to this definition">¶</a></dt>
+<dd><p>Additional controls for client behavior with respect to operation validation and flow control; these checks
+go beyond the MQTT5 spec to respect limits of specific MQTT brokers.</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.ExtendedValidationAndFlowControlOptions.NONE">
+<span class="sig-name descname"><span class="pre">NONE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#awscrt.mqtt5.ExtendedValidationAndFlowControlOptions.NONE" title="Link to this definition">¶</a></dt>
+<dd><p>Do not do any additional validation or flow control</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.ExtendedValidationAndFlowControlOptions.AWS_IOT_CORE_DEFAULTS">
+<span class="sig-name descname"><span class="pre">AWS_IOT_CORE_DEFAULTS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#awscrt.mqtt5.ExtendedValidationAndFlowControlOptions.AWS_IOT_CORE_DEFAULTS" title="Link to this definition">¶</a></dt>
+<dd><p>Apply additional client-side validation and operational flow control that respects the
+default AWS IoT Core limits.</p>
+<p>Currently applies the following additional validation:</p>
+<ul class="simple">
+<li><p>No more than 8 subscriptions per SUBSCRIBE packet</p></li>
+<li><p>Topics and topic filters have a maximum of 7 slashes (8 segments), not counting any AWS rules prefix</p></li>
+<li><p>Topics must be 256 bytes or less in length</p></li>
+<li><p>Client id must be 128 or less bytes in length</p></li>
+</ul>
+<p>Also applies the following flow control:</p>
+<ul class="simple">
+<li><p>Outbound throughput throttled to 512KB/s</p></li>
+<li><p>Outbound publish TPS throttled to 100</p></li>
+</ul>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt5.ClientOperationQueueBehaviorType">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt5.</span></span><span class="sig-name descname"><span class="pre">ClientOperationQueueBehaviorType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt5.ClientOperationQueueBehaviorType" title="Link to this definition">¶</a></dt>
+<dd><p>Controls how disconnects affect the queued and in-progress operations tracked by the client.  Also controls
+how operations are handled while the client is not connected.  In particular, if the client is not connected,
+then any operation that would be failed on disconnect (according to these rules) will be rejected.</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.ClientOperationQueueBehaviorType.DEFAULT">
+<span class="sig-name descname"><span class="pre">DEFAULT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#awscrt.mqtt5.ClientOperationQueueBehaviorType.DEFAULT" title="Link to this definition">¶</a></dt>
+<dd><p>Default client operation queue behavior. Maps to FAIL_QOS0_PUBLISH_ON_DISCONNECT.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.ClientOperationQueueBehaviorType.FAIL_NON_QOS1_PUBLISH_ON_DISCONNECT">
+<span class="sig-name descname"><span class="pre">FAIL_NON_QOS1_PUBLISH_ON_DISCONNECT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#awscrt.mqtt5.ClientOperationQueueBehaviorType.FAIL_NON_QOS1_PUBLISH_ON_DISCONNECT" title="Link to this definition">¶</a></dt>
+<dd><p>Re-queues QoS 1+ publishes on disconnect; un-acked publishes go to the front while unprocessed publishes stay
+in place.  All other operations (QoS 0 publishes, subscribe, unsubscribe) are failed.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.ClientOperationQueueBehaviorType.FAIL_QOS0_PUBLISH_ON_DISCONNECT">
+<span class="sig-name descname"><span class="pre">FAIL_QOS0_PUBLISH_ON_DISCONNECT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#awscrt.mqtt5.ClientOperationQueueBehaviorType.FAIL_QOS0_PUBLISH_ON_DISCONNECT" title="Link to this definition">¶</a></dt>
+<dd><p>QoS 0 publishes that are not complete at the time of disconnection are failed.  Un-acked QoS 1+ publishes are
+re-queued at the head of the line for immediate retransmission on a session resumption.  All other operations
+are requeued in original order behind any retransmissions.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.ClientOperationQueueBehaviorType.FAIL_ALL_ON_DISCONNECT">
+<span class="sig-name descname"><span class="pre">FAIL_ALL_ON_DISCONNECT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">3</span></em><a class="headerlink" href="#awscrt.mqtt5.ClientOperationQueueBehaviorType.FAIL_ALL_ON_DISCONNECT" title="Link to this definition">¶</a></dt>
+<dd><p>All operations that are not complete at the time of disconnection are failed, except operations that
+the MQTT5 spec requires to be retransmitted (un-acked QoS1+ publishes).</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt5.ExponentialBackoffJitterMode">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt5.</span></span><span class="sig-name descname"><span class="pre">ExponentialBackoffJitterMode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt5.ExponentialBackoffJitterMode" title="Link to this definition">¶</a></dt>
+<dd><p>Controls how the reconnect delay is modified in order to smooth out the distribution of reconnection attempt
+timepoints for a large set of reconnecting clients.</p>
+<p>See <a class="reference external" href="https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/">Exponential Backoff and Jitter</a></p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.ExponentialBackoffJitterMode.DEFAULT">
+<span class="sig-name descname"><span class="pre">DEFAULT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#awscrt.mqtt5.ExponentialBackoffJitterMode.DEFAULT" title="Link to this definition">¶</a></dt>
+<dd><p>Maps to Full</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.ExponentialBackoffJitterMode.NONE">
+<span class="sig-name descname"><span class="pre">NONE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#awscrt.mqtt5.ExponentialBackoffJitterMode.NONE" title="Link to this definition">¶</a></dt>
+<dd><p>Do not perform any randomization on the reconnect delay</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.ExponentialBackoffJitterMode.FULL">
+<span class="sig-name descname"><span class="pre">FULL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#awscrt.mqtt5.ExponentialBackoffJitterMode.FULL" title="Link to this definition">¶</a></dt>
+<dd><p>Fully random between no delay and the current exponential backoff value.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.ExponentialBackoffJitterMode.DECORRELATED">
+<span class="sig-name descname"><span class="pre">DECORRELATED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">3</span></em><a class="headerlink" href="#awscrt.mqtt5.ExponentialBackoffJitterMode.DECORRELATED" title="Link to this definition">¶</a></dt>
+<dd><p>Backoff is taken randomly from the interval between the base backoff
+interval and a scaling (greater than 1) of the current backoff value</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt5.UserProperty">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt5.</span></span><span class="sig-name descname"><span class="pre">UserProperty</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt5.UserProperty" title="Link to this definition">¶</a></dt>
+<dd><p>MQTT5 User Property</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Property name</p></li>
+<li><p><strong>value</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Property value</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt5.OutboundTopicAliasBehaviorType">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt5.</span></span><span class="sig-name descname"><span class="pre">OutboundTopicAliasBehaviorType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt5.OutboundTopicAliasBehaviorType" title="Link to this definition">¶</a></dt>
+<dd><p>An enumeration that controls how the client applies topic aliasing to outbound publish packets.</p>
+<p>Topic alias behavior is described in <a class="reference external" href="https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901113">MQTT5 Topic Aliasing</a></p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.OutboundTopicAliasBehaviorType.DEFAULT">
+<span class="sig-name descname"><span class="pre">DEFAULT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#awscrt.mqtt5.OutboundTopicAliasBehaviorType.DEFAULT" title="Link to this definition">¶</a></dt>
+<dd><p>Maps to Disabled.  This keeps the client from being broken (by default) if the broker
+topic aliasing implementation has a problem.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.OutboundTopicAliasBehaviorType.MANUAL">
+<span class="sig-name descname"><span class="pre">MANUAL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#awscrt.mqtt5.OutboundTopicAliasBehaviorType.MANUAL" title="Link to this definition">¶</a></dt>
+<dd><p>Outbound aliasing is the user’s responsibility.  Client will cache and use
+previously-established aliases if they fall within the negotiated limits of the connection.</p>
+<p>The user must still always submit a full topic in their publishes because disconnections disrupt
+topic alias mappings unpredictably.  The client will properly use a requested alias when the most-recently-seen
+binding for a topic alias value matches the alias and topic in the publish packet.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.OutboundTopicAliasBehaviorType.LRU">
+<span class="sig-name descname"><span class="pre">LRU</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#awscrt.mqtt5.OutboundTopicAliasBehaviorType.LRU" title="Link to this definition">¶</a></dt>
+<dd><p>(Recommended) The client will ignore any user-specified topic aliasing and instead use an LRU cache to drive
+alias usage.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.OutboundTopicAliasBehaviorType.DISABLED">
+<span class="sig-name descname"><span class="pre">DISABLED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">3</span></em><a class="headerlink" href="#awscrt.mqtt5.OutboundTopicAliasBehaviorType.DISABLED" title="Link to this definition">¶</a></dt>
+<dd><p>Completely disable outbound topic aliasing.</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt5.InboundTopicAliasBehaviorType">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt5.</span></span><span class="sig-name descname"><span class="pre">InboundTopicAliasBehaviorType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt5.InboundTopicAliasBehaviorType" title="Link to this definition">¶</a></dt>
+<dd><dl class="simple">
+<dt>An enumeration that controls whether or not the client allows the broker to send publishes that use topic</dt><dd><p>aliasing.</p>
+</dd>
+</dl>
+<p>Topic alias behavior is described in <a class="reference external" href="https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901113">MQTT5 Topic Aliasing</a></p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.InboundTopicAliasBehaviorType.DEFAULT">
+<span class="sig-name descname"><span class="pre">DEFAULT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#awscrt.mqtt5.InboundTopicAliasBehaviorType.DEFAULT" title="Link to this definition">¶</a></dt>
+<dd><p>Maps to Disabled.  This keeps the client from being broken (by default) if the broker
+topic aliasing implementation has a problem.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.InboundTopicAliasBehaviorType.ENABLED">
+<span class="sig-name descname"><span class="pre">ENABLED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#awscrt.mqtt5.InboundTopicAliasBehaviorType.ENABLED" title="Link to this definition">¶</a></dt>
+<dd><p>Allow the server to send PUBLISH packets to the client that use topic aliasing</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.InboundTopicAliasBehaviorType.DISABLED">
+<span class="sig-name descname"><span class="pre">DISABLED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#awscrt.mqtt5.InboundTopicAliasBehaviorType.DISABLED" title="Link to this definition">¶</a></dt>
+<dd><p>Forbid the server from sending PUBLISH packets to the client that use topic aliasing</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt5.TopicAliasingOptions">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt5.</span></span><span class="sig-name descname"><span class="pre">TopicAliasingOptions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">outbound_behavior</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.mqtt5.OutboundTopicAliasBehaviorType" title="awscrt.mqtt5.OutboundTopicAliasBehaviorType"><span class="pre">OutboundTopicAliasBehaviorType</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">outbound_cache_max_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inbound_behavior</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.mqtt5.InboundTopicAliasBehaviorType" title="awscrt.mqtt5.InboundTopicAliasBehaviorType"><span class="pre">InboundTopicAliasBehaviorType</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inbound_cache_max_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt5.TopicAliasingOptions" title="Link to this definition">¶</a></dt>
+<dd><p>Configuration for all client topic aliasing behavior.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>outbound_behavior</strong> (<a class="reference internal" href="#awscrt.mqtt5.OutboundTopicAliasBehaviorType" title="awscrt.mqtt5.OutboundTopicAliasBehaviorType"><em>OutboundTopicAliasBehaviorType</em></a>) – Controls what kind of outbound topic aliasing behavior the client should attempt to use.  If topic aliasing is not supported by the server, this setting has no effect and any attempts to directly manipulate the topic alias id in outbound publishes will be ignored.  If left undefined, then outbound topic aliasing is disabled.</p></li>
+<li><p><strong>outbound_cache_max_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – If outbound topic aliasing is set to LRU, this controls the maximum size of the cache.  If outbound topic aliasing is set to LRU and this is zero or undefined, a sensible default is used (25).  If outbound topic aliasing is not set to LRU, then this setting has no effect.</p></li>
+<li><p><strong>inbound_behavior</strong> (<a class="reference internal" href="#awscrt.mqtt5.InboundTopicAliasBehaviorType" title="awscrt.mqtt5.InboundTopicAliasBehaviorType"><em>InboundTopicAliasBehaviorType</em></a>) – Controls whether or not the client allows the broker to use topic aliasing when sending publishes.  Even if inbound topic aliasing is enabled, it is up to the server to choose whether or not to use it.  If left undefined, then inbound topic aliasing is disabled.</p></li>
+<li><p><strong>inbound_cache_max_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – If inbound topic aliasing is enabled, this will control the size of the inbound alias cache.  If inbound aliases are enabled and this is zero or undefined, then a sensible default will be used (25).  If inbound aliases are disabled, this setting has no effect.  Behaviorally, this value overrides anything present in the topic_alias_maximum field of the CONNECT packet options.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt5.NegotiatedSettings">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt5.</span></span><span class="sig-name descname"><span class="pre">NegotiatedSettings</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">maximum_qos</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.mqtt5.QoS" title="awscrt.mqtt5.QoS"><span class="pre">QoS</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session_expiry_interval_sec</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">receive_maximum_from_server</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">maximum_packet_size_to_server</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">topic_alias_maximum_to_server</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">topic_alias_maximum_to_client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">server_keep_alive_sec</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">retain_available</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">wildcard_subscriptions_available</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subscription_identifiers_available</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">shared_subscriptions_available</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rejoined_session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt5.NegotiatedSettings" title="Link to this definition">¶</a></dt>
+<dd><p>Mqtt behavior settings that are dynamically negotiated as part of the CONNECT/CONNACK exchange.</p>
+<p>While you can infer all of these values from a combination of:
+- defaults as specified in the mqtt5 spec
+- your CONNECT settings
+- the CONNACK from the broker</p>
+<p>the client instead does the combining for you and emits a NegotiatedSettings object with final, authoritative values.</p>
+<p>Negotiated settings are communicated with every successful connection establishment.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>maximum_qos</strong> (<a class="reference internal" href="#awscrt.mqtt5.QoS" title="awscrt.mqtt5.QoS"><em>QoS</em></a>) – The maximum QoS allowed for publishes on this connection instance</p></li>
+<li><p><strong>session_expiry_interval_sec</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – The amount of time in seconds the server will retain the MQTT session after a disconnect.</p></li>
+<li><p><strong>receive_maximum_from_server</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – The number of in-flight QoS 1 and QoS 2 publications the server is willing to process concurrently.</p></li>
+<li><p><strong>maximum_packet_size_to_server</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – The maximum packet size the server is willing to accept.</p></li>
+<li><p><strong>topic_alias_maximum_to_server</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – the maximum allowed topic alias value on publishes sent from client to server</p></li>
+<li><p><strong>topic_alias_maximum_to_client</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – the maximum allowed topic alias value on publishes sent from server to client</p></li>
+<li><p><strong>server_keep_alive_sec</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – The maximum amount of time in seconds between client packets. The client will use PINGREQs to ensure this limit is not breached.  The server will disconnect the client for inactivity if no MQTT packet is received in a time interval equal to 1.5 x this value.</p></li>
+<li><p><strong>retain_available</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – Whether the server supports retained messages.</p></li>
+<li><p><strong>wildcard_subscriptions_available</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – Whether the server supports wildcard subscriptions.</p></li>
+<li><p><strong>subscription_identifiers_available</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – Whether the server supports subscription identifiers</p></li>
+<li><p><strong>shared_subscriptions_available</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – Whether the server supports shared subscriptions</p></li>
+<li><p><strong>rejoined_session</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – Whether the client has rejoined an existing session.</p></li>
+<li><p><strong>client_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – The final client id in use by the newly-established connection.  This will be the configured client id if one was given in the configuration, otherwise, if no client id was specified, this will be the client id assigned by the server.  Reconnection attempts will always use the auto-assigned client id, allowing for auto-assigned session resumption.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt5.ConnackPacket">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt5.</span></span><span class="sig-name descname"><span class="pre">ConnackPacket</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">session_present</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reason_code</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.mqtt5.ConnectReasonCode" title="awscrt.mqtt5.ConnectReasonCode"><span class="pre">ConnectReasonCode</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session_expiry_interval_sec</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">receive_maximum</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">maximum_qos</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.mqtt5.QoS" title="awscrt.mqtt5.QoS"><span class="pre">QoS</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">retain_available</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">maximum_packet_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">assigned_client_identifier</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">topic_alias_maximum</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reason_string</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_properties</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence" title="(in Python v3.12)"><span class="pre">Sequence</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#awscrt.mqtt5.UserProperty" title="awscrt.mqtt5.UserProperty"><span class="pre">UserProperty</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">wildcard_subscriptions_available</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subscription_identifiers_available</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">shared_subscription_available</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">server_keep_alive_sec</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_information</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">server_reference</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt5.ConnackPacket" title="Link to this definition">¶</a></dt>
+<dd><p>Data model of an <a class="reference external" href="https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901074">MQTT5 CONNACK</a> packet.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>session_present</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – True if the client rejoined an existing session on the server, false otherwise.</p></li>
+<li><p><strong>reason_code</strong> (<a class="reference internal" href="#awscrt.mqtt5.ConnectReasonCode" title="awscrt.mqtt5.ConnectReasonCode"><em>ConnectReasonCode</em></a>) – Indicates either success or the reason for failure for the connection attempt.</p></li>
+<li><p><strong>session_expiry_interval_sec</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – A time interval, in seconds, that the server will persist this connection’s MQTT session state for.  If present, this value overrides any session expiry specified in the preceding CONNECT packet.</p></li>
+<li><p><strong>receive_maximum</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – The maximum amount of in-flight QoS 1 or 2 messages that the server is willing to handle at once. If omitted or None, the limit is based on the valid MQTT packet id space (65535).</p></li>
+<li><p><strong>maximum_qos</strong> (<a class="reference internal" href="#awscrt.mqtt5.QoS" title="awscrt.mqtt5.QoS"><em>QoS</em></a>) – The maximum message delivery quality of service that the server will allow on this connection.</p></li>
+<li><p><strong>retain_available</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – Indicates whether the server supports retained messages.  If None, retained messages are supported.</p></li>
+<li><p><strong>maximum_packet_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – Specifies the maximum packet size, in bytes, that the server is willing to accept.  If None, there is no limit beyond what is imposed by the MQTT spec itself.</p></li>
+<li><p><strong>assigned_client_identifier</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Specifies a client identifier assigned to this connection by the server.  Only valid when the client id of the preceding CONNECT packet was left empty.</p></li>
+<li><p><strong>topic_alias_maximum</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – The maximum allowed value for topic aliases in outbound publish packets.  If 0 or None, then outbound topic aliasing is not allowed.</p></li>
+<li><p><strong>reason_string</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Additional diagnostic information about the result of the connection attempt.</p></li>
+<li><p><strong>user_properties</strong> (<em>Sequence</em><em>[</em><a class="reference internal" href="#awscrt.mqtt5.UserProperty" title="awscrt.mqtt5.UserProperty"><em>UserProperty</em></a><em>]</em>) – List of MQTT5 user properties included with the packet.</p></li>
+<li><p><strong>wildcard_subscriptions_available</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – Indicates whether the server supports wildcard subscriptions.  If None, wildcard subscriptions are supported.</p></li>
+<li><p><strong>subscription_identifiers_available</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – Indicates whether the server supports subscription identifiers.  If None, subscription identifiers are supported.</p></li>
+<li><p><strong>shared_subscription_available</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – Indicates whether the server supports shared subscription topic filters.  If None, shared subscriptions are supported.</p></li>
+<li><p><strong>server_keep_alive</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – DEPRECATED. Please use <cite>server_keep_alive_sec</cite>.</p></li>
+<li><p><strong>server_keep_alive_sec</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – Server-requested override of the keep alive interval, in seconds.  If None, the keep alive value sent by the client should be used.</p></li>
+<li><p><strong>response_information</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – A value that can be used in the creation of a response topic associated with this connection. MQTT5-based request/response is outside the purview of the MQTT5 spec and this client.</p></li>
+<li><p><strong>server_reference</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Property indicating an alternate server that the client may temporarily or permanently attempt to connect to instead of the configured endpoint.  Will only be set if the reason code indicates another server may be used (ServerMoved, UseAnotherServer).</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt5.DisconnectPacket">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt5.</span></span><span class="sig-name descname"><span class="pre">DisconnectPacket</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">reason_code</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.mqtt5.DisconnectReasonCode" title="awscrt.mqtt5.DisconnectReasonCode"><span class="pre">DisconnectReasonCode</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">DisconnectReasonCode.NORMAL_DISCONNECTION</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session_expiry_interval_sec</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reason_string</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_properties</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence" title="(in Python v3.12)"><span class="pre">Sequence</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#awscrt.mqtt5.UserProperty" title="awscrt.mqtt5.UserProperty"><span class="pre">UserProperty</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">server_reference</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt5.DisconnectPacket" title="Link to this definition">¶</a></dt>
+<dd><p>Data model of an <a class="reference external" href="https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901205">MQTT5 DISCONNECT</a> packet.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>reason_code</strong> (<a class="reference internal" href="#awscrt.mqtt5.DisconnectReasonCode" title="awscrt.mqtt5.DisconnectReasonCode"><em>DisconnectReasonCode</em></a>) – Value indicating the reason that the sender is closing the connection</p></li>
+<li><p><strong>session_expiry_interval_sec</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – A change to the session expiry interval negotiated at connection time as part of the disconnect.  Only valid for DISCONNECT packets sent from client to server.  It is not valid to attempt to change session expiry from zero to a non-zero value.</p></li>
+<li><p><strong>reason_string</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Additional diagnostic information about the reason that the sender is closing the connection</p></li>
+<li><p><strong>user_properties</strong> (<em>Sequence</em><em>[</em><a class="reference internal" href="#awscrt.mqtt5.UserProperty" title="awscrt.mqtt5.UserProperty"><em>UserProperty</em></a><em>]</em>) – List of MQTT5 user properties included with the packet.</p></li>
+<li><p><strong>server_reference</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Property indicating an alternate server that the client may temporarily or permanently attempt to connect to instead of the configured endpoint.  Will only be set if the reason code indicates another server may be used (ServerMoved, UseAnotherServer).</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt5.Subscription">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt5.</span></span><span class="sig-name descname"><span class="pre">Subscription</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">topic_filter</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">qos</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.mqtt5.QoS" title="awscrt.mqtt5.QoS"><span class="pre">QoS</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">QoS.AT_MOST_ONCE</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">no_local</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">retain_as_published</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">retain_handling_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.mqtt5.RetainHandlingType" title="awscrt.mqtt5.RetainHandlingType"><span class="pre">RetainHandlingType</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">RetainHandlingType.SEND_ON_SUBSCRIBE</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt5.Subscription" title="Link to this definition">¶</a></dt>
+<dd><p>Configures a single subscription within a Subscribe operation</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>topic_filter</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – The topic filter to subscribe to</p></li>
+<li><p><strong>qos</strong> (<a class="reference internal" href="#awscrt.mqtt5.QoS" title="awscrt.mqtt5.QoS"><em>QoS</em></a>) – The maximum QoS on which the subscriber will accept publish messages</p></li>
+<li><p><strong>no_local</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – Whether the server will not send publishes to a client when that client was the one who sent the publish</p></li>
+<li><p><strong>retain_as_published</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – Whether messages sent due to this subscription keep the retain flag preserved on the message</p></li>
+<li><p><strong>retain_handling_type</strong> (<a class="reference internal" href="#awscrt.mqtt5.RetainHandlingType" title="awscrt.mqtt5.RetainHandlingType"><em>RetainHandlingType</em></a>) – Whether retained messages on matching topics be sent in reaction to this subscription</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt5.SubscribePacket">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt5.</span></span><span class="sig-name descname"><span class="pre">SubscribePacket</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">subscriptions</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence" title="(in Python v3.12)"><span class="pre">Sequence</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#awscrt.mqtt5.Subscription" title="awscrt.mqtt5.Subscription"><span class="pre">Subscription</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subscription_identifier</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_properties</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence" title="(in Python v3.12)"><span class="pre">Sequence</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#awscrt.mqtt5.UserProperty" title="awscrt.mqtt5.UserProperty"><span class="pre">UserProperty</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt5.SubscribePacket" title="Link to this definition">¶</a></dt>
+<dd><p>Data model of an <a class="reference external" href="https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901161">MQTT5 SUBSCRIBE</a> packet.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>subscriptions</strong> (<em>Sequence</em><em>[</em><a class="reference internal" href="#awscrt.mqtt5.Subscription" title="awscrt.mqtt5.Subscription"><em>Subscription</em></a><em>]</em>) – The list of topic filters that the client wishes to listen to</p></li>
+<li><p><strong>subscription_identifier</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – The positive int to associate with all topic filters in this request.  Publish packets that match a subscription in this request should include this identifier in the resulting message.</p></li>
+<li><p><strong>user_properties</strong> (<em>Sequence</em><em>[</em><a class="reference internal" href="#awscrt.mqtt5.UserProperty" title="awscrt.mqtt5.UserProperty"><em>UserProperty</em></a><em>]</em>) – The list of MQTT5 user properties included with the packet.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt5.SubackPacket">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt5.</span></span><span class="sig-name descname"><span class="pre">SubackPacket</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">reason_string</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_properties</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence" title="(in Python v3.12)"><span class="pre">Sequence</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#awscrt.mqtt5.UserProperty" title="awscrt.mqtt5.UserProperty"><span class="pre">UserProperty</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reason_codes</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence" title="(in Python v3.12)"><span class="pre">Sequence</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#awscrt.mqtt5.SubackReasonCode" title="awscrt.mqtt5.SubackReasonCode"><span class="pre">SubackReasonCode</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt5.SubackPacket" title="Link to this definition">¶</a></dt>
+<dd><p>Data model of an <a class="reference external" href="https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901171">MQTT5 SUBACK</a> packet.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>reason_string</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Additional diagnostic information about the result of the SUBSCRIBE attempt.</p></li>
+<li><p><strong>user_properties</strong> (<em>Sequence</em><em>[</em><a class="reference internal" href="#awscrt.mqtt5.UserProperty" title="awscrt.mqtt5.UserProperty"><em>UserProperty</em></a><em>]</em>) – List of MQTT5 user properties included with the packet.</p></li>
+<li><p><strong>reason_codes</strong> (<em>Sequence</em><em>[</em><a class="reference internal" href="#awscrt.mqtt5.SubackReasonCode" title="awscrt.mqtt5.SubackReasonCode"><em>SubackReasonCode</em></a><em>]</em>) – List of reason codes indicating the result of each individual subscription entry in the associated SUBSCRIBE packet.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt5.UnsubscribePacket">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt5.</span></span><span class="sig-name descname"><span class="pre">UnsubscribePacket</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">topic_filters</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence" title="(in Python v3.12)"><span class="pre">Sequence</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_properties</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence" title="(in Python v3.12)"><span class="pre">Sequence</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#awscrt.mqtt5.UserProperty" title="awscrt.mqtt5.UserProperty"><span class="pre">UserProperty</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt5.UnsubscribePacket" title="Link to this definition">¶</a></dt>
+<dd><p>Data model of an <a class="reference external" href="https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc384800445">MQTT5 UNSUBSCRIBE</a> packet.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>topic_filters</strong> (<em>Sequence</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>]</em>) – List of topic filters that the client wishes to unsubscribe from.</p></li>
+<li><p><strong>user_properties</strong> (<em>Sequence</em><em>[</em><a class="reference internal" href="#awscrt.mqtt5.UserProperty" title="awscrt.mqtt5.UserProperty"><em>UserProperty</em></a><em>]</em>) – List of MQTT5 user properties included with the packet.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt5.UnsubackPacket">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt5.</span></span><span class="sig-name descname"><span class="pre">UnsubackPacket</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">reason_string</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_properties</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence" title="(in Python v3.12)"><span class="pre">Sequence</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#awscrt.mqtt5.UserProperty" title="awscrt.mqtt5.UserProperty"><span class="pre">UserProperty</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reason_codes</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence" title="(in Python v3.12)"><span class="pre">Sequence</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#awscrt.mqtt5.UnsubackReasonCode" title="awscrt.mqtt5.UnsubackReasonCode"><span class="pre">UnsubackReasonCode</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt5.UnsubackPacket" title="Link to this definition">¶</a></dt>
+<dd><p>Data model of an <a class="reference external" href="https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc471483687">MQTT5 UNSUBACK</a> packet.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>reason_string</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Additional diagnostic information about the result of the UNSUBSCRIBE attempt.</p></li>
+<li><p><strong>user_properties</strong> (<em>Sequence</em><em>[</em><a class="reference internal" href="#awscrt.mqtt5.UserProperty" title="awscrt.mqtt5.UserProperty"><em>UserProperty</em></a><em>]</em>) – List of MQTT5 user properties included with the packet.</p></li>
+<li><p><strong>reason_codes</strong> (<em>Sequence</em><em>[</em><a class="reference internal" href="#awscrt.mqtt5.UnsubackReasonCode" title="awscrt.mqtt5.UnsubackReasonCode"><em>UnsubackReasonCode</em></a><em>]</em>) – A list of reason codes indicating the result of unsubscribing from each individual topic filter entry in the associated UNSUBSCRIBE packet.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt5.PublishPacket">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt5.</span></span><span class="sig-name descname"><span class="pre">PublishPacket</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">payload</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.12)"><span class="pre">Any</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">qos</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.mqtt5.QoS" title="awscrt.mqtt5.QoS"><span class="pre">QoS</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">QoS.AT_MOST_ONCE</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">retain</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">topic</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">payload_format_indicator</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.mqtt5.PayloadFormatIndicator" title="awscrt.mqtt5.PayloadFormatIndicator"><span class="pre">PayloadFormatIndicator</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message_expiry_interval_sec</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">topic_alias</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_topic</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">correlation_data_bytes</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.12)"><span class="pre">bytes</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">correlation_data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.12)"><span class="pre">bytes</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subscription_identifiers</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">content_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_properties</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#awscrt.mqtt5.UserProperty" title="awscrt.mqtt5.UserProperty"><span class="pre">UserProperty</span></a><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt5.PublishPacket" title="Link to this definition">¶</a></dt>
+<dd><p>Data model of an <a class="reference external" href="https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901100">MQTT5 PUBLISH</a> packet</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>payload</strong> (<em>Any</em>) – The payload of the publish message.</p></li>
+<li><p><strong>qos</strong> (<a class="reference internal" href="#awscrt.mqtt5.QoS" title="awscrt.mqtt5.QoS"><em>QoS</em></a>) – The MQTT quality of service associated with this PUBLISH packet.</p></li>
+<li><p><strong>retain</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – True if this is a retained message, false otherwise.</p></li>
+<li><p><strong>topic</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – The topic associated with this PUBLISH packet.</p></li>
+<li><p><strong>payload_format_indicator</strong> (<a class="reference internal" href="#awscrt.mqtt5.PayloadFormatIndicator" title="awscrt.mqtt5.PayloadFormatIndicator"><em>PayloadFormatIndicator</em></a>) – Property specifying the format of the payload data. The mqtt5 client does not enforce or use this value in a meaningful way.</p></li>
+<li><p><strong>message_expiry_interval_sec</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – Sent publishes - indicates the maximum amount of time allowed to elapse for message delivery before the server should instead delete the message (relative to a recipient). Received publishes - indicates the remaining amount of time (from the server’s perspective) before the message would have been deleted relative to the subscribing client. If left None, indicates no expiration timeout.</p></li>
+<li><p><strong>topic_alias</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – An integer value that is used to identify the Topic instead of using the Topic Name.  On outbound publishes, this will only be used if the outbound topic aliasing behavior has been set to Manual.</p></li>
+<li><p><strong>response_topic</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Opaque topic string intended to assist with request/response implementations.  Not internally meaningful to MQTT5 or this client.</p></li>
+<li><p><strong>correlation_data</strong> (<em>Optional</em><em>[</em><em>Union</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.12)"><em>bytes</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>]</em><em>]</em>) – Deprecated, use <cite>correlation_data_bytes</cite> instead.  Opaque binary data used to correlate between publish messages, as a potential method for request-response implementation.  Not internally meaningful to MQTT5.  For incoming publishes, this will be a utf8 string (if correlation data exists and it’s convertible to utf-8) or None (either it didn’t exist, or did but wasn’t convertible)</p></li>
+<li><p><strong>correlation_data_bytes</strong> (<em>Optional</em><em>[</em><em>Union</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.12)"><em>bytes</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>]</em><em>]</em>) – Opaque binary data used to correlate between publish messages, as a potential method for request-response implementation.  Not internally meaningful to MQTT5.  For outbound publishes, this field takes priority over <cite>correlation_data</cite>.  For incoming publishes, this will be binary data if correlation data is set, otherwise it will be None.</p></li>
+<li><p><strong>subscription_identifiers</strong> (<em>Sequence</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a><em>]</em>) – The subscription identifiers of all the subscriptions this message matched.  This field is ignored on outbound publishes (setting it is a protocol error).</p></li>
+<li><p><strong>content_type</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Property specifying the content type of the payload.  Not internally meaningful to MQTT5.</p></li>
+<li><p><strong>user_properties</strong> (<em>Sequence</em><em>[</em><a class="reference internal" href="#awscrt.mqtt5.UserProperty" title="awscrt.mqtt5.UserProperty"><em>UserProperty</em></a><em>]</em>) – List of MQTT5 user properties included with the packet.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt5.PubackPacket">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt5.</span></span><span class="sig-name descname"><span class="pre">PubackPacket</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">reason_code</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.mqtt5.PubackReasonCode" title="awscrt.mqtt5.PubackReasonCode"><span class="pre">PubackReasonCode</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reason_string</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_properties</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence" title="(in Python v3.12)"><span class="pre">Sequence</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#awscrt.mqtt5.UserProperty" title="awscrt.mqtt5.UserProperty"><span class="pre">UserProperty</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt5.PubackPacket" title="Link to this definition">¶</a></dt>
+<dd><p>Data model of an <a class="reference external" href="https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901121">MQTT5 PUBACK</a> packet</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>reason_code</strong> (<a class="reference internal" href="#awscrt.mqtt5.PubackReasonCode" title="awscrt.mqtt5.PubackReasonCode"><em>PubackReasonCode</em></a>) – Success indicator or failure reason for the associated PUBLISH packet.</p></li>
+<li><p><strong>reason_string</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Additional diagnostic information about the result of the PUBLISH attempt.</p></li>
+<li><p><strong>user_properties</strong> (<em>Sequence</em><em>[</em><a class="reference internal" href="#awscrt.mqtt5.UserProperty" title="awscrt.mqtt5.UserProperty"><em>UserProperty</em></a><em>]</em>) – List of MQTT5 user properties included with the packet.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt5.ConnectPacket">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt5.</span></span><span class="sig-name descname"><span class="pre">ConnectPacket</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">keep_alive_interval_sec</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">username</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">password</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session_expiry_interval_sec</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">request_response_information</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">request_problem_information</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">receive_maximum</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">maximum_packet_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">will_delay_interval_sec</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">will</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.mqtt5.PublishPacket" title="awscrt.mqtt5.PublishPacket"><span class="pre">PublishPacket</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_properties</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence" title="(in Python v3.12)"><span class="pre">Sequence</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#awscrt.mqtt5.UserProperty" title="awscrt.mqtt5.UserProperty"><span class="pre">UserProperty</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt5.ConnectPacket" title="Link to this definition">¶</a></dt>
+<dd><p>Data model of an <a class="reference external" href="https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901033">MQTT5 CONNECT</a> packet.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>keep_alive_interval_sec</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – The maximum time interval, in seconds, that is permitted to elapse between the point at which the client finishes transmitting one MQTT packet and the point it starts sending the next.  The client will use PINGREQ packets to maintain this property. If the responding CONNACK contains a keep alive property value, then that is the negotiated keep alive value. Otherwise, the keep alive sent by the client is the negotiated value.</p></li>
+<li><p><strong>client_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – A unique string identifying the client to the server.  Used to restore session state between connections. If left empty, the broker will auto-assign a unique client id.  When reconnecting, the mqtt5 client will always use the auto-assigned client id.</p></li>
+<li><p><strong>username</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – A string value that the server may use for client authentication and authorization.</p></li>
+<li><p><strong>password</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Opaque binary data that the server may use for client authentication and authorization.</p></li>
+<li><p><strong>session_expiry_interval_sec</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – A time interval, in seconds, that the client requests the server to persist this connection’s MQTT session state for.  Has no meaning if the client has not been configured to rejoin sessions.  Must be non-zero in order to successfully rejoin a session. If the responding CONNACK contains a session expiry property value, then that is the negotiated session expiry value.  Otherwise, the session expiry sent by the client is the negotiated value.</p></li>
+<li><p><strong>request_response_information</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – If true, requests that the server send response information in the subsequent CONNACK.  This response information may be used to set up request-response implementations over MQTT, but doing so is outside the scope of the MQTT5 spec and client.</p></li>
+<li><p><strong>request_problem_information</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – If true, requests that the server send additional diagnostic information (via response string or user properties) in DISCONNECT or CONNACK packets from the server.</p></li>
+<li><p><strong>receive_maximum</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – Notifies the server of the maximum number of in-flight QoS 1 and 2 messages the client is willing to handle.  If omitted or None, then no limit is requested.</p></li>
+<li><p><strong>maximum_packet_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – Notifies the server of the maximum packet size the client is willing to handle.  If omitted or None, then no limit beyond the natural limits of MQTT packet size is requested.</p></li>
+<li><p><strong>will_delay_interval_sec</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – A time interval, in seconds, that the server should wait (for a session reconnection) before sending the will message associated with the connection’s session.  If omitted or None, the server will send the will when the associated session is destroyed.  If the session is destroyed before a will delay interval has elapsed, then the will must be sent at the time of session destruction.</p></li>
+<li><p><strong>will</strong> (<a class="reference internal" href="#awscrt.mqtt5.PublishPacket" title="awscrt.mqtt5.PublishPacket"><em>PublishPacket</em></a>) – The definition of a message to be published when the connection’s session is destroyed by the server or when the will delay interval has elapsed, whichever comes first.  If None, then nothing will be sent.</p></li>
+<li><p><strong>user_properties</strong> (<em>Sequence</em><em>[</em><a class="reference internal" href="#awscrt.mqtt5.UserProperty" title="awscrt.mqtt5.UserProperty"><em>UserProperty</em></a><em>]</em>) – List of MQTT5 user properties included with the packet.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt5.WebsocketHandshakeTransformArgs">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt5.</span></span><span class="sig-name descname"><span class="pre">WebsocketHandshakeTransformArgs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">http_request</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">done_future</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt5.WebsocketHandshakeTransformArgs" title="Link to this definition">¶</a></dt>
+<dd><p>Argument to a “websocket_handshake_transform” function.</p>
+<p>A websocket_handshake_transform function has signature:
+<code class="docutils literal notranslate"><span class="pre">fn(transform_args:</span> <span class="pre">WebsocketHandshakeTransformArgs)</span> <span class="pre">-&gt;</span> <span class="pre">None</span></code></p>
+<p>The function implementer may modify <cite>transform_args.http_request</cite> as desired.
+They MUST call <cite>transform_args.set_done()</cite> when complete, passing an
+exception if something went wrong. Failure to call <cite>set_done()</cite>
+will hang the application.</p>
+<p>The implementer may do asynchronous work before calling <cite>transform_args.set_done()</cite>,
+they are not required to call <cite>set_done()</cite> within the scope of the transform function.
+An example of async work would be to fetch credentials from another service,
+sign the request headers, and finally call <cite>set_done()</cite> to mark the transform complete.</p>
+<p>The default websocket handshake request uses path “/mqtt”.
+All required headers are present,
+plus the optional header “Sec-WebSocket-Protocol: mqtt”.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>client</strong> (<a class="reference internal" href="#awscrt.mqtt5.Client" title="awscrt.mqtt5.Client"><em>Client</em></a>) – Client this handshake is for.</p></li>
+<li><p><strong>http_request</strong> (<a class="reference internal" href="http.html#awscrt.http.HttpRequest" title="awscrt.http.HttpRequest"><em>awscrt.http.HttpRequest</em></a>) – HTTP request for this handshake.</p></li>
+<li><p><strong>done_future</strong> (<a class="reference external" href="https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.Future" title="(in Python v3.12)"><em>concurrent.futures.Future</em></a>) – Future to complete when the
+<a class="reference internal" href="#awscrt.mqtt5.WebsocketHandshakeTransformArgs.set_done" title="awscrt.mqtt5.WebsocketHandshakeTransformArgs.set_done"><code class="xref py py-meth docutils literal notranslate"><span class="pre">set_done()</span></code></a> is called. It will contain None if successful,
+or an exception will be set.</p></li>
+</ul>
+</dd>
+</dl>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.WebsocketHandshakeTransformArgs.client">
+<span class="sig-name descname"><span class="pre">client</span></span><a class="headerlink" href="#awscrt.mqtt5.WebsocketHandshakeTransformArgs.client" title="Link to this definition">¶</a></dt>
+<dd><p>Client this handshake is for.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference internal" href="#awscrt.mqtt5.Client" title="awscrt.mqtt5.Client">Client</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.mqtt5.WebsocketHandshakeTransformArgs.http_request">
+<span class="sig-name descname"><span class="pre">http_request</span></span><a class="headerlink" href="#awscrt.mqtt5.WebsocketHandshakeTransformArgs.http_request" title="Link to this definition">¶</a></dt>
+<dd><p>HTTP request for this handshake.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference internal" href="http.html#awscrt.http.HttpRequest" title="awscrt.http.HttpRequest">awscrt.http.HttpRequest</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.mqtt5.WebsocketHandshakeTransformArgs.set_done">
+<span class="sig-name descname"><span class="pre">set_done</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">exception</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt5.WebsocketHandshakeTransformArgs.set_done" title="Link to this definition">¶</a></dt>
+<dd><p>Mark the transformation complete.
+If exception is passed in, the handshake is canceled.</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt5.PublishReceivedData">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt5.</span></span><span class="sig-name descname"><span class="pre">PublishReceivedData</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">publish_packet</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.mqtt5.PublishPacket" title="awscrt.mqtt5.PublishPacket"><span class="pre">PublishPacket</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt5.PublishReceivedData" title="Link to this definition">¶</a></dt>
+<dd><p>Dataclass containing data related to a Publish Received Callback</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>publish_packet</strong> (<a class="reference internal" href="#awscrt.mqtt5.PublishPacket" title="awscrt.mqtt5.PublishPacket"><em>PublishPacket</em></a>) – <p>Data model of an <a class="reference external" href="https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901100">MQTT5 PUBLISH</a> packet.</p>
+</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt5.OperationStatisticsData">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt5.</span></span><span class="sig-name descname"><span class="pre">OperationStatisticsData</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">incomplete_operation_count</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">incomplete_operation_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">unacked_operation_count</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">unacked_operation_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt5.OperationStatisticsData" title="Link to this definition">¶</a></dt>
+<dd><p>Dataclass containing some simple statistics about the current state of the client’s queue of operations</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>incomplete_operation_count</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – Total number of operations submitted to the client that have not yet been completed.  Unacked operations are a subset of this.</p></li>
+<li><p><strong>incomplete_operation_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – Total packet size of operations submitted to the client that have not yet been completed.  Unacked operations are a subset of this.</p></li>
+<li><p><strong>unacked_operation_count</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – Total number of operations that have been sent to the server and are waiting for a corresponding ACK before they can be completed.</p></li>
+<li><p><strong>unacked_operation_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – Total packet size of operations that have been sent to the server and are waiting for a corresponding ACK before they can be completed.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt5.LifecycleStoppedData">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt5.</span></span><span class="sig-name descname"><span class="pre">LifecycleStoppedData</span></span><a class="headerlink" href="#awscrt.mqtt5.LifecycleStoppedData" title="Link to this definition">¶</a></dt>
+<dd><p>Dataclass containing results of an Stopped Lifecycle Event
+Currently Unused</p>
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt5.LifecycleAttemptingConnectData">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt5.</span></span><span class="sig-name descname"><span class="pre">LifecycleAttemptingConnectData</span></span><a class="headerlink" href="#awscrt.mqtt5.LifecycleAttemptingConnectData" title="Link to this definition">¶</a></dt>
+<dd><p>Dataclass containing results of an Attempting Connect Lifecycle Event
+Currently Unused</p>
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt5.LifecycleConnectSuccessData">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt5.</span></span><span class="sig-name descname"><span class="pre">LifecycleConnectSuccessData</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">connack_packet</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.mqtt5.ConnackPacket" title="awscrt.mqtt5.ConnackPacket"><span class="pre">ConnackPacket</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">negotiated_settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.mqtt5.NegotiatedSettings" title="awscrt.mqtt5.NegotiatedSettings"><span class="pre">NegotiatedSettings</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt5.LifecycleConnectSuccessData" title="Link to this definition">¶</a></dt>
+<dd><p>Dataclass containing results of a Connect Success Lifecycle Event</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>connack_packet</strong> (<a class="reference internal" href="#awscrt.mqtt5.ConnackPacket" title="awscrt.mqtt5.ConnackPacket"><em>ConnackPacket</em></a>) – <p>Data model of an <a class="reference external" href="https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901074">MQTT5 CONNACK</a> packet.</p>
+</p></li>
+<li><p><strong>negotiated_settings</strong> – (NegotiatedSettings): Mqtt behavior settings that have been dynamically negotiated as part of the CONNECT/CONNACK exchange.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt5.LifecycleConnectFailureData">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt5.</span></span><span class="sig-name descname"><span class="pre">LifecycleConnectFailureData</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">connack_packet</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.mqtt5.ConnackPacket" title="awscrt.mqtt5.ConnackPacket"><span class="pre">ConnackPacket</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exception</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.12)"><span class="pre">Exception</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt5.LifecycleConnectFailureData" title="Link to this definition">¶</a></dt>
+<dd><p>Dataclass containing results of a Connect Failure Lifecycle Event</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>connack_packet</strong> (<a class="reference internal" href="#awscrt.mqtt5.ConnackPacket" title="awscrt.mqtt5.ConnackPacket"><em>ConnackPacket</em></a>) – <p>Data model of an <a class="reference external" href="https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901074">MQTT5 CONNACK</a> packet.</p>
+</p></li>
+<li><p><strong>error_code</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – (<a class="reference internal" href="exceptions.html#awscrt.exceptions.AwsCrtError" title="awscrt.exceptions.AwsCrtError"><code class="xref py py-class docutils literal notranslate"><span class="pre">awscrt.exceptions.AwsCrtError</span></code></a>): Exception which caused connection failure.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt5.LifecycleDisconnectData">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt5.</span></span><span class="sig-name descname"><span class="pre">LifecycleDisconnectData</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">disconnect_packet</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.mqtt5.DisconnectPacket" title="awscrt.mqtt5.DisconnectPacket"><span class="pre">DisconnectPacket</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exception</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.12)"><span class="pre">Exception</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt5.LifecycleDisconnectData" title="Link to this definition">¶</a></dt>
+<dd><p>Dataclass containing results of a Disconnect Lifecycle Event</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>disconnect_packet</strong> (<a class="reference internal" href="#awscrt.mqtt5.DisconnectPacket" title="awscrt.mqtt5.DisconnectPacket"><em>DisconnectPacket</em></a>) – <p>Data model of an <a class="reference external" href="https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901205">MQTT5 DISCONNECT</a> packet.</p>
+</p></li>
+<li><p><strong>error_code</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – (<a class="reference internal" href="exceptions.html#awscrt.exceptions.AwsCrtError" title="awscrt.exceptions.AwsCrtError"><code class="xref py py-class docutils literal notranslate"><span class="pre">awscrt.exceptions.AwsCrtError</span></code></a>): Exception which caused disconnection.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt5.PublishCompletionData">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt5.</span></span><span class="sig-name descname"><span class="pre">PublishCompletionData</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">puback</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.mqtt5.PubackPacket" title="awscrt.mqtt5.PubackPacket"><span class="pre">PubackPacket</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt5.PublishCompletionData" title="Link to this definition">¶</a></dt>
+<dd><p>Dataclass containing results of a Publish</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>puback</strong> (<a class="reference internal" href="#awscrt.mqtt5.PubackPacket" title="awscrt.mqtt5.PubackPacket"><em>PubackPacket</em></a>) – On a successful completion of a QoS1 publish a PubackPacket will be included.</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt5.ClientOptions">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt5.</span></span><span class="sig-name descname"><span class="pre">ClientOptions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bootstrap</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="io.html#awscrt.io.ClientBootstrap" title="awscrt.io.ClientBootstrap"><span class="pre">ClientBootstrap</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">socket_options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="io.html#awscrt.io.SocketOptions" title="awscrt.io.SocketOptions"><span class="pre">SocketOptions</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tls_ctx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="io.html#awscrt.io.ClientTlsContext" title="awscrt.io.ClientTlsContext"><span class="pre">ClientTlsContext</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">http_proxy_options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="http.html#awscrt.http.HttpProxyOptions" title="awscrt.http.HttpProxyOptions"><span class="pre">HttpProxyOptions</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">websocket_handshake_transform</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.12)"><span class="pre">Callable</span></a><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#awscrt.mqtt5.WebsocketHandshakeTransformArgs" title="awscrt.mqtt5.WebsocketHandshakeTransformArgs"><span class="pre">WebsocketHandshakeTransformArgs</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">connect_options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.mqtt5.ConnectPacket" title="awscrt.mqtt5.ConnectPacket"><span class="pre">ConnectPacket</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session_behavior</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.mqtt5.ClientSessionBehaviorType" title="awscrt.mqtt5.ClientSessionBehaviorType"><span class="pre">ClientSessionBehaviorType</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extended_validation_and_flow_control_options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.mqtt5.ExtendedValidationAndFlowControlOptions" title="awscrt.mqtt5.ExtendedValidationAndFlowControlOptions"><span class="pre">ExtendedValidationAndFlowControlOptions</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">offline_queue_behavior</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.mqtt5.ClientOperationQueueBehaviorType" title="awscrt.mqtt5.ClientOperationQueueBehaviorType"><span class="pre">ClientOperationQueueBehaviorType</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">retry_jitter_mode</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.mqtt5.ExponentialBackoffJitterMode" title="awscrt.mqtt5.ExponentialBackoffJitterMode"><span class="pre">ExponentialBackoffJitterMode</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">min_reconnect_delay_ms</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_reconnect_delay_ms</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">min_connected_time_to_reset_reconnect_delay_ms</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ping_timeout_ms</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">connack_timeout_ms</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ack_timeout_sec</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">topic_aliasing_options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.mqtt5.TopicAliasingOptions" title="awscrt.mqtt5.TopicAliasingOptions"><span class="pre">TopicAliasingOptions</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">on_publish_callback_fn</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.12)"><span class="pre">Callable</span></a><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#awscrt.mqtt5.PublishReceivedData" title="awscrt.mqtt5.PublishReceivedData"><span class="pre">PublishReceivedData</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">on_lifecycle_event_stopped_fn</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.12)"><span class="pre">Callable</span></a><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#awscrt.mqtt5.LifecycleStoppedData" title="awscrt.mqtt5.LifecycleStoppedData"><span class="pre">LifecycleStoppedData</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">on_lifecycle_event_attempting_connect_fn</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.12)"><span class="pre">Callable</span></a><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#awscrt.mqtt5.LifecycleAttemptingConnectData" title="awscrt.mqtt5.LifecycleAttemptingConnectData"><span class="pre">LifecycleAttemptingConnectData</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">on_lifecycle_event_connection_success_fn</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.12)"><span class="pre">Callable</span></a><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#awscrt.mqtt5.LifecycleConnectSuccessData" title="awscrt.mqtt5.LifecycleConnectSuccessData"><span class="pre">LifecycleConnectSuccessData</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">on_lifecycle_event_connection_failure_fn</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.12)"><span class="pre">Callable</span></a><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#awscrt.mqtt5.LifecycleConnectFailureData" title="awscrt.mqtt5.LifecycleConnectFailureData"><span class="pre">LifecycleConnectFailureData</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">on_lifecycle_event_disconnection_fn</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.12)"><span class="pre">Callable</span></a><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#awscrt.mqtt5.LifecycleDisconnectData" title="awscrt.mqtt5.LifecycleDisconnectData"><span class="pre">LifecycleDisconnectData</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt5.ClientOptions" title="Link to this definition">¶</a></dt>
+<dd><p>Configuration for the creation of MQTT5 clients</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>host_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Host name of the MQTT server to connect to.</p></li>
+<li><p><strong>port</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – Network port of the MQTT server to connect to.</p></li>
+<li><p><strong>bootstrap</strong> (<a class="reference internal" href="io.html#awscrt.io.ClientBootstrap" title="awscrt.io.ClientBootstrap"><em>ClientBootstrap</em></a>) – The Client bootstrap used</p></li>
+<li><p><strong>socket_options</strong> (<a class="reference internal" href="io.html#awscrt.io.SocketOptions" title="awscrt.io.SocketOptions"><em>SocketOptions</em></a>) – The socket properties of the underlying MQTT connections made by the client or None if defaults are used.</p></li>
+<li><p><strong>tls_ctx</strong> (<a class="reference internal" href="io.html#awscrt.io.ClientTlsContext" title="awscrt.io.ClientTlsContext"><em>ClientTlsContext</em></a>) – The TLS context for secure socket connections. If None, then a plaintext connection will be used.</p></li>
+<li><p><strong>http_proxy_options</strong> (<a class="reference internal" href="http.html#awscrt.http.HttpProxyOptions" title="awscrt.http.HttpProxyOptions"><em>HttpProxyOptions</em></a>) – The (tunneling) HTTP proxy usage when establishing MQTT connections</p></li>
+<li><p><strong>websocket_handshake_transform</strong> (<em>Callable</em><em>[</em><em>[</em><a class="reference internal" href="#awscrt.mqtt5.WebsocketHandshakeTransformArgs" title="awscrt.mqtt5.WebsocketHandshakeTransformArgs"><em>WebsocketHandshakeTransformArgs</em></a><em>]</em><em>,</em><em>]</em>) – This callback allows a custom transformation of the HTTP request that acts as the websocket handshake. Websockets will be used if this is set to a valid transformation callback.  To use websockets but not perform a transformation, just set this as a trivial completion callback.  If None, the connection will be made with direct MQTT.</p></li>
+<li><p><strong>connect_options</strong> (<a class="reference internal" href="#awscrt.mqtt5.ConnectPacket" title="awscrt.mqtt5.ConnectPacket"><em>ConnectPacket</em></a>) – All configurable options with respect to the CONNECT packet sent by the client, including the will. These connect properties will be used for every connection attempt made by the client.</p></li>
+<li><p><strong>session_behavior</strong> (<a class="reference internal" href="#awscrt.mqtt5.ClientSessionBehaviorType" title="awscrt.mqtt5.ClientSessionBehaviorType"><em>ClientSessionBehaviorType</em></a>) – How the MQTT5 client should behave with respect to MQTT sessions.</p></li>
+<li><p><strong>extended_validation_and_flow_control_options</strong> (<a class="reference internal" href="#awscrt.mqtt5.ExtendedValidationAndFlowControlOptions" title="awscrt.mqtt5.ExtendedValidationAndFlowControlOptions"><em>ExtendedValidationAndFlowControlOptions</em></a>) – The additional controls for client behavior with respect to operation validation and flow control; these checks go beyond the base MQTT5 spec to respect limits of specific MQTT brokers.</p></li>
+<li><p><strong>offline_queue_behavior</strong> (<a class="reference internal" href="#awscrt.mqtt5.ClientOperationQueueBehaviorType" title="awscrt.mqtt5.ClientOperationQueueBehaviorType"><em>ClientOperationQueueBehaviorType</em></a>) – Returns how disconnects affect the queued and in-progress operations tracked by the client.  Also controls how new operations are handled while the client is not connected.  In particular, if the client is not connected, then any operation that would be failed on disconnect (according to these rules) will also be rejected.</p></li>
+<li><p><strong>retry_jitter_mode</strong> (<a class="reference internal" href="#awscrt.mqtt5.ExponentialBackoffJitterMode" title="awscrt.mqtt5.ExponentialBackoffJitterMode"><em>ExponentialBackoffJitterMode</em></a>) – How the reconnect delay is modified in order to smooth out the distribution of reconnection attempt timepoints for a large set of reconnecting clients.</p></li>
+<li><p><strong>min_reconnect_delay_ms</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – The minimum amount of time to wait to reconnect after a disconnect. Exponential backoff is performed with jitter after each connection failure.</p></li>
+<li><p><strong>max_reconnect_delay_ms</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – The maximum amount of time to wait to reconnect after a disconnect.  Exponential backoff is performed with jitter after each connection failure.</p></li>
+<li><p><strong>min_connected_time_to_reset_reconnect_delay_ms</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – The amount of time that must elapse with an established connection before the reconnect delay is reset to the minimum. This helps alleviate bandwidth-waste in fast reconnect cycles due to permission failures on operations.</p></li>
+<li><p><strong>ping_timeout_ms</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – The time interval to wait after sending a PINGREQ for a PINGRESP to arrive. If one does not arrive, the client will close the current connection.</p></li>
+<li><p><strong>connack_timeout_ms</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – The time interval to wait after sending a CONNECT request for a CONNACK to arrive.  If one does not arrive, the connection will be shut down.</p></li>
+<li><p><strong>ack_timeout_sec</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – The time interval to wait for an ack after sending a QoS 1+ PUBLISH, SUBSCRIBE, or UNSUBSCRIBE before failing the operation.</p></li>
+<li><p><strong>topic_aliasing_options</strong> (<a class="reference internal" href="#awscrt.mqtt5.TopicAliasingOptions" title="awscrt.mqtt5.TopicAliasingOptions"><em>TopicAliasingOptions</em></a>) – All configurable options with respect to client topic aliasing behavior.</p></li>
+<li><p><strong>on_publish_callback_fn</strong> (<em>Callable</em><em>[</em><em>[</em><a class="reference internal" href="#awscrt.mqtt5.PublishReceivedData" title="awscrt.mqtt5.PublishReceivedData"><em>PublishReceivedData</em></a><em>]</em><em>,</em><em>]</em>) – Callback for all publish packets received by client.</p></li>
+<li><p><strong>on_lifecycle_event_stopped_fn</strong> (<em>Callable</em><em>[</em><em>[</em><a class="reference internal" href="#awscrt.mqtt5.LifecycleStoppedData" title="awscrt.mqtt5.LifecycleStoppedData"><em>LifecycleStoppedData</em></a><em>]</em><em>,</em><em>]</em>) – Callback for Lifecycle Event Stopped.</p></li>
+<li><p><strong>on_lifecycle_event_attempting_connect_fn</strong> (<em>Callable</em><em>[</em><em>[</em><a class="reference internal" href="#awscrt.mqtt5.LifecycleAttemptingConnectData" title="awscrt.mqtt5.LifecycleAttemptingConnectData"><em>LifecycleAttemptingConnectData</em></a><em>]</em><em>,</em><em>]</em>) – Callback for Lifecycle Event Attempting Connect.</p></li>
+<li><p><strong>on_lifecycle_event_connection_success_fn</strong> (<em>Callable</em><em>[</em><em>[</em><a class="reference internal" href="#awscrt.mqtt5.LifecycleConnectSuccessData" title="awscrt.mqtt5.LifecycleConnectSuccessData"><em>LifecycleConnectSuccessData</em></a><em>]</em><em>,</em><em>]</em>) – Callback for Lifecycle Event Connection Success.</p></li>
+<li><p><strong>on_lifecycle_event_connection_failure_fn</strong> (<em>Callable</em><em>[</em><em>[</em><a class="reference internal" href="#awscrt.mqtt5.LifecycleConnectFailureData" title="awscrt.mqtt5.LifecycleConnectFailureData"><em>LifecycleConnectFailureData</em></a><em>]</em><em>,</em><em>]</em>) – Callback for Lifecycle Event Connection Failure.</p></li>
+<li><p><strong>on_lifecycle_event_disconnection_fn</strong> (<em>Callable</em><em>[</em><em>[</em><a class="reference internal" href="#awscrt.mqtt5.LifecycleDisconnectData" title="awscrt.mqtt5.LifecycleDisconnectData"><em>LifecycleDisconnectData</em></a><em>]</em><em>,</em><em>]</em>) – Callback for Lifecycle Event Disconnection.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.mqtt5.Client">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.mqtt5.</span></span><span class="sig-name descname"><span class="pre">Client</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client_options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.mqtt5.ClientOptions" title="awscrt.mqtt5.ClientOptions"><span class="pre">ClientOptions</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt5.Client" title="Link to this definition">¶</a></dt>
+<dd><p>This class wraps the aws-c-mqtt MQTT5 client to provide the basic MQTT5 pub/sub functionalities via the AWS Common Runtime</p>
+<p>One Client class creates one connection.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>client_options</strong> (<a class="reference internal" href="#awscrt.mqtt5.ClientOptions" title="awscrt.mqtt5.ClientOptions"><em>ClientOptions</em></a>) – The ClientOptions dataclass to used to configure the new Client.</p>
+</dd>
+</dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.mqtt5.Client.start">
+<span class="sig-name descname"><span class="pre">start</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt5.Client.start" title="Link to this definition">¶</a></dt>
+<dd><p>Notifies the MQTT5 client that you want it maintain connectivity to the configured endpoint.
+The client will attempt to stay connected using the properties of the reconnect-related parameters in the mqtt5 client configuration.</p>
+<p>This is an asynchronous operation.</p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.mqtt5.Client.stop">
+<span class="sig-name descname"><span class="pre">stop</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">disconnect_packet</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.mqtt5.DisconnectPacket" title="awscrt.mqtt5.DisconnectPacket"><span class="pre">DisconnectPacket</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt5.Client.stop" title="Link to this definition">¶</a></dt>
+<dd><p>Notifies the MQTT5 client that you want it to end connectivity to the configured endpoint, disconnecting any existing connection and halting any reconnect attempts.</p>
+<p>This is an asynchronous operation.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>disconnect_packet</strong> (<a class="reference internal" href="#awscrt.mqtt5.DisconnectPacket" title="awscrt.mqtt5.DisconnectPacket"><em>DisconnectPacket</em></a>) – (optional) Properties of a DISCONNECT packet to send as part of the shutdown process</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.mqtt5.Client.publish">
+<span class="sig-name descname"><span class="pre">publish</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">publish_packet</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.mqtt5.PublishPacket" title="awscrt.mqtt5.PublishPacket"><span class="pre">PublishPacket</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt5.Client.publish" title="Link to this definition">¶</a></dt>
+<dd><p>Tells the client to attempt to send a PUBLISH packet.</p>
+<p>Will return a future containing a PubAckResult if the publish is successful. The data in the PubAckResult varies depending on the QoS of the Publish. For QoS 0, the PubAckResult will not contain data. For QoS 1, the PubAckResult will contain a PubAckPacket. See PubAckResult class documentation for more info.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>publish_packet</strong> (<a class="reference internal" href="#awscrt.mqtt5.PublishPacket" title="awscrt.mqtt5.PublishPacket"><em>PublishPacket</em></a>) – PUBLISH packet to send to the server</p>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>A future with a (<a class="reference internal" href="#awscrt.mqtt5.PublishCompletionData" title="awscrt.mqtt5.PublishCompletionData"><code class="xref py py-class docutils literal notranslate"><span class="pre">PublishCompletionData</span></code></a>)</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.mqtt5.Client.subscribe">
+<span class="sig-name descname"><span class="pre">subscribe</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">subscribe_packet</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.mqtt5.SubscribePacket" title="awscrt.mqtt5.SubscribePacket"><span class="pre">SubscribePacket</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt5.Client.subscribe" title="Link to this definition">¶</a></dt>
+<dd><p>Tells the client to attempt to subscribe to one or more topic filters.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>subscribe_packet</strong> (<a class="reference internal" href="#awscrt.mqtt5.SubscribePacket" title="awscrt.mqtt5.SubscribePacket"><em>SubscribePacket</em></a>) – SUBSCRIBE packet to send to the server</p>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>A future with a (<a class="reference internal" href="#awscrt.mqtt5.SubackPacket" title="awscrt.mqtt5.SubackPacket"><code class="xref py py-class docutils literal notranslate"><span class="pre">SubackPacket</span></code></a>)</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.mqtt5.Client.unsubscribe">
+<span class="sig-name descname"><span class="pre">unsubscribe</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">unsubscribe_packet</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.mqtt5.UnsubscribePacket" title="awscrt.mqtt5.UnsubscribePacket"><span class="pre">UnsubscribePacket</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt5.Client.unsubscribe" title="Link to this definition">¶</a></dt>
+<dd><p>Tells the client to attempt to unsubscribe from one or more topic filters.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>unsubscribe_packet</strong> (<a class="reference internal" href="#awscrt.mqtt5.UnsubscribePacket" title="awscrt.mqtt5.UnsubscribePacket"><em>UnsubscribePacket</em></a>) – UNSUBSCRIBE packet to send to the server</p>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>A future with a (<a class="reference internal" href="#awscrt.mqtt5.UnsubackPacket" title="awscrt.mqtt5.UnsubackPacket"><code class="xref py py-class docutils literal notranslate"><span class="pre">UnsubackPacket</span></code></a>)</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.mqtt5.Client.get_stats">
+<span class="sig-name descname"><span class="pre">get_stats</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.mqtt5.Client.get_stats" title="Link to this definition">¶</a></dt>
+<dd><p>Queries the client’s internal statistics for incomplete operations.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p>The (<a class="reference internal" href="#awscrt.mqtt5.OperationStatisticsData" title="awscrt.mqtt5.OperationStatisticsData"><code class="xref py py-class docutils literal notranslate"><span class="pre">OperationStatisticsData</span></code></a>) containing the statistics</p>
+</dd>
+</dl>
+</dd></dl>
+
+</dd></dl>
+
+</section>
+
+
+            <div class="clearer"></div>
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+  <div>
+    <h3><a href="../index.html">Table of Contents</a></h3>
+    <ul>
+<li><a class="reference internal" href="#">awscrt.mqtt5</a><ul>
+<li><a class="reference internal" href="#awscrt.mqtt5.QoS"><code class="docutils literal notranslate"><span class="pre">QoS</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.mqtt5.QoS.AT_MOST_ONCE"><code class="docutils literal notranslate"><span class="pre">AT_MOST_ONCE</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.QoS.AT_LEAST_ONCE"><code class="docutils literal notranslate"><span class="pre">AT_LEAST_ONCE</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.QoS.EXACTLY_ONCE"><code class="docutils literal notranslate"><span class="pre">EXACTLY_ONCE</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.mqtt5.ConnectReasonCode"><code class="docutils literal notranslate"><span class="pre">ConnectReasonCode</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.mqtt5.ConnectReasonCode.SUCCESS"><code class="docutils literal notranslate"><span class="pre">SUCCESS</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.ConnectReasonCode.UNSPECIFIED_ERROR"><code class="docutils literal notranslate"><span class="pre">UNSPECIFIED_ERROR</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.ConnectReasonCode.MALFORMED_PACKET"><code class="docutils literal notranslate"><span class="pre">MALFORMED_PACKET</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.ConnectReasonCode.PROTOCOL_ERROR"><code class="docutils literal notranslate"><span class="pre">PROTOCOL_ERROR</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.ConnectReasonCode.IMPLEMENTATION_SPECIFIC_ERROR"><code class="docutils literal notranslate"><span class="pre">IMPLEMENTATION_SPECIFIC_ERROR</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.ConnectReasonCode.UNSUPPORTED_PROTOCOL_VERSION"><code class="docutils literal notranslate"><span class="pre">UNSUPPORTED_PROTOCOL_VERSION</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.ConnectReasonCode.CLIENT_IDENTIFIER_NOT_VALID"><code class="docutils literal notranslate"><span class="pre">CLIENT_IDENTIFIER_NOT_VALID</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.ConnectReasonCode.BAD_USERNAME_OR_PASSWORD"><code class="docutils literal notranslate"><span class="pre">BAD_USERNAME_OR_PASSWORD</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.ConnectReasonCode.NOT_AUTHORIZED"><code class="docutils literal notranslate"><span class="pre">NOT_AUTHORIZED</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.ConnectReasonCode.SERVER_UNAVAILABLE"><code class="docutils literal notranslate"><span class="pre">SERVER_UNAVAILABLE</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.ConnectReasonCode.SERVER_BUSY"><code class="docutils literal notranslate"><span class="pre">SERVER_BUSY</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.ConnectReasonCode.BANNED"><code class="docutils literal notranslate"><span class="pre">BANNED</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.ConnectReasonCode.BAD_AUTHENTICATION_METHOD"><code class="docutils literal notranslate"><span class="pre">BAD_AUTHENTICATION_METHOD</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.ConnectReasonCode.TOPIC_NAME_INVALID"><code class="docutils literal notranslate"><span class="pre">TOPIC_NAME_INVALID</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.ConnectReasonCode.PACKET_TOO_LARGE"><code class="docutils literal notranslate"><span class="pre">PACKET_TOO_LARGE</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.ConnectReasonCode.QUOTA_EXCEEDED"><code class="docutils literal notranslate"><span class="pre">QUOTA_EXCEEDED</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.ConnectReasonCode.PAYLOAD_FORMAT_INVALID"><code class="docutils literal notranslate"><span class="pre">PAYLOAD_FORMAT_INVALID</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.ConnectReasonCode.RETAIN_NOT_SUPPORTED"><code class="docutils literal notranslate"><span class="pre">RETAIN_NOT_SUPPORTED</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.ConnectReasonCode.QOS_NOT_SUPPORTED"><code class="docutils literal notranslate"><span class="pre">QOS_NOT_SUPPORTED</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.ConnectReasonCode.USE_ANOTHER_SERVER"><code class="docutils literal notranslate"><span class="pre">USE_ANOTHER_SERVER</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.ConnectReasonCode.SERVER_MOVED"><code class="docutils literal notranslate"><span class="pre">SERVER_MOVED</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.ConnectReasonCode.CONNECTION_RATE_EXCEEDED"><code class="docutils literal notranslate"><span class="pre">CONNECTION_RATE_EXCEEDED</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.mqtt5.DisconnectReasonCode"><code class="docutils literal notranslate"><span class="pre">DisconnectReasonCode</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.mqtt5.DisconnectReasonCode.NORMAL_DISCONNECTION"><code class="docutils literal notranslate"><span class="pre">NORMAL_DISCONNECTION</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.DisconnectReasonCode.DISCONNECT_WITH_WILL_MESSAGE"><code class="docutils literal notranslate"><span class="pre">DISCONNECT_WITH_WILL_MESSAGE</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.DisconnectReasonCode.UNSPECIFIED_ERROR"><code class="docutils literal notranslate"><span class="pre">UNSPECIFIED_ERROR</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.DisconnectReasonCode.MALFORMED_PACKET"><code class="docutils literal notranslate"><span class="pre">MALFORMED_PACKET</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.DisconnectReasonCode.PROTOCOL_ERROR"><code class="docutils literal notranslate"><span class="pre">PROTOCOL_ERROR</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.DisconnectReasonCode.IMPLEMENTATION_SPECIFIC_ERROR"><code class="docutils literal notranslate"><span class="pre">IMPLEMENTATION_SPECIFIC_ERROR</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.DisconnectReasonCode.NOT_AUTHORIZED"><code class="docutils literal notranslate"><span class="pre">NOT_AUTHORIZED</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.DisconnectReasonCode.SERVER_BUSY"><code class="docutils literal notranslate"><span class="pre">SERVER_BUSY</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.DisconnectReasonCode.SERVER_SHUTTING_DOWN"><code class="docutils literal notranslate"><span class="pre">SERVER_SHUTTING_DOWN</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.DisconnectReasonCode.KEEP_ALIVE_TIMEOUT"><code class="docutils literal notranslate"><span class="pre">KEEP_ALIVE_TIMEOUT</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.DisconnectReasonCode.SESSION_TAKEN_OVER"><code class="docutils literal notranslate"><span class="pre">SESSION_TAKEN_OVER</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.DisconnectReasonCode.TOPIC_FILTER_INVALID"><code class="docutils literal notranslate"><span class="pre">TOPIC_FILTER_INVALID</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.DisconnectReasonCode.TOPIC_NAME_INVALID"><code class="docutils literal notranslate"><span class="pre">TOPIC_NAME_INVALID</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.DisconnectReasonCode.RECEIVE_MAXIMUM_EXCEEDED"><code class="docutils literal notranslate"><span class="pre">RECEIVE_MAXIMUM_EXCEEDED</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.DisconnectReasonCode.TOPIC_ALIAS_INVALID"><code class="docutils literal notranslate"><span class="pre">TOPIC_ALIAS_INVALID</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.DisconnectReasonCode.PACKET_TOO_LARGE"><code class="docutils literal notranslate"><span class="pre">PACKET_TOO_LARGE</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.DisconnectReasonCode.MESSAGE_RATE_TOO_HIGH"><code class="docutils literal notranslate"><span class="pre">MESSAGE_RATE_TOO_HIGH</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.DisconnectReasonCode.QUOTA_EXCEEDED"><code class="docutils literal notranslate"><span class="pre">QUOTA_EXCEEDED</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.DisconnectReasonCode.ADMINISTRATIVE_ACTION"><code class="docutils literal notranslate"><span class="pre">ADMINISTRATIVE_ACTION</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.DisconnectReasonCode.PAYLOAD_FORMAT_INVALID"><code class="docutils literal notranslate"><span class="pre">PAYLOAD_FORMAT_INVALID</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.DisconnectReasonCode.RETAIN_NOT_SUPPORTED"><code class="docutils literal notranslate"><span class="pre">RETAIN_NOT_SUPPORTED</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.DisconnectReasonCode.QOS_NOT_SUPPORTED"><code class="docutils literal notranslate"><span class="pre">QOS_NOT_SUPPORTED</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.DisconnectReasonCode.USE_ANOTHER_SERVER"><code class="docutils literal notranslate"><span class="pre">USE_ANOTHER_SERVER</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.DisconnectReasonCode.SERVER_MOVED"><code class="docutils literal notranslate"><span class="pre">SERVER_MOVED</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.DisconnectReasonCode.SHARED_SUBSCRIPTIONS_NOT_SUPPORTED"><code class="docutils literal notranslate"><span class="pre">SHARED_SUBSCRIPTIONS_NOT_SUPPORTED</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.DisconnectReasonCode.CONNECTION_RATE_EXCEEDED"><code class="docutils literal notranslate"><span class="pre">CONNECTION_RATE_EXCEEDED</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.DisconnectReasonCode.MAXIMUM_CONNECT_TIME"><code class="docutils literal notranslate"><span class="pre">MAXIMUM_CONNECT_TIME</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.DisconnectReasonCode.SUBSCRIPTION_IDENTIFIERS_NOT_SUPPORTED"><code class="docutils literal notranslate"><span class="pre">SUBSCRIPTION_IDENTIFIERS_NOT_SUPPORTED</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.DisconnectReasonCode.WILDCARD_SUBSCRIPTIONS_NOT_SUPPORTED"><code class="docutils literal notranslate"><span class="pre">WILDCARD_SUBSCRIPTIONS_NOT_SUPPORTED</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.mqtt5.PubackReasonCode"><code class="docutils literal notranslate"><span class="pre">PubackReasonCode</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.mqtt5.PubackReasonCode.SUCCESS"><code class="docutils literal notranslate"><span class="pre">SUCCESS</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.PubackReasonCode.NO_MATCHING_SUBSCRIBERS"><code class="docutils literal notranslate"><span class="pre">NO_MATCHING_SUBSCRIBERS</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.PubackReasonCode.UNSPECIFIED_ERROR"><code class="docutils literal notranslate"><span class="pre">UNSPECIFIED_ERROR</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.PubackReasonCode.IMPLEMENTATION_SPECIFIC_ERROR"><code class="docutils literal notranslate"><span class="pre">IMPLEMENTATION_SPECIFIC_ERROR</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.PubackReasonCode.NOT_AUTHORIZED"><code class="docutils literal notranslate"><span class="pre">NOT_AUTHORIZED</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.PubackReasonCode.TOPIC_NAME_INVALID"><code class="docutils literal notranslate"><span class="pre">TOPIC_NAME_INVALID</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.PubackReasonCode.PACKET_IDENTIFIER_IN_USE"><code class="docutils literal notranslate"><span class="pre">PACKET_IDENTIFIER_IN_USE</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.PubackReasonCode.QUOTA_EXCEEDED"><code class="docutils literal notranslate"><span class="pre">QUOTA_EXCEEDED</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.PubackReasonCode.PAYLOAD_FORMAT_INVALID"><code class="docutils literal notranslate"><span class="pre">PAYLOAD_FORMAT_INVALID</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.mqtt5.SubackReasonCode"><code class="docutils literal notranslate"><span class="pre">SubackReasonCode</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.mqtt5.SubackReasonCode.GRANTED_QOS_0"><code class="docutils literal notranslate"><span class="pre">GRANTED_QOS_0</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.SubackReasonCode.GRANTED_QOS_1"><code class="docutils literal notranslate"><span class="pre">GRANTED_QOS_1</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.SubackReasonCode.GRANTED_QOS_2"><code class="docutils literal notranslate"><span class="pre">GRANTED_QOS_2</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.SubackReasonCode.UNSPECIFIED_ERROR"><code class="docutils literal notranslate"><span class="pre">UNSPECIFIED_ERROR</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.SubackReasonCode.IMPLEMENTATION_SPECIFIC_ERROR"><code class="docutils literal notranslate"><span class="pre">IMPLEMENTATION_SPECIFIC_ERROR</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.SubackReasonCode.NOT_AUTHORIZED"><code class="docutils literal notranslate"><span class="pre">NOT_AUTHORIZED</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.SubackReasonCode.TOPIC_FILTER_INVALID"><code class="docutils literal notranslate"><span class="pre">TOPIC_FILTER_INVALID</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.SubackReasonCode.PACKET_IDENTIFIER_IN_USE"><code class="docutils literal notranslate"><span class="pre">PACKET_IDENTIFIER_IN_USE</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.SubackReasonCode.QUOTA_EXCEEDED"><code class="docutils literal notranslate"><span class="pre">QUOTA_EXCEEDED</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.SubackReasonCode.SHARED_SUBSCRIPTIONS_NOT_SUPPORTED"><code class="docutils literal notranslate"><span class="pre">SHARED_SUBSCRIPTIONS_NOT_SUPPORTED</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.SubackReasonCode.SUBSCRIPTION_IDENTIFIERS_NOT_SUPPORTED"><code class="docutils literal notranslate"><span class="pre">SUBSCRIPTION_IDENTIFIERS_NOT_SUPPORTED</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.SubackReasonCode.WILDCARD_SUBSCRIPTIONS_NOT_SUPPORTED"><code class="docutils literal notranslate"><span class="pre">WILDCARD_SUBSCRIPTIONS_NOT_SUPPORTED</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.mqtt5.UnsubackReasonCode"><code class="docutils literal notranslate"><span class="pre">UnsubackReasonCode</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.mqtt5.UnsubackReasonCode.SUCCESS"><code class="docutils literal notranslate"><span class="pre">SUCCESS</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.UnsubackReasonCode.NO_SUBSCRIPTION_EXISTED"><code class="docutils literal notranslate"><span class="pre">NO_SUBSCRIPTION_EXISTED</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.UnsubackReasonCode.UNSPECIFIED_ERROR"><code class="docutils literal notranslate"><span class="pre">UNSPECIFIED_ERROR</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.UnsubackReasonCode.IMPLEMENTATION_SPECIFIC_ERROR"><code class="docutils literal notranslate"><span class="pre">IMPLEMENTATION_SPECIFIC_ERROR</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.UnsubackReasonCode.NOT_AUTHORIZED"><code class="docutils literal notranslate"><span class="pre">NOT_AUTHORIZED</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.UnsubackReasonCode.TOPIC_FILTER_INVALID"><code class="docutils literal notranslate"><span class="pre">TOPIC_FILTER_INVALID</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.UnsubackReasonCode.PACKET_IDENTIFIER_IN_USE"><code class="docutils literal notranslate"><span class="pre">PACKET_IDENTIFIER_IN_USE</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.mqtt5.ClientSessionBehaviorType"><code class="docutils literal notranslate"><span class="pre">ClientSessionBehaviorType</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.mqtt5.ClientSessionBehaviorType.DEFAULT"><code class="docutils literal notranslate"><span class="pre">DEFAULT</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.ClientSessionBehaviorType.CLEAN"><code class="docutils literal notranslate"><span class="pre">CLEAN</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.ClientSessionBehaviorType.REJOIN_POST_SUCCESS"><code class="docutils literal notranslate"><span class="pre">REJOIN_POST_SUCCESS</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.ClientSessionBehaviorType.REJOIN_ALWAYS"><code class="docutils literal notranslate"><span class="pre">REJOIN_ALWAYS</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.mqtt5.PayloadFormatIndicator"><code class="docutils literal notranslate"><span class="pre">PayloadFormatIndicator</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.mqtt5.PayloadFormatIndicator.AWS_MQTT5_PFI_BYTES"><code class="docutils literal notranslate"><span class="pre">AWS_MQTT5_PFI_BYTES</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.PayloadFormatIndicator.AWS_MQTT5_PFI_UTF8"><code class="docutils literal notranslate"><span class="pre">AWS_MQTT5_PFI_UTF8</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.mqtt5.RetainHandlingType"><code class="docutils literal notranslate"><span class="pre">RetainHandlingType</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.mqtt5.RetainHandlingType.SEND_ON_SUBSCRIBE"><code class="docutils literal notranslate"><span class="pre">SEND_ON_SUBSCRIBE</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.RetainHandlingType.SEND_ON_SUBSCRIBE_IF_NEW"><code class="docutils literal notranslate"><span class="pre">SEND_ON_SUBSCRIBE_IF_NEW</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.RetainHandlingType.DONT_SEND"><code class="docutils literal notranslate"><span class="pre">DONT_SEND</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.mqtt5.RetainAndHandlingType"><code class="docutils literal notranslate"><span class="pre">RetainAndHandlingType</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.mqtt5.RetainAndHandlingType.SEND_ON_SUBSCRIBE"><code class="docutils literal notranslate"><span class="pre">SEND_ON_SUBSCRIBE</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.RetainAndHandlingType.SEND_ON_SUBSCRIBE_IF_NEW"><code class="docutils literal notranslate"><span class="pre">SEND_ON_SUBSCRIBE_IF_NEW</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.RetainAndHandlingType.DONT_SEND"><code class="docutils literal notranslate"><span class="pre">DONT_SEND</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.mqtt5.ExtendedValidationAndFlowControlOptions"><code class="docutils literal notranslate"><span class="pre">ExtendedValidationAndFlowControlOptions</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.mqtt5.ExtendedValidationAndFlowControlOptions.NONE"><code class="docutils literal notranslate"><span class="pre">NONE</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.ExtendedValidationAndFlowControlOptions.AWS_IOT_CORE_DEFAULTS"><code class="docutils literal notranslate"><span class="pre">AWS_IOT_CORE_DEFAULTS</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.mqtt5.ClientOperationQueueBehaviorType"><code class="docutils literal notranslate"><span class="pre">ClientOperationQueueBehaviorType</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.mqtt5.ClientOperationQueueBehaviorType.DEFAULT"><code class="docutils literal notranslate"><span class="pre">DEFAULT</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.ClientOperationQueueBehaviorType.FAIL_NON_QOS1_PUBLISH_ON_DISCONNECT"><code class="docutils literal notranslate"><span class="pre">FAIL_NON_QOS1_PUBLISH_ON_DISCONNECT</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.ClientOperationQueueBehaviorType.FAIL_QOS0_PUBLISH_ON_DISCONNECT"><code class="docutils literal notranslate"><span class="pre">FAIL_QOS0_PUBLISH_ON_DISCONNECT</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.ClientOperationQueueBehaviorType.FAIL_ALL_ON_DISCONNECT"><code class="docutils literal notranslate"><span class="pre">FAIL_ALL_ON_DISCONNECT</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.mqtt5.ExponentialBackoffJitterMode"><code class="docutils literal notranslate"><span class="pre">ExponentialBackoffJitterMode</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.mqtt5.ExponentialBackoffJitterMode.DEFAULT"><code class="docutils literal notranslate"><span class="pre">DEFAULT</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.ExponentialBackoffJitterMode.NONE"><code class="docutils literal notranslate"><span class="pre">NONE</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.ExponentialBackoffJitterMode.FULL"><code class="docutils literal notranslate"><span class="pre">FULL</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.ExponentialBackoffJitterMode.DECORRELATED"><code class="docutils literal notranslate"><span class="pre">DECORRELATED</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.mqtt5.UserProperty"><code class="docutils literal notranslate"><span class="pre">UserProperty</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.OutboundTopicAliasBehaviorType"><code class="docutils literal notranslate"><span class="pre">OutboundTopicAliasBehaviorType</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.mqtt5.OutboundTopicAliasBehaviorType.DEFAULT"><code class="docutils literal notranslate"><span class="pre">DEFAULT</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.OutboundTopicAliasBehaviorType.MANUAL"><code class="docutils literal notranslate"><span class="pre">MANUAL</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.OutboundTopicAliasBehaviorType.LRU"><code class="docutils literal notranslate"><span class="pre">LRU</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.OutboundTopicAliasBehaviorType.DISABLED"><code class="docutils literal notranslate"><span class="pre">DISABLED</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.mqtt5.InboundTopicAliasBehaviorType"><code class="docutils literal notranslate"><span class="pre">InboundTopicAliasBehaviorType</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.mqtt5.InboundTopicAliasBehaviorType.DEFAULT"><code class="docutils literal notranslate"><span class="pre">DEFAULT</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.InboundTopicAliasBehaviorType.ENABLED"><code class="docutils literal notranslate"><span class="pre">ENABLED</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.InboundTopicAliasBehaviorType.DISABLED"><code class="docutils literal notranslate"><span class="pre">DISABLED</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.mqtt5.TopicAliasingOptions"><code class="docutils literal notranslate"><span class="pre">TopicAliasingOptions</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.NegotiatedSettings"><code class="docutils literal notranslate"><span class="pre">NegotiatedSettings</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.ConnackPacket"><code class="docutils literal notranslate"><span class="pre">ConnackPacket</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.DisconnectPacket"><code class="docutils literal notranslate"><span class="pre">DisconnectPacket</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.Subscription"><code class="docutils literal notranslate"><span class="pre">Subscription</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.SubscribePacket"><code class="docutils literal notranslate"><span class="pre">SubscribePacket</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.SubackPacket"><code class="docutils literal notranslate"><span class="pre">SubackPacket</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.UnsubscribePacket"><code class="docutils literal notranslate"><span class="pre">UnsubscribePacket</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.UnsubackPacket"><code class="docutils literal notranslate"><span class="pre">UnsubackPacket</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.PublishPacket"><code class="docutils literal notranslate"><span class="pre">PublishPacket</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.PubackPacket"><code class="docutils literal notranslate"><span class="pre">PubackPacket</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.ConnectPacket"><code class="docutils literal notranslate"><span class="pre">ConnectPacket</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.WebsocketHandshakeTransformArgs"><code class="docutils literal notranslate"><span class="pre">WebsocketHandshakeTransformArgs</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.mqtt5.WebsocketHandshakeTransformArgs.client"><code class="docutils literal notranslate"><span class="pre">client</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.WebsocketHandshakeTransformArgs.http_request"><code class="docutils literal notranslate"><span class="pre">http_request</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.WebsocketHandshakeTransformArgs.set_done"><code class="docutils literal notranslate"><span class="pre">set_done()</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.mqtt5.PublishReceivedData"><code class="docutils literal notranslate"><span class="pre">PublishReceivedData</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.OperationStatisticsData"><code class="docutils literal notranslate"><span class="pre">OperationStatisticsData</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.LifecycleStoppedData"><code class="docutils literal notranslate"><span class="pre">LifecycleStoppedData</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.LifecycleAttemptingConnectData"><code class="docutils literal notranslate"><span class="pre">LifecycleAttemptingConnectData</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.LifecycleConnectSuccessData"><code class="docutils literal notranslate"><span class="pre">LifecycleConnectSuccessData</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.LifecycleConnectFailureData"><code class="docutils literal notranslate"><span class="pre">LifecycleConnectFailureData</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.LifecycleDisconnectData"><code class="docutils literal notranslate"><span class="pre">LifecycleDisconnectData</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.PublishCompletionData"><code class="docutils literal notranslate"><span class="pre">PublishCompletionData</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.ClientOptions"><code class="docutils literal notranslate"><span class="pre">ClientOptions</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.Client"><code class="docutils literal notranslate"><span class="pre">Client</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.mqtt5.Client.start"><code class="docutils literal notranslate"><span class="pre">start()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.Client.stop"><code class="docutils literal notranslate"><span class="pre">stop()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.Client.publish"><code class="docutils literal notranslate"><span class="pre">publish()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.Client.subscribe"><code class="docutils literal notranslate"><span class="pre">subscribe()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.Client.unsubscribe"><code class="docutils literal notranslate"><span class="pre">unsubscribe()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.mqtt5.Client.get_stats"><code class="docutils literal notranslate"><span class="pre">get_stats()</span></code></a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+
+  </div>
+  <div>
+    <h4>Previous topic</h4>
+    <p class="topless"><a href="mqtt.html"
+                          title="previous chapter">awscrt.mqtt</a></p>
+  </div>
+  <div>
+    <h4>Next topic</h4>
+    <p class="topless"><a href="s3.html"
+                          title="next chapter">awscrt.s3</a></p>
+  </div>
+  <div role="note" aria-label="source link">
+    <h3>This Page</h3>
+    <ul class="this-page-menu">
+      <li><a href="../_sources/api/mqtt5.rst.txt"
+            rel="nofollow">Show Source</a></li>
+    </ul>
+   </div>
+<div id="searchbox" style="display: none" role="search">
+  <h3 id="searchlabel">Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="../search.html" method="get">
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+      <input type="submit" value="Go" />
+    </form>
+    </div>
+</div>
+<script>document.getElementById('searchbox').style.display = "block"</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../genindex.html" title="General Index"
+             >index</a></li>
+        <li class="right" >
+          <a href="../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="right" >
+          <a href="s3.html" title="awscrt.s3"
+             >next</a> |</li>
+        <li class="right" >
+          <a href="mqtt.html" title="awscrt.mqtt"
+             >previous</a> |</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">awscrt  documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">awscrt.mqtt5</a></li> 
+      </ul>
+    </div>
+    <div class="footer" role="contentinfo">
+    &#169; Copyright 2020, Amazon Web Services, Inc.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
+    </div>
+  </body>
+</html>
\ No newline at end of file
diff --git a/docs/api/s3.html b/docs/api/s3.html
new file mode 100644
index 000000000..8e37d3ed0
--- /dev/null
+++ b/docs/api/s3.html
@@ -0,0 +1,745 @@
+
+
+<!doctype html>
+
+<html lang="en" data-content_root="../">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+
+    <title>awscrt.s3 &#8212; awscrt  documentation</title>
+    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=649a27d8" />
+    <link rel="stylesheet" type="text/css" href="../_static/css/custom.css?v=93be7416" />
+    
+    <script src="../_static/documentation_options.js?v=5929fcd5"></script>
+    <script src="../_static/doctools.js?v=888ff710"></script>
+    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script src="../_static/bizstyle.js"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" />
+    <link rel="next" title="awscrt.websocket" href="websocket.html" />
+    <link rel="prev" title="awscrt.mqtt5" href="mqtt5.html" />
+    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+    <!--[if lt IE 9]>
+    <script src="_static/css3-mediaqueries.js"></script>
+    <![endif]-->
+  </head><body>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../genindex.html" title="General Index"
+             accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="right" >
+          <a href="websocket.html" title="awscrt.websocket"
+             accesskey="N">next</a> |</li>
+        <li class="right" >
+          <a href="mqtt5.html" title="awscrt.mqtt5"
+             accesskey="P">previous</a> |</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">awscrt  documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">awscrt.s3</a></li> 
+      </ul>
+    </div>  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body" role="main">
+            
+  <section id="module-awscrt.s3">
+<span id="awscrt-s3"></span><h1>awscrt.s3<a class="headerlink" href="#module-awscrt.s3" title="Link to this heading">¶</a></h1>
+<p>S3 client</p>
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.s3.CrossProcessLock">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.s3.</span></span><span class="sig-name descname"><span class="pre">CrossProcessLock</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">lock_scope_name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.s3.CrossProcessLock" title="Link to this definition">¶</a></dt>
+<dd><p>Class representing an exclusive cross-process lock, scoped by <cite>lock_scope_name</cite></p>
+<p>Recommended usage is to either explicitly call acquire() followed by release() when the lock  is no longer required, or use this in a ‘with’ statement.</p>
+<p>acquire() will throw a RuntimeError with AWS_MUTEX_CALLER_NOT_OWNER as the error code, if the lock could not be acquired.</p>
+<p>If the lock has not been explicitly released when the process exits, it will be released by the operating system.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Keyword Arguments<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>lock_scope_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Unique string identifying the caller holding the lock.</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.s3.S3RequestType">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.s3.</span></span><span class="sig-name descname"><span class="pre">S3RequestType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.s3.S3RequestType" title="Link to this definition">¶</a></dt>
+<dd><p>The type of the AWS S3 request</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.s3.S3RequestType.DEFAULT">
+<span class="sig-name descname"><span class="pre">DEFAULT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#awscrt.s3.S3RequestType.DEFAULT" title="Link to this definition">¶</a></dt>
+<dd><p>Default type, for all S3 request types other than
+<a class="reference internal" href="#awscrt.s3.S3RequestType.GET_OBJECT" title="awscrt.s3.S3RequestType.GET_OBJECT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">GET_OBJECT</span></code></a>/<a class="reference internal" href="#awscrt.s3.S3RequestType.PUT_OBJECT" title="awscrt.s3.S3RequestType.PUT_OBJECT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">PUT_OBJECT</span></code></a>.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.s3.S3RequestType.GET_OBJECT">
+<span class="sig-name descname"><span class="pre">GET_OBJECT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#awscrt.s3.S3RequestType.GET_OBJECT" title="Link to this definition">¶</a></dt>
+<dd><p>Get Object S3 request</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.s3.S3RequestType.PUT_OBJECT">
+<span class="sig-name descname"><span class="pre">PUT_OBJECT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#awscrt.s3.S3RequestType.PUT_OBJECT" title="Link to this definition">¶</a></dt>
+<dd><p>Put Object S3 request</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.s3.S3RequestTlsMode">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.s3.</span></span><span class="sig-name descname"><span class="pre">S3RequestTlsMode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.s3.S3RequestTlsMode" title="Link to this definition">¶</a></dt>
+<dd><p>TLS mode for S3 request</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.s3.S3RequestTlsMode.ENABLED">
+<span class="sig-name descname"><span class="pre">ENABLED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#awscrt.s3.S3RequestTlsMode.ENABLED" title="Link to this definition">¶</a></dt>
+<dd><p>Enable TLS for S3 request.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.s3.S3RequestTlsMode.DISABLED">
+<span class="sig-name descname"><span class="pre">DISABLED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#awscrt.s3.S3RequestTlsMode.DISABLED" title="Link to this definition">¶</a></dt>
+<dd><p>Disable TLS for S3 request.</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.s3.S3ChecksumAlgorithm">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.s3.</span></span><span class="sig-name descname"><span class="pre">S3ChecksumAlgorithm</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.s3.S3ChecksumAlgorithm" title="Link to this definition">¶</a></dt>
+<dd><p>Checksum algorithm used to verify object integrity.
+<a class="reference external" href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html</a></p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.s3.S3ChecksumAlgorithm.CRC32C">
+<span class="sig-name descname"><span class="pre">CRC32C</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#awscrt.s3.S3ChecksumAlgorithm.CRC32C" title="Link to this definition">¶</a></dt>
+<dd><p>CRC32C</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.s3.S3ChecksumAlgorithm.CRC32">
+<span class="sig-name descname"><span class="pre">CRC32</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#awscrt.s3.S3ChecksumAlgorithm.CRC32" title="Link to this definition">¶</a></dt>
+<dd><p>CRC32</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.s3.S3ChecksumAlgorithm.SHA1">
+<span class="sig-name descname"><span class="pre">SHA1</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">3</span></em><a class="headerlink" href="#awscrt.s3.S3ChecksumAlgorithm.SHA1" title="Link to this definition">¶</a></dt>
+<dd><p>SHA-1</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.s3.S3ChecksumAlgorithm.SHA256">
+<span class="sig-name descname"><span class="pre">SHA256</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">4</span></em><a class="headerlink" href="#awscrt.s3.S3ChecksumAlgorithm.SHA256" title="Link to this definition">¶</a></dt>
+<dd><p>SHA-256</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.s3.S3ChecksumLocation">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.s3.</span></span><span class="sig-name descname"><span class="pre">S3ChecksumLocation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.s3.S3ChecksumLocation" title="Link to this definition">¶</a></dt>
+<dd><p>Where to put the checksum.</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.s3.S3ChecksumLocation.HEADER">
+<span class="sig-name descname"><span class="pre">HEADER</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#awscrt.s3.S3ChecksumLocation.HEADER" title="Link to this definition">¶</a></dt>
+<dd><p>Add checksum as a request header field.
+The checksum is calculated before any part of the request is sent to the server.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.s3.S3ChecksumLocation.TRAILER">
+<span class="sig-name descname"><span class="pre">TRAILER</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#awscrt.s3.S3ChecksumLocation.TRAILER" title="Link to this definition">¶</a></dt>
+<dd><p>Add checksum as a request trailer field.
+The checksum is calculated as the body is streamed to the server, then
+added as a trailer field. This may be more efficient than HEADER, but
+can only be used with “streaming” requests that support it.</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.s3.S3ChecksumConfig">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.s3.</span></span><span class="sig-name descname"><span class="pre">S3ChecksumConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">algorithm</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.s3.S3ChecksumAlgorithm" title="awscrt.s3.S3ChecksumAlgorithm"><span class="pre">S3ChecksumAlgorithm</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">location</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.s3.S3ChecksumLocation" title="awscrt.s3.S3ChecksumLocation"><span class="pre">S3ChecksumLocation</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">validate_response</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.s3.S3ChecksumConfig" title="Link to this definition">¶</a></dt>
+<dd><p>Configures how the S3Client calculates and verifies checksums.</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.s3.S3ChecksumConfig.algorithm">
+<span class="sig-name descname"><span class="pre">algorithm</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#awscrt.s3.S3ChecksumAlgorithm" title="awscrt.s3.S3ChecksumAlgorithm"><span class="pre">S3ChecksumAlgorithm</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#awscrt.s3.S3ChecksumConfig.algorithm" title="Link to this definition">¶</a></dt>
+<dd><p>If set, the S3Client will calculate a checksum using this algorithm
+and add it to the request. If you set this, you must also set <cite>location</cite>.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.s3.S3ChecksumConfig.location">
+<span class="sig-name descname"><span class="pre">location</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#awscrt.s3.S3ChecksumLocation" title="awscrt.s3.S3ChecksumLocation"><span class="pre">S3ChecksumLocation</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#awscrt.s3.S3ChecksumConfig.location" title="Link to this definition">¶</a></dt>
+<dd><p>Where to put the request checksum.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.s3.S3ChecksumConfig.validate_response">
+<span class="sig-name descname"><span class="pre">validate_response</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="headerlink" href="#awscrt.s3.S3ChecksumConfig.validate_response" title="Link to this definition">¶</a></dt>
+<dd><p>Whether to retrieve and validate response checksums.</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.s3.S3Client">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.s3.</span></span><span class="sig-name descname"><span class="pre">S3Client</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bootstrap</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">region</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tls_mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">signing_config</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">credential_provider</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tls_connection_options</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">part_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">multipart_upload_threshold</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">throughput_target_gbps</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">enable_s3express</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">memory_limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.s3.S3Client" title="Link to this definition">¶</a></dt>
+<dd><p>S3 client</p>
+<dl class="field-list simple">
+<dt class="field-odd">Keyword Arguments<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>bootstrap</strong> (<em>Optional</em><em> [</em><a class="reference internal" href="io.html#awscrt.io.ClientBootstrap" title="awscrt.io.ClientBootstrap"><em>ClientBootstrap</em></a><em>]</em>) – Client bootstrap to use when initiating socket connection.
+If None is provided, the default singleton is used.</p></li>
+<li><p><strong>region</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Region that the S3 bucket lives in.</p></li>
+<li><p><strong>tls_mode</strong> (<em>Optional</em><em>[</em><a class="reference internal" href="#awscrt.s3.S3RequestTlsMode" title="awscrt.s3.S3RequestTlsMode"><em>S3RequestTlsMode</em></a><em>]</em>) – <p>How TLS should be used while performing the request</p>
+<dl class="simple">
+<dt>If this is <a class="reference internal" href="#awscrt.s3.S3RequestTlsMode.ENABLED" title="awscrt.s3.S3RequestTlsMode.ENABLED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">S3RequestTlsMode.ENABLED</span></code></a>:</dt><dd><p>If <cite>tls_connection_options</cite> is set, then those TLS options will be used
+If <cite>tls_connection_options</cite> is unset, then default TLS options will be used</p>
+</dd>
+<dt>If this is <a class="reference internal" href="#awscrt.s3.S3RequestTlsMode.DISABLED" title="awscrt.s3.S3RequestTlsMode.DISABLED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">S3RequestTlsMode.DISABLED</span></code></a>:</dt><dd><p>No TLS options will be used, regardless of <cite>tls_connection_options</cite> value.</p>
+</dd>
+</dl>
+</p></li>
+<li><p><strong>signing_config</strong> (<em>Optional</em><em>[</em><a class="reference internal" href="auth.html#awscrt.auth.AwsSigningConfig" title="awscrt.auth.AwsSigningConfig"><em>AwsSigningConfig</em></a><em>]</em>) – <p>Configuration for signing of the client.
+Use <a class="reference internal" href="#awscrt.s3.create_default_s3_signing_config" title="awscrt.s3.create_default_s3_signing_config"><code class="xref py py-func docutils literal notranslate"><span class="pre">create_default_s3_signing_config()</span></code></a> to create the default config.</p>
+<p>If not set, a default config will be used with anonymous credentials and skip signing the request.</p>
+<dl>
+<dt>If set:</dt><dd><dl class="simple">
+<dt>Credentials provider is required. Other configs are all optional, and will be default to what</dt><dd><p>needs to sign the request for S3, only overrides when Non-zero/Not-empty is set.</p>
+</dd>
+</dl>
+<p>S3 Client will derive the right config for signing process based on this.</p>
+</dd>
+</dl>
+<p class="rubric">Notes</p>
+<ol class="arabic simple">
+<li><dl class="simple">
+<dt>For SIGV4_S3EXPRESS, S3 client will use the credentials in the config to derive the S3 Express</dt><dd><p>credentials that are used in the signing process.</p>
+</dd>
+</dl>
+</li>
+<li><p>Client may make modifications to signing config before passing it on to signer.</p></li>
+</ol>
+</p></li>
+<li><p><strong>credential_provider</strong> (<em>Optional</em><em>[</em><a class="reference internal" href="auth.html#awscrt.auth.AwsCredentialsProvider" title="awscrt.auth.AwsCredentialsProvider"><em>AwsCredentialsProvider</em></a><em>]</em>) – Deprecated, prefer <cite>signing_config</cite> instead.
+Credentials providers source the <a class="reference internal" href="auth.html#awscrt.auth.AwsCredentials" title="awscrt.auth.AwsCredentials"><code class="xref py py-class docutils literal notranslate"><span class="pre">AwsCredentials</span></code></a> needed to sign an authenticated AWS request.
+If None is provided, the request will not be signed.</p></li>
+<li><p><strong>tls_connection_options</strong> (<em>Optional</em><em>[</em><a class="reference internal" href="io.html#awscrt.io.TlsConnectionOptions" title="awscrt.io.TlsConnectionOptions"><em>TlsConnectionOptions</em></a><em>]</em>) – Optional TLS Options to be used
+for each connection, unless <cite>tls_mode</cite> is <a class="reference internal" href="#awscrt.s3.S3RequestTlsMode.DISABLED" title="awscrt.s3.S3RequestTlsMode.DISABLED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">S3RequestTlsMode.DISABLED</span></code></a></p></li>
+<li><p><strong>part_size</strong> (<em>Optional</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a><em>]</em>) – Size, in bytes, of parts that files will be downloaded or uploaded in.
+Note: for <a class="reference internal" href="#awscrt.s3.S3RequestType.PUT_OBJECT" title="awscrt.s3.S3RequestType.PUT_OBJECT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">S3RequestType.PUT_OBJECT</span></code></a> request, client will adjust the part size to meet the service limits.
+(max number of parts per upload is 10,000, minimum upload part size is 5 MiB)</p></li>
+<li><p><strong>multipart_upload_threshold</strong> (<em>Optional</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a><em>]</em>) – The size threshold in bytes, for when to use multipart uploads.
+This only affects <a class="reference internal" href="#awscrt.s3.S3RequestType.PUT_OBJECT" title="awscrt.s3.S3RequestType.PUT_OBJECT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">S3RequestType.PUT_OBJECT</span></code></a> request.
+Uploads over this size will use the multipart upload strategy.
+Uploads this size or less will use a single request.
+If not set, maximal of <cite>part_size</cite> and 5 MiB will be used.</p></li>
+<li><p><strong>throughput_target_gbps</strong> (<em>Optional</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)"><em>float</em></a><em>]</em>) – Throughput target in
+Gigabits per second (Gbps) that we are trying to reach.
+You can also use <cite>get_recommended_throughput_target_gbps()</cite> to get recommended value for your system.
+10.0 Gbps by default (may change in future)</p></li>
+<li><p><strong>enable_s3express</strong> (<em>Optional</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a><em>]</em>) – To enable S3 Express support for the client.
+The typical usage for a S3 Express request is to set this to true and let the request to be
+signed with <cite>AwsSigningAlgorithm.V4_S3EXPRESS</cite>, either from the client-level <cite>signing_config</cite>
+or the request-level override.</p></li>
+<li><p><strong>memory_limit</strong> (<em>Optional</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a><em>]</em>) – Memory limit, in bytes, of how much memory
+client can use for buffering data for requests.
+Default values scale with target throughput and are currently
+between 2GiB and 8GiB (may change in future)</p></li>
+</ul>
+</dd>
+</dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.s3.S3Client.make_request">
+<span class="sig-name descname"><span class="pre">make_request</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">request</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">operation_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">recv_filepath</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">send_filepath</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">signing_config</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">credential_provider</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">checksum_config</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">part_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">multipart_upload_threshold</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">on_headers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">on_body</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">on_done</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">on_progress</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.s3.S3Client.make_request" title="Link to this definition">¶</a></dt>
+<dd><p>Create the Request to the the S3 server,
+<a class="reference internal" href="#awscrt.s3.S3RequestType.GET_OBJECT" title="awscrt.s3.S3RequestType.GET_OBJECT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">GET_OBJECT</span></code></a>/<a class="reference internal" href="#awscrt.s3.S3RequestType.PUT_OBJECT" title="awscrt.s3.S3RequestType.PUT_OBJECT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">PUT_OBJECT</span></code></a> requests are split it into multi-part
+requests under the hood for acceleration.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Keyword Arguments<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>type</strong> (<a class="reference internal" href="#awscrt.s3.S3RequestType" title="awscrt.s3.S3RequestType"><em>S3RequestType</em></a>) – The type of S3 request passed in,
+<a class="reference internal" href="#awscrt.s3.S3RequestType.GET_OBJECT" title="awscrt.s3.S3RequestType.GET_OBJECT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">GET_OBJECT</span></code></a>/<a class="reference internal" href="#awscrt.s3.S3RequestType.PUT_OBJECT" title="awscrt.s3.S3RequestType.PUT_OBJECT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">PUT_OBJECT</span></code></a> can be accelerated</p></li>
+<li><p><strong>request</strong> (<a class="reference internal" href="http.html#awscrt.http.HttpRequest" title="awscrt.http.HttpRequest"><em>HttpRequest</em></a>) – The overall outgoing API request for S3 operation.
+If the request body is a file, set send_filepath for better performance.</p></li>
+<li><p><strong>operation_name</strong> (<em>Optional</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>]</em>) – Optional S3 operation name (e.g. “CreateBucket”).
+This will only be used when <cite>type</cite> is <a class="reference internal" href="#awscrt.s3.S3RequestType.DEFAULT" title="awscrt.s3.S3RequestType.DEFAULT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">DEFAULT</span></code></a>;
+it is automatically populated for other types.
+This name is used to fill out details in metrics and error reports.</p></li>
+<li><p><strong>recv_filepath</strong> (<em>Optional</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>]</em>) – Optional file path. If set, the
+response body is written directly to a file and the
+<cite>on_body</cite> callback is not invoked. This should give better
+performance than writing to file from the <cite>on_body</cite> callback.</p></li>
+<li><p><strong>send_filepath</strong> (<em>Optional</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>]</em>) – Optional file path. If set, the
+request body is read directly from a file and the
+request’s <cite>body_stream</cite> is ignored. This should give better
+performance than reading a file from a stream.</p></li>
+<li><p><strong>signing_config</strong> (<em>Optional</em><em>[</em><a class="reference internal" href="auth.html#awscrt.auth.AwsSigningConfig" title="awscrt.auth.AwsSigningConfig"><em>AwsSigningConfig</em></a><em>]</em>) – <p>Configuration for signing of the request to override the configuration from client.
+Use <a class="reference internal" href="#awscrt.s3.create_default_s3_signing_config" title="awscrt.s3.create_default_s3_signing_config"><code class="xref py py-func docutils literal notranslate"><span class="pre">create_default_s3_signing_config()</span></code></a> to create the default config.</p>
+<p>If None is provided, the client configuration will be used.</p>
+<dl class="simple">
+<dt>If set:</dt><dd><p>All fields are optional. The credentials will be resolve from client if not set.
+S3 Client will derive the right config for signing process based on this.</p>
+</dd>
+</dl>
+<p class="rubric">Notes</p>
+<ol class="arabic simple">
+<li><dl class="simple">
+<dt>For SIGV4_S3EXPRESS, S3 client will use the credentials in the config to derive the S3 Express</dt><dd><p>credentials that are used in the signing process.</p>
+</dd>
+</dl>
+</li>
+<li><p>Client may make modifications to signing config before passing it on to signer.</p></li>
+</ol>
+</p></li>
+<li><p><strong>credential_provider</strong> (<em>Optional</em><em>[</em><a class="reference internal" href="auth.html#awscrt.auth.AwsCredentialsProvider" title="awscrt.auth.AwsCredentialsProvider"><em>AwsCredentialsProvider</em></a><em>]</em>) – Deprecated, prefer <cite>signing_config</cite> instead.
+Credentials providers source the <a class="reference internal" href="auth.html#awscrt.auth.AwsCredentials" title="awscrt.auth.AwsCredentials"><code class="xref py py-class docutils literal notranslate"><span class="pre">AwsCredentials</span></code></a> needed to sign an authenticated AWS request, for this request only.
+If None is provided, the client configuration will be used.</p></li>
+<li><p><strong>checksum_config</strong> (<em>Optional</em><em>[</em><a class="reference internal" href="#awscrt.s3.S3ChecksumConfig" title="awscrt.s3.S3ChecksumConfig"><em>S3ChecksumConfig</em></a><em>]</em>) – Optional checksum settings.</p></li>
+<li><p><strong>part_size</strong> (<em>Optional</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a><em>]</em>) – Size, in bytes, of parts that files will be downloaded or uploaded in.
+If not set, the part size configured for the client will be used.
+Note: for <a class="reference internal" href="#awscrt.s3.S3RequestType.PUT_OBJECT" title="awscrt.s3.S3RequestType.PUT_OBJECT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">S3RequestType.PUT_OBJECT</span></code></a> request, client will adjust the part size to meet the service limits.
+(max number of parts per upload is 10,000, minimum upload part size is 5 MiB)</p></li>
+<li><p><strong>multipart_upload_threshold</strong> (<em>Optional</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a><em>]</em>) – The size threshold in bytes, for when to use multipart uploads.
+This only affects <a class="reference internal" href="#awscrt.s3.S3RequestType.PUT_OBJECT" title="awscrt.s3.S3RequestType.PUT_OBJECT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">S3RequestType.PUT_OBJECT</span></code></a> request.
+Uploads over this size will use the multipart upload strategy.
+Uploads this size or less will use a single request.
+If set, this should be at least <cite>part_size</cite>.
+If not set, <cite>part_size</cite> adjusted by client will be used as the threshold.
+If both <cite>part_size</cite> and <cite>multipart_upload_threshold</cite> are not set,
+the values from <cite>aws_s3_client_config</cite> are used.</p></li>
+<li><p><strong>on_headers</strong> – <p>Optional callback invoked as the response received, and even the API request
+has been split into multiple parts, this callback will only be invoked once as
+it’s just making one API request to S3.
+The function should take the following arguments and return nothing:</p>
+<blockquote>
+<div><ul>
+<li><p><cite>status_code</cite> (int): Response status code.</p></li>
+<li><p><cite>headers</cite> (List[Tuple[str, str]]): Response headers as a
+list of (name,value) pairs.</p></li>
+<li><p><cite>**kwargs</cite> (dict): Forward-compatibility kwargs.</p></li>
+</ul>
+</div></blockquote>
+</p></li>
+<li><p><strong>on_body</strong> – <p>Optional callback invoked 0+ times as the response body received from S3 server.
+If simply writing to a file, use <cite>recv_filepath</cite> instead of <cite>on_body</cite> for better performance.
+The function should take the following arguments and return nothing:</p>
+<blockquote>
+<div><ul>
+<li><p><cite>chunk</cite> (buffer): Response body data (not necessarily
+a whole “chunk” of chunked encoding).</p></li>
+<li><p><cite>offset</cite> (int): The offset of the chunk started in the whole body.</p></li>
+<li><p><cite>**kwargs</cite> (dict): Forward-compatibility kwargs.</p></li>
+</ul>
+</div></blockquote>
+</p></li>
+<li><p><strong>on_done</strong> – <p>Optional callback invoked when the request has finished the job.
+The function should take the following arguments and return nothing:</p>
+<blockquote>
+<div><ul>
+<li><p><cite>error</cite> (Optional[Exception]): None if the request was
+successfully sent and valid response received, or an Exception
+if it failed.</p></li>
+<li><p><cite>error_headers</cite> (Optional[List[Tuple[str, str]]]): If request
+failed because server side sent an unsuccessful response, the headers
+of the response is provided here. Else None will be returned.</p></li>
+<li><p><cite>error_body</cite> (Optional[bytes]): If request failed because server
+side sent an unsuccessful response, the body of the response is
+provided here. Else None will be returned.</p></li>
+<li><p><cite>error_operation_name</cite> (Optional[str]): If request failed
+because server side sent and unsuccessful response, this
+is the name of the S3 operation it was responding to.
+For example, if a <a class="reference internal" href="#awscrt.s3.S3RequestType.PUT_OBJECT" title="awscrt.s3.S3RequestType.PUT_OBJECT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">PUT_OBJECT</span></code></a> fails
+this could be “PutObject”, “CreateMultipartUpload”, “UploadPart”,
+“CompleteMultipartUpload”, or others. For <a class="reference internal" href="#awscrt.s3.S3RequestType.DEFAULT" title="awscrt.s3.S3RequestType.DEFAULT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">DEFAULT</span></code></a>,
+this is the <cite>operation_name</cite> passed to <a class="reference internal" href="#awscrt.s3.S3Client.make_request" title="awscrt.s3.S3Client.make_request"><code class="xref py py-meth docutils literal notranslate"><span class="pre">S3Client.make_request()</span></code></a>.
+This will be None if the request failed for another reason,
+or the S3 operation name is unknown.</p></li>
+<li><p><cite>status_code</cite> (Optional[int]): HTTP response status code (if available).
+If request failed because server side sent an unsuccessful response,
+this is its status code. If the operation was successful,
+this is the final response’s status code. If the operation
+failed for another reason, None is returned.</p></li>
+<li><dl class="simple">
+<dt><cite>did_validate_checksum</cite> (bool):</dt><dd><p>Was the server side checksum compared against a calculated checksum of the response body.
+This may be false even if <a class="reference internal" href="#awscrt.s3.S3ChecksumConfig.validate_response" title="awscrt.s3.S3ChecksumConfig.validate_response"><code class="xref py py-attr docutils literal notranslate"><span class="pre">S3ChecksumConfig.validate_response</span></code></a> was set because
+the object was uploaded without a checksum, or downloaded differently from how it’s uploaded.</p>
+</dd>
+</dl>
+</li>
+<li><p><cite>checksum_validation_algorithm</cite> (Optional[S3ChecksumAlgorithm]): The checksum algorithm used to validate the response.</p></li>
+<li><p><cite>**kwargs</cite> (dict): Forward-compatibility kwargs.</p></li>
+</ul>
+</div></blockquote>
+</p></li>
+<li><p><strong>on_progress</strong> – <p>Optional callback invoked when part of the transfer is done to report the progress.
+The function should take the following arguments and return nothing:</p>
+<blockquote>
+<div><ul>
+<li><p><cite>progress</cite> (int): Number of bytes of data that just get transferred</p></li>
+<li><p><cite>**kwargs</cite> (dict): Forward-compatibility kwargs.</p></li>
+</ul>
+</div></blockquote>
+</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>S3Request</p>
+</dd>
+</dl>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.s3.S3Request">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.s3.</span></span><span class="sig-name descname"><span class="pre">S3Request</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">request</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">operation_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">recv_filepath</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">send_filepath</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">signing_config</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">credential_provider</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">checksum_config</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">part_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">multipart_upload_threshold</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">on_headers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">on_body</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">on_done</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">on_progress</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">region</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.s3.S3Request" title="Link to this definition">¶</a></dt>
+<dd><p>S3 request
+Create a new S3Request with <a class="reference internal" href="#awscrt.s3.S3Client.make_request" title="awscrt.s3.S3Client.make_request"><code class="xref py py-meth docutils literal notranslate"><span class="pre">S3Client.make_request()</span></code></a></p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.s3.S3Request.finished_future">
+<span class="sig-name descname"><span class="pre">finished_future</span></span><a class="headerlink" href="#awscrt.s3.S3Request.finished_future" title="Link to this definition">¶</a></dt>
+<dd><p>Future that will
+resolve when the s3 request has finished successfully.
+If the error happens, the Future will contain an exception
+indicating why it failed. Note: Future will set before on_done invoked</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.Future" title="(in Python v3.12)">concurrent.futures.Future</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.s3.S3Request.shutdown_event">
+<span class="sig-name descname"><span class="pre">shutdown_event</span></span><a class="headerlink" href="#awscrt.s3.S3Request.shutdown_event" title="Link to this definition">¶</a></dt>
+<dd><p>Signals when underlying threads and
+structures have all finished shutting down. Shutdown begins when the
+S3Request object is destroyed.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/threading.html#threading.Event" title="(in Python v3.12)">threading.Event</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py exception">
+<dt class="sig sig-object py" id="awscrt.s3.S3ResponseError">
+<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.s3.</span></span><span class="sig-name descname"><span class="pre">S3ResponseError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">code</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">status_code</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.12)"><span class="pre">List</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Tuple" title="(in Python v3.12)"><span class="pre">Tuple</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">headers</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.12)"><span class="pre">List</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Tuple" title="(in Python v3.12)"><span class="pre">Tuple</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">body</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.12)"><span class="pre">bytes</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">operation_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.s3.S3ResponseError" title="Link to this definition">¶</a></dt>
+<dd><p>An error response from S3.</p>
+<p>Subclasses <a class="reference internal" href="exceptions.html#awscrt.exceptions.AwsCrtError" title="awscrt.exceptions.AwsCrtError"><code class="xref py py-class docutils literal notranslate"><span class="pre">awscrt.exceptions.AwsCrtError</span></code></a>.</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.s3.S3ResponseError.status_code">
+<span class="sig-name descname"><span class="pre">status_code</span></span><a class="headerlink" href="#awscrt.s3.S3ResponseError.status_code" title="Link to this definition">¶</a></dt>
+<dd><p>HTTP response status code.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)">int</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.s3.S3ResponseError.headers">
+<span class="sig-name descname"><span class="pre">headers</span></span><a class="headerlink" href="#awscrt.s3.S3ResponseError.headers" title="Link to this definition">¶</a></dt>
+<dd><p>Headers from HTTP response.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)">list</a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.12)">tuple</a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a>, <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a>]]</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.s3.S3ResponseError.body">
+<span class="sig-name descname"><span class="pre">body</span></span><a class="headerlink" href="#awscrt.s3.S3ResponseError.body" title="Link to this definition">¶</a></dt>
+<dd><p>Body of HTTP response (if any).
+This is usually XML. It may be None in the case of a HEAD response.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>Optional[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.12)">bytes</a>]</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.s3.S3ResponseError.operation_name">
+<span class="sig-name descname"><span class="pre">operation_name</span></span><a class="headerlink" href="#awscrt.s3.S3ResponseError.operation_name" title="Link to this definition">¶</a></dt>
+<dd><p>Name of the S3 operation that failed (if known).
+For example, if a <a class="reference internal" href="#awscrt.s3.S3RequestType.PUT_OBJECT" title="awscrt.s3.S3RequestType.PUT_OBJECT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">PUT_OBJECT</span></code></a> fails
+this could be “PutObject”, “CreateMultipartUpload”, “UploadPart”,
+“CompleteMultipartUpload”, or others. For <a class="reference internal" href="#awscrt.s3.S3RequestType.DEFAULT" title="awscrt.s3.S3RequestType.DEFAULT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">DEFAULT</span></code></a>,
+this is the <cite>operation_name</cite> passed to <a class="reference internal" href="#awscrt.s3.S3Client.make_request" title="awscrt.s3.S3Client.make_request"><code class="xref py py-meth docutils literal notranslate"><span class="pre">S3Client.make_request()</span></code></a>.
+If the S3 operation name is unknown, this will be None.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>Optional[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a>]</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.s3.S3ResponseError.code">
+<span class="sig-name descname"><span class="pre">code</span></span><a class="headerlink" href="#awscrt.s3.S3ResponseError.code" title="Link to this definition">¶</a></dt>
+<dd><p>CRT error code.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)">int</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.s3.S3ResponseError.name">
+<span class="sig-name descname"><span class="pre">name</span></span><a class="headerlink" href="#awscrt.s3.S3ResponseError.name" title="Link to this definition">¶</a></dt>
+<dd><p>CRT error name.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.s3.S3ResponseError.message">
+<span class="sig-name descname"><span class="pre">message</span></span><a class="headerlink" href="#awscrt.s3.S3ResponseError.message" title="Link to this definition">¶</a></dt>
+<dd><p>CRT error message.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="awscrt.s3.create_default_s3_signing_config">
+<span class="sig-prename descclassname"><span class="pre">awscrt.s3.</span></span><span class="sig-name descname"><span class="pre">create_default_s3_signing_config</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">region</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">credential_provider</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="auth.html#awscrt.auth.AwsCredentialsProvider" title="awscrt.auth.AwsCredentialsProvider"><span class="pre">AwsCredentialsProvider</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.s3.create_default_s3_signing_config" title="Link to this definition">¶</a></dt>
+<dd><p>Create a default <cite>AwsSigningConfig</cite> for S3 service.</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.s3.region">
+<span class="sig-prename descclassname"><span class="pre">awscrt.s3.</span></span><span class="sig-name descname"><span class="pre">region</span></span><a class="headerlink" href="#awscrt.s3.region" title="Link to this definition">¶</a></dt>
+<dd><p>The region to sign against.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.s3.credential_provider">
+<span class="sig-prename descclassname"><span class="pre">awscrt.s3.</span></span><span class="sig-name descname"><span class="pre">credential_provider</span></span><a class="headerlink" href="#awscrt.s3.credential_provider" title="Link to this definition">¶</a></dt>
+<dd><p>Credentials provider
+to fetch signing credentials with.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference internal" href="auth.html#awscrt.auth.AwsCredentialsProvider" title="awscrt.auth.AwsCredentialsProvider">AwsCredentialsProvider</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py">
+<span class="sig-name descname"><span class="pre">`**kwargs`</span></span></dt>
+<dd><p>Forward compatibility kwargs.</p>
+</dd></dl>
+
+<dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p>AwsSigningConfig</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="awscrt.s3.get_ec2_instance_type">
+<span class="sig-prename descclassname"><span class="pre">awscrt.s3.</span></span><span class="sig-name descname"><span class="pre">get_ec2_instance_type</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.s3.get_ec2_instance_type" title="Link to this definition">¶</a></dt>
+<dd><p>First this function will check it’s running on EC2 via. attempting to read DMI info to avoid making IMDS calls.</p>
+<p>If the function detects it’s on EC2, and it was able to detect the instance type without a call to IMDS
+it will return it.</p>
+<p>Finally, it will call IMDS and return the instance type from there.
+Note that in the case of the IMDS call, a new client stack is spun up using 1 background thread. The call is made
+synchronously with a 1 second timeout: It’s not cheap. To make this easier, the underlying result is cached
+internally and will be freed when this module is unloaded is called.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p>A string indicating the instance type or None if it could not be determined.</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="awscrt.s3.is_optimized_for_system">
+<span class="sig-prename descclassname"><span class="pre">awscrt.s3.</span></span><span class="sig-name descname"><span class="pre">is_optimized_for_system</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.s3.is_optimized_for_system" title="Link to this definition">¶</a></dt>
+<dd><dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p>true if the current build of this module has an optimized configuration
+for the current system.</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="awscrt.s3.get_optimized_platforms">
+<span class="sig-prename descclassname"><span class="pre">awscrt.s3.</span></span><span class="sig-name descname"><span class="pre">get_optimized_platforms</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.s3.get_optimized_platforms" title="Link to this definition">¶</a></dt>
+<dd><dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p>A list[str] of platform identifiers, such as EC2 instance types, for which S3 client is pre-optimized
+and have a recommended throughput_target_gbps. You can use <cite>get_recommended_throughput_target_gbps()</cite>
+to obtain the recommended throughput_target_gbps for those platforms.</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="awscrt.s3.get_recommended_throughput_target_gbps">
+<span class="sig-prename descclassname"><span class="pre">awscrt.s3.</span></span><span class="sig-name descname"><span class="pre">get_recommended_throughput_target_gbps</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)"><span class="pre">float</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#awscrt.s3.get_recommended_throughput_target_gbps" title="Link to this definition">¶</a></dt>
+<dd><dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p>Recommended throughput, in gigabits per second, based on detected system configuration.
+If the best throughput configuration is unknown, returns None.
+Use this as the S3Client’s <cite>throughput_target_gbps</cite>.</p>
+</dd>
+</dl>
+</dd></dl>
+
+</section>
+
+
+            <div class="clearer"></div>
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+  <div>
+    <h3><a href="../index.html">Table of Contents</a></h3>
+    <ul>
+<li><a class="reference internal" href="#">awscrt.s3</a><ul>
+<li><a class="reference internal" href="#awscrt.s3.CrossProcessLock"><code class="docutils literal notranslate"><span class="pre">CrossProcessLock</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.s3.S3RequestType"><code class="docutils literal notranslate"><span class="pre">S3RequestType</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.s3.S3RequestType.DEFAULT"><code class="docutils literal notranslate"><span class="pre">DEFAULT</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.s3.S3RequestType.GET_OBJECT"><code class="docutils literal notranslate"><span class="pre">GET_OBJECT</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.s3.S3RequestType.PUT_OBJECT"><code class="docutils literal notranslate"><span class="pre">PUT_OBJECT</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.s3.S3RequestTlsMode"><code class="docutils literal notranslate"><span class="pre">S3RequestTlsMode</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.s3.S3RequestTlsMode.ENABLED"><code class="docutils literal notranslate"><span class="pre">ENABLED</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.s3.S3RequestTlsMode.DISABLED"><code class="docutils literal notranslate"><span class="pre">DISABLED</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.s3.S3ChecksumAlgorithm"><code class="docutils literal notranslate"><span class="pre">S3ChecksumAlgorithm</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.s3.S3ChecksumAlgorithm.CRC32C"><code class="docutils literal notranslate"><span class="pre">CRC32C</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.s3.S3ChecksumAlgorithm.CRC32"><code class="docutils literal notranslate"><span class="pre">CRC32</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.s3.S3ChecksumAlgorithm.SHA1"><code class="docutils literal notranslate"><span class="pre">SHA1</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.s3.S3ChecksumAlgorithm.SHA256"><code class="docutils literal notranslate"><span class="pre">SHA256</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.s3.S3ChecksumLocation"><code class="docutils literal notranslate"><span class="pre">S3ChecksumLocation</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.s3.S3ChecksumLocation.HEADER"><code class="docutils literal notranslate"><span class="pre">HEADER</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.s3.S3ChecksumLocation.TRAILER"><code class="docutils literal notranslate"><span class="pre">TRAILER</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.s3.S3ChecksumConfig"><code class="docutils literal notranslate"><span class="pre">S3ChecksumConfig</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.s3.S3ChecksumConfig.algorithm"><code class="docutils literal notranslate"><span class="pre">algorithm</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.s3.S3ChecksumConfig.location"><code class="docutils literal notranslate"><span class="pre">location</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.s3.S3ChecksumConfig.validate_response"><code class="docutils literal notranslate"><span class="pre">validate_response</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.s3.S3Client"><code class="docutils literal notranslate"><span class="pre">S3Client</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.s3.S3Client.make_request"><code class="docutils literal notranslate"><span class="pre">make_request()</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.s3.S3Request"><code class="docutils literal notranslate"><span class="pre">S3Request</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.s3.S3Request.finished_future"><code class="docutils literal notranslate"><span class="pre">finished_future</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.s3.S3Request.shutdown_event"><code class="docutils literal notranslate"><span class="pre">shutdown_event</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.s3.S3ResponseError"><code class="docutils literal notranslate"><span class="pre">S3ResponseError</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.s3.S3ResponseError.status_code"><code class="docutils literal notranslate"><span class="pre">status_code</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.s3.S3ResponseError.headers"><code class="docutils literal notranslate"><span class="pre">headers</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.s3.S3ResponseError.body"><code class="docutils literal notranslate"><span class="pre">body</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.s3.S3ResponseError.operation_name"><code class="docutils literal notranslate"><span class="pre">operation_name</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.s3.S3ResponseError.code"><code class="docutils literal notranslate"><span class="pre">code</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.s3.S3ResponseError.name"><code class="docutils literal notranslate"><span class="pre">name</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.s3.S3ResponseError.message"><code class="docutils literal notranslate"><span class="pre">message</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.s3.create_default_s3_signing_config"><code class="docutils literal notranslate"><span class="pre">create_default_s3_signing_config()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.s3.region"><code class="docutils literal notranslate"><span class="pre">region</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.s3.credential_provider"><code class="docutils literal notranslate"><span class="pre">credential_provider</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.s3.get_ec2_instance_type"><code class="docutils literal notranslate"><span class="pre">get_ec2_instance_type()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.s3.is_optimized_for_system"><code class="docutils literal notranslate"><span class="pre">is_optimized_for_system()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.s3.get_optimized_platforms"><code class="docutils literal notranslate"><span class="pre">get_optimized_platforms()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.s3.get_recommended_throughput_target_gbps"><code class="docutils literal notranslate"><span class="pre">get_recommended_throughput_target_gbps()</span></code></a></li>
+</ul>
+</li>
+</ul>
+
+  </div>
+  <div>
+    <h4>Previous topic</h4>
+    <p class="topless"><a href="mqtt5.html"
+                          title="previous chapter">awscrt.mqtt5</a></p>
+  </div>
+  <div>
+    <h4>Next topic</h4>
+    <p class="topless"><a href="websocket.html"
+                          title="next chapter">awscrt.websocket</a></p>
+  </div>
+  <div role="note" aria-label="source link">
+    <h3>This Page</h3>
+    <ul class="this-page-menu">
+      <li><a href="../_sources/api/s3.rst.txt"
+            rel="nofollow">Show Source</a></li>
+    </ul>
+   </div>
+<div id="searchbox" style="display: none" role="search">
+  <h3 id="searchlabel">Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="../search.html" method="get">
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+      <input type="submit" value="Go" />
+    </form>
+    </div>
+</div>
+<script>document.getElementById('searchbox').style.display = "block"</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../genindex.html" title="General Index"
+             >index</a></li>
+        <li class="right" >
+          <a href="../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="right" >
+          <a href="websocket.html" title="awscrt.websocket"
+             >next</a> |</li>
+        <li class="right" >
+          <a href="mqtt5.html" title="awscrt.mqtt5"
+             >previous</a> |</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">awscrt  documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">awscrt.s3</a></li> 
+      </ul>
+    </div>
+    <div class="footer" role="contentinfo">
+    &#169; Copyright 2020, Amazon Web Services, Inc.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
+    </div>
+  </body>
+</html>
\ No newline at end of file
diff --git a/docs/api/websocket.html b/docs/api/websocket.html
new file mode 100644
index 000000000..b900efd99
--- /dev/null
+++ b/docs/api/websocket.html
@@ -0,0 +1,690 @@
+
+
+<!doctype html>
+
+<html lang="en" data-content_root="../">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+
+    <title>awscrt.websocket &#8212; awscrt  documentation</title>
+    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=649a27d8" />
+    <link rel="stylesheet" type="text/css" href="../_static/css/custom.css?v=93be7416" />
+    
+    <script src="../_static/documentation_options.js?v=5929fcd5"></script>
+    <script src="../_static/doctools.js?v=888ff710"></script>
+    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script src="../_static/bizstyle.js"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" />
+    <link rel="prev" title="awscrt.s3" href="s3.html" />
+    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+    <!--[if lt IE 9]>
+    <script src="_static/css3-mediaqueries.js"></script>
+    <![endif]-->
+  </head><body>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../genindex.html" title="General Index"
+             accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="right" >
+          <a href="s3.html" title="awscrt.s3"
+             accesskey="P">previous</a> |</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">awscrt  documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">awscrt.websocket</a></li> 
+      </ul>
+    </div>  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body" role="main">
+            
+  <section id="module-awscrt.websocket">
+<span id="awscrt-websocket"></span><h1>awscrt.websocket<a class="headerlink" href="#module-awscrt.websocket" title="Link to this heading">¶</a></h1>
+<p>WebSocket - <a class="reference external" href="https://www.rfc-editor.org/rfc/rfc6455">RFC 6455</a></p>
+<p>Use the <a class="reference internal" href="#awscrt.websocket.connect" title="awscrt.websocket.connect"><code class="xref py py-func docutils literal notranslate"><span class="pre">connect()</span></code></a> to establish a <a class="reference internal" href="#awscrt.websocket.WebSocket" title="awscrt.websocket.WebSocket"><code class="xref py py-class docutils literal notranslate"><span class="pre">WebSocket</span></code></a> client connection.</p>
+<p>Note from the developer: This is a very low-level API, which forces the
+user to deal with things like data fragmentation.
+A higher-level API could easily be built on top of this.</p>
+<section id="authoring-callbacks">
+<span id="id1"></span><h2>Authoring Callbacks<a class="headerlink" href="#authoring-callbacks" title="Link to this heading">¶</a></h2>
+<p>All network operations in <cite>awscrt.websocket</cite> are asynchronous.
+Callbacks are always invoked on the WebSocket’s networking thread.
+You MUST NOT perform blocking network operations from any callback, or you will cause a deadlock.
+For example: do not send a frame, and then wait for that frame to complete,
+within a callback. The WebSocket cannot do work until your callback returns,
+so the thread will be stuck. You can send the frame from within the callback,
+just don’t wait for it to complete within the callback.</p>
+<p>If you want to do blocking waits, do it from a thread you control, like the main thread.
+It’s fine for the main thread to send a frame, and wait until it completes.</p>
+<p>All functions and methods in <cite>awscrt.websocket</cite> are thread-safe.
+They can be called from any mix of threads.</p>
+</section>
+<section id="flow-control-reading">
+<span id="id2"></span><h2>Flow Control (reading)<a class="headerlink" href="#flow-control-reading" title="Link to this heading">¶</a></h2>
+<p>By default, the WebSocket will read from the network as fast as it can hand you the data.
+You must prevent the WebSocket from reading data faster than you can process it,
+or memory usage could balloon until your application explodes.</p>
+<p>There are two ways to manage this.</p>
+<p>First, and simplest, is to process incoming data synchronously within the
+<cite>on_incoming_frame</cite> callbacks. Since callbacks are invoked on the WebSocket’s
+networking thread, the WebSocket cannot read more data until the callback returns.
+Therefore, processing the data in a synchronous manner
+(i.e. writing to disk, printing to screen, etc) will naturally
+affect <a class="reference external" href="https://en.wikipedia.org/wiki/Transmission_Control_Protocol#Flow_control">TCP flow control</a>,
+and prevent data from arriving too fast. However, you MUST NOT perform a blocking
+network operation from within the callback or you risk deadlock (see <a class="reference internal" href="#authoring-callbacks"><span class="std std-ref">Authoring Callbacks</span></a>).</p>
+<p>The second, more complex, way requires you to manage the size of the read window.
+Do this if you are processing the data asynchronously
+(i.e. sending the data along on another network connection).
+Create the WebSocket with <cite>manage_read_window</cite> set true,
+and set <cite>initial_read_window</cite> to the number of bytes you are ready to receive right away.
+Whenever the read window reaches 0, you will stop receiving anything.
+The read window shrinks as you receive the payload from “data” frames (TEXT, BINARY, CONTINUATION).
+Call <a class="reference internal" href="#awscrt.websocket.WebSocket.increment_read_window" title="awscrt.websocket.WebSocket.increment_read_window"><code class="xref py py-meth docutils literal notranslate"><span class="pre">WebSocket.increment_read_window()</span></code></a> to increase the window again keep frames flowing in.
+You only need to worry about the payload from “data” frames.
+The WebSocket automatically increments its window to account for any
+other incoming bytes, including other parts of a frame (opcode, payload-length, etc)
+and the payload of other frame types (PING, PONG, CLOSE).
+You’ll probably want to do it like this:
+Pick the max amount of memory to buffer, and set this as the <cite>initial_read_window</cite>.
+When data arrives, the window has shrunk by that amount.
+Send this data along on the other network connection.
+When that data is done sending, call <cite>increment_read_window()</cite>
+by the amount you just finished sending.
+If you don’t want to receive any data at first, set the <cite>initial_read_window</cite> to 0,
+and <cite>increment_read_window()</cite> when you’re ready.
+Maintaining a larger window is better for overall throughput.</p>
+</section>
+<section id="flow-control-writing">
+<span id="id3"></span><h2>Flow Control (writing)<a class="headerlink" href="#flow-control-writing" title="Link to this heading">¶</a></h2>
+<p>You must also ensure that you do not continually send frames faster than the other
+side can read them, or memory usage could balloon until your application explodes.</p>
+<p>The simplest approach is to only send 1 frame at a time.
+Use the <a class="reference internal" href="#awscrt.websocket.WebSocket.send_frame" title="awscrt.websocket.WebSocket.send_frame"><code class="xref py py-meth docutils literal notranslate"><span class="pre">WebSocket.send_frame()</span></code></a> <cite>on_complete</cite> callback to know when the send is complete.
+Then you can try and send another.</p>
+<p>A more complex, but higher throughput, way is to let multiple frames be in flight
+but have a cap. If the number of frames in flight, or bytes in flight, reaches
+your cap then wait until some frames complete before trying to send more.</p>
+</section>
+<section id="api">
+<span id="id4"></span><h2>API<a class="headerlink" href="#api" title="Link to this heading">¶</a></h2>
+</section>
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.websocket.Opcode">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.websocket.</span></span><span class="sig-name descname"><span class="pre">Opcode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.websocket.Opcode" title="Link to this definition">¶</a></dt>
+<dd><p>An opcode defines a frame’s type.</p>
+<p>RFC 6455 classifies TEXT and BINARY as <a class="reference external" href="https://www.rfc-editor.org/rfc/rfc6455#section-5.6">data frames</a>.
+A CONTINUATION frame “continues” the most recent data frame.
+All other opcodes are for <a class="reference external" href="https://www.rfc-editor.org/rfc/rfc6455#section-5.5">control frames</a>.</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.websocket.Opcode.CONTINUATION">
+<span class="sig-name descname"><span class="pre">CONTINUATION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#awscrt.websocket.Opcode.CONTINUATION" title="Link to this definition">¶</a></dt>
+<dd><p>Continues the most recent TEXT or BINARY data frame.</p>
+<p>See <a class="reference external" href="https://www.rfc-editor.org/rfc/rfc6455#section-5.4">RFC 6455 section 5.4 - Fragmentation</a>.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.websocket.Opcode.TEXT">
+<span class="sig-name descname"><span class="pre">TEXT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#awscrt.websocket.Opcode.TEXT" title="Link to this definition">¶</a></dt>
+<dd><p>The data frame for sending text.</p>
+<p>The payload must contain UTF-8.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.websocket.Opcode.BINARY">
+<span class="sig-name descname"><span class="pre">BINARY</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#awscrt.websocket.Opcode.BINARY" title="Link to this definition">¶</a></dt>
+<dd><p>The data frame for sending binary.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.websocket.Opcode.CLOSE">
+<span class="sig-name descname"><span class="pre">CLOSE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">8</span></em><a class="headerlink" href="#awscrt.websocket.Opcode.CLOSE" title="Link to this definition">¶</a></dt>
+<dd><p>The control frame which is the final frame sent by an endpoint.</p>
+<p>The CLOSE frame may include a payload, but its format is very particular.
+See <a class="reference external" href="https://www.rfc-editor.org/rfc/rfc6455#section-5.5.1">RFC 6455 section 5.5.1</a>.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.websocket.Opcode.PING">
+<span class="sig-name descname"><span class="pre">PING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">9</span></em><a class="headerlink" href="#awscrt.websocket.Opcode.PING" title="Link to this definition">¶</a></dt>
+<dd><p>A control frame that may serve as either a keepalive or as a means to verify
+that the remote endpoint is still responsive.</p>
+<p>DO NOT manually send a PONG frame in response to a PING,
+the implementation does this automatically.</p>
+<p>A PING frame may include a payload.
+See <a class="reference external" href="https://www.rfc-editor.org/rfc/rfc6455#section-5.5.2">RFC 6455 section 5.5.2</a>.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.websocket.Opcode.PONG">
+<span class="sig-name descname"><span class="pre">PONG</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">10</span></em><a class="headerlink" href="#awscrt.websocket.Opcode.PONG" title="Link to this definition">¶</a></dt>
+<dd><p>The control frame that is the response to a PING frame.</p>
+<p>DO NOT manually send a PONG frame in response to a PING,
+the implementation does this automatically.</p>
+<p>See <a class="reference external" href="https://www.rfc-editor.org/rfc/rfc6455#section-5.5.3">RFC 6455 section 5.5.3</a>.</p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.websocket.Opcode.is_data_frame">
+<span class="sig-name descname"><span class="pre">is_data_frame</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.websocket.Opcode.is_data_frame" title="Link to this definition">¶</a></dt>
+<dd><p>True if this is a “data frame” opcode.</p>
+<p>TEXT, BINARY, and CONTINUATION are “data frames”. The rest are “control” frames.</p>
+<p>If the WebSocket was created with <cite>manage_read_window</cite>,
+then the read window shrinks as “data frames” are received.
+See <a class="reference internal" href="#flow-control-reading"><span class="std std-ref">Flow Control (reading)</span></a> for a thorough explanation.</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py data">
+<dt class="sig sig-object py" id="awscrt.websocket.MAX_PAYLOAD_LENGTH">
+<span class="sig-prename descclassname"><span class="pre">awscrt.websocket.</span></span><span class="sig-name descname"><span class="pre">MAX_PAYLOAD_LENGTH</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">9223372036854775807</span></em><a class="headerlink" href="#awscrt.websocket.MAX_PAYLOAD_LENGTH" title="Link to this definition">¶</a></dt>
+<dd><p>The maximum frame payload length allowed by RFC 6455</p>
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.websocket.OnConnectionSetupData">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.websocket.</span></span><span class="sig-name descname"><span class="pre">OnConnectionSetupData</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">exception</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.12)"><span class="pre">Exception</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">websocket</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.websocket.WebSocket" title="awscrt.websocket.WebSocket"><span class="pre">WebSocket</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">handshake_response_status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">handshake_response_headers</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.12)"><span class="pre">Sequence</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Tuple" title="(in Python v3.12)"><span class="pre">Tuple</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">handshake_response_body</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.12)"><span class="pre">bytes</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.websocket.OnConnectionSetupData" title="Link to this definition">¶</a></dt>
+<dd><p>Data passed to the <cite>on_connection_setup</cite> callback</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.websocket.OnConnectionSetupData.exception">
+<span class="sig-name descname"><span class="pre">exception</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.12)"><span class="pre">Exception</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#awscrt.websocket.OnConnectionSetupData.exception" title="Link to this definition">¶</a></dt>
+<dd><p>If the connection failed, this exception explains why.</p>
+<p>This is None if the connection succeeded.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.websocket.OnConnectionSetupData.websocket">
+<span class="sig-name descname"><span class="pre">websocket</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#awscrt.websocket.WebSocket" title="awscrt.websocket.WebSocket"><span class="pre">WebSocket</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#awscrt.websocket.OnConnectionSetupData.websocket" title="Link to this definition">¶</a></dt>
+<dd><p>If the connection succeeded, here’s the WebSocket.</p>
+<p>You should store this WebSocket somewhere
+(the connection will shut down if the class is garbage collected).</p>
+<p>This is None if the connection failed.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.websocket.OnConnectionSetupData.handshake_response_status">
+<span class="sig-name descname"><span class="pre">handshake_response_status</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#awscrt.websocket.OnConnectionSetupData.handshake_response_status" title="Link to this definition">¶</a></dt>
+<dd><p>The HTTP response status-code, if you’re interested.</p>
+<p>This is present if an HTTP response was received, regardless of whether
+the handshake was accepted or rejected. This always has the value 101
+for successful connections.</p>
+<p>This is None if the connection failed before receiving an HTTP response.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.websocket.OnConnectionSetupData.handshake_response_headers">
+<span class="sig-name descname"><span class="pre">handshake_response_headers</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.12)"><span class="pre">Sequence</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Tuple" title="(in Python v3.12)"><span class="pre">Tuple</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#awscrt.websocket.OnConnectionSetupData.handshake_response_headers" title="Link to this definition">¶</a></dt>
+<dd><p>The HTTP response headers, if you’re interested.</p>
+<p>These are present if an HTTP response was received, regardless of whether
+the handshake was accepted or rejected.</p>
+<p>This is None if the connection failed before receiving an HTTP response.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.websocket.OnConnectionSetupData.handshake_response_body">
+<span class="sig-name descname"><span class="pre">handshake_response_body</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.12)"><span class="pre">bytes</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#awscrt.websocket.OnConnectionSetupData.handshake_response_body" title="Link to this definition">¶</a></dt>
+<dd><p>The HTTP response body, if you’re interested.</p>
+<p>This is only present if the server sent a full HTTP response rejecting the handshake.
+It is not present if the connection succeeded,
+or the connection failed for other reasons.</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.websocket.OnConnectionShutdownData">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.websocket.</span></span><span class="sig-name descname"><span class="pre">OnConnectionShutdownData</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">exception</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.12)"><span class="pre">Exception</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.websocket.OnConnectionShutdownData" title="Link to this definition">¶</a></dt>
+<dd><p>Data passed to the <cite>on_connection_shutdown</cite> callback</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.websocket.OnConnectionShutdownData.exception">
+<span class="sig-name descname"><span class="pre">exception</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.12)"><span class="pre">Exception</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#awscrt.websocket.OnConnectionShutdownData.exception" title="Link to this definition">¶</a></dt>
+<dd><p>If the connection shut down cleanly, this is None.</p>
+<p>If the connection shut down due to error, or an error occurs while
+shutting down, this exception explains why.</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.websocket.IncomingFrame">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.websocket.</span></span><span class="sig-name descname"><span class="pre">IncomingFrame</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">opcode</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.websocket.Opcode" title="awscrt.websocket.Opcode"><span class="pre">Opcode</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">payload_length</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">fin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.websocket.IncomingFrame" title="Link to this definition">¶</a></dt>
+<dd><p>Describes the frame you are receiving.</p>
+<p>Used in <cite>on_incoming_frame</cite> callbacks</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.websocket.IncomingFrame.opcode">
+<span class="sig-name descname"><span class="pre">opcode</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#awscrt.websocket.Opcode" title="awscrt.websocket.Opcode"><span class="pre">Opcode</span></a></em><a class="headerlink" href="#awscrt.websocket.IncomingFrame.opcode" title="Link to this definition">¶</a></dt>
+<dd><p>This frame’s opcode.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.websocket.IncomingFrame.payload_length">
+<span class="sig-name descname"><span class="pre">payload_length</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></em><a class="headerlink" href="#awscrt.websocket.IncomingFrame.payload_length" title="Link to this definition">¶</a></dt>
+<dd><p>This frame’s payload length (in bytes).</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.websocket.IncomingFrame.fin">
+<span class="sig-name descname"><span class="pre">fin</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a></em><a class="headerlink" href="#awscrt.websocket.IncomingFrame.fin" title="Link to this definition">¶</a></dt>
+<dd><p>The FIN bit indicates whether this is the final fragment in a message.</p>
+<p>See <a class="reference external" href="https://www.rfc-editor.org/rfc/rfc6455#section-5.4">RFC 6455 section 5.4 - Fragmentation</a></p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.websocket.IncomingFrame.is_data_frame">
+<span class="sig-name descname"><span class="pre">is_data_frame</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.websocket.IncomingFrame.is_data_frame" title="Link to this definition">¶</a></dt>
+<dd><p>True if this is a “data frame”.</p>
+<p>TEXT, BINARY, and CONTINUATION are “data frames”. The rest are “control frames”.</p>
+<p>If the WebSocket was created with <cite>manage_read_window</cite>,
+then the read window shrinks as “data frames” are received.
+See <a class="reference internal" href="#flow-control-reading"><span class="std std-ref">Flow Control (reading)</span></a> for a thorough explanation.</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.websocket.OnIncomingFrameBeginData">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.websocket.</span></span><span class="sig-name descname"><span class="pre">OnIncomingFrameBeginData</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">frame</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.websocket.IncomingFrame" title="awscrt.websocket.IncomingFrame"><span class="pre">IncomingFrame</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.websocket.OnIncomingFrameBeginData" title="Link to this definition">¶</a></dt>
+<dd><p>Data passed to the <cite>on_incoming_frame_begin</cite> callback.</p>
+<p>Each <cite>on_incoming_frame_begin</cite> call will be followed by
+0+ <cite>on_incoming_frame_payload</cite> calls,
+followed by one <cite>on_incoming_frame_complete</cite> call.</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.websocket.OnIncomingFrameBeginData.frame">
+<span class="sig-name descname"><span class="pre">frame</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#awscrt.websocket.IncomingFrame" title="awscrt.websocket.IncomingFrame"><span class="pre">IncomingFrame</span></a></em><a class="headerlink" href="#awscrt.websocket.OnIncomingFrameBeginData.frame" title="Link to this definition">¶</a></dt>
+<dd><p>Describes the frame you are starting to receive.</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.websocket.OnIncomingFramePayloadData">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.websocket.</span></span><span class="sig-name descname"><span class="pre">OnIncomingFramePayloadData</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">frame</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.websocket.IncomingFrame" title="awscrt.websocket.IncomingFrame"><span class="pre">IncomingFrame</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.12)"><span class="pre">bytes</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.websocket.OnIncomingFramePayloadData" title="Link to this definition">¶</a></dt>
+<dd><p>Data passed to the <cite>on_incoming_frame_payload</cite> callback.</p>
+<p>This callback will be invoked 0+ times.
+Each time, <cite>data</cite> will contain a bit more of the payload.
+Once all <cite>frame.payload_length</cite> bytes have been received
+(or the network connection is lost), the <cite>on_incoming_frame_complete</cite>
+callback will be invoked.</p>
+<p>If the WebSocket was created with <cite>manage_read_window</cite>,
+and this is a “data frame” (TEXT, BINARY, CONTINUATION),
+then the read window shrinks by <cite>len(data)</cite>.
+See <a class="reference internal" href="#flow-control-reading"><span class="std std-ref">Flow Control (reading)</span></a> for a thorough explanation.</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.websocket.OnIncomingFramePayloadData.frame">
+<span class="sig-name descname"><span class="pre">frame</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#awscrt.websocket.IncomingFrame" title="awscrt.websocket.IncomingFrame"><span class="pre">IncomingFrame</span></a></em><a class="headerlink" href="#awscrt.websocket.OnIncomingFramePayloadData.frame" title="Link to this definition">¶</a></dt>
+<dd><p>Describes the frame whose payload you are receiving.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.websocket.OnIncomingFramePayloadData.data">
+<span class="sig-name descname"><span class="pre">data</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.12)"><span class="pre">bytes</span></a></em><a class="headerlink" href="#awscrt.websocket.OnIncomingFramePayloadData.data" title="Link to this definition">¶</a></dt>
+<dd><p>The next chunk of this frame’s payload.</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.websocket.OnIncomingFrameCompleteData">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.websocket.</span></span><span class="sig-name descname"><span class="pre">OnIncomingFrameCompleteData</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">frame</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.websocket.IncomingFrame" title="awscrt.websocket.IncomingFrame"><span class="pre">IncomingFrame</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">exception</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.12)"><span class="pre">Exception</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.websocket.OnIncomingFrameCompleteData" title="Link to this definition">¶</a></dt>
+<dd><p>Data passed to the <cite>on_incoming_frame_complete</cite> callback.</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.websocket.OnIncomingFrameCompleteData.frame">
+<span class="sig-name descname"><span class="pre">frame</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#awscrt.websocket.IncomingFrame" title="awscrt.websocket.IncomingFrame"><span class="pre">IncomingFrame</span></a></em><a class="headerlink" href="#awscrt.websocket.OnIncomingFrameCompleteData.frame" title="Link to this definition">¶</a></dt>
+<dd><p>Describes the frame you are done receiving.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.websocket.OnIncomingFrameCompleteData.exception">
+<span class="sig-name descname"><span class="pre">exception</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.12)"><span class="pre">Exception</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#awscrt.websocket.OnIncomingFrameCompleteData.exception" title="Link to this definition">¶</a></dt>
+<dd><p>If <cite>exception</cite> is set, then something went wrong processing the frame
+or the connection was lost before the frame was fully received.</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.websocket.OnSendFrameCompleteData">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.websocket.</span></span><span class="sig-name descname"><span class="pre">OnSendFrameCompleteData</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">exception</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.12)"><span class="pre">Exception</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.websocket.OnSendFrameCompleteData" title="Link to this definition">¶</a></dt>
+<dd><p>Data passed to the <a class="reference internal" href="#awscrt.websocket.WebSocket.send_frame" title="awscrt.websocket.WebSocket.send_frame"><code class="xref py py-meth docutils literal notranslate"><span class="pre">WebSocket.send_frame()</span></code></a> <cite>on_complete</cite> callback.</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="awscrt.websocket.OnSendFrameCompleteData.exception">
+<span class="sig-name descname"><span class="pre">exception</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.12)"><span class="pre">Exception</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#awscrt.websocket.OnSendFrameCompleteData.exception" title="Link to this definition">¶</a></dt>
+<dd><p>If <cite>exception</cite> is set, the connection was lost before this frame could be completely sent.</p>
+<p>If <cite>exception</cite> is None, the frame was successfully written to the OS socket.
+Note that this data may still be buffered in the OS, it has
+not necessarily left this machine or reached the other endpoint yet.</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="awscrt.websocket.WebSocket">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awscrt.websocket.</span></span><span class="sig-name descname"><span class="pre">WebSocket</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">binding</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.websocket.WebSocket" title="Link to this definition">¶</a></dt>
+<dd><p>A WebSocket connection.</p>
+<p>Use <a class="reference internal" href="#awscrt.websocket.connect" title="awscrt.websocket.connect"><code class="xref py py-meth docutils literal notranslate"><span class="pre">connect()</span></code></a> to establish a new client connection.</p>
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.websocket.WebSocket.close">
+<span class="sig-name descname"><span class="pre">close</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.websocket.WebSocket.close" title="Link to this definition">¶</a></dt>
+<dd><p>Close the WebSocket asynchronously.</p>
+<p>You should call this when you are done with a healthy WebSocket,
+to ensure that it shuts down and cleans up.
+You don’t need to call this on a WebSocket that has already shut
+down, or is in the middle of shutting down, but it is safe to do so.
+This function is idempotent.</p>
+<p>To determine when shutdown has completed, you can use the
+<cite>on_shutdown_complete</cite> callback (passed into <a class="reference internal" href="#awscrt.websocket.connect" title="awscrt.websocket.connect"><code class="xref py py-meth docutils literal notranslate"><span class="pre">connect()</span></code></a>).</p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.websocket.WebSocket.send_frame">
+<span class="sig-name descname"><span class="pre">send_frame</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">opcode</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#awscrt.websocket.Opcode" title="awscrt.websocket.Opcode"><span class="pre">Opcode</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">payload</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.12)"><span class="pre">bytes</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytearray" title="(in Python v3.12)"><span class="pre">bytearray</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#memoryview" title="(in Python v3.12)"><span class="pre">memoryview</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">on_complete</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.12)"><span class="pre">Callable</span></a><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#awscrt.websocket.OnSendFrameCompleteData" title="awscrt.websocket.OnSendFrameCompleteData"><span class="pre">OnSendFrameCompleteData</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.websocket.WebSocket.send_frame" title="Link to this definition">¶</a></dt>
+<dd><p>Send a WebSocket frame asynchronously.</p>
+<p>See <a class="reference external" href="https://www.rfc-editor.org/rfc/rfc6455#section-5">RFC 6455 section 5 - Data Framing</a>
+for details on all frame types.</p>
+<p>This is a low-level API, which requires you to send the appropriate payload for each type of opcode.
+If you are not an expert, stick to sending <a class="reference internal" href="#awscrt.websocket.Opcode.TEXT" title="awscrt.websocket.Opcode.TEXT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Opcode.TEXT</span></code></a> or <a class="reference internal" href="#awscrt.websocket.Opcode.BINARY" title="awscrt.websocket.Opcode.BINARY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Opcode.BINARY</span></code></a> frames,
+and don’t touch the FIN bit.</p>
+<p>See <a class="reference internal" href="#flow-control-writing"><span class="std std-ref">Flow Control (writing)</span></a> to learn about limiting the amount of
+unsent data buffered in memory.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>opcode</strong> – <a class="reference internal" href="#awscrt.websocket.Opcode" title="awscrt.websocket.Opcode"><code class="xref py py-class docutils literal notranslate"><span class="pre">Opcode</span></code></a> for this frame.</p></li>
+<li><p><strong>payload</strong> – Any <a class="reference external" href="https://docs.python.org/3/glossary.html#term-bytes-like-object">bytes-like object</a>.
+<cite>str</cite> will always be encoded as UTF-8. It is fine to pass a <cite>str</cite> for a BINARY frame.
+None will result in an empty payload, the same as passing empty <cite>bytes()</cite></p></li>
+<li><p><strong>fin</strong> – The FIN bit indicates that this is the final fragment in a message.
+Do not set this False unless you understand
+<a class="reference external" href="https://www.rfc-editor.org/rfc/rfc6455#section-5.4">WebSocket fragmentation</a></p></li>
+<li><p><strong>on_complete</strong> – <p>Optional callback, invoked when the frame has finished sending.
+Takes a single <a class="reference internal" href="#awscrt.websocket.OnSendFrameCompleteData" title="awscrt.websocket.OnSendFrameCompleteData"><code class="xref py py-class docutils literal notranslate"><span class="pre">OnSendFrameCompleteData</span></code></a> argument.</p>
+<p>If <a class="reference internal" href="#awscrt.websocket.OnSendFrameCompleteData.exception" title="awscrt.websocket.OnSendFrameCompleteData.exception"><code class="xref py py-attr docutils literal notranslate"><span class="pre">OnSendFrameCompleteData.exception</span></code></a> is set, the connection
+was lost before this frame could be completely sent.</p>
+<p>But if <cite>exception</cite> is None, the frame was successfully written to the OS socket.
+(This doesn’t mean the other endpoint has received the data yet,
+or even guarantee that the data has left the machine yet,
+but it’s on track to get there).</p>
+<p>Be sure to read about <a class="reference internal" href="#authoring-callbacks"><span class="std std-ref">Authoring Callbacks</span></a>.</p>
+</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="awscrt.websocket.WebSocket.increment_read_window">
+<span class="sig-name descname"><span class="pre">increment_read_window</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.websocket.WebSocket.increment_read_window" title="Link to this definition">¶</a></dt>
+<dd><p>Manually increment the read window by this many bytes, to continue receiving frames.</p>
+<p>See <a class="reference internal" href="#flow-control-reading"><span class="std std-ref">Flow Control (reading)</span></a> for a thorough explanation.
+If the WebSocket was created without <cite>manage_read_window</cite>, this function does nothing.
+This function may be called from any thread.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>size</strong> – in bytes</p>
+</dd>
+</dl>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="awscrt.websocket.connect">
+<span class="sig-prename descclassname"><span class="pre">awscrt.websocket.</span></span><span class="sig-name descname"><span class="pre">connect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">handshake_request</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="http.html#awscrt.http.HttpRequest" title="awscrt.http.HttpRequest"><span class="pre">HttpRequest</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">bootstrap</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="io.html#awscrt.io.ClientBootstrap" title="awscrt.io.ClientBootstrap"><span class="pre">ClientBootstrap</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">socket_options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="io.html#awscrt.io.SocketOptions" title="awscrt.io.SocketOptions"><span class="pre">SocketOptions</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tls_connection_options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="io.html#awscrt.io.TlsConnectionOptions" title="awscrt.io.TlsConnectionOptions"><span class="pre">TlsConnectionOptions</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">proxy_options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="http.html#awscrt.http.HttpProxyOptions" title="awscrt.http.HttpProxyOptions"><span class="pre">HttpProxyOptions</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">manage_read_window</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">initial_read_window</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">on_connection_setup</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.12)"><span class="pre">Callable</span></a><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#awscrt.websocket.OnConnectionSetupData" title="awscrt.websocket.OnConnectionSetupData"><span class="pre">OnConnectionSetupData</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">on_connection_shutdown</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.12)"><span class="pre">Callable</span></a><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#awscrt.websocket.OnConnectionShutdownData" title="awscrt.websocket.OnConnectionShutdownData"><span class="pre">OnConnectionShutdownData</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">on_incoming_frame_begin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.12)"><span class="pre">Callable</span></a><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#awscrt.websocket.OnIncomingFrameBeginData" title="awscrt.websocket.OnIncomingFrameBeginData"><span class="pre">OnIncomingFrameBeginData</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">on_incoming_frame_payload</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.12)"><span class="pre">Callable</span></a><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#awscrt.websocket.OnIncomingFramePayloadData" title="awscrt.websocket.OnIncomingFramePayloadData"><span class="pre">OnIncomingFramePayloadData</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">on_incoming_frame_complete</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.12)"><span class="pre">Callable</span></a><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#awscrt.websocket.OnIncomingFrameCompleteData" title="awscrt.websocket.OnIncomingFrameCompleteData"><span class="pre">OnIncomingFrameCompleteData</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#awscrt.websocket.connect" title="Link to this definition">¶</a></dt>
+<dd><p>Asynchronously establish a client WebSocket connection.</p>
+<p>The <cite>on_connection_setup</cite> callback is invoked once the connection
+has succeeded or failed.</p>
+<p>If successful, a <a class="reference internal" href="#awscrt.websocket.WebSocket" title="awscrt.websocket.WebSocket"><code class="xref py py-class docutils literal notranslate"><span class="pre">WebSocket</span></code></a> will be provided in the
+<a class="reference internal" href="#awscrt.websocket.OnConnectionSetupData" title="awscrt.websocket.OnConnectionSetupData"><code class="xref py py-class docutils literal notranslate"><span class="pre">OnConnectionSetupData</span></code></a>. You should store this WebSocket somewhere,
+so that you can continue using it (the connection will shut down
+if the class is garbage collected).</p>
+<dl class="simple">
+<dt>The WebSocket will shut down after one of these things occur:</dt><dd><ul class="simple">
+<li><p>You call <a class="reference internal" href="#awscrt.websocket.WebSocket.close" title="awscrt.websocket.WebSocket.close"><code class="xref py py-meth docutils literal notranslate"><span class="pre">WebSocket.close()</span></code></a></p></li>
+<li><p>You, or the server, sends a CLOSE frame.</p></li>
+<li><p>The underlying socket shuts down.</p></li>
+<li><p>All references to the WebSocket are dropped,
+causing it to be garbage collected. However, you should NOT
+rely on this behavior. You should call <a class="reference internal" href="#awscrt.websocket.WebSocket.close" title="awscrt.websocket.WebSocket.close"><code class="xref py py-meth docutils literal notranslate"><span class="pre">close()</span></code></a> when you are
+done with a healthy WebSocket, to ensure that it shuts down and cleans up.
+It is very easy to accidentally keep a reference around without realizing it.</p></li>
+</ul>
+</dd>
+</dl>
+<p>Be sure to read about <a class="reference internal" href="#authoring-callbacks"><span class="std std-ref">Authoring Callbacks</span></a>.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>host</strong> – Hostname to connect to.</p></li>
+<li><p><strong>port</strong> – Port to connect to. If not specified, it defaults to port 443
+when <cite>tls_connection_options</cite> is present, and port 80 otherwise.</p></li>
+<li><p><strong>handshake_request</strong> – <p>HTTP request for the initial WebSocket handshake.</p>
+<p>The request’s method MUST be “GET”, and the following headers are
+required:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Host</span><span class="p">:</span> <span class="o">&lt;</span><span class="n">host</span><span class="o">&gt;</span>
+<span class="n">Upgrade</span><span class="p">:</span> <span class="n">websocket</span>
+<span class="n">Connection</span><span class="p">:</span> <span class="n">Upgrade</span>
+<span class="n">Sec</span><span class="o">-</span><span class="n">WebSocket</span><span class="o">-</span><span class="n">Key</span><span class="p">:</span> <span class="o">&lt;</span><span class="n">base64</span><span class="o">-</span><span class="n">encoding</span> <span class="n">of</span> <span class="mi">16</span> <span class="n">random</span> <span class="nb">bytes</span><span class="o">&gt;</span>
+<span class="n">Sec</span><span class="o">-</span><span class="n">WebSocket</span><span class="o">-</span><span class="n">Version</span><span class="p">:</span> <span class="mi">13</span>
+</pre></div>
+</div>
+<p>You can use <a class="reference internal" href="#awscrt.websocket.create_handshake_request" title="awscrt.websocket.create_handshake_request"><code class="xref py py-meth docutils literal notranslate"><span class="pre">create_handshake_request()</span></code></a> to make a valid WebSocket
+handshake request, modifying the path and headers to fit your needs,
+and then passing it here.</p>
+</p></li>
+<li><p><strong>bootstrap</strong> – Client bootstrap to use when initiating socket connection.
+If not specified, the default singleton is used.</p></li>
+<li><p><strong>socket_options</strong> – Socket options.
+If not specified, default options are used.</p></li>
+<li><p><strong>proxy_options</strong> – HTTP Proxy options.
+If not specified, no proxy is used.</p></li>
+<li><p><strong>manage_read_window</strong> – Set true to manually manage the flow-control read window.
+If false (the default), data arrives as fast as possible.
+See <a class="reference internal" href="#flow-control-reading"><span class="std std-ref">Flow Control (reading)</span></a> for a thorough explanation.</p></li>
+<li><p><strong>initial_read_window</strong> – The initial size of the read window, in bytes.
+This must be set if <cite>manage_read_window</cite> is true,
+otherwise it is ignored.
+See <a class="reference internal" href="#flow-control-reading"><span class="std std-ref">Flow Control (reading)</span></a> for a thorough explanation.
+An initial size of 0 will prevent any frames from arriving
+until <a class="reference internal" href="#awscrt.websocket.WebSocket.increment_read_window" title="awscrt.websocket.WebSocket.increment_read_window"><code class="xref py py-meth docutils literal notranslate"><span class="pre">WebSocket.increment_read_window()</span></code></a> is called.</p></li>
+<li><p><strong>on_connection_setup</strong> – <p>Callback invoked when the connect completes.
+Takes a single <a class="reference internal" href="#awscrt.websocket.OnConnectionSetupData" title="awscrt.websocket.OnConnectionSetupData"><code class="xref py py-class docutils literal notranslate"><span class="pre">OnConnectionSetupData</span></code></a> argument.</p>
+<p>If successful, <a class="reference internal" href="#awscrt.websocket.OnConnectionSetupData.websocket" title="awscrt.websocket.OnConnectionSetupData.websocket"><code class="xref py py-attr docutils literal notranslate"><span class="pre">OnConnectionSetupData.websocket</span></code></a> will be set.
+You should store the <a class="reference internal" href="#awscrt.websocket.WebSocket" title="awscrt.websocket.WebSocket"><code class="xref py py-class docutils literal notranslate"><span class="pre">WebSocket</span></code></a> somewhere, so you can
+use it to send data when you’re ready.
+The other callbacks will be invoked as events occur,
+until the final <cite>on_connection_shutdown</cite> callback.</p>
+<p>If unsuccessful, <a class="reference internal" href="#awscrt.websocket.OnConnectionSetupData.exception" title="awscrt.websocket.OnConnectionSetupData.exception"><code class="xref py py-attr docutils literal notranslate"><span class="pre">OnConnectionSetupData.exception</span></code></a> will be set,
+and no further callbacks will be invoked.</p>
+<p>If this callback raises an exception, the connection will shut down.</p>
+</p></li>
+<li><p><strong>on_connection_shutdown</strong> – <p>Optional callback, invoked when a connection shuts down.
+Takes a single <a class="reference internal" href="#awscrt.websocket.OnConnectionShutdownData" title="awscrt.websocket.OnConnectionShutdownData"><code class="xref py py-class docutils literal notranslate"><span class="pre">OnConnectionShutdownData</span></code></a> argument.</p>
+<p>This callback is never invoked if <cite>on_connection_setup</cite> reported an exception.</p>
+</p></li>
+<li><p><strong>on_incoming_frame_begin</strong> – <p>Optional callback, invoked once at the start of each incoming frame.
+Takes a single <a class="reference internal" href="#awscrt.websocket.OnIncomingFrameBeginData" title="awscrt.websocket.OnIncomingFrameBeginData"><code class="xref py py-class docutils literal notranslate"><span class="pre">OnIncomingFrameBeginData</span></code></a> argument.</p>
+<p>Each <cite>on_incoming_frame_begin</cite> call will be followed by 0+
+<cite>on_incoming_frame_payload</cite> calls, followed by one
+<cite>on_incoming_frame_complete</cite> call.</p>
+<p>The “frame complete” callback is guaranteed to be invoked
+once for each “frame begin” callback, even if the connection
+is lost before the whole frame has been received.</p>
+<p>If this callback raises an exception, the connection will shut down.</p>
+</p></li>
+<li><p><strong>on_incoming_frame_payload</strong> – <p>Optional callback, invoked 0+ times as payload data arrives.
+Takes a single <a class="reference internal" href="#awscrt.websocket.OnIncomingFramePayloadData" title="awscrt.websocket.OnIncomingFramePayloadData"><code class="xref py py-class docutils literal notranslate"><span class="pre">OnIncomingFramePayloadData</span></code></a> argument.</p>
+<p>If <cite>manage_read_window</cite> is on, and this is a “data frame”,
+then the read window shrinks accordingly.
+See <a class="reference internal" href="#flow-control-reading"><span class="std std-ref">Flow Control (reading)</span></a> for a thorough explanation.</p>
+<p>If this callback raises an exception, the connection will shut down.</p>
+</p></li>
+<li><p><strong>on_incoming_frame_complete</strong> – <p>Optional callback, invoked when the WebSocket
+is done processing an incoming frame.
+Takes a single <a class="reference internal" href="#awscrt.websocket.OnIncomingFrameCompleteData" title="awscrt.websocket.OnIncomingFrameCompleteData"><code class="xref py py-class docutils literal notranslate"><span class="pre">OnIncomingFrameCompleteData</span></code></a> argument.</p>
+<p>If <a class="reference internal" href="#awscrt.websocket.OnIncomingFrameCompleteData.exception" title="awscrt.websocket.OnIncomingFrameCompleteData.exception"><code class="xref py py-attr docutils literal notranslate"><span class="pre">OnIncomingFrameCompleteData.exception</span></code></a> is set,
+then something went wrong processing the frame
+or the connection was lost before the frame could be completed.</p>
+<p>If this callback raises an exception, the connection will shut down.</p>
+</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="awscrt.websocket.create_handshake_request">
+<span class="sig-prename descclassname"><span class="pre">awscrt.websocket.</span></span><span class="sig-name descname"><span class="pre">create_handshake_request</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'/'</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="http.html#awscrt.http.HttpRequest" title="awscrt.http.HttpRequest"><span class="pre">HttpRequest</span></a></span></span><a class="headerlink" href="#awscrt.websocket.create_handshake_request" title="Link to this definition">¶</a></dt>
+<dd><p>Create an HTTP request with all the required fields for a WebSocket handshake.</p>
+<p>The method will be “GET”, and the following headers are added:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Host</span><span class="p">:</span> <span class="o">&lt;</span><span class="n">host</span><span class="o">&gt;</span>
+<span class="n">Upgrade</span><span class="p">:</span> <span class="n">websocket</span>
+<span class="n">Connection</span><span class="p">:</span> <span class="n">Upgrade</span>
+<span class="n">Sec</span><span class="o">-</span><span class="n">WebSocket</span><span class="o">-</span><span class="n">Key</span><span class="p">:</span> <span class="o">&lt;</span><span class="n">base64</span><span class="o">-</span><span class="n">encoding</span> <span class="n">of</span> <span class="mi">16</span> <span class="n">random</span> <span class="nb">bytes</span><span class="o">&gt;</span>
+<span class="n">Sec</span><span class="o">-</span><span class="n">WebSocket</span><span class="o">-</span><span class="n">Version</span><span class="p">:</span> <span class="mi">13</span>
+</pre></div>
+</div>
+<p>You may can add headers, or modify the path, before using this request.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>host</strong> – Value for “Host” header</p></li>
+<li><p><strong>path</strong> – Path (and query) string. Defaults to “/”.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
+</section>
+
+
+            <div class="clearer"></div>
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+  <div>
+    <h3><a href="../index.html">Table of Contents</a></h3>
+    <ul>
+<li><a class="reference internal" href="#">awscrt.websocket</a><ul>
+<li><a class="reference internal" href="#authoring-callbacks">Authoring Callbacks</a></li>
+<li><a class="reference internal" href="#flow-control-reading">Flow Control (reading)</a></li>
+<li><a class="reference internal" href="#flow-control-writing">Flow Control (writing)</a></li>
+<li><a class="reference internal" href="#api">API</a></li>
+<li><a class="reference internal" href="#awscrt.websocket.Opcode"><code class="docutils literal notranslate"><span class="pre">Opcode</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.websocket.Opcode.CONTINUATION"><code class="docutils literal notranslate"><span class="pre">CONTINUATION</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.websocket.Opcode.TEXT"><code class="docutils literal notranslate"><span class="pre">TEXT</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.websocket.Opcode.BINARY"><code class="docutils literal notranslate"><span class="pre">BINARY</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.websocket.Opcode.CLOSE"><code class="docutils literal notranslate"><span class="pre">CLOSE</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.websocket.Opcode.PING"><code class="docutils literal notranslate"><span class="pre">PING</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.websocket.Opcode.PONG"><code class="docutils literal notranslate"><span class="pre">PONG</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.websocket.Opcode.is_data_frame"><code class="docutils literal notranslate"><span class="pre">is_data_frame()</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.websocket.MAX_PAYLOAD_LENGTH"><code class="docutils literal notranslate"><span class="pre">MAX_PAYLOAD_LENGTH</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.websocket.OnConnectionSetupData"><code class="docutils literal notranslate"><span class="pre">OnConnectionSetupData</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.websocket.OnConnectionSetupData.exception"><code class="docutils literal notranslate"><span class="pre">exception</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.websocket.OnConnectionSetupData.websocket"><code class="docutils literal notranslate"><span class="pre">websocket</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.websocket.OnConnectionSetupData.handshake_response_status"><code class="docutils literal notranslate"><span class="pre">handshake_response_status</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.websocket.OnConnectionSetupData.handshake_response_headers"><code class="docutils literal notranslate"><span class="pre">handshake_response_headers</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.websocket.OnConnectionSetupData.handshake_response_body"><code class="docutils literal notranslate"><span class="pre">handshake_response_body</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.websocket.OnConnectionShutdownData"><code class="docutils literal notranslate"><span class="pre">OnConnectionShutdownData</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.websocket.OnConnectionShutdownData.exception"><code class="docutils literal notranslate"><span class="pre">exception</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.websocket.IncomingFrame"><code class="docutils literal notranslate"><span class="pre">IncomingFrame</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.websocket.IncomingFrame.opcode"><code class="docutils literal notranslate"><span class="pre">opcode</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.websocket.IncomingFrame.payload_length"><code class="docutils literal notranslate"><span class="pre">payload_length</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.websocket.IncomingFrame.fin"><code class="docutils literal notranslate"><span class="pre">fin</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.websocket.IncomingFrame.is_data_frame"><code class="docutils literal notranslate"><span class="pre">is_data_frame()</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.websocket.OnIncomingFrameBeginData"><code class="docutils literal notranslate"><span class="pre">OnIncomingFrameBeginData</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.websocket.OnIncomingFrameBeginData.frame"><code class="docutils literal notranslate"><span class="pre">frame</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.websocket.OnIncomingFramePayloadData"><code class="docutils literal notranslate"><span class="pre">OnIncomingFramePayloadData</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.websocket.OnIncomingFramePayloadData.frame"><code class="docutils literal notranslate"><span class="pre">frame</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.websocket.OnIncomingFramePayloadData.data"><code class="docutils literal notranslate"><span class="pre">data</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.websocket.OnIncomingFrameCompleteData"><code class="docutils literal notranslate"><span class="pre">OnIncomingFrameCompleteData</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.websocket.OnIncomingFrameCompleteData.frame"><code class="docutils literal notranslate"><span class="pre">frame</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.websocket.OnIncomingFrameCompleteData.exception"><code class="docutils literal notranslate"><span class="pre">exception</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.websocket.OnSendFrameCompleteData"><code class="docutils literal notranslate"><span class="pre">OnSendFrameCompleteData</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.websocket.OnSendFrameCompleteData.exception"><code class="docutils literal notranslate"><span class="pre">exception</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.websocket.WebSocket"><code class="docutils literal notranslate"><span class="pre">WebSocket</span></code></a><ul>
+<li><a class="reference internal" href="#awscrt.websocket.WebSocket.close"><code class="docutils literal notranslate"><span class="pre">close()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.websocket.WebSocket.send_frame"><code class="docutils literal notranslate"><span class="pre">send_frame()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.websocket.WebSocket.increment_read_window"><code class="docutils literal notranslate"><span class="pre">increment_read_window()</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#awscrt.websocket.connect"><code class="docutils literal notranslate"><span class="pre">connect()</span></code></a></li>
+<li><a class="reference internal" href="#awscrt.websocket.create_handshake_request"><code class="docutils literal notranslate"><span class="pre">create_handshake_request()</span></code></a></li>
+</ul>
+</li>
+</ul>
+
+  </div>
+  <div>
+    <h4>Previous topic</h4>
+    <p class="topless"><a href="s3.html"
+                          title="previous chapter">awscrt.s3</a></p>
+  </div>
+  <div role="note" aria-label="source link">
+    <h3>This Page</h3>
+    <ul class="this-page-menu">
+      <li><a href="../_sources/api/websocket.rst.txt"
+            rel="nofollow">Show Source</a></li>
+    </ul>
+   </div>
+<div id="searchbox" style="display: none" role="search">
+  <h3 id="searchlabel">Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="../search.html" method="get">
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+      <input type="submit" value="Go" />
+    </form>
+    </div>
+</div>
+<script>document.getElementById('searchbox').style.display = "block"</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../genindex.html" title="General Index"
+             >index</a></li>
+        <li class="right" >
+          <a href="../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="right" >
+          <a href="s3.html" title="awscrt.s3"
+             >previous</a> |</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">awscrt  documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">awscrt.websocket</a></li> 
+      </ul>
+    </div>
+    <div class="footer" role="contentinfo">
+    &#169; Copyright 2020, Amazon Web Services, Inc.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
+    </div>
+  </body>
+</html>
\ No newline at end of file
diff --git a/docs/genindex.html b/docs/genindex.html
new file mode 100644
index 000000000..8a9a13542
--- /dev/null
+++ b/docs/genindex.html
@@ -0,0 +1,1581 @@
+
+
+<!doctype html>
+
+<html lang="en" data-content_root="./">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Index &#8212; awscrt  documentation</title>
+    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=649a27d8" />
+    <link rel="stylesheet" type="text/css" href="_static/css/custom.css?v=93be7416" />
+    
+    <script src="_static/documentation_options.js?v=5929fcd5"></script>
+    <script src="_static/doctools.js?v=888ff710"></script>
+    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script src="_static/bizstyle.js"></script>
+    <link rel="index" title="Index" href="#" />
+    <link rel="search" title="Search" href="search.html" />
+    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+    <!--[if lt IE 9]>
+    <script src="_static/css3-mediaqueries.js"></script>
+    <![endif]-->
+  </head><body>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="#" title="General Index"
+             accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="nav-item nav-item-0"><a href="index.html">awscrt  documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">Index</a></li> 
+      </ul>
+    </div>  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body" role="main">
+            
+
+<h1 id="index">Index</h1>
+
+<div class="genindex-jumpbox">
+ <a href="#A"><strong>A</strong></a>
+ | <a href="#B"><strong>B</strong></a>
+ | <a href="#C"><strong>C</strong></a>
+ | <a href="#D"><strong>D</strong></a>
+ | <a href="#E"><strong>E</strong></a>
+ | <a href="#F"><strong>F</strong></a>
+ | <a href="#G"><strong>G</strong></a>
+ | <a href="#H"><strong>H</strong></a>
+ | <a href="#I"><strong>I</strong></a>
+ | <a href="#K"><strong>K</strong></a>
+ | <a href="#L"><strong>L</strong></a>
+ | <a href="#M"><strong>M</strong></a>
+ | <a href="#N"><strong>N</strong></a>
+ | <a href="#O"><strong>O</strong></a>
+ | <a href="#P"><strong>P</strong></a>
+ | <a href="#Q"><strong>Q</strong></a>
+ | <a href="#R"><strong>R</strong></a>
+ | <a href="#S"><strong>S</strong></a>
+ | <a href="#T"><strong>T</strong></a>
+ | <a href="#U"><strong>U</strong></a>
+ | <a href="#V"><strong>V</strong></a>
+ | <a href="#W"><strong>W</strong></a>
+ | <a href="#X"><strong>X</strong></a>
+ 
+</div>
+<h2 id="A">A</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api/mqtt.html#awscrt.mqtt.ConnectReturnCode.ACCEPTED">ACCEPTED (awscrt.mqtt.ConnectReturnCode attribute)</a>
+</li>
+      <li><a href="api/auth.html#awscrt.auth.AwsCredentials.access_key_id">access_key_id (awscrt.auth.AwsCredentials attribute)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.rpc.ClientContinuation.activate">activate() (awscrt.eventstream.rpc.ClientContinuation method)</a>
+
+      <ul>
+        <li><a href="api/http.html#awscrt.http.HttpClientStream.activate">(awscrt.http.HttpClientStream method)</a>
+</li>
+      </ul></li>
+      <li><a href="api/http.html#awscrt.http.HttpHeaders.add">add() (awscrt.http.HttpHeaders method)</a>
+</li>
+      <li><a href="api/http.html#awscrt.http.HttpHeaders.add_pairs">add_pairs() (awscrt.http.HttpHeaders method)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.DisconnectReasonCode.ADMINISTRATIVE_ACTION">ADMINISTRATIVE_ACTION (awscrt.mqtt5.DisconnectReasonCode attribute)</a>
+</li>
+      <li><a href="api/auth.html#awscrt.auth.AwsSigningConfig.algorithm">algorithm (awscrt.auth.AwsSigningConfig property)</a>
+
+      <ul>
+        <li><a href="api/s3.html#awscrt.s3.S3ChecksumConfig.algorithm">(awscrt.s3.S3ChecksumConfig attribute)</a>
+</li>
+      </ul></li>
+      <li><a href="api/io.html#awscrt.io.TlsContextOptions.alpn_list">alpn_list (awscrt.io.TlsContextOptions attribute)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.rpc.MessageType.APPLICATION_ERROR">APPLICATION_ERROR (awscrt.eventstream.rpc.MessageType attribute)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.rpc.MessageType.APPLICATION_MESSAGE">APPLICATION_MESSAGE (awscrt.eventstream.rpc.MessageType attribute)</a>
+</li>
+      <li><a href="api/mqtt.html#awscrt.mqtt.QoS.AT_LEAST_ONCE">AT_LEAST_ONCE (awscrt.mqtt.QoS attribute)</a>
+
+      <ul>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.QoS.AT_LEAST_ONCE">(awscrt.mqtt5.QoS attribute)</a>
+</li>
+      </ul></li>
+      <li><a href="api/mqtt.html#awscrt.mqtt.QoS.AT_MOST_ONCE">AT_MOST_ONCE (awscrt.mqtt.QoS attribute)</a>
+
+      <ul>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.QoS.AT_MOST_ONCE">(awscrt.mqtt5.QoS attribute)</a>
+</li>
+      </ul></li>
+      <li><a href="api/http.html#awscrt.http.HttpProxyOptions.auth_password">auth_password (awscrt.http.HttpProxyOptions attribute)</a>
+</li>
+      <li><a href="api/http.html#awscrt.http.HttpProxyOptions.auth_type">auth_type (awscrt.http.HttpProxyOptions attribute)</a>
+</li>
+      <li><a href="api/http.html#awscrt.http.HttpProxyOptions.auth_username">auth_username (awscrt.http.HttpProxyOptions attribute)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.ExtendedValidationAndFlowControlOptions.AWS_IOT_CORE_DEFAULTS">AWS_IOT_CORE_DEFAULTS (awscrt.mqtt5.ExtendedValidationAndFlowControlOptions attribute)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.PayloadFormatIndicator.AWS_MQTT5_PFI_BYTES">AWS_MQTT5_PFI_BYTES (awscrt.mqtt5.PayloadFormatIndicator attribute)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.PayloadFormatIndicator.AWS_MQTT5_PFI_UTF8">AWS_MQTT5_PFI_UTF8 (awscrt.mqtt5.PayloadFormatIndicator attribute)</a>
+</li>
+      <li><a href="api/auth.html#awscrt.auth.aws_sign_request">aws_sign_request() (in module awscrt.auth)</a>
+</li>
+      <li><a href="api/auth.html#awscrt.auth.AwsCredentials">AwsCredentials (class in awscrt.auth)</a>
+</li>
+      <li><a href="api/auth.html#awscrt.auth.AwsCredentialsProvider">AwsCredentialsProvider (class in awscrt.auth)</a>
+</li>
+      <li>
+    awscrt.auth
+
+      <ul>
+        <li><a href="api/auth.html#module-awscrt.auth">module</a>
+</li>
+      </ul></li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li>
+    awscrt.common
+
+      <ul>
+        <li><a href="api/common.html#module-awscrt.common">module</a>
+</li>
+      </ul></li>
+      <li>
+    awscrt.crypto
+
+      <ul>
+        <li><a href="api/crypto.html#module-awscrt.crypto">module</a>
+</li>
+      </ul></li>
+      <li>
+    awscrt.eventstream
+
+      <ul>
+        <li><a href="api/eventstream.html#module-awscrt.eventstream">module</a>
+</li>
+      </ul></li>
+      <li>
+    awscrt.eventstream.rpc
+
+      <ul>
+        <li><a href="api/eventstream.html#module-awscrt.eventstream.rpc">module</a>
+</li>
+      </ul></li>
+      <li>
+    awscrt.exceptions
+
+      <ul>
+        <li><a href="api/exceptions.html#module-awscrt.exceptions">module</a>
+</li>
+      </ul></li>
+      <li>
+    awscrt.http
+
+      <ul>
+        <li><a href="api/http.html#module-awscrt.http">module</a>
+</li>
+      </ul></li>
+      <li>
+    awscrt.io
+
+      <ul>
+        <li><a href="api/io.html#module-awscrt.io">module</a>
+</li>
+      </ul></li>
+      <li>
+    awscrt.mqtt
+
+      <ul>
+        <li><a href="api/mqtt.html#module-awscrt.mqtt">module</a>
+</li>
+      </ul></li>
+      <li>
+    awscrt.mqtt5
+
+      <ul>
+        <li><a href="api/mqtt5.html#module-awscrt.mqtt5">module</a>
+</li>
+      </ul></li>
+      <li>
+    awscrt.s3
+
+      <ul>
+        <li><a href="api/s3.html#module-awscrt.s3">module</a>
+</li>
+      </ul></li>
+      <li>
+    awscrt.websocket
+
+      <ul>
+        <li><a href="api/websocket.html#module-awscrt.websocket">module</a>
+</li>
+      </ul></li>
+      <li><a href="api/exceptions.html#awscrt.exceptions.AwsCrtError">AwsCrtError</a>
+</li>
+      <li><a href="api/auth.html#awscrt.auth.AwsSignatureType">AwsSignatureType (class in awscrt.auth)</a>
+</li>
+      <li><a href="api/auth.html#awscrt.auth.AwsSignedBodyHeaderType">AwsSignedBodyHeaderType (class in awscrt.auth)</a>
+</li>
+      <li><a href="api/auth.html#awscrt.auth.AwsSignedBodyValue">AwsSignedBodyValue (class in awscrt.auth)</a>
+</li>
+      <li><a href="api/auth.html#awscrt.auth.AwsSigningAlgorithm">AwsSigningAlgorithm (class in awscrt.auth)</a>
+</li>
+      <li><a href="api/auth.html#awscrt.auth.AwsSigningConfig">AwsSigningConfig (class in awscrt.auth)</a>
+</li>
+  </ul></td>
+</tr></table>
+
+<h2 id="B">B</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.ConnectReasonCode.BAD_AUTHENTICATION_METHOD">BAD_AUTHENTICATION_METHOD (awscrt.mqtt5.ConnectReasonCode attribute)</a>
+</li>
+      <li><a href="api/mqtt.html#awscrt.mqtt.ConnectReturnCode.BAD_USERNAME_OR_PASSWORD">BAD_USERNAME_OR_PASSWORD (awscrt.mqtt.ConnectReturnCode attribute)</a>
+
+      <ul>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.ConnectReasonCode.BAD_USERNAME_OR_PASSWORD">(awscrt.mqtt5.ConnectReasonCode attribute)</a>
+</li>
+      </ul></li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.ConnectReasonCode.BANNED">BANNED (awscrt.mqtt5.ConnectReasonCode attribute)</a>
+</li>
+      <li><a href="api/http.html#awscrt.http.HttpProxyAuthenticationType.Basic">Basic (awscrt.http.HttpProxyAuthenticationType attribute)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api/websocket.html#awscrt.websocket.Opcode.BINARY">BINARY (awscrt.websocket.Opcode attribute)</a>
+</li>
+      <li><a href="api/s3.html#awscrt.s3.S3ResponseError.body">body (awscrt.s3.S3ResponseError attribute)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.HeaderType.BOOL_FALSE">BOOL_FALSE (awscrt.eventstream.HeaderType attribute)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.HeaderType.BOOL_TRUE">BOOL_TRUE (awscrt.eventstream.HeaderType attribute)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.HeaderType.BYTE">BYTE (awscrt.eventstream.HeaderType attribute)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.HeaderType.BYTE_BUF">BYTE_BUF (awscrt.eventstream.HeaderType attribute)</a>
+</li>
+  </ul></td>
+</tr></table>
+
+<h2 id="C">C</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api/io.html#awscrt.io.TlsContextOptions.cipher_pref">cipher_pref (awscrt.io.TlsContextOptions attribute)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.ClientSessionBehaviorType.CLEAN">CLEAN (awscrt.mqtt5.ClientSessionBehaviorType attribute)</a>
+</li>
+      <li><a href="api/http.html#awscrt.http.HttpHeaders.clear">clear() (awscrt.http.HttpHeaders method)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.WebsocketHandshakeTransformArgs.client">client (awscrt.mqtt5.WebsocketHandshakeTransformArgs attribute)</a>
+</li>
+      <li><a href="api/mqtt.html#awscrt.mqtt.Client">Client (class in awscrt.mqtt)</a>
+
+      <ul>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.Client">(class in awscrt.mqtt5)</a>
+</li>
+      </ul></li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.ConnectReasonCode.CLIENT_IDENTIFIER_NOT_VALID">CLIENT_IDENTIFIER_NOT_VALID (awscrt.mqtt5.ConnectReasonCode attribute)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.ClientBootstrap">ClientBootstrap (class in awscrt.io)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.rpc.ClientConnection">ClientConnection (class in awscrt.eventstream.rpc)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.rpc.ClientConnectionHandler">ClientConnectionHandler (class in awscrt.eventstream.rpc)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.rpc.ClientContinuation">ClientContinuation (class in awscrt.eventstream.rpc)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.rpc.ClientContinuationHandler">ClientContinuationHandler (class in awscrt.eventstream.rpc)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.ClientOperationQueueBehaviorType">ClientOperationQueueBehaviorType (class in awscrt.mqtt5)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.ClientOptions">ClientOptions (class in awscrt.mqtt5)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.ClientSessionBehaviorType">ClientSessionBehaviorType (class in awscrt.mqtt5)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.ClientTlsContext">ClientTlsContext (class in awscrt.io)</a>
+</li>
+      <li><a href="api/websocket.html#awscrt.websocket.Opcode.CLOSE">CLOSE (awscrt.websocket.Opcode attribute)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.rpc.ClientConnection.close">close() (awscrt.eventstream.rpc.ClientConnection method)</a>
+
+      <ul>
+        <li><a href="api/http.html#awscrt.http.HttpClientConnection.close">(awscrt.http.HttpClientConnection method)</a>
+</li>
+        <li><a href="api/websocket.html#awscrt.websocket.WebSocket.close">(awscrt.websocket.WebSocket method)</a>
+</li>
+      </ul></li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.rpc.ClientContinuation.closed_future">closed_future (awscrt.eventstream.rpc.ClientContinuation attribute)</a>
+</li>
+      <li><a href="api/exceptions.html#awscrt.exceptions.AwsCrtError.code">code (awscrt.exceptions.AwsCrtError attribute)</a>
+
+      <ul>
+        <li><a href="api/s3.html#awscrt.s3.S3ResponseError.code">(awscrt.s3.S3ResponseError attribute)</a>
+</li>
+      </ul></li>
+      <li><a href="api/http.html#awscrt.http.HttpClientStream.completion_future">completion_future (awscrt.http.HttpClientStream attribute)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.ConnackPacket">ConnackPacket (class in awscrt.mqtt5)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.rpc.MessageType.CONNECT">CONNECT (awscrt.eventstream.rpc.MessageType attribute)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.rpc.ClientConnection.connect">connect() (awscrt.eventstream.rpc.ClientConnection class method)</a>
+
+      <ul>
+        <li><a href="api/mqtt.html#awscrt.mqtt.Connection.connect">(awscrt.mqtt.Connection method)</a>
+</li>
+        <li><a href="api/websocket.html#awscrt.websocket.connect">(in module awscrt.websocket)</a>
+</li>
+      </ul></li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api/eventstream.html#awscrt.eventstream.rpc.MessageType.CONNECT_ACK">CONNECT_ACK (awscrt.eventstream.rpc.MessageType attribute)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.SocketOptions.connect_timeout_ms">connect_timeout_ms (awscrt.io.SocketOptions attribute)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.rpc.ClientContinuation.connection">connection (awscrt.eventstream.rpc.ClientContinuation attribute)</a>
+
+      <ul>
+        <li><a href="api/http.html#awscrt.http.HttpClientStream.connection">(awscrt.http.HttpClientStream attribute)</a>
+</li>
+      </ul></li>
+      <li><a href="api/mqtt.html#awscrt.mqtt.Connection">Connection (class in awscrt.mqtt)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.rpc.MessageFlag.CONNECTION_ACCEPTED">CONNECTION_ACCEPTED (awscrt.eventstream.rpc.MessageFlag attribute)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.ConnectReasonCode.CONNECTION_RATE_EXCEEDED">CONNECTION_RATE_EXCEEDED (awscrt.mqtt5.ConnectReasonCode attribute)</a>
+
+      <ul>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.DisconnectReasonCode.CONNECTION_RATE_EXCEEDED">(awscrt.mqtt5.DisconnectReasonCode attribute)</a>
+</li>
+      </ul></li>
+      <li><a href="api/http.html#awscrt.http.HttpProxyOptions.connection_type">connection_type (awscrt.http.HttpProxyOptions attribute)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.ConnectPacket">ConnectPacket (class in awscrt.mqtt5)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.ConnectReasonCode">ConnectReasonCode (class in awscrt.mqtt5)</a>
+</li>
+      <li><a href="api/mqtt.html#awscrt.mqtt.ConnectReturnCode">ConnectReturnCode (class in awscrt.mqtt)</a>
+</li>
+      <li><a href="api/websocket.html#awscrt.websocket.Opcode.CONTINUATION">CONTINUATION (awscrt.websocket.Opcode attribute)</a>
+</li>
+      <li><a href="api/s3.html#awscrt.s3.S3ChecksumAlgorithm.CRC32">CRC32 (awscrt.s3.S3ChecksumAlgorithm attribute)</a>
+</li>
+      <li><a href="api/s3.html#awscrt.s3.S3ChecksumAlgorithm.CRC32C">CRC32C (awscrt.s3.S3ChecksumAlgorithm attribute)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.TlsContextOptions.create_client_with_mtls">create_client_with_mtls() (awscrt.io.TlsContextOptions static method)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.TlsContextOptions.create_client_with_mtls_from_path">create_client_with_mtls_from_path() (awscrt.io.TlsContextOptions static method)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.TlsContextOptions.create_client_with_mtls_pkcs11">create_client_with_mtls_pkcs11() (awscrt.io.TlsContextOptions static method)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.TlsContextOptions.create_client_with_mtls_pkcs12">create_client_with_mtls_pkcs12() (awscrt.io.TlsContextOptions static method)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.TlsContextOptions.create_client_with_mtls_windows_cert_store_path">create_client_with_mtls_windows_cert_store_path() (awscrt.io.TlsContextOptions static method)</a>
+</li>
+      <li><a href="api/s3.html#awscrt.s3.create_default_s3_signing_config">create_default_s3_signing_config() (in module awscrt.s3)</a>
+</li>
+      <li><a href="api/websocket.html#awscrt.websocket.create_handshake_request">create_handshake_request() (in module awscrt.websocket)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.TlsContextOptions.create_server">create_server() (awscrt.io.TlsContextOptions static method)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.TlsContextOptions.create_server_from_path">create_server_from_path() (awscrt.io.TlsContextOptions static method)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.TlsContextOptions.create_server_pkcs12">create_server_pkcs12() (awscrt.io.TlsContextOptions static method)</a>
+</li>
+      <li><a href="api/s3.html#awscrt.s3.credential_provider">credential_provider (in module awscrt.s3)</a>
+</li>
+      <li><a href="api/auth.html#awscrt.auth.AwsSigningConfig.credentials_provider">credentials_provider (awscrt.auth.AwsSigningConfig property)</a>
+</li>
+      <li><a href="api/s3.html#awscrt.s3.CrossProcessLock">CrossProcessLock (class in awscrt.s3)</a>
+</li>
+  </ul></td>
+</tr></table>
+
+<h2 id="D">D</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api/websocket.html#awscrt.websocket.OnIncomingFramePayloadData.data">data (awscrt.websocket.OnIncomingFramePayloadData attribute)</a>
+</li>
+      <li><a href="api/auth.html#awscrt.auth.AwsSigningConfig.date">date (awscrt.auth.AwsSigningConfig property)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.LogLevel.Debug">Debug (awscrt.io.LogLevel attribute)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.ExponentialBackoffJitterMode.DECORRELATED">DECORRELATED (awscrt.mqtt5.ExponentialBackoffJitterMode attribute)</a>
+</li>
+      <li><a href="api/crypto.html#awscrt.crypto.RSA.decrypt">decrypt() (awscrt.crypto.RSA method)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.Pkcs11Lib.InitializeFinalizeBehavior.DEFAULT">DEFAULT (awscrt.io.Pkcs11Lib.InitializeFinalizeBehavior attribute)</a>
+
+      <ul>
+        <li><a href="api/io.html#awscrt.io.TlsCipherPref.DEFAULT">(awscrt.io.TlsCipherPref attribute)</a>
+</li>
+        <li><a href="api/io.html#awscrt.io.TlsVersion.DEFAULT">(awscrt.io.TlsVersion attribute)</a>
+</li>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.ClientOperationQueueBehaviorType.DEFAULT">(awscrt.mqtt5.ClientOperationQueueBehaviorType attribute)</a>
+</li>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.ClientSessionBehaviorType.DEFAULT">(awscrt.mqtt5.ClientSessionBehaviorType attribute)</a>
+</li>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.ExponentialBackoffJitterMode.DEFAULT">(awscrt.mqtt5.ExponentialBackoffJitterMode attribute)</a>
+</li>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.InboundTopicAliasBehaviorType.DEFAULT">(awscrt.mqtt5.InboundTopicAliasBehaviorType attribute)</a>
+</li>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.OutboundTopicAliasBehaviorType.DEFAULT">(awscrt.mqtt5.OutboundTopicAliasBehaviorType attribute)</a>
+</li>
+        <li><a href="api/s3.html#awscrt.s3.S3RequestType.DEFAULT">(awscrt.s3.S3RequestType attribute)</a>
+</li>
+      </ul></li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api/io.html#awscrt.io.DefaultHostResolver">DefaultHostResolver (class in awscrt.io)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.SocketType.DGram">DGram (awscrt.io.SocketType attribute)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.InboundTopicAliasBehaviorType.DISABLED">DISABLED (awscrt.mqtt5.InboundTopicAliasBehaviorType attribute)</a>
+
+      <ul>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.OutboundTopicAliasBehaviorType.DISABLED">(awscrt.mqtt5.OutboundTopicAliasBehaviorType attribute)</a>
+</li>
+        <li><a href="api/s3.html#awscrt.s3.S3RequestTlsMode.DISABLED">(awscrt.s3.S3RequestTlsMode attribute)</a>
+</li>
+      </ul></li>
+      <li><a href="api/mqtt.html#awscrt.mqtt.Connection.disconnect">disconnect() (awscrt.mqtt.Connection method)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.DisconnectReasonCode.DISCONNECT_WITH_WILL_MESSAGE">DISCONNECT_WITH_WILL_MESSAGE (awscrt.mqtt5.DisconnectReasonCode attribute)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.DisconnectPacket">DisconnectPacket (class in awscrt.mqtt5)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.DisconnectReasonCode">DisconnectReasonCode (class in awscrt.mqtt5)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.SocketOptions.domain">domain (awscrt.io.SocketOptions attribute)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.RetainAndHandlingType.DONT_SEND">DONT_SEND (awscrt.mqtt5.RetainAndHandlingType attribute)</a>
+
+      <ul>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.RetainHandlingType.DONT_SEND">(awscrt.mqtt5.RetainHandlingType attribute)</a>
+</li>
+      </ul></li>
+  </ul></td>
+</tr></table>
+
+<h2 id="E">E</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api/auth.html#awscrt.auth.AwsSignedBodyValue.EMPTY_SHA256">EMPTY_SHA256 (awscrt.auth.AwsSignedBodyValue attribute)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.InboundTopicAliasBehaviorType.ENABLED">ENABLED (awscrt.mqtt5.InboundTopicAliasBehaviorType attribute)</a>
+
+      <ul>
+        <li><a href="api/s3.html#awscrt.s3.S3RequestTlsMode.ENABLED">(awscrt.s3.S3RequestTlsMode attribute)</a>
+</li>
+      </ul></li>
+      <li><a href="api/crypto.html#awscrt.crypto.RSA.encrypt">encrypt() (awscrt.crypto.RSA method)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.LogLevel.Error">Error (awscrt.io.LogLevel attribute)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.EventLoopGroup">EventLoopGroup (class in awscrt.io)</a>
+</li>
+      <li><a href="api/mqtt.html#awscrt.mqtt.QoS.EXACTLY_ONCE">EXACTLY_ONCE (awscrt.mqtt.QoS attribute)</a>
+
+      <ul>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.QoS.EXACTLY_ONCE">(awscrt.mqtt5.QoS attribute)</a>
+</li>
+      </ul></li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api/websocket.html#awscrt.websocket.OnConnectionSetupData.exception">exception (awscrt.websocket.OnConnectionSetupData attribute)</a>
+
+      <ul>
+        <li><a href="api/websocket.html#awscrt.websocket.OnConnectionShutdownData.exception">(awscrt.websocket.OnConnectionShutdownData attribute)</a>
+</li>
+        <li><a href="api/websocket.html#awscrt.websocket.OnIncomingFrameCompleteData.exception">(awscrt.websocket.OnIncomingFrameCompleteData attribute)</a>
+</li>
+        <li><a href="api/websocket.html#awscrt.websocket.OnSendFrameCompleteData.exception">(awscrt.websocket.OnSendFrameCompleteData attribute)</a>
+</li>
+      </ul></li>
+      <li><a href="api/auth.html#awscrt.auth.AwsCredentials.expiration">expiration (awscrt.auth.AwsCredentials attribute)</a>
+</li>
+      <li><a href="api/auth.html#awscrt.auth.AwsSigningConfig.expiration_in_seconds">expiration_in_seconds (awscrt.auth.AwsSigningConfig property)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.ExponentialBackoffJitterMode">ExponentialBackoffJitterMode (class in awscrt.mqtt5)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.ExtendedValidationAndFlowControlOptions">ExtendedValidationAndFlowControlOptions (class in awscrt.mqtt5)</a>
+</li>
+  </ul></td>
+</tr></table>
+
+<h2 id="F">F</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.ClientOperationQueueBehaviorType.FAIL_ALL_ON_DISCONNECT">FAIL_ALL_ON_DISCONNECT (awscrt.mqtt5.ClientOperationQueueBehaviorType attribute)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.ClientOperationQueueBehaviorType.FAIL_NON_QOS1_PUBLISH_ON_DISCONNECT">FAIL_NON_QOS1_PUBLISH_ON_DISCONNECT (awscrt.mqtt5.ClientOperationQueueBehaviorType attribute)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.ClientOperationQueueBehaviorType.FAIL_QOS0_PUBLISH_ON_DISCONNECT">FAIL_QOS0_PUBLISH_ON_DISCONNECT (awscrt.mqtt5.ClientOperationQueueBehaviorType attribute)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.LogLevel.Fatal">Fatal (awscrt.io.LogLevel attribute)</a>
+</li>
+      <li><a href="api/websocket.html#awscrt.websocket.IncomingFrame.fin">fin (awscrt.websocket.IncomingFrame attribute)</a>
+</li>
+      <li><a href="api/s3.html#awscrt.s3.S3Request.finished_future">finished_future (awscrt.s3.S3Request attribute)</a>
+</li>
+      <li><a href="api/http.html#awscrt.http.HttpProxyConnectionType.Forwarding">Forwarding (awscrt.http.HttpProxyConnectionType attribute)</a>
+</li>
+      <li><a href="api/websocket.html#awscrt.websocket.OnIncomingFrameBeginData.frame">frame (awscrt.websocket.OnIncomingFrameBeginData attribute)</a>
+
+      <ul>
+        <li><a href="api/websocket.html#awscrt.websocket.OnIncomingFrameCompleteData.frame">(awscrt.websocket.OnIncomingFrameCompleteData attribute)</a>
+</li>
+        <li><a href="api/websocket.html#awscrt.websocket.OnIncomingFramePayloadData.frame">(awscrt.websocket.OnIncomingFramePayloadData attribute)</a>
+</li>
+      </ul></li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api/eventstream.html#awscrt.eventstream.Header.from_bool">from_bool() (awscrt.eventstream.Header class method)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.Header.from_byte">from_byte() (awscrt.eventstream.Header class method)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.Header.from_byte_buf">from_byte_buf() (awscrt.eventstream.Header class method)</a>
+</li>
+      <li><a href="api/exceptions.html#awscrt.exceptions.from_code">from_code() (in module awscrt.exceptions)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.Header.from_int16">from_int16() (awscrt.eventstream.Header class method)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.Header.from_int32">from_int32() (awscrt.eventstream.Header class method)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.Header.from_int64">from_int64() (awscrt.eventstream.Header class method)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.Header.from_string">from_string() (awscrt.eventstream.Header class method)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.Header.from_timestamp">from_timestamp() (awscrt.eventstream.Header class method)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.Header.from_uuid">from_uuid() (awscrt.eventstream.Header class method)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.ExponentialBackoffJitterMode.FULL">FULL (awscrt.mqtt5.ExponentialBackoffJitterMode attribute)</a>
+</li>
+  </ul></td>
+</tr></table>
+
+<h2 id="G">G</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api/http.html#awscrt.http.HttpHeaders.get">get() (awscrt.http.HttpHeaders method)</a>
+</li>
+      <li><a href="api/common.html#awscrt.common.get_cpu_count_for_group">get_cpu_count_for_group() (in module awscrt.common)</a>
+</li>
+      <li><a href="api/common.html#awscrt.common.get_cpu_group_count">get_cpu_group_count() (in module awscrt.common)</a>
+</li>
+      <li><a href="api/auth.html#awscrt.auth.AwsCredentialsProvider.get_credentials">get_credentials() (awscrt.auth.AwsCredentialsProvider method)</a>
+</li>
+      <li><a href="api/s3.html#awscrt.s3.get_ec2_instance_type">get_ec2_instance_type() (in module awscrt.s3)</a>
+</li>
+      <li><a href="api/s3.html#awscrt.s3.S3RequestType.GET_OBJECT">GET_OBJECT (awscrt.s3.S3RequestType attribute)</a>
+</li>
+      <li><a href="api/s3.html#awscrt.s3.get_optimized_platforms">get_optimized_platforms() (in module awscrt.s3)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api/s3.html#awscrt.s3.get_recommended_throughput_target_gbps">get_recommended_throughput_target_gbps() (in module awscrt.s3)</a>
+</li>
+      <li><a href="api/mqtt.html#awscrt.mqtt.Connection.get_stats">get_stats() (awscrt.mqtt.Connection method)</a>
+
+      <ul>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.Client.get_stats">(awscrt.mqtt5.Client method)</a>
+</li>
+      </ul></li>
+      <li><a href="api/http.html#awscrt.http.HttpHeaders.get_values">get_values() (awscrt.http.HttpHeaders method)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.SubackReasonCode.GRANTED_QOS_0">GRANTED_QOS_0 (awscrt.mqtt5.SubackReasonCode attribute)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.SubackReasonCode.GRANTED_QOS_1">GRANTED_QOS_1 (awscrt.mqtt5.SubackReasonCode attribute)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.SubackReasonCode.GRANTED_QOS_2">GRANTED_QOS_2 (awscrt.mqtt5.SubackReasonCode attribute)</a>
+</li>
+  </ul></td>
+</tr></table>
+
+<h2 id="H">H</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api/websocket.html#awscrt.websocket.OnConnectionSetupData.handshake_response_body">handshake_response_body (awscrt.websocket.OnConnectionSetupData attribute)</a>
+</li>
+      <li><a href="api/websocket.html#awscrt.websocket.OnConnectionSetupData.handshake_response_headers">handshake_response_headers (awscrt.websocket.OnConnectionSetupData attribute)</a>
+</li>
+      <li><a href="api/websocket.html#awscrt.websocket.OnConnectionSetupData.handshake_response_status">handshake_response_status (awscrt.websocket.OnConnectionSetupData attribute)</a>
+</li>
+      <li><a href="api/s3.html#awscrt.s3.S3ChecksumLocation.HEADER">HEADER (awscrt.s3.S3ChecksumLocation attribute)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.Header">Header (class in awscrt.eventstream)</a>
+</li>
+      <li><a href="api/http.html#awscrt.http.HttpRequest.headers">headers (awscrt.http.HttpRequest property)</a>
+
+      <ul>
+        <li><a href="api/s3.html#awscrt.s3.S3ResponseError.headers">(awscrt.s3.S3ResponseError attribute)</a>
+</li>
+      </ul></li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.HeaderType">HeaderType (class in awscrt.eventstream)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.rpc.ClientConnection.host_name">host_name (awscrt.eventstream.rpc.ClientConnection attribute)</a>
+
+      <ul>
+        <li><a href="api/http.html#awscrt.http.HttpClientConnection.host_name">(awscrt.http.HttpClientConnection property)</a>
+</li>
+        <li><a href="api/http.html#awscrt.http.HttpProxyOptions.host_name">(awscrt.http.HttpProxyOptions attribute)</a>
+</li>
+      </ul></li>
+      <li><a href="api/io.html#awscrt.io.HostResolverBase">HostResolverBase (class in awscrt.io)</a>
+</li>
+      <li><a href="api/http.html#awscrt.http.HttpVersion.Http1_0">Http1_0 (awscrt.http.HttpVersion attribute)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api/http.html#awscrt.http.HttpVersion.Http1_1">Http1_1 (awscrt.http.HttpVersion attribute)</a>
+</li>
+      <li><a href="api/http.html#awscrt.http.HttpVersion.Http2">Http2 (awscrt.http.HttpVersion attribute)</a>
+</li>
+      <li><a href="api/mqtt.html#awscrt.mqtt.WebsocketHandshakeTransformArgs.http_request">http_request (awscrt.mqtt.WebsocketHandshakeTransformArgs attribute)</a>
+
+      <ul>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.WebsocketHandshakeTransformArgs.http_request">(awscrt.mqtt5.WebsocketHandshakeTransformArgs attribute)</a>
+</li>
+      </ul></li>
+      <li><a href="api/auth.html#awscrt.auth.AwsSignatureType.HTTP_REQUEST_HEADERS">HTTP_REQUEST_HEADERS (awscrt.auth.AwsSignatureType attribute)</a>
+</li>
+      <li><a href="api/auth.html#awscrt.auth.AwsSignatureType.HTTP_REQUEST_QUERY_PARAMS">HTTP_REQUEST_QUERY_PARAMS (awscrt.auth.AwsSignatureType attribute)</a>
+</li>
+      <li><a href="api/http.html#awscrt.http.HttpClientConnection">HttpClientConnection (class in awscrt.http)</a>
+</li>
+      <li><a href="api/http.html#awscrt.http.HttpClientStream">HttpClientStream (class in awscrt.http)</a>
+</li>
+      <li><a href="api/http.html#awscrt.http.HttpHeaders">HttpHeaders (class in awscrt.http)</a>
+</li>
+      <li><a href="api/http.html#awscrt.http.HttpProxyAuthenticationType">HttpProxyAuthenticationType (class in awscrt.http)</a>
+</li>
+      <li><a href="api/http.html#awscrt.http.HttpProxyConnectionType">HttpProxyConnectionType (class in awscrt.http)</a>
+</li>
+      <li><a href="api/http.html#awscrt.http.HttpProxyOptions">HttpProxyOptions (class in awscrt.http)</a>
+</li>
+      <li><a href="api/http.html#awscrt.http.HttpRequest">HttpRequest (class in awscrt.http)</a>
+</li>
+      <li><a href="api/http.html#awscrt.http.HttpVersion">HttpVersion (class in awscrt.http)</a>
+</li>
+  </ul></td>
+</tr></table>
+
+<h2 id="I">I</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api/mqtt.html#awscrt.mqtt.ConnectReturnCode.IDENTIFIER_REJECTED">IDENTIFIER_REJECTED (awscrt.mqtt.ConnectReturnCode attribute)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.ConnectReasonCode.IMPLEMENTATION_SPECIFIC_ERROR">IMPLEMENTATION_SPECIFIC_ERROR (awscrt.mqtt5.ConnectReasonCode attribute)</a>
+
+      <ul>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.DisconnectReasonCode.IMPLEMENTATION_SPECIFIC_ERROR">(awscrt.mqtt5.DisconnectReasonCode attribute)</a>
+</li>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.PubackReasonCode.IMPLEMENTATION_SPECIFIC_ERROR">(awscrt.mqtt5.PubackReasonCode attribute)</a>
+</li>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.SubackReasonCode.IMPLEMENTATION_SPECIFIC_ERROR">(awscrt.mqtt5.SubackReasonCode attribute)</a>
+</li>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.UnsubackReasonCode.IMPLEMENTATION_SPECIFIC_ERROR">(awscrt.mqtt5.UnsubackReasonCode attribute)</a>
+</li>
+      </ul></li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.InboundTopicAliasBehaviorType">InboundTopicAliasBehaviorType (class in awscrt.mqtt5)</a>
+</li>
+      <li><a href="api/websocket.html#awscrt.websocket.IncomingFrame">IncomingFrame (class in awscrt.websocket)</a>
+</li>
+      <li><a href="api/websocket.html#awscrt.websocket.WebSocket.increment_read_window">increment_read_window() (awscrt.websocket.WebSocket method)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.LogLevel.Info">Info (awscrt.io.LogLevel attribute)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.init_logging">init_logging() (in module awscrt.io)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.InputStream">InputStream (class in awscrt.io)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api/eventstream.html#awscrt.eventstream.HeaderType.INT16">INT16 (awscrt.eventstream.HeaderType attribute)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.HeaderType.INT32">INT32 (awscrt.eventstream.HeaderType attribute)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.HeaderType.INT64">INT64 (awscrt.eventstream.HeaderType attribute)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.rpc.MessageType.INTERNAL_ERROR">INTERNAL_ERROR (awscrt.eventstream.rpc.MessageType attribute)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.SocketDomain.IPv4">IPv4 (awscrt.io.SocketDomain attribute)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.SocketDomain.IPv6">IPv6 (awscrt.io.SocketDomain attribute)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.is_alpn_available">is_alpn_available() (in module awscrt.io)</a>
+</li>
+      <li><a href="api/websocket.html#awscrt.websocket.IncomingFrame.is_data_frame">is_data_frame() (awscrt.websocket.IncomingFrame method)</a>
+
+      <ul>
+        <li><a href="api/websocket.html#awscrt.websocket.Opcode.is_data_frame">(awscrt.websocket.Opcode method)</a>
+</li>
+      </ul></li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.rpc.ClientConnection.is_open">is_open() (awscrt.eventstream.rpc.ClientConnection method)</a>
+
+      <ul>
+        <li><a href="api/http.html#awscrt.http.HttpClientConnection.is_open">(awscrt.http.HttpClientConnection method)</a>
+</li>
+      </ul></li>
+      <li><a href="api/s3.html#awscrt.s3.is_optimized_for_system">is_optimized_for_system() (in module awscrt.s3)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.TlsCipherPref.is_supported">is_supported() (awscrt.io.TlsCipherPref method)</a>
+</li>
+  </ul></td>
+</tr></table>
+
+<h2 id="K">K</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api/io.html#awscrt.io.SocketOptions.keep_alive">keep_alive (awscrt.io.SocketOptions attribute)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.SocketOptions.keep_alive_interval_secs">keep_alive_interval_secs (awscrt.io.SocketOptions attribute)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api/io.html#awscrt.io.SocketOptions.keep_alive_max_probes">keep_alive_max_probes (awscrt.io.SocketOptions attribute)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.DisconnectReasonCode.KEEP_ALIVE_TIMEOUT">KEEP_ALIVE_TIMEOUT (awscrt.mqtt5.DisconnectReasonCode attribute)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.SocketOptions.keep_alive_timeout_secs">keep_alive_timeout_secs (awscrt.io.SocketOptions attribute)</a>
+</li>
+  </ul></td>
+</tr></table>
+
+<h2 id="L">L</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api/http.html#awscrt.http.HttpProxyConnectionType.Legacy">Legacy (awscrt.http.HttpProxyConnectionType attribute)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.LifecycleAttemptingConnectData">LifecycleAttemptingConnectData (class in awscrt.mqtt5)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.LifecycleConnectFailureData">LifecycleConnectFailureData (class in awscrt.mqtt5)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.LifecycleConnectSuccessData">LifecycleConnectSuccessData (class in awscrt.mqtt5)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.LifecycleDisconnectData">LifecycleDisconnectData (class in awscrt.mqtt5)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.LifecycleStoppedData">LifecycleStoppedData (class in awscrt.mqtt5)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.SocketDomain.Local">Local (awscrt.io.SocketDomain attribute)</a>
+</li>
+      <li><a href="api/s3.html#awscrt.s3.S3ChecksumConfig.location">location (awscrt.s3.S3ChecksumConfig attribute)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.LogLevel">LogLevel (class in awscrt.io)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.OutboundTopicAliasBehaviorType.LRU">LRU (awscrt.mqtt5.OutboundTopicAliasBehaviorType attribute)</a>
+</li>
+  </ul></td>
+</tr></table>
+
+<h2 id="M">M</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api/s3.html#awscrt.s3.S3Client.make_request">make_request() (awscrt.s3.S3Client method)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.ConnectReasonCode.MALFORMED_PACKET">MALFORMED_PACKET (awscrt.mqtt5.ConnectReasonCode attribute)</a>
+
+      <ul>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.DisconnectReasonCode.MALFORMED_PACKET">(awscrt.mqtt5.DisconnectReasonCode attribute)</a>
+</li>
+      </ul></li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.OutboundTopicAliasBehaviorType.MANUAL">MANUAL (awscrt.mqtt5.OutboundTopicAliasBehaviorType attribute)</a>
+</li>
+      <li><a href="api/websocket.html#awscrt.websocket.MAX_PAYLOAD_LENGTH">MAX_PAYLOAD_LENGTH (in module awscrt.websocket)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.DisconnectReasonCode.MAXIMUM_CONNECT_TIME">MAXIMUM_CONNECT_TIME (awscrt.mqtt5.DisconnectReasonCode attribute)</a>
+</li>
+      <li><a href="api/exceptions.html#awscrt.exceptions.AwsCrtError.message">message (awscrt.exceptions.AwsCrtError attribute)</a>
+
+      <ul>
+        <li><a href="api/s3.html#awscrt.s3.S3ResponseError.message">(awscrt.s3.S3ResponseError attribute)</a>
+</li>
+      </ul></li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.DisconnectReasonCode.MESSAGE_RATE_TOO_HIGH">MESSAGE_RATE_TOO_HIGH (awscrt.mqtt5.DisconnectReasonCode attribute)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.rpc.MessageFlag">MessageFlag (class in awscrt.eventstream.rpc)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.rpc.MessageType">MessageType (class in awscrt.eventstream.rpc)</a>
+</li>
+      <li><a href="api/http.html#awscrt.http.HttpRequest.method">method (awscrt.http.HttpRequest property)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.TlsContextOptions.min_tls_ver">min_tls_ver (awscrt.io.TlsContextOptions attribute)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li>
+    module
+
+      <ul>
+        <li><a href="api/auth.html#module-awscrt.auth">awscrt.auth</a>
+</li>
+        <li><a href="api/common.html#module-awscrt.common">awscrt.common</a>
+</li>
+        <li><a href="api/crypto.html#module-awscrt.crypto">awscrt.crypto</a>
+</li>
+        <li><a href="api/eventstream.html#module-awscrt.eventstream">awscrt.eventstream</a>
+</li>
+        <li><a href="api/eventstream.html#module-awscrt.eventstream.rpc">awscrt.eventstream.rpc</a>
+</li>
+        <li><a href="api/exceptions.html#module-awscrt.exceptions">awscrt.exceptions</a>
+</li>
+        <li><a href="api/http.html#module-awscrt.http">awscrt.http</a>
+</li>
+        <li><a href="api/io.html#module-awscrt.io">awscrt.io</a>
+</li>
+        <li><a href="api/mqtt.html#module-awscrt.mqtt">awscrt.mqtt</a>
+</li>
+        <li><a href="api/mqtt5.html#module-awscrt.mqtt5">awscrt.mqtt5</a>
+</li>
+        <li><a href="api/s3.html#module-awscrt.s3">awscrt.s3</a>
+</li>
+        <li><a href="api/websocket.html#module-awscrt.websocket">awscrt.websocket</a>
+</li>
+      </ul></li>
+      <li><a href="api/mqtt.html#awscrt.mqtt.WebsocketHandshakeTransformArgs.mqtt_connection">mqtt_connection (awscrt.mqtt.WebsocketHandshakeTransformArgs attribute)</a>
+</li>
+  </ul></td>
+</tr></table>
+
+<h2 id="N">N</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api/eventstream.html#awscrt.eventstream.Header.name">name (awscrt.eventstream.Header property)</a>
+
+      <ul>
+        <li><a href="api/exceptions.html#awscrt.exceptions.AwsCrtError.name">(awscrt.exceptions.AwsCrtError attribute)</a>
+</li>
+        <li><a href="api/s3.html#awscrt.s3.S3ResponseError.name">(awscrt.s3.S3ResponseError attribute)</a>
+</li>
+      </ul></li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.NegotiatedSettings">NegotiatedSettings (class in awscrt.mqtt5)</a>
+</li>
+      <li><a href="api/http.html#awscrt.http.HttpClientConnection.new">new() (awscrt.http.HttpClientConnection class method)</a>
+</li>
+      <li><a href="api/auth.html#awscrt.auth.AwsCredentialsProvider.new_chain">new_chain() (awscrt.auth.AwsCredentialsProvider class method)</a>
+</li>
+      <li><a href="api/auth.html#awscrt.auth.AwsCredentialsProvider.new_cognito">new_cognito() (awscrt.auth.AwsCredentialsProvider class method)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.ClientTlsContext.new_connection_options">new_connection_options() (awscrt.io.ClientTlsContext method)</a>
+</li>
+      <li><a href="api/auth.html#awscrt.auth.AwsCredentialsProvider.new_default_chain">new_default_chain() (awscrt.auth.AwsCredentialsProvider class method)</a>
+</li>
+      <li><a href="api/auth.html#awscrt.auth.AwsCredentialsProvider.new_delegate">new_delegate() (awscrt.auth.AwsCredentialsProvider class method)</a>
+</li>
+      <li><a href="api/auth.html#awscrt.auth.AwsCredentialsProvider.new_environment">new_environment() (awscrt.auth.AwsCredentialsProvider class method)</a>
+</li>
+      <li><a href="api/crypto.html#awscrt.crypto.RSA.new_private_key_from_pem_data">new_private_key_from_pem_data() (awscrt.crypto.RSA static method)</a>
+</li>
+      <li><a href="api/auth.html#awscrt.auth.AwsCredentialsProvider.new_process">new_process() (awscrt.auth.AwsCredentialsProvider class method)</a>
+</li>
+      <li><a href="api/auth.html#awscrt.auth.AwsCredentialsProvider.new_profile">new_profile() (awscrt.auth.AwsCredentialsProvider class method)</a>
+</li>
+      <li><a href="api/crypto.html#awscrt.crypto.RSA.new_public_key_from_pem_data">new_public_key_from_pem_data() (awscrt.crypto.RSA static method)</a>
+</li>
+      <li><a href="api/auth.html#awscrt.auth.AwsCredentialsProvider.new_static">new_static() (awscrt.auth.AwsCredentialsProvider class method)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api/eventstream.html#awscrt.eventstream.rpc.ClientConnection.new_stream">new_stream() (awscrt.eventstream.rpc.ClientConnection method)</a>
+</li>
+      <li><a href="api/auth.html#awscrt.auth.AwsCredentialsProvider.new_x509">new_x509() (awscrt.auth.AwsCredentialsProvider class method)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.PubackReasonCode.NO_MATCHING_SUBSCRIBERS">NO_MATCHING_SUBSCRIBERS (awscrt.mqtt5.PubackReasonCode attribute)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.UnsubackReasonCode.NO_SUBSCRIPTION_EXISTED">NO_SUBSCRIPTION_EXISTED (awscrt.mqtt5.UnsubackReasonCode attribute)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.LogLevel.NoLogs">NoLogs (awscrt.io.LogLevel attribute)</a>
+</li>
+      <li><a href="api/auth.html#awscrt.auth.AwsSignedBodyHeaderType.NONE">NONE (awscrt.auth.AwsSignedBodyHeaderType attribute)</a>
+
+      <ul>
+        <li><a href="api/eventstream.html#awscrt.eventstream.rpc.MessageFlag.NONE">(awscrt.eventstream.rpc.MessageFlag attribute)</a>
+</li>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.ExponentialBackoffJitterMode.NONE">(awscrt.mqtt5.ExponentialBackoffJitterMode attribute)</a>
+</li>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.ExtendedValidationAndFlowControlOptions.NONE">(awscrt.mqtt5.ExtendedValidationAndFlowControlOptions attribute)</a>
+</li>
+      </ul></li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.DisconnectReasonCode.NORMAL_DISCONNECTION">NORMAL_DISCONNECTION (awscrt.mqtt5.DisconnectReasonCode attribute)</a>
+</li>
+      <li><a href="api/mqtt.html#awscrt.mqtt.ConnectReturnCode.NOT_AUTHORIZED">NOT_AUTHORIZED (awscrt.mqtt.ConnectReturnCode attribute)</a>
+
+      <ul>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.ConnectReasonCode.NOT_AUTHORIZED">(awscrt.mqtt5.ConnectReasonCode attribute)</a>
+</li>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.DisconnectReasonCode.NOT_AUTHORIZED">(awscrt.mqtt5.DisconnectReasonCode attribute)</a>
+</li>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.PubackReasonCode.NOT_AUTHORIZED">(awscrt.mqtt5.PubackReasonCode attribute)</a>
+</li>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.SubackReasonCode.NOT_AUTHORIZED">(awscrt.mqtt5.SubackReasonCode attribute)</a>
+</li>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.UnsubackReasonCode.NOT_AUTHORIZED">(awscrt.mqtt5.UnsubackReasonCode attribute)</a>
+</li>
+      </ul></li>
+      <li><a href="api/http.html#awscrt.http.HttpProxyAuthenticationType.Nothing">Nothing (awscrt.http.HttpProxyAuthenticationType attribute)</a>
+</li>
+  </ul></td>
+</tr></table>
+
+<h2 id="O">O</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api/crypto.html#awscrt.crypto.RSAEncryptionAlgorithm.OAEP_SHA256">OAEP_SHA256 (awscrt.crypto.RSAEncryptionAlgorithm attribute)</a>
+</li>
+      <li><a href="api/crypto.html#awscrt.crypto.RSAEncryptionAlgorithm.OAEP_SHA512">OAEP_SHA512 (awscrt.crypto.RSAEncryptionAlgorithm attribute)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.Pkcs11Lib.InitializeFinalizeBehavior.OMIT">OMIT (awscrt.io.Pkcs11Lib.InitializeFinalizeBehavior attribute)</a>
+</li>
+      <li><a href="api/auth.html#awscrt.auth.AwsSigningConfig.omit_session_token">omit_session_token (awscrt.auth.AwsSigningConfig property)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.rpc.ClientConnectionHandler.on_connection_setup">on_connection_setup() (awscrt.eventstream.rpc.ClientConnectionHandler method)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.rpc.ClientConnectionHandler.on_connection_shutdown">on_connection_shutdown() (awscrt.eventstream.rpc.ClientConnectionHandler method)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.rpc.ClientContinuationHandler.on_continuation_closed">on_continuation_closed() (awscrt.eventstream.rpc.ClientContinuationHandler method)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.rpc.ClientContinuationHandler.on_continuation_message">on_continuation_message() (awscrt.eventstream.rpc.ClientContinuationHandler method)</a>
+</li>
+      <li><a href="api/mqtt.html#awscrt.mqtt.Connection.on_message">on_message() (awscrt.mqtt.Connection method)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.rpc.ClientConnectionHandler.on_protocol_message">on_protocol_message() (awscrt.eventstream.rpc.ClientConnectionHandler method)</a>
+</li>
+      <li><a href="api/mqtt.html#awscrt.mqtt.OnConnectionClosedData">OnConnectionClosedData (class in awscrt.mqtt)</a>
+</li>
+      <li><a href="api/mqtt.html#awscrt.mqtt.OnConnectionFailureData">OnConnectionFailureData (class in awscrt.mqtt)</a>
+</li>
+      <li><a href="api/websocket.html#awscrt.websocket.OnConnectionSetupData">OnConnectionSetupData (class in awscrt.websocket)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api/websocket.html#awscrt.websocket.OnConnectionShutdownData">OnConnectionShutdownData (class in awscrt.websocket)</a>
+</li>
+      <li><a href="api/mqtt.html#awscrt.mqtt.OnConnectionSuccessData">OnConnectionSuccessData (class in awscrt.mqtt)</a>
+</li>
+      <li><a href="api/websocket.html#awscrt.websocket.OnIncomingFrameBeginData">OnIncomingFrameBeginData (class in awscrt.websocket)</a>
+</li>
+      <li><a href="api/websocket.html#awscrt.websocket.OnIncomingFrameCompleteData">OnIncomingFrameCompleteData (class in awscrt.websocket)</a>
+</li>
+      <li><a href="api/websocket.html#awscrt.websocket.OnIncomingFramePayloadData">OnIncomingFramePayloadData (class in awscrt.websocket)</a>
+</li>
+      <li><a href="api/websocket.html#awscrt.websocket.OnSendFrameCompleteData">OnSendFrameCompleteData (class in awscrt.websocket)</a>
+</li>
+      <li><a href="api/websocket.html#awscrt.websocket.IncomingFrame.opcode">opcode (awscrt.websocket.IncomingFrame attribute)</a>
+</li>
+      <li><a href="api/websocket.html#awscrt.websocket.Opcode">Opcode (class in awscrt.websocket)</a>
+</li>
+      <li><a href="api/s3.html#awscrt.s3.S3ResponseError.operation_name">operation_name (awscrt.s3.S3ResponseError attribute)</a>
+</li>
+      <li><a href="api/mqtt.html#awscrt.mqtt.OperationStatisticsData">OperationStatisticsData (class in awscrt.mqtt)</a>
+
+      <ul>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.OperationStatisticsData">(class in awscrt.mqtt5)</a>
+</li>
+      </ul></li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.OutboundTopicAliasBehaviorType">OutboundTopicAliasBehaviorType (class in awscrt.mqtt5)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.TlsContextOptions.override_default_trust_store">override_default_trust_store() (awscrt.io.TlsContextOptions method)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.TlsContextOptions.override_default_trust_store_from_path">override_default_trust_store_from_path() (awscrt.io.TlsContextOptions method)</a>
+</li>
+  </ul></td>
+</tr></table>
+
+<h2 id="P">P</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.PubackReasonCode.PACKET_IDENTIFIER_IN_USE">PACKET_IDENTIFIER_IN_USE (awscrt.mqtt5.PubackReasonCode attribute)</a>
+
+      <ul>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.SubackReasonCode.PACKET_IDENTIFIER_IN_USE">(awscrt.mqtt5.SubackReasonCode attribute)</a>
+</li>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.UnsubackReasonCode.PACKET_IDENTIFIER_IN_USE">(awscrt.mqtt5.UnsubackReasonCode attribute)</a>
+</li>
+      </ul></li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.ConnectReasonCode.PACKET_TOO_LARGE">PACKET_TOO_LARGE (awscrt.mqtt5.ConnectReasonCode attribute)</a>
+
+      <ul>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.DisconnectReasonCode.PACKET_TOO_LARGE">(awscrt.mqtt5.DisconnectReasonCode attribute)</a>
+</li>
+      </ul></li>
+      <li><a href="api/http.html#awscrt.http.HttpRequest.path">path (awscrt.http.HttpRequest property)</a>
+</li>
+      <li><a href="api/mqtt.html#awscrt.mqtt.Will.payload">payload (awscrt.mqtt.Will attribute)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.ConnectReasonCode.PAYLOAD_FORMAT_INVALID">PAYLOAD_FORMAT_INVALID (awscrt.mqtt5.ConnectReasonCode attribute)</a>
+
+      <ul>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.DisconnectReasonCode.PAYLOAD_FORMAT_INVALID">(awscrt.mqtt5.DisconnectReasonCode attribute)</a>
+</li>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.PubackReasonCode.PAYLOAD_FORMAT_INVALID">(awscrt.mqtt5.PubackReasonCode attribute)</a>
+</li>
+      </ul></li>
+      <li><a href="api/websocket.html#awscrt.websocket.IncomingFrame.payload_length">payload_length (awscrt.websocket.IncomingFrame attribute)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.PayloadFormatIndicator">PayloadFormatIndicator (class in awscrt.mqtt5)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.rpc.MessageType.PING">PING (awscrt.eventstream.rpc.MessageType attribute)</a>
+
+      <ul>
+        <li><a href="api/websocket.html#awscrt.websocket.Opcode.PING">(awscrt.websocket.Opcode attribute)</a>
+</li>
+      </ul></li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.rpc.MessageType.PING_RESPONSE">PING_RESPONSE (awscrt.eventstream.rpc.MessageType attribute)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.Pkcs11Lib">Pkcs11Lib (class in awscrt.io)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.Pkcs11Lib.InitializeFinalizeBehavior">Pkcs11Lib.InitializeFinalizeBehavior (class in awscrt.io)</a>
+</li>
+      <li><a href="api/crypto.html#awscrt.crypto.RSAEncryptionAlgorithm.PKCS1_5">PKCS1_5 (awscrt.crypto.RSAEncryptionAlgorithm attribute)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api/crypto.html#awscrt.crypto.RSASignatureAlgorithm.PKCS1_5_SHA256">PKCS1_5_SHA256 (awscrt.crypto.RSASignatureAlgorithm attribute)</a>
+</li>
+      <li><a href="api/websocket.html#awscrt.websocket.Opcode.PONG">PONG (awscrt.websocket.Opcode attribute)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.rpc.ClientConnection.port">port (awscrt.eventstream.rpc.ClientConnection attribute)</a>
+
+      <ul>
+        <li><a href="api/http.html#awscrt.http.HttpClientConnection.port">(awscrt.http.HttpClientConnection property)</a>
+</li>
+        <li><a href="api/http.html#awscrt.http.HttpProxyOptions.port">(awscrt.http.HttpProxyOptions attribute)</a>
+</li>
+      </ul></li>
+      <li><a href="api/io.html#awscrt.io.TlsCipherPref.PQ_TLSv1_0_2021_05">PQ_TLSv1_0_2021_05 (awscrt.io.TlsCipherPref attribute)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.rpc.MessageType.PROTOCOL_ERROR">PROTOCOL_ERROR (awscrt.eventstream.rpc.MessageType attribute)</a>
+
+      <ul>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.ConnectReasonCode.PROTOCOL_ERROR">(awscrt.mqtt5.ConnectReasonCode attribute)</a>
+</li>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.DisconnectReasonCode.PROTOCOL_ERROR">(awscrt.mqtt5.DisconnectReasonCode attribute)</a>
+</li>
+      </ul></li>
+      <li><a href="api/crypto.html#awscrt.crypto.RSASignatureAlgorithm.PSS_SHA256">PSS_SHA256 (awscrt.crypto.RSASignatureAlgorithm attribute)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.PubackPacket">PubackPacket (class in awscrt.mqtt5)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.PubackReasonCode">PubackReasonCode (class in awscrt.mqtt5)</a>
+</li>
+      <li><a href="api/mqtt.html#awscrt.mqtt.Connection.publish">publish() (awscrt.mqtt.Connection method)</a>
+
+      <ul>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.Client.publish">(awscrt.mqtt5.Client method)</a>
+</li>
+      </ul></li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.PublishCompletionData">PublishCompletionData (class in awscrt.mqtt5)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.PublishPacket">PublishPacket (class in awscrt.mqtt5)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.PublishReceivedData">PublishReceivedData (class in awscrt.mqtt5)</a>
+</li>
+      <li><a href="api/s3.html#awscrt.s3.S3RequestType.PUT_OBJECT">PUT_OBJECT (awscrt.s3.S3RequestType attribute)</a>
+</li>
+  </ul></td>
+</tr></table>
+
+<h2 id="Q">Q</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api/mqtt.html#awscrt.mqtt.Will.qos">qos (awscrt.mqtt.Will attribute)</a>
+</li>
+      <li><a href="api/mqtt.html#awscrt.mqtt.QoS">QoS (class in awscrt.mqtt)</a>
+
+      <ul>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.QoS">(class in awscrt.mqtt5)</a>
+</li>
+      </ul></li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.ConnectReasonCode.QOS_NOT_SUPPORTED">QOS_NOT_SUPPORTED (awscrt.mqtt5.ConnectReasonCode attribute)</a>
+
+      <ul>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.DisconnectReasonCode.QOS_NOT_SUPPORTED">(awscrt.mqtt5.DisconnectReasonCode attribute)</a>
+</li>
+      </ul></li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.ConnectReasonCode.QUOTA_EXCEEDED">QUOTA_EXCEEDED (awscrt.mqtt5.ConnectReasonCode attribute)</a>
+
+      <ul>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.DisconnectReasonCode.QUOTA_EXCEEDED">(awscrt.mqtt5.DisconnectReasonCode attribute)</a>
+</li>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.PubackReasonCode.QUOTA_EXCEEDED">(awscrt.mqtt5.PubackReasonCode attribute)</a>
+</li>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.SubackReasonCode.QUOTA_EXCEEDED">(awscrt.mqtt5.SubackReasonCode attribute)</a>
+</li>
+      </ul></li>
+  </ul></td>
+</tr></table>
+
+<h2 id="R">R</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.DisconnectReasonCode.RECEIVE_MAXIMUM_EXCEEDED">RECEIVE_MAXIMUM_EXCEEDED (awscrt.mqtt5.DisconnectReasonCode attribute)</a>
+</li>
+      <li><a href="api/auth.html#awscrt.auth.AwsSigningConfig.region">region (awscrt.auth.AwsSigningConfig property)</a>
+
+      <ul>
+        <li><a href="api/s3.html#awscrt.s3.region">(in module awscrt.s3)</a>
+</li>
+      </ul></li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.ClientSessionBehaviorType.REJOIN_ALWAYS">REJOIN_ALWAYS (awscrt.mqtt5.ClientSessionBehaviorType attribute)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.ClientSessionBehaviorType.REJOIN_POST_SUCCESS">REJOIN_POST_SUCCESS (awscrt.mqtt5.ClientSessionBehaviorType attribute)</a>
+</li>
+      <li><a href="api/http.html#awscrt.http.HttpHeaders.remove">remove() (awscrt.http.HttpHeaders method)</a>
+</li>
+      <li><a href="api/http.html#awscrt.http.HttpHeaders.remove_value">remove_value() (awscrt.http.HttpHeaders method)</a>
+</li>
+      <li><a href="api/auth.html#awscrt.auth.AwsSigningConfig.replace">replace() (awscrt.auth.AwsSigningConfig method)</a>
+</li>
+      <li><a href="api/http.html#awscrt.http.HttpClientConnection.request">request() (awscrt.http.HttpClientConnection method)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api/http.html#awscrt.http.HttpClientStream.response_status_code">response_status_code (awscrt.http.HttpClientStream property)</a>
+</li>
+      <li><a href="api/mqtt.html#awscrt.mqtt.Connection.resubscribe_existing_topics">resubscribe_existing_topics() (awscrt.mqtt.Connection method)</a>
+</li>
+      <li><a href="api/mqtt.html#awscrt.mqtt.Will.retain">retain (awscrt.mqtt.Will attribute)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.ConnectReasonCode.RETAIN_NOT_SUPPORTED">RETAIN_NOT_SUPPORTED (awscrt.mqtt5.ConnectReasonCode attribute)</a>
+
+      <ul>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.DisconnectReasonCode.RETAIN_NOT_SUPPORTED">(awscrt.mqtt5.DisconnectReasonCode attribute)</a>
+</li>
+      </ul></li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.RetainAndHandlingType">RetainAndHandlingType (class in awscrt.mqtt5)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.RetainHandlingType">RetainHandlingType (class in awscrt.mqtt5)</a>
+</li>
+      <li><a href="api/crypto.html#awscrt.crypto.RSA">RSA (class in awscrt.crypto)</a>
+</li>
+      <li><a href="api/crypto.html#awscrt.crypto.RSAEncryptionAlgorithm">RSAEncryptionAlgorithm (class in awscrt.crypto)</a>
+</li>
+      <li><a href="api/crypto.html#awscrt.crypto.RSASignatureAlgorithm">RSASignatureAlgorithm (class in awscrt.crypto)</a>
+</li>
+  </ul></td>
+</tr></table>
+
+<h2 id="S">S</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api/s3.html#awscrt.s3.S3ChecksumAlgorithm">S3ChecksumAlgorithm (class in awscrt.s3)</a>
+</li>
+      <li><a href="api/s3.html#awscrt.s3.S3ChecksumConfig">S3ChecksumConfig (class in awscrt.s3)</a>
+</li>
+      <li><a href="api/s3.html#awscrt.s3.S3ChecksumLocation">S3ChecksumLocation (class in awscrt.s3)</a>
+</li>
+      <li><a href="api/s3.html#awscrt.s3.S3Client">S3Client (class in awscrt.s3)</a>
+</li>
+      <li><a href="api/s3.html#awscrt.s3.S3Request">S3Request (class in awscrt.s3)</a>
+</li>
+      <li><a href="api/s3.html#awscrt.s3.S3RequestTlsMode">S3RequestTlsMode (class in awscrt.s3)</a>
+</li>
+      <li><a href="api/s3.html#awscrt.s3.S3RequestType">S3RequestType (class in awscrt.s3)</a>
+</li>
+      <li><a href="api/s3.html#awscrt.s3.S3ResponseError">S3ResponseError</a>
+</li>
+      <li><a href="api/auth.html#awscrt.auth.AwsCredentials.secret_access_key">secret_access_key (awscrt.auth.AwsCredentials attribute)</a>
+</li>
+      <li><a href="api/websocket.html#awscrt.websocket.WebSocket.send_frame">send_frame() (awscrt.websocket.WebSocket method)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.rpc.ClientContinuation.send_message">send_message() (awscrt.eventstream.rpc.ClientContinuation method)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.RetainAndHandlingType.SEND_ON_SUBSCRIBE">SEND_ON_SUBSCRIBE (awscrt.mqtt5.RetainAndHandlingType attribute)</a>
+
+      <ul>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.RetainHandlingType.SEND_ON_SUBSCRIBE">(awscrt.mqtt5.RetainHandlingType attribute)</a>
+</li>
+      </ul></li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.RetainAndHandlingType.SEND_ON_SUBSCRIBE_IF_NEW">SEND_ON_SUBSCRIBE_IF_NEW (awscrt.mqtt5.RetainAndHandlingType attribute)</a>
+
+      <ul>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.RetainHandlingType.SEND_ON_SUBSCRIBE_IF_NEW">(awscrt.mqtt5.RetainHandlingType attribute)</a>
+</li>
+      </ul></li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.rpc.ClientConnection.send_protocol_message">send_protocol_message() (awscrt.eventstream.rpc.ClientConnection method)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.ConnectReasonCode.SERVER_BUSY">SERVER_BUSY (awscrt.mqtt5.ConnectReasonCode attribute)</a>
+
+      <ul>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.DisconnectReasonCode.SERVER_BUSY">(awscrt.mqtt5.DisconnectReasonCode attribute)</a>
+</li>
+      </ul></li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.ConnectReasonCode.SERVER_MOVED">SERVER_MOVED (awscrt.mqtt5.ConnectReasonCode attribute)</a>
+
+      <ul>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.DisconnectReasonCode.SERVER_MOVED">(awscrt.mqtt5.DisconnectReasonCode attribute)</a>
+</li>
+      </ul></li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.DisconnectReasonCode.SERVER_SHUTTING_DOWN">SERVER_SHUTTING_DOWN (awscrt.mqtt5.DisconnectReasonCode attribute)</a>
+</li>
+      <li><a href="api/mqtt.html#awscrt.mqtt.ConnectReturnCode.SERVER_UNAVAILABLE">SERVER_UNAVAILABLE (awscrt.mqtt.ConnectReturnCode attribute)</a>
+
+      <ul>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.ConnectReasonCode.SERVER_UNAVAILABLE">(awscrt.mqtt5.ConnectReasonCode attribute)</a>
+</li>
+      </ul></li>
+      <li><a href="api/auth.html#awscrt.auth.AwsSigningConfig.service">service (awscrt.auth.AwsSigningConfig property)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.DisconnectReasonCode.SESSION_TAKEN_OVER">SESSION_TAKEN_OVER (awscrt.mqtt5.DisconnectReasonCode attribute)</a>
+</li>
+      <li><a href="api/auth.html#awscrt.auth.AwsCredentials.session_token">session_token (awscrt.auth.AwsCredentials attribute)</a>
+</li>
+      <li><a href="api/http.html#awscrt.http.HttpHeaders.set">set() (awscrt.http.HttpHeaders method)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.TlsConnectionOptions.set_alpn_list">set_alpn_list() (awscrt.io.TlsConnectionOptions method)</a>
+</li>
+      <li><a href="api/mqtt.html#awscrt.mqtt.WebsocketHandshakeTransformArgs.set_done">set_done() (awscrt.mqtt.WebsocketHandshakeTransformArgs method)</a>
+
+      <ul>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.WebsocketHandshakeTransformArgs.set_done">(awscrt.mqtt5.WebsocketHandshakeTransformArgs method)</a>
+</li>
+      </ul></li>
+      <li><a href="api/io.html#awscrt.io.TlsConnectionOptions.set_server_name">set_server_name() (awscrt.io.TlsConnectionOptions method)</a>
+</li>
+      <li><a href="api/s3.html#awscrt.s3.S3ChecksumAlgorithm.SHA1">SHA1 (awscrt.s3.S3ChecksumAlgorithm attribute)</a>
+</li>
+      <li><a href="api/s3.html#awscrt.s3.S3ChecksumAlgorithm.SHA256">SHA256 (awscrt.s3.S3ChecksumAlgorithm attribute)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.DisconnectReasonCode.SHARED_SUBSCRIPTIONS_NOT_SUPPORTED">SHARED_SUBSCRIPTIONS_NOT_SUPPORTED (awscrt.mqtt5.DisconnectReasonCode attribute)</a>
+
+      <ul>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.SubackReasonCode.SHARED_SUBSCRIPTIONS_NOT_SUPPORTED">(awscrt.mqtt5.SubackReasonCode attribute)</a>
+</li>
+      </ul></li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api/auth.html#awscrt.auth.AwsSigningConfig.should_normalize_uri_path">should_normalize_uri_path (awscrt.auth.AwsSigningConfig property)</a>
+</li>
+      <li><a href="api/auth.html#awscrt.auth.AwsSigningConfig.should_sign_header">should_sign_header (awscrt.auth.AwsSigningConfig property)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.ClientBootstrap.shutdown_event">shutdown_event (awscrt.io.ClientBootstrap attribute)</a>
+
+      <ul>
+        <li><a href="api/io.html#awscrt.io.EventLoopGroup.shutdown_event">(awscrt.io.EventLoopGroup attribute)</a>
+</li>
+        <li><a href="api/s3.html#awscrt.s3.S3Request.shutdown_event">(awscrt.s3.S3Request attribute)</a>
+</li>
+      </ul></li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.rpc.ClientConnection.shutdown_future">shutdown_future (awscrt.eventstream.rpc.ClientConnection attribute)</a>
+
+      <ul>
+        <li><a href="api/http.html#awscrt.http.HttpClientConnection.shutdown_future">(awscrt.http.HttpClientConnection property)</a>
+</li>
+      </ul></li>
+      <li><a href="api/crypto.html#awscrt.crypto.RSA.sign">sign() (awscrt.crypto.RSA method)</a>
+</li>
+      <li><a href="api/auth.html#awscrt.auth.AwsSigningConfig.signature_type">signature_type (awscrt.auth.AwsSigningConfig property)</a>
+</li>
+      <li><a href="api/auth.html#awscrt.auth.AwsSigningConfig.signed_body_header_type">signed_body_header_type (awscrt.auth.AwsSigningConfig property)</a>
+</li>
+      <li><a href="api/auth.html#awscrt.auth.AwsSigningConfig.signed_body_value">signed_body_value (awscrt.auth.AwsSigningConfig property)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.SocketDomain">SocketDomain (class in awscrt.io)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.SocketOptions">SocketOptions (class in awscrt.io)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.SocketType">SocketType (class in awscrt.io)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.TlsVersion.SSLv3">SSLv3 (awscrt.io.TlsVersion attribute)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.Client.start">start() (awscrt.mqtt5.Client method)</a>
+</li>
+      <li><a href="api/s3.html#awscrt.s3.S3ResponseError.status_code">status_code (awscrt.s3.S3ResponseError attribute)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.Client.stop">stop() (awscrt.mqtt5.Client method)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.SocketType.Stream">Stream (awscrt.io.SocketType attribute)</a>
+</li>
+      <li><a href="api/auth.html#awscrt.auth.AwsSignedBodyValue.STREAMING_AWS4_HMAC_SHA256_EVENTS">STREAMING_AWS4_HMAC_SHA256_EVENTS (awscrt.auth.AwsSignedBodyValue attribute)</a>
+</li>
+      <li><a href="api/auth.html#awscrt.auth.AwsSignedBodyValue.STREAMING_AWS4_HMAC_SHA256_PAYLOAD">STREAMING_AWS4_HMAC_SHA256_PAYLOAD (awscrt.auth.AwsSignedBodyValue attribute)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.Pkcs11Lib.InitializeFinalizeBehavior.STRICT">STRICT (awscrt.io.Pkcs11Lib.InitializeFinalizeBehavior attribute)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.HeaderType.STRING">STRING (awscrt.eventstream.HeaderType attribute)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.SubackPacket">SubackPacket (class in awscrt.mqtt5)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.SubackReasonCode">SubackReasonCode (class in awscrt.mqtt5)</a>
+</li>
+      <li><a href="api/mqtt.html#awscrt.mqtt.Connection.subscribe">subscribe() (awscrt.mqtt.Connection method)</a>
+
+      <ul>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.Client.subscribe">(awscrt.mqtt5.Client method)</a>
+</li>
+      </ul></li>
+      <li><a href="api/mqtt.html#awscrt.mqtt.SubscribeError">SubscribeError</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.SubscribePacket">SubscribePacket (class in awscrt.mqtt5)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.Subscription">Subscription (class in awscrt.mqtt5)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.DisconnectReasonCode.SUBSCRIPTION_IDENTIFIERS_NOT_SUPPORTED">SUBSCRIPTION_IDENTIFIERS_NOT_SUPPORTED (awscrt.mqtt5.DisconnectReasonCode attribute)</a>
+
+      <ul>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.SubackReasonCode.SUBSCRIPTION_IDENTIFIERS_NOT_SUPPORTED">(awscrt.mqtt5.SubackReasonCode attribute)</a>
+</li>
+      </ul></li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.ConnectReasonCode.SUCCESS">SUCCESS (awscrt.mqtt5.ConnectReasonCode attribute)</a>
+
+      <ul>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.PubackReasonCode.SUCCESS">(awscrt.mqtt5.PubackReasonCode attribute)</a>
+</li>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.UnsubackReasonCode.SUCCESS">(awscrt.mqtt5.UnsubackReasonCode attribute)</a>
+</li>
+      </ul></li>
+  </ul></td>
+</tr></table>
+
+<h2 id="T">T</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api/eventstream.html#awscrt.eventstream.rpc.MessageFlag.TERMINATE_STREAM">TERMINATE_STREAM (awscrt.eventstream.rpc.MessageFlag attribute)</a>
+</li>
+      <li><a href="api/websocket.html#awscrt.websocket.Opcode.TEXT">TEXT (awscrt.websocket.Opcode attribute)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.HeaderType.TIMESTAMP">TIMESTAMP (awscrt.eventstream.HeaderType attribute)</a>
+</li>
+      <li><a href="api/http.html#awscrt.http.HttpProxyOptions.tls_connection_options">tls_connection_options (awscrt.http.HttpProxyOptions attribute)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.TlsConnectionOptions.tls_ctx">tls_ctx (awscrt.io.TlsConnectionOptions attribute)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.TlsCipherPref">TlsCipherPref (class in awscrt.io)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.TlsConnectionOptions">TlsConnectionOptions (class in awscrt.io)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.TlsContextOptions">TlsContextOptions (class in awscrt.io)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.TlsVersion.TLSv1">TLSv1 (awscrt.io.TlsVersion attribute)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.TlsVersion.TLSv1_1">TLSv1_1 (awscrt.io.TlsVersion attribute)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.TlsVersion.TLSv1_2">TLSv1_2 (awscrt.io.TlsVersion attribute)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.TlsVersion.TLSv1_3">TLSv1_3 (awscrt.io.TlsVersion attribute)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.TlsVersion">TlsVersion (class in awscrt.io)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api/mqtt.html#awscrt.mqtt.Will.topic">topic (awscrt.mqtt.Will attribute)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.DisconnectReasonCode.TOPIC_ALIAS_INVALID">TOPIC_ALIAS_INVALID (awscrt.mqtt5.DisconnectReasonCode attribute)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.DisconnectReasonCode.TOPIC_FILTER_INVALID">TOPIC_FILTER_INVALID (awscrt.mqtt5.DisconnectReasonCode attribute)</a>
+
+      <ul>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.SubackReasonCode.TOPIC_FILTER_INVALID">(awscrt.mqtt5.SubackReasonCode attribute)</a>
+</li>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.UnsubackReasonCode.TOPIC_FILTER_INVALID">(awscrt.mqtt5.UnsubackReasonCode attribute)</a>
+</li>
+      </ul></li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.ConnectReasonCode.TOPIC_NAME_INVALID">TOPIC_NAME_INVALID (awscrt.mqtt5.ConnectReasonCode attribute)</a>
+
+      <ul>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.DisconnectReasonCode.TOPIC_NAME_INVALID">(awscrt.mqtt5.DisconnectReasonCode attribute)</a>
+</li>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.PubackReasonCode.TOPIC_NAME_INVALID">(awscrt.mqtt5.PubackReasonCode attribute)</a>
+</li>
+      </ul></li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.TopicAliasingOptions">TopicAliasingOptions (class in awscrt.mqtt5)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.LogLevel.Trace">Trace (awscrt.io.LogLevel attribute)</a>
+</li>
+      <li><a href="api/s3.html#awscrt.s3.S3ChecksumLocation.TRAILER">TRAILER (awscrt.s3.S3ChecksumLocation attribute)</a>
+</li>
+      <li><a href="api/http.html#awscrt.http.HttpProxyConnectionType.Tunneling">Tunneling (awscrt.http.HttpProxyConnectionType attribute)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.Header.type">type (awscrt.eventstream.Header property)</a>
+
+      <ul>
+        <li><a href="api/io.html#awscrt.io.SocketOptions.type">(awscrt.io.SocketOptions attribute)</a>
+</li>
+      </ul></li>
+  </ul></td>
+</tr></table>
+
+<h2 id="U">U</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api/mqtt.html#awscrt.mqtt.ConnectReturnCode.UNACCEPTABLE_PROTOCOL_VERSION">UNACCEPTABLE_PROTOCOL_VERSION (awscrt.mqtt.ConnectReturnCode attribute)</a>
+</li>
+      <li><a href="api/http.html#awscrt.http.HttpVersion.Unknown">Unknown (awscrt.http.HttpVersion attribute)</a>
+</li>
+      <li><a href="api/auth.html#awscrt.auth.AwsSignedBodyValue.UNSIGNED_PAYLOAD">UNSIGNED_PAYLOAD (awscrt.auth.AwsSignedBodyValue attribute)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.ConnectReasonCode.UNSPECIFIED_ERROR">UNSPECIFIED_ERROR (awscrt.mqtt5.ConnectReasonCode attribute)</a>
+
+      <ul>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.DisconnectReasonCode.UNSPECIFIED_ERROR">(awscrt.mqtt5.DisconnectReasonCode attribute)</a>
+</li>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.PubackReasonCode.UNSPECIFIED_ERROR">(awscrt.mqtt5.PubackReasonCode attribute)</a>
+</li>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.SubackReasonCode.UNSPECIFIED_ERROR">(awscrt.mqtt5.SubackReasonCode attribute)</a>
+</li>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.UnsubackReasonCode.UNSPECIFIED_ERROR">(awscrt.mqtt5.UnsubackReasonCode attribute)</a>
+</li>
+      </ul></li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.UnsubackPacket">UnsubackPacket (class in awscrt.mqtt5)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.UnsubackReasonCode">UnsubackReasonCode (class in awscrt.mqtt5)</a>
+</li>
+      <li><a href="api/mqtt.html#awscrt.mqtt.Connection.unsubscribe">unsubscribe() (awscrt.mqtt.Connection method)</a>
+
+      <ul>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.Client.unsubscribe">(awscrt.mqtt5.Client method)</a>
+</li>
+      </ul></li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.UnsubscribePacket">UnsubscribePacket (class in awscrt.mqtt5)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.ConnectReasonCode.UNSUPPORTED_PROTOCOL_VERSION">UNSUPPORTED_PROTOCOL_VERSION (awscrt.mqtt5.ConnectReasonCode attribute)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.ConnectReasonCode.USE_ANOTHER_SERVER">USE_ANOTHER_SERVER (awscrt.mqtt5.ConnectReasonCode attribute)</a>
+
+      <ul>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.DisconnectReasonCode.USE_ANOTHER_SERVER">(awscrt.mqtt5.DisconnectReasonCode attribute)</a>
+</li>
+      </ul></li>
+      <li><a href="api/auth.html#awscrt.auth.AwsSigningConfig.use_double_uri_encode">use_double_uri_encode (awscrt.auth.AwsSigningConfig property)</a>
+</li>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.UserProperty">UserProperty (class in awscrt.mqtt5)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.HeaderType.UUID">UUID (awscrt.eventstream.HeaderType attribute)</a>
+</li>
+  </ul></td>
+</tr></table>
+
+<h2 id="V">V</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api/auth.html#awscrt.auth.AwsSigningAlgorithm.V4">V4 (awscrt.auth.AwsSigningAlgorithm attribute)</a>
+</li>
+      <li><a href="api/auth.html#awscrt.auth.AwsSigningAlgorithm.V4_ASYMMETRIC">V4_ASYMMETRIC (awscrt.auth.AwsSigningAlgorithm attribute)</a>
+</li>
+      <li><a href="api/auth.html#awscrt.auth.AwsSigningAlgorithm.V4_S3EXPRESS">V4_S3EXPRESS (awscrt.auth.AwsSigningAlgorithm attribute)</a>
+</li>
+      <li><a href="api/s3.html#awscrt.s3.S3ChecksumConfig.validate_response">validate_response (awscrt.s3.S3ChecksumConfig attribute)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.Header.value">value (awscrt.eventstream.Header property)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.Header.value_as_bool">value_as_bool() (awscrt.eventstream.Header method)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.Header.value_as_byte">value_as_byte() (awscrt.eventstream.Header method)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.Header.value_as_byte_buf">value_as_byte_buf() (awscrt.eventstream.Header method)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api/eventstream.html#awscrt.eventstream.Header.value_as_int16">value_as_int16() (awscrt.eventstream.Header method)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.Header.value_as_int32">value_as_int32() (awscrt.eventstream.Header method)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.Header.value_as_int64">value_as_int64() (awscrt.eventstream.Header method)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.Header.value_as_string">value_as_string() (awscrt.eventstream.Header method)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.Header.value_as_timestamp">value_as_timestamp() (awscrt.eventstream.Header method)</a>
+</li>
+      <li><a href="api/eventstream.html#awscrt.eventstream.Header.value_as_uuid">value_as_uuid() (awscrt.eventstream.Header method)</a>
+</li>
+      <li><a href="api/crypto.html#awscrt.crypto.RSA.verify">verify() (awscrt.crypto.RSA method)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.TlsContextOptions.verify_peer">verify_peer (awscrt.io.TlsContextOptions attribute)</a>
+</li>
+      <li><a href="api/http.html#awscrt.http.HttpClientConnection.version">version (awscrt.http.HttpClientConnection property)</a>
+</li>
+  </ul></td>
+</tr></table>
+
+<h2 id="W">W</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api/io.html#awscrt.io.LogLevel.Warn">Warn (awscrt.io.LogLevel attribute)</a>
+</li>
+      <li><a href="api/websocket.html#awscrt.websocket.OnConnectionSetupData.websocket">websocket (awscrt.websocket.OnConnectionSetupData attribute)</a>
+</li>
+      <li><a href="api/websocket.html#awscrt.websocket.WebSocket">WebSocket (class in awscrt.websocket)</a>
+</li>
+      <li><a href="api/mqtt.html#awscrt.mqtt.WebsocketHandshakeTransformArgs">WebsocketHandshakeTransformArgs (class in awscrt.mqtt)</a>
+
+      <ul>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.WebsocketHandshakeTransformArgs">(class in awscrt.mqtt5)</a>
+</li>
+      </ul></li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api/mqtt5.html#awscrt.mqtt5.DisconnectReasonCode.WILDCARD_SUBSCRIPTIONS_NOT_SUPPORTED">WILDCARD_SUBSCRIPTIONS_NOT_SUPPORTED (awscrt.mqtt5.DisconnectReasonCode attribute)</a>
+
+      <ul>
+        <li><a href="api/mqtt5.html#awscrt.mqtt5.SubackReasonCode.WILDCARD_SUBSCRIPTIONS_NOT_SUPPORTED">(awscrt.mqtt5.SubackReasonCode attribute)</a>
+</li>
+      </ul></li>
+      <li><a href="api/mqtt.html#awscrt.mqtt.Will">Will (class in awscrt.mqtt)</a>
+</li>
+      <li><a href="api/io.html#awscrt.io.InputStream.wrap">wrap() (awscrt.io.InputStream class method)</a>
+</li>
+  </ul></td>
+</tr></table>
+
+<h2 id="X">X</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api/auth.html#awscrt.auth.AwsSignedBodyHeaderType.X_AMZ_CONTENT_SHA_256">X_AMZ_CONTENT_SHA_256 (awscrt.auth.AwsSignedBodyHeaderType attribute)</a>
+</li>
+  </ul></td>
+</tr></table>
+
+
+
+            <div class="clearer"></div>
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+<div id="searchbox" style="display: none" role="search">
+  <h3 id="searchlabel">Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="search.html" method="get">
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+      <input type="submit" value="Go" />
+    </form>
+    </div>
+</div>
+<script>document.getElementById('searchbox').style.display = "block"</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="#" title="General Index"
+             >index</a></li>
+        <li class="right" >
+          <a href="py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="nav-item nav-item-0"><a href="index.html">awscrt  documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">Index</a></li> 
+      </ul>
+    </div>
+    <div class="footer" role="contentinfo">
+    &#169; Copyright 2020, Amazon Web Services, Inc.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
+    </div>
+  </body>
+</html>
\ No newline at end of file
diff --git a/docs/index.html b/docs/index.html
new file mode 100644
index 000000000..421afe46e
--- /dev/null
+++ b/docs/index.html
@@ -0,0 +1,297 @@
+
+
+<!doctype html>
+
+<html lang="en" data-content_root="./">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+
+    <title>Welcome to awscrt’s documentation! &#8212; awscrt  documentation</title>
+    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=649a27d8" />
+    <link rel="stylesheet" type="text/css" href="_static/css/custom.css?v=93be7416" />
+    
+    <script src="_static/documentation_options.js?v=5929fcd5"></script>
+    <script src="_static/doctools.js?v=888ff710"></script>
+    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script src="_static/bizstyle.js"></script>
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" />
+    <link rel="next" title="awscrt.auth" href="api/auth.html" />
+    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+    <!--[if lt IE 9]>
+    <script src="_static/css3-mediaqueries.js"></script>
+    <![endif]-->
+  </head><body>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="genindex.html" title="General Index"
+             accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="right" >
+          <a href="api/auth.html" title="awscrt.auth"
+             accesskey="N">next</a> |</li>
+        <li class="nav-item nav-item-0"><a href="#">awscrt  documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">Welcome to awscrt’s documentation!</a></li> 
+      </ul>
+    </div>  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body" role="main">
+            
+  <section id="welcome-to-awscrt-s-documentation">
+<h1>Welcome to awscrt’s documentation!<a class="headerlink" href="#welcome-to-awscrt-s-documentation" title="Link to this heading">¶</a></h1>
+<p>Python bindings for the AWS Common Runtime.</p>
+<p>GitHub: <a class="reference external" href="https://github.com/awslabs/aws-crt-python">https://github.com/awslabs/aws-crt-python</a></p>
+<p>PyPI: <a class="reference external" href="https://pypi.org/project/awscrt/">https://pypi.org/project/awscrt/</a></p>
+<section id="api-reference">
+<h2>API Reference<a class="headerlink" href="#api-reference" title="Link to this heading">¶</a></h2>
+<div class="toctree-wrapper compound">
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="api/auth.html">awscrt.auth</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="api/auth.html#awscrt.auth.AwsCredentials"><code class="docutils literal notranslate"><span class="pre">AwsCredentials</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/auth.html#awscrt.auth.AwsCredentialsProvider"><code class="docutils literal notranslate"><span class="pre">AwsCredentialsProvider</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/auth.html#awscrt.auth.AwsSigningAlgorithm"><code class="docutils literal notranslate"><span class="pre">AwsSigningAlgorithm</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/auth.html#awscrt.auth.AwsSignatureType"><code class="docutils literal notranslate"><span class="pre">AwsSignatureType</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/auth.html#awscrt.auth.AwsSignedBodyValue"><code class="docutils literal notranslate"><span class="pre">AwsSignedBodyValue</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/auth.html#awscrt.auth.AwsSignedBodyHeaderType"><code class="docutils literal notranslate"><span class="pre">AwsSignedBodyHeaderType</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/auth.html#awscrt.auth.AwsSigningConfig"><code class="docutils literal notranslate"><span class="pre">AwsSigningConfig</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/auth.html#awscrt.auth.aws_sign_request"><code class="docutils literal notranslate"><span class="pre">aws_sign_request()</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="api/common.html">awscrt.common</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="api/common.html#awscrt.common.get_cpu_group_count"><code class="docutils literal notranslate"><span class="pre">get_cpu_group_count()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/common.html#awscrt.common.get_cpu_count_for_group"><code class="docutils literal notranslate"><span class="pre">get_cpu_count_for_group()</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="api/crypto.html">awscrt.crypto</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="api/crypto.html#awscrt.crypto.RSAEncryptionAlgorithm"><code class="docutils literal notranslate"><span class="pre">RSAEncryptionAlgorithm</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/crypto.html#awscrt.crypto.RSASignatureAlgorithm"><code class="docutils literal notranslate"><span class="pre">RSASignatureAlgorithm</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/crypto.html#awscrt.crypto.RSA"><code class="docutils literal notranslate"><span class="pre">RSA</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="api/exceptions.html">awscrt.exceptions</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="api/exceptions.html#awscrt.exceptions.from_code"><code class="docutils literal notranslate"><span class="pre">from_code()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/exceptions.html#awscrt.exceptions.AwsCrtError"><code class="docutils literal notranslate"><span class="pre">AwsCrtError</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="api/eventstream.html">awscrt.eventstream</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="api/eventstream.html#awscrt.eventstream.HeaderType"><code class="docutils literal notranslate"><span class="pre">HeaderType</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/eventstream.html#awscrt.eventstream.Header"><code class="docutils literal notranslate"><span class="pre">Header</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/eventstream.html#awscrt.eventstream.rpc.MessageType"><code class="docutils literal notranslate"><span class="pre">MessageType</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/eventstream.html#awscrt.eventstream.rpc.MessageFlag"><code class="docutils literal notranslate"><span class="pre">MessageFlag</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/eventstream.html#awscrt.eventstream.rpc.ClientConnectionHandler"><code class="docutils literal notranslate"><span class="pre">ClientConnectionHandler</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/eventstream.html#awscrt.eventstream.rpc.ClientConnection"><code class="docutils literal notranslate"><span class="pre">ClientConnection</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/eventstream.html#awscrt.eventstream.rpc.ClientContinuation"><code class="docutils literal notranslate"><span class="pre">ClientContinuation</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/eventstream.html#awscrt.eventstream.rpc.ClientContinuationHandler"><code class="docutils literal notranslate"><span class="pre">ClientContinuationHandler</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="api/http.html">awscrt.http</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="api/http.html#awscrt.http.HttpVersion"><code class="docutils literal notranslate"><span class="pre">HttpVersion</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/http.html#awscrt.http.HttpClientConnection"><code class="docutils literal notranslate"><span class="pre">HttpClientConnection</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/http.html#awscrt.http.HttpClientStream"><code class="docutils literal notranslate"><span class="pre">HttpClientStream</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/http.html#awscrt.http.HttpRequest"><code class="docutils literal notranslate"><span class="pre">HttpRequest</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/http.html#awscrt.http.HttpHeaders"><code class="docutils literal notranslate"><span class="pre">HttpHeaders</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/http.html#awscrt.http.HttpProxyConnectionType"><code class="docutils literal notranslate"><span class="pre">HttpProxyConnectionType</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/http.html#awscrt.http.HttpProxyAuthenticationType"><code class="docutils literal notranslate"><span class="pre">HttpProxyAuthenticationType</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/http.html#awscrt.http.HttpProxyOptions"><code class="docutils literal notranslate"><span class="pre">HttpProxyOptions</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="api/io.html">awscrt.io</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="api/io.html#awscrt.io.LogLevel"><code class="docutils literal notranslate"><span class="pre">LogLevel</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/io.html#awscrt.io.init_logging"><code class="docutils literal notranslate"><span class="pre">init_logging()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/io.html#awscrt.io.EventLoopGroup"><code class="docutils literal notranslate"><span class="pre">EventLoopGroup</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/io.html#awscrt.io.HostResolverBase"><code class="docutils literal notranslate"><span class="pre">HostResolverBase</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/io.html#awscrt.io.DefaultHostResolver"><code class="docutils literal notranslate"><span class="pre">DefaultHostResolver</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/io.html#awscrt.io.ClientBootstrap"><code class="docutils literal notranslate"><span class="pre">ClientBootstrap</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/io.html#awscrt.io.SocketDomain"><code class="docutils literal notranslate"><span class="pre">SocketDomain</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/io.html#awscrt.io.SocketType"><code class="docutils literal notranslate"><span class="pre">SocketType</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/io.html#awscrt.io.SocketOptions"><code class="docutils literal notranslate"><span class="pre">SocketOptions</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/io.html#awscrt.io.TlsVersion"><code class="docutils literal notranslate"><span class="pre">TlsVersion</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/io.html#awscrt.io.TlsCipherPref"><code class="docutils literal notranslate"><span class="pre">TlsCipherPref</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/io.html#awscrt.io.TlsContextOptions"><code class="docutils literal notranslate"><span class="pre">TlsContextOptions</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/io.html#awscrt.io.ClientTlsContext"><code class="docutils literal notranslate"><span class="pre">ClientTlsContext</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/io.html#awscrt.io.TlsConnectionOptions"><code class="docutils literal notranslate"><span class="pre">TlsConnectionOptions</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/io.html#awscrt.io.is_alpn_available"><code class="docutils literal notranslate"><span class="pre">is_alpn_available()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/io.html#awscrt.io.InputStream"><code class="docutils literal notranslate"><span class="pre">InputStream</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/io.html#awscrt.io.Pkcs11Lib"><code class="docutils literal notranslate"><span class="pre">Pkcs11Lib</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="api/mqtt.html">awscrt.mqtt</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt.html#awscrt.mqtt.QoS"><code class="docutils literal notranslate"><span class="pre">QoS</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt.html#awscrt.mqtt.ConnectReturnCode"><code class="docutils literal notranslate"><span class="pre">ConnectReturnCode</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt.html#awscrt.mqtt.Will"><code class="docutils literal notranslate"><span class="pre">Will</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt.html#awscrt.mqtt.OnConnectionSuccessData"><code class="docutils literal notranslate"><span class="pre">OnConnectionSuccessData</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt.html#awscrt.mqtt.OnConnectionFailureData"><code class="docutils literal notranslate"><span class="pre">OnConnectionFailureData</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt.html#awscrt.mqtt.OnConnectionClosedData"><code class="docutils literal notranslate"><span class="pre">OnConnectionClosedData</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt.html#awscrt.mqtt.Client"><code class="docutils literal notranslate"><span class="pre">Client</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt.html#awscrt.mqtt.OperationStatisticsData"><code class="docutils literal notranslate"><span class="pre">OperationStatisticsData</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt.html#awscrt.mqtt.Connection"><code class="docutils literal notranslate"><span class="pre">Connection</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt.html#awscrt.mqtt.WebsocketHandshakeTransformArgs"><code class="docutils literal notranslate"><span class="pre">WebsocketHandshakeTransformArgs</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt.html#awscrt.mqtt.SubscribeError"><code class="docutils literal notranslate"><span class="pre">SubscribeError</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="api/mqtt5.html">awscrt.mqtt5</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt5.html#awscrt.mqtt5.QoS"><code class="docutils literal notranslate"><span class="pre">QoS</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt5.html#awscrt.mqtt5.ConnectReasonCode"><code class="docutils literal notranslate"><span class="pre">ConnectReasonCode</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt5.html#awscrt.mqtt5.DisconnectReasonCode"><code class="docutils literal notranslate"><span class="pre">DisconnectReasonCode</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt5.html#awscrt.mqtt5.PubackReasonCode"><code class="docutils literal notranslate"><span class="pre">PubackReasonCode</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt5.html#awscrt.mqtt5.SubackReasonCode"><code class="docutils literal notranslate"><span class="pre">SubackReasonCode</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt5.html#awscrt.mqtt5.UnsubackReasonCode"><code class="docutils literal notranslate"><span class="pre">UnsubackReasonCode</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt5.html#awscrt.mqtt5.ClientSessionBehaviorType"><code class="docutils literal notranslate"><span class="pre">ClientSessionBehaviorType</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt5.html#awscrt.mqtt5.PayloadFormatIndicator"><code class="docutils literal notranslate"><span class="pre">PayloadFormatIndicator</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt5.html#awscrt.mqtt5.RetainHandlingType"><code class="docutils literal notranslate"><span class="pre">RetainHandlingType</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt5.html#awscrt.mqtt5.RetainAndHandlingType"><code class="docutils literal notranslate"><span class="pre">RetainAndHandlingType</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt5.html#awscrt.mqtt5.ExtendedValidationAndFlowControlOptions"><code class="docutils literal notranslate"><span class="pre">ExtendedValidationAndFlowControlOptions</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt5.html#awscrt.mqtt5.ClientOperationQueueBehaviorType"><code class="docutils literal notranslate"><span class="pre">ClientOperationQueueBehaviorType</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt5.html#awscrt.mqtt5.ExponentialBackoffJitterMode"><code class="docutils literal notranslate"><span class="pre">ExponentialBackoffJitterMode</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt5.html#awscrt.mqtt5.UserProperty"><code class="docutils literal notranslate"><span class="pre">UserProperty</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt5.html#awscrt.mqtt5.OutboundTopicAliasBehaviorType"><code class="docutils literal notranslate"><span class="pre">OutboundTopicAliasBehaviorType</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt5.html#awscrt.mqtt5.InboundTopicAliasBehaviorType"><code class="docutils literal notranslate"><span class="pre">InboundTopicAliasBehaviorType</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt5.html#awscrt.mqtt5.TopicAliasingOptions"><code class="docutils literal notranslate"><span class="pre">TopicAliasingOptions</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt5.html#awscrt.mqtt5.NegotiatedSettings"><code class="docutils literal notranslate"><span class="pre">NegotiatedSettings</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt5.html#awscrt.mqtt5.ConnackPacket"><code class="docutils literal notranslate"><span class="pre">ConnackPacket</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt5.html#awscrt.mqtt5.DisconnectPacket"><code class="docutils literal notranslate"><span class="pre">DisconnectPacket</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt5.html#awscrt.mqtt5.Subscription"><code class="docutils literal notranslate"><span class="pre">Subscription</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt5.html#awscrt.mqtt5.SubscribePacket"><code class="docutils literal notranslate"><span class="pre">SubscribePacket</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt5.html#awscrt.mqtt5.SubackPacket"><code class="docutils literal notranslate"><span class="pre">SubackPacket</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt5.html#awscrt.mqtt5.UnsubscribePacket"><code class="docutils literal notranslate"><span class="pre">UnsubscribePacket</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt5.html#awscrt.mqtt5.UnsubackPacket"><code class="docutils literal notranslate"><span class="pre">UnsubackPacket</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt5.html#awscrt.mqtt5.PublishPacket"><code class="docutils literal notranslate"><span class="pre">PublishPacket</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt5.html#awscrt.mqtt5.PubackPacket"><code class="docutils literal notranslate"><span class="pre">PubackPacket</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt5.html#awscrt.mqtt5.ConnectPacket"><code class="docutils literal notranslate"><span class="pre">ConnectPacket</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt5.html#awscrt.mqtt5.WebsocketHandshakeTransformArgs"><code class="docutils literal notranslate"><span class="pre">WebsocketHandshakeTransformArgs</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt5.html#awscrt.mqtt5.PublishReceivedData"><code class="docutils literal notranslate"><span class="pre">PublishReceivedData</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt5.html#awscrt.mqtt5.OperationStatisticsData"><code class="docutils literal notranslate"><span class="pre">OperationStatisticsData</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt5.html#awscrt.mqtt5.LifecycleStoppedData"><code class="docutils literal notranslate"><span class="pre">LifecycleStoppedData</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt5.html#awscrt.mqtt5.LifecycleAttemptingConnectData"><code class="docutils literal notranslate"><span class="pre">LifecycleAttemptingConnectData</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt5.html#awscrt.mqtt5.LifecycleConnectSuccessData"><code class="docutils literal notranslate"><span class="pre">LifecycleConnectSuccessData</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt5.html#awscrt.mqtt5.LifecycleConnectFailureData"><code class="docutils literal notranslate"><span class="pre">LifecycleConnectFailureData</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt5.html#awscrt.mqtt5.LifecycleDisconnectData"><code class="docutils literal notranslate"><span class="pre">LifecycleDisconnectData</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt5.html#awscrt.mqtt5.PublishCompletionData"><code class="docutils literal notranslate"><span class="pre">PublishCompletionData</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt5.html#awscrt.mqtt5.ClientOptions"><code class="docutils literal notranslate"><span class="pre">ClientOptions</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/mqtt5.html#awscrt.mqtt5.Client"><code class="docutils literal notranslate"><span class="pre">Client</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="api/s3.html">awscrt.s3</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="api/s3.html#awscrt.s3.CrossProcessLock"><code class="docutils literal notranslate"><span class="pre">CrossProcessLock</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/s3.html#awscrt.s3.S3RequestType"><code class="docutils literal notranslate"><span class="pre">S3RequestType</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/s3.html#awscrt.s3.S3RequestTlsMode"><code class="docutils literal notranslate"><span class="pre">S3RequestTlsMode</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/s3.html#awscrt.s3.S3ChecksumAlgorithm"><code class="docutils literal notranslate"><span class="pre">S3ChecksumAlgorithm</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/s3.html#awscrt.s3.S3ChecksumLocation"><code class="docutils literal notranslate"><span class="pre">S3ChecksumLocation</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/s3.html#awscrt.s3.S3ChecksumConfig"><code class="docutils literal notranslate"><span class="pre">S3ChecksumConfig</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/s3.html#awscrt.s3.S3Client"><code class="docutils literal notranslate"><span class="pre">S3Client</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/s3.html#awscrt.s3.S3Request"><code class="docutils literal notranslate"><span class="pre">S3Request</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/s3.html#awscrt.s3.S3ResponseError"><code class="docutils literal notranslate"><span class="pre">S3ResponseError</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/s3.html#awscrt.s3.create_default_s3_signing_config"><code class="docutils literal notranslate"><span class="pre">create_default_s3_signing_config()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/s3.html#awscrt.s3.region"><code class="docutils literal notranslate"><span class="pre">region</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/s3.html#awscrt.s3.credential_provider"><code class="docutils literal notranslate"><span class="pre">credential_provider</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/s3.html#awscrt.s3.get_ec2_instance_type"><code class="docutils literal notranslate"><span class="pre">get_ec2_instance_type()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/s3.html#awscrt.s3.is_optimized_for_system"><code class="docutils literal notranslate"><span class="pre">is_optimized_for_system()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/s3.html#awscrt.s3.get_optimized_platforms"><code class="docutils literal notranslate"><span class="pre">get_optimized_platforms()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/s3.html#awscrt.s3.get_recommended_throughput_target_gbps"><code class="docutils literal notranslate"><span class="pre">get_recommended_throughput_target_gbps()</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="api/websocket.html">awscrt.websocket</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="api/websocket.html#authoring-callbacks">Authoring Callbacks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/websocket.html#flow-control-reading">Flow Control (reading)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/websocket.html#flow-control-writing">Flow Control (writing)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/websocket.html#api">API</a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/websocket.html#awscrt.websocket.Opcode"><code class="docutils literal notranslate"><span class="pre">Opcode</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/websocket.html#awscrt.websocket.MAX_PAYLOAD_LENGTH"><code class="docutils literal notranslate"><span class="pre">MAX_PAYLOAD_LENGTH</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/websocket.html#awscrt.websocket.OnConnectionSetupData"><code class="docutils literal notranslate"><span class="pre">OnConnectionSetupData</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/websocket.html#awscrt.websocket.OnConnectionShutdownData"><code class="docutils literal notranslate"><span class="pre">OnConnectionShutdownData</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/websocket.html#awscrt.websocket.IncomingFrame"><code class="docutils literal notranslate"><span class="pre">IncomingFrame</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/websocket.html#awscrt.websocket.OnIncomingFrameBeginData"><code class="docutils literal notranslate"><span class="pre">OnIncomingFrameBeginData</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/websocket.html#awscrt.websocket.OnIncomingFramePayloadData"><code class="docutils literal notranslate"><span class="pre">OnIncomingFramePayloadData</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/websocket.html#awscrt.websocket.OnIncomingFrameCompleteData"><code class="docutils literal notranslate"><span class="pre">OnIncomingFrameCompleteData</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/websocket.html#awscrt.websocket.OnSendFrameCompleteData"><code class="docutils literal notranslate"><span class="pre">OnSendFrameCompleteData</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/websocket.html#awscrt.websocket.WebSocket"><code class="docutils literal notranslate"><span class="pre">WebSocket</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/websocket.html#awscrt.websocket.connect"><code class="docutils literal notranslate"><span class="pre">connect()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/websocket.html#awscrt.websocket.create_handshake_request"><code class="docutils literal notranslate"><span class="pre">create_handshake_request()</span></code></a></li>
+</ul>
+</li>
+</ul>
+</div>
+</section>
+</section>
+<section id="indices-and-tables">
+<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Link to this heading">¶</a></h1>
+<ul class="simple">
+<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
+<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
+</ul>
+</section>
+
+
+            <div class="clearer"></div>
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+  <div>
+    <h3><a href="#">Table of Contents</a></h3>
+    <ul>
+<li><a class="reference internal" href="#">Welcome to awscrt’s documentation!</a><ul>
+<li><a class="reference internal" href="#api-reference">API Reference</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
+</ul>
+
+  </div>
+  <div>
+    <h4>Next topic</h4>
+    <p class="topless"><a href="api/auth.html"
+                          title="next chapter">awscrt.auth</a></p>
+  </div>
+  <div role="note" aria-label="source link">
+    <h3>This Page</h3>
+    <ul class="this-page-menu">
+      <li><a href="_sources/index.rst.txt"
+            rel="nofollow">Show Source</a></li>
+    </ul>
+   </div>
+<div id="searchbox" style="display: none" role="search">
+  <h3 id="searchlabel">Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="search.html" method="get">
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+      <input type="submit" value="Go" />
+    </form>
+    </div>
+</div>
+<script>document.getElementById('searchbox').style.display = "block"</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="genindex.html" title="General Index"
+             >index</a></li>
+        <li class="right" >
+          <a href="py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="right" >
+          <a href="api/auth.html" title="awscrt.auth"
+             >next</a> |</li>
+        <li class="nav-item nav-item-0"><a href="#">awscrt  documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">Welcome to awscrt’s documentation!</a></li> 
+      </ul>
+    </div>
+    <div class="footer" role="contentinfo">
+    &#169; Copyright 2020, Amazon Web Services, Inc.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
+    </div>
+  </body>
+</html>
\ No newline at end of file
diff --git a/docs/objects.inv b/docs/objects.inv
new file mode 100644
index 000000000..07658eb8a
Binary files /dev/null and b/docs/objects.inv differ
diff --git a/docs/py-modindex.html b/docs/py-modindex.html
new file mode 100644
index 000000000..7c6fd77ea
--- /dev/null
+++ b/docs/py-modindex.html
@@ -0,0 +1,164 @@
+
+
+<!doctype html>
+
+<html lang="en" data-content_root="./">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Python Module Index &#8212; awscrt  documentation</title>
+    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=649a27d8" />
+    <link rel="stylesheet" type="text/css" href="_static/css/custom.css?v=93be7416" />
+    
+    <script src="_static/documentation_options.js?v=5929fcd5"></script>
+    <script src="_static/doctools.js?v=888ff710"></script>
+    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script src="_static/bizstyle.js"></script>
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" />
+
+    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+    <!--[if lt IE 9]>
+    <script src="_static/css3-mediaqueries.js"></script>
+    <![endif]-->
+
+
+  </head><body>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="genindex.html" title="General Index"
+             accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="#" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="nav-item nav-item-0"><a href="index.html">awscrt  documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">Python Module Index</a></li> 
+      </ul>
+    </div>  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body" role="main">
+            
+
+   <h1>Python Module Index</h1>
+
+   <div class="modindex-jumpbox">
+   <a href="#cap-a"><strong>a</strong></a>
+   </div>
+
+   <table class="indextable modindextable">
+     <tr class="pcap"><td></td><td>&#160;</td><td></td></tr>
+     <tr class="cap" id="cap-a"><td></td><td>
+       <strong>a</strong></td><td></td></tr>
+     <tr>
+       <td><img src="_static/minus.png" class="toggler"
+              id="toggle-1" style="display: none" alt="-" /></td>
+       <td>
+       <code class="xref">awscrt</code></td><td>
+       <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&#160;&#160;&#160;
+       <a href="api/auth.html#module-awscrt.auth"><code class="xref">awscrt.auth</code></a></td><td>
+       <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&#160;&#160;&#160;
+       <a href="api/common.html#module-awscrt.common"><code class="xref">awscrt.common</code></a></td><td>
+       <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&#160;&#160;&#160;
+       <a href="api/crypto.html#module-awscrt.crypto"><code class="xref">awscrt.crypto</code></a></td><td>
+       <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&#160;&#160;&#160;
+       <a href="api/eventstream.html#module-awscrt.eventstream"><code class="xref">awscrt.eventstream</code></a></td><td>
+       <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&#160;&#160;&#160;
+       <a href="api/eventstream.html#module-awscrt.eventstream.rpc"><code class="xref">awscrt.eventstream.rpc</code></a></td><td>
+       <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&#160;&#160;&#160;
+       <a href="api/exceptions.html#module-awscrt.exceptions"><code class="xref">awscrt.exceptions</code></a></td><td>
+       <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&#160;&#160;&#160;
+       <a href="api/http.html#module-awscrt.http"><code class="xref">awscrt.http</code></a></td><td>
+       <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&#160;&#160;&#160;
+       <a href="api/io.html#module-awscrt.io"><code class="xref">awscrt.io</code></a></td><td>
+       <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&#160;&#160;&#160;
+       <a href="api/mqtt.html#module-awscrt.mqtt"><code class="xref">awscrt.mqtt</code></a></td><td>
+       <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&#160;&#160;&#160;
+       <a href="api/mqtt5.html#module-awscrt.mqtt5"><code class="xref">awscrt.mqtt5</code></a></td><td>
+       <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&#160;&#160;&#160;
+       <a href="api/s3.html#module-awscrt.s3"><code class="xref">awscrt.s3</code></a></td><td>
+       <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&#160;&#160;&#160;
+       <a href="api/websocket.html#module-awscrt.websocket"><code class="xref">awscrt.websocket</code></a></td><td>
+       <em></em></td></tr>
+   </table>
+
+
+            <div class="clearer"></div>
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+<div id="searchbox" style="display: none" role="search">
+  <h3 id="searchlabel">Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="search.html" method="get">
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+      <input type="submit" value="Go" />
+    </form>
+    </div>
+</div>
+<script>document.getElementById('searchbox').style.display = "block"</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="genindex.html" title="General Index"
+             >index</a></li>
+        <li class="right" >
+          <a href="#" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="nav-item nav-item-0"><a href="index.html">awscrt  documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">Python Module Index</a></li> 
+      </ul>
+    </div>
+    <div class="footer" role="contentinfo">
+    &#169; Copyright 2020, Amazon Web Services, Inc.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
+    </div>
+  </body>
+</html>
\ No newline at end of file
diff --git a/docs/search.html b/docs/search.html
new file mode 100644
index 000000000..0a9b313fe
--- /dev/null
+++ b/docs/search.html
@@ -0,0 +1,108 @@
+
+
+<!doctype html>
+
+<html lang="en" data-content_root="./">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Search &#8212; awscrt  documentation</title>
+    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=649a27d8" />
+    <link rel="stylesheet" type="text/css" href="_static/css/custom.css?v=93be7416" />
+    
+    
+    <script src="_static/documentation_options.js?v=5929fcd5"></script>
+    <script src="_static/doctools.js?v=888ff710"></script>
+    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script src="_static/bizstyle.js"></script>
+    <script src="_static/searchtools.js"></script>
+    <script src="_static/language_data.js"></script>
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="#" />
+  <script src="searchindex.js" defer></script>
+  
+    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+    <!--[if lt IE 9]>
+    <script src="_static/css3-mediaqueries.js"></script>
+    <![endif]-->
+
+  </head><body>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="genindex.html" title="General Index"
+             accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="nav-item nav-item-0"><a href="index.html">awscrt  documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">Search</a></li> 
+      </ul>
+    </div>  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body" role="main">
+            
+  <h1 id="search-documentation">Search</h1>
+  
+  <noscript>
+  <div class="admonition warning">
+  <p>
+    Please activate JavaScript to enable the search
+    functionality.
+  </p>
+  </div>
+  </noscript>
+  
+  
+  <p>
+    Searching for multiple words only shows matches that contain
+    all words.
+  </p>
+  
+  
+  <form action="" method="get">
+    <input type="text" name="q" aria-labelledby="search-documentation" value="" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+    <input type="submit" value="search" />
+    <span id="search-progress" style="padding-left: 10px"></span>
+  </form>
+  
+  
+  
+  <div id="search-results">
+  
+  </div>
+  
+
+            <div class="clearer"></div>
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="genindex.html" title="General Index"
+             >index</a></li>
+        <li class="right" >
+          <a href="py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="nav-item nav-item-0"><a href="index.html">awscrt  documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">Search</a></li> 
+      </ul>
+    </div>
+    <div class="footer" role="contentinfo">
+    &#169; Copyright 2020, Amazon Web Services, Inc.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
+    </div>
+  </body>
+</html>
\ No newline at end of file
diff --git a/docs/searchindex.js b/docs/searchindex.js
new file mode 100644
index 000000000..ebf8b7d5d
--- /dev/null
+++ b/docs/searchindex.js
@@ -0,0 +1 @@
+Search.setIndex({"docnames": ["api/auth", "api/common", "api/crypto", "api/eventstream", "api/exceptions", "api/http", "api/io", "api/mqtt", "api/mqtt5", "api/s3", "api/websocket", "index"], "filenames": ["api/auth.rst", "api/common.rst", "api/crypto.rst", "api/eventstream.rst", "api/exceptions.rst", "api/http.rst", "api/io.rst", "api/mqtt.rst", "api/mqtt5.rst", "api/s3.rst", "api/websocket.rst", "index.rst"], "titles": ["awscrt.auth", "awscrt.common", "awscrt.crypto", "awscrt.eventstream", "awscrt.exceptions", "awscrt.http", "awscrt.io", "awscrt.mqtt", "awscrt.mqtt5", "awscrt.s3", "awscrt.websocket", "Welcome to awscrt\u2019s documentation!"], "terms": {"aw": [0, 4, 7, 8, 9, 11], "client": [0, 3, 5, 6, 7, 8, 9, 10, 11], "side": [0, 8, 9, 10], "authent": [0, 5, 6, 8, 9], "standard": [0, 6], "credenti": [0, 7, 8, 9], "provid": [0, 3, 5, 6, 7, 8, 9, 10], "sign": [0, 2, 3, 5, 7, 8, 9], "class": [0, 2, 3, 4, 5, 6, 7, 8, 9, 10], "awscredenti": [0, 9, 11], "access_key_id": 0, "secret_access_kei": 0, "session_token": 0, "none": [0, 3, 5, 6, 7, 8, 9, 10], "expir": [0, 8], "ar": [0, 3, 5, 6, 7, 8, 9, 10], "public": [0, 2, 8], "privat": [0, 2, 6], "data": [0, 2, 3, 5, 7, 8, 9, 10], "need": [0, 6, 9, 10], "an": [0, 3, 4, 5, 6, 7, 8, 9, 10], "request": [0, 5, 7, 8, 9, 10], "immut": 0, "paramet": [0, 3, 4, 5, 6, 7, 8, 10], "str": [0, 2, 3, 4, 5, 6, 7, 8, 9, 10], "access": [0, 1, 6], "kei": [0, 2, 6, 10], "id": [0, 3, 6, 7, 8], "secret": 0, "option": [0, 3, 5, 6, 7, 8, 9, 10], "secur": [0, 7, 8], "token": [0, 6], "associ": [0, 7, 8], "datetim": 0, "longer": [0, 7, 8, 9], "valid": [0, 5, 6, 8, 9, 10], "past": 0, "convert": [0, 8], "utc": 0, "timezon": 0, "round": [0, 6], "down": [0, 3, 5, 6, 8, 9, 10], "nearest": 0, "second": [0, 3, 6, 7, 8, 9, 10], "If": [0, 3, 5, 6, 7, 8, 9, 10], "set": [0, 5, 6, 7, 8, 9, 10], "do": [0, 6, 7, 8, 10], "type": [0, 3, 4, 5, 6, 7, 8, 9, 10], "i": [0, 3, 4, 5, 6, 7, 8, 9, 10], "alwai": [0, 3, 5, 6, 8, 10], "awscredentialsprovid": [0, 9, 11], "bind": [0, 2, 8, 10, 11], "sourc": [0, 9], "thi": [0, 3, 5, 6, 7, 8, 9, 10], "new_x": 0, "function": [0, 2, 3, 5, 7, 8, 9, 10], "sever": 0, "built": [0, 10], "To": [0, 6, 8, 9, 10], "defin": [0, 10], "custom": [0, 6, 8], "us": [0, 1, 2, 3, 5, 6, 7, 8, 9, 10], "new_deleg": 0, "classmethod": [0, 3, 5, 6], "new_default_chain": 0, "client_bootstrap": 0, "creat": [0, 2, 3, 5, 6, 8, 9, 10], "default": [0, 3, 5, 6, 7, 8, 9, 10], "chain": [0, 6], "most": [0, 6, 7, 8, 10], "sdk": 0, "gener": [0, 7], "environ": 0, "profil": 0, "condit": [0, 6], "off": 0, "ec": 0, "ec2": [0, 9], "instanc": [0, 2, 6, 8, 9], "metadata": 0, "clientbootstrap": [0, 3, 5, 6, 7, 8, 9, 10, 11], "bootstrap": [0, 3, 5, 7, 8, 9, 10], "when": [0, 3, 5, 6, 7, 8, 9, 10], "initi": [0, 3, 5, 6, 7, 8, 9, 10], "socket": [0, 3, 5, 6, 7, 8, 9, 10], "connect": [0, 3, 5, 6, 7, 8, 9, 10, 11], "static": [0, 2, 6], "instead": [0, 6, 7, 8, 9], "return": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10], "new_stat": 0, "simpl": [0, 7, 8], "just": [0, 6, 8, 9, 10], "fix": 0, "session": [0, 7, 8], "new_profil": 0, "profile_nam": 0, "config_filepath": 0, "credentials_filepath": 0, "from": [0, 2, 3, 5, 6, 7, 8, 9, 10], "valu": [0, 2, 3, 4, 5, 6, 7, 8, 9, 10], "load": [0, 6], "file": [0, 6, 9], "name": [0, 3, 4, 5, 6, 7, 8, 9], "aws_profil": 0, "variabl": 0, "path": [0, 5, 6, 7, 8, 9, 10], "config": [0, 9], "aws_config_fil": 0, "aws_shared_credentials_fil": 0, "new_process": 0, "profile_to_us": 0, "run": [0, 6, 9], "extern": 0, "command": 0, "process": [0, 3, 6, 8, 9, 10], "The": [0, 3, 5, 6, 7, 8, 9, 10], "select": 0, "rule": [0, 8], "read": [0, 6, 9, 11], "credential_process": 0, "exampl": [0, 3, 4, 6, 7, 8, 9, 10], "opt": 0, "amazon": [0, 7, 9], "bin": 0, "my": [0, 6], "fetcher": 0, "argsa": 0, "abc": 0, "On": [0, 8], "successfulli": [0, 3, 7, 8, 9, 10], "output": 0, "should": [0, 3, 5, 6, 7, 8, 9, 10], "json": 0, "follow": [0, 3, 5, 7, 8, 9, 10], "format": [0, 6, 8, 10], "version": [0, 5, 6, 7, 8, 10], "1": [0, 2, 3, 4, 5, 6, 7, 8, 9, 10], "accesskeyid": 0, "accesskei": 0, "secretaccesskei": 0, "sessiontoken": 0, "2019": 0, "05": 0, "29t00": 0, "21": 0, "43z": 0, "here": [0, 9, 10], "identifi": [0, 7, 8, 9], "part": [0, 6, 8, 9, 10], "which": [0, 3, 5, 6, 7, 8, 9, 10], "look": 0, "new_environ": 0, "aws_access_key_id": 0, "aws_secret_access_kei": 0, "aws_session_token": 0, "new_chain": 0, "order": [0, 6, 8], "sequenc": [0, 3, 8, 10], "first": [0, 3, 5, 8, 9, 10], "queri": [0, 3, 5, 7, 8, 10], "one": [0, 3, 6, 8, 9, 10], "time": [0, 5, 7, 8, 9, 10], "until": [0, 3, 5, 7, 8, 10], "preced": [0, 8], "ha": [0, 3, 5, 6, 7, 8, 9, 10], "fail": [0, 3, 5, 6, 7, 8, 9, 10], "list": [0, 5, 6, 7, 8, 9], "get_credenti": 0, "synchron": [0, 9, 10], "callback": [0, 3, 5, 7, 8, 9, 11], "callabl": [0, 3, 8, 10], "take": [0, 3, 5, 7, 8, 9, 10], "argument": [0, 3, 5, 6, 7, 8, 9, 10], "new_cognito": 0, "endpoint": [0, 5, 8, 10], "ident": 0, "tls_ctx": [0, 6, 7, 8], "clienttlscontext": [0, 6, 7, 8, 11], "login": 0, "tupl": [0, 5, 7, 9, 10], "custom_role_arn": 0, "http_proxy_opt": [0, 8], "httpproxyopt": [0, 5, 7, 8, 10, 11], "cognito": 0, "servic": [0, 7, 8, 9], "region": [0, 9, 11], "fetch": [0, 7, 8, 9], "rel": [0, 8], "tl": [0, 3, 5, 6, 7, 8, 9], "context": [0, 6, 7, 8], "http": [0, 7, 8, 9, 10, 11], "specifi": [0, 5, 6, 8, 10], "pair": [0, 2, 5, 9], "repres": [0, 6, 8, 9], "establish": [0, 3, 5, 7, 8, 10], "purpos": 0, "arn": 0, "role": 0, "assum": [0, 6, 7], "multipl": [0, 5, 9, 10], "were": [0, 7, 8], "receiv": [0, 3, 5, 6, 7, 8, 9, 10], "proxi": [0, 5, 7, 8, 10], "new_x509": 0, "thing_nam": 0, "role_alia": 0, "iot": [0, 7, 8], "": [0, 3, 4, 5, 6, 7, 8, 9, 10], "x509": 0, "per": [0, 6, 7, 8, 9], "account": [0, 7, 10], "can": [0, 3, 5, 6, 7, 8, 9, 10], "determin": [0, 3, 7, 8, 9, 10], "via": [0, 3, 6, 7, 8, 9], "cli": 0, "describ": [0, 8, 10], "credentialprovid": 0, "thing": [0, 10], "alia": [0, 8], "through": [0, 5, 6], "asynchron": [0, 3, 5, 6, 7, 8, 10], "concurr": [0, 3, 5, 6, 7, 8, 9], "futur": [0, 3, 5, 7, 8, 9], "A": [0, 3, 5, 6, 7, 8, 9, 10], "contain": [0, 3, 5, 6, 7, 8, 9, 10], "except": [0, 3, 5, 6, 7, 8, 9, 10, 11], "oper": [0, 3, 5, 6, 7, 8, 9, 10], "complet": [0, 3, 5, 7, 8, 10], "mai": [0, 3, 5, 6, 7, 8, 9, 10], "differ": [0, 3, 6, 8, 9], "thread": [0, 3, 5, 6, 9, 10], "awssigningalgorithm": [0, 9, 11], "algorithm": [0, 2, 6, 9], "enumer": [0, 3, 5, 6, 7, 8], "v4": 0, "0": [0, 2, 3, 5, 6, 7, 8, 9, 10], "signatur": [0, 2, 7, 8], "4": [0, 3, 6, 7, 8, 9, 10], "v4_asymmetr": 0, "asymmetr": 0, "v4_s3express": [0, 9], "2": [0, 2, 3, 5, 6, 7, 8, 9, 10], "s3": [0, 11], "express": [0, 9], "awssignaturetyp": [0, 11], "sort": 0, "comput": 0, "signabl": 0, "http_request_head": 0, "full": [0, 8, 10], "header": [0, 3, 5, 7, 8, 9, 10, 11], "updat": [0, 6], "appli": [0, 7, 8], "result": [0, 3, 4, 5, 7, 8, 9, 10], "http_request_query_param": 0, "param": 0, "awssignedbodyvalu": [0, 11], "awssigningconfig": [0, 9, 11], "signed_body_valu": 0, "some": [0, 6, 7, 8, 10], "special": 0, "e": [0, 9, 10], "g": [0, 9], "unsign": 0, "payload": [0, 3, 7, 8, 10], "bodi": [0, 5, 9, 10], "being": [0, 6, 7, 8], "usual": [0, 6, 9], "wai": [0, 6, 8, 10], "empty_sha256": 0, "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855": 0, "sha": [0, 9], "256": [0, 8, 9], "empti": [0, 5, 7, 8, 9, 10], "string": [0, 3, 6, 8, 9, 10], "unsigned_payload": 0, "accept": [0, 3, 7, 8, 10], "all": [0, 3, 5, 6, 7, 8, 9, 10], "streaming_aws4_hmac_sha256_payload": 0, "stream": [0, 3, 5, 6, 9], "aws4": 0, "hmac": 0, "sha256": [0, 2, 9], "each": [0, 3, 6, 7, 8, 9, 10], "chunk": [0, 5, 9, 10], "streaming_aws4_hmac_sha256_ev": 0, "event": [0, 3, 5, 6, 8, 9, 10], "awssignedbodyheadertyp": [0, 11], "control": [0, 6, 8, 11], "add": [0, 5, 9, 10], "canon": 0, "see": [0, 6, 7, 8, 10], "x_amz_content_sha_256": 0, "x": [0, 6, 8], "amz": 0, "content": [0, 6, 7, 8], "signature_typ": 0, "credentials_provid": 0, "date": 0, "should_sign_head": 0, "use_double_uri_encod": 0, "true": [0, 2, 3, 5, 6, 7, 8, 9, 10], "should_normalize_uri_path": 0, "signed_body_header_typ": 0, "expiration_in_second": 0, "omit_session_token": 0, "fals": [0, 2, 3, 5, 6, 7, 8, 9, 10], "configur": [0, 6, 8, 9], "relat": [0, 7, 8], "It": [0, 7, 8, 9, 10], "good": 0, "practic": 0, "new": [0, 2, 3, 5, 7, 8, 9, 10], "might": [0, 6, 7], "get": [0, 5, 9, 10], "too": [0, 8, 10], "old": [0, 5], "ecc": 0, "base": [0, 3, 4, 6, 8, 9], "deriv": [0, 9], "against": [0, 2, 9], "amzn": 0, "ad": [0, 9, 10], "dure": 0, "now": [0, 7], "naiv": 0, "lack": 0, "info": [0, 6, 7, 8, 9], "local": [0, 3, 5, 6], "bool": [0, 2, 3, 5, 6, 7, 8, 9, 10], "skip": [0, 6, 9], "requir": [0, 7, 8, 9, 10], "unus": [0, 7, 8], "inject": 0, "skippabl": 0, "doe": [0, 2, 5, 6, 7, 8, 10], "overrid": [0, 3, 6, 8, 9], "intern": [0, 3, 6, 7, 8, 9], "check": [0, 3, 5, 6, 8, 9], "trace": [0, 6], "user": [0, 3, 6, 7, 8, 10], "agent": 0, "rather": 0, "supplement": 0, "In": [0, 5, 8], "particular": [0, 8, 10], "onli": [0, 3, 6, 8, 9, 10], "both": [0, 6, 9], "whether": [0, 6, 7, 8, 9, 10], "doubl": [0, 7], "encod": [0, 5, 8, 9, 10], "resourc": [0, 3, 6], "construct": [0, 5], "alreadi": [0, 3, 5, 6, 7, 8, 10], "normal": [0, 8], "build": [0, 9], "typic": [0, 9], "written": [0, 3, 7, 9, 10], "lowercas": 0, "hex": 0, "been": [0, 3, 5, 7, 8, 9, 10], "precalcul": 0, "certain": 0, "also": [0, 6, 8, 9, 10], "pass": [0, 6, 7, 8, 9, 10], "calcul": [0, 9], "int": [0, 1, 3, 4, 5, 6, 7, 8, 9, 10], "equal": [0, 8], "omit": [0, 6, 8], "replac": 0, "kwarg": [0, 3, 5, 7, 9], "same": [0, 3, 6, 8, 10], "attribut": 0, "those": [0, 9], "given": [0, 1, 2, 3, 4, 5, 6, 8], "whichev": [0, 8], "keyword": [0, 3, 6, 9], "properti": [0, 3, 5, 8], "object": [0, 2, 3, 6, 8, 9, 10], "By": [0, 10], "what": [0, 8, 9], "otherwis": [0, 3, 4, 5, 6, 7, 8, 10], "effect": [0, 3, 5, 8], "aws_sign_request": [0, 11], "http_request": [0, 7, 8], "signing_config": [0, 9], "perform": [0, 6, 7, 8, 9, 10], "httprequest": [0, 5, 7, 8, 9, 10, 11], "transform": [0, 5, 7, 8], "accord": [0, 7, 8], "befor": [0, 5, 6, 7, 8, 9, 10], "thei": [0, 3, 6, 7, 8, 10], "signer": [0, 9], "author": [0, 7, 8, 11], "signedhead": 0, "whose": [0, 7, 8, 10], "cross": [1, 9], "platform": [1, 6, 9], "librari": [1, 3, 6], "get_cpu_group_count": [1, 11], "number": [1, 5, 6, 7, 8, 9, 10], "processor": [1, 6], "group": [1, 6], "system": [1, 6, 9], "work": [1, 6, 7, 8, 10], "non": [1, 6, 8, 9], "uniform": [1, 6], "memori": [1, 6, 9, 10], "numa": [1, 6], "node": [1, 6], "get_cpu_count_for_group": [1, 11], "group_idx": 1, "rsaencryptionalgorithm": [2, 11], "rsa": [2, 6, 11], "encrypt": 2, "pkcs1_5": 2, "pkcsv1": 2, "5": [2, 3, 6, 7, 8, 9, 10], "pad": 2, "oaep_sha256": 2, "oaep": 2, "hash": 2, "oaep_sha512": 2, "sha512": 2, "rsasignaturealgorithm": [2, 11], "pkcs1_5_sha256": 2, "pss_sha256": 2, "pss": 2, "new_private_key_from_pem_data": 2, "pem_data": 2, "byte": [2, 3, 6, 7, 8, 9, 10], "bytearrai": [2, 6, 7, 10], "memoryview": [2, 10], "pem": [2, 6], "rais": [2, 3, 5, 6, 10], "valueerror": [2, 5], "have": [2, 5, 6, 7, 8, 9, 10], "new_public_key_from_pem_data": 2, "encryption_algorithm": 2, "plaintext": [2, 8], "decrypt": 2, "ciphertext": 2, "signature_algorithm": 2, "digest": 2, "note": [2, 3, 5, 6, 7, 8, 9, 10], "expect": [2, 3], "messag": [2, 3, 4, 6, 7, 8, 9, 10], "ex": [2, 5, 6], "verifi": [2, 9, 10], "match": [2, 7, 8], "headertyp": [3, 11], "support": [3, 6, 7, 8, 9], "within": [3, 7, 8, 10], "bool_tru": 3, "No": [3, 5, 7, 8, 9], "actual": [3, 7], "transmit": [3, 6, 8], "wire": 3, "bool_fals": 3, "8": [3, 7, 8, 10], "bit": [3, 10], "int16": 3, "3": [3, 5, 6, 7, 8, 9, 10], "16": [3, 6, 8, 10], "int32": 3, "32": 3, "int64": 3, "64": 3, "byte_buf": 3, "6": [3, 6], "raw": 3, "7": [3, 6, 8], "utf": [3, 7, 8, 10], "timestamp": 3, "posix": 3, "sinc": [3, 8, 10], "unix": [3, 6], "epoch": 3, "uuid": 3, "9": [3, 10], "ani": [3, 5, 6, 7, 8, 9, 10], "header_typ": 3, "from_x": 3, "from_bool": 3, "from_byt": 3, "must": [3, 5, 6, 7, 8, 9, 10], "fit": [3, 10], "from_int16": 3, "from_int32": 3, "from_int64": 3, "from_byte_buf": 3, "bytestr": 3, "like": [3, 6, 10], "from_str": 3, "from_timestamp": 3, "from_uuid": 3, "value_as_x": 3, "method": [3, 5, 6, 8, 10], "value_as_bool": 3, "value_as_byt": 3, "value_as_int16": 3, "value_as_int32": 3, "value_as_int64": 3, "value_as_byte_buf": 3, "value_as_str": 3, "value_as_timestamp": 3, "value_as_uuid": 3, "rpc": 3, "remot": [3, 5, 8, 10], "procedur": 3, "call": [3, 5, 6, 7, 8, 9, 10], "protocol": [3, 5, 6, 7, 8], "messagetyp": [3, 11], "application_messag": 3, "application_error": 3, "sent": [3, 5, 7, 8, 9, 10], "never": [3, 6, 10], "arriv": [3, 5, 7, 8, 10], "For": [3, 4, 6, 7, 8, 9, 10], "other": [3, 6, 7, 8, 9, 10], "specif": [3, 5, 6, 8], "flag": [3, 7, 8], "consult": 3, "document": [3, 8], "applic": [3, 6, 7, 8, 10], "error": [3, 4, 5, 6, 7, 8, 9, 10], "ping": [3, 7, 10], "ping_respons": 3, "respons": [3, 5, 7, 8, 9, 10], "connect_ack": 3, "acknowledg": [3, 6, 7], "messageflag": [3, 11], "connection_accept": 3, "present": [3, 6, 7, 8, 10], "reject": [3, 7, 8, 10], "protocol_error": [3, 8], "internal_error": 3, "xore": 3, "togeth": 3, "Not": [3, 8, 9], "absent": 3, "terminate_stream": 3, "termin": [3, 8], "sender": [3, 7, 8], "close": [3, 5, 7, 8, 10], "after": [3, 7, 8, 10], "deliv": [3, 7, 8], "clientconnectionhandl": [3, 11], "handl": [3, 6, 8], "inherit": 3, "invok": [3, 5, 7, 9, 10], "on_connection_setup": [3, 10], "abstract": 3, "upon": 3, "setup": [3, 6], "attempt": [3, 5, 7, 8, 9], "wa": [3, 7, 8, 9, 10], "success": [3, 5, 7, 8, 9, 10], "network": [3, 5, 6, 7, 8, 10], "stai": [3, 8], "aliv": [3, 7, 8], "even": [3, 8, 9, 10], "refer": [3, 10], "remain": [3, 8], "store": [3, 6, 7, 10], "done": [3, 7, 9, 10], "avoid": [3, 9], "leak": [3, 6], "handler": 3, "further": [3, 10], "forward": [3, 5, 7, 9], "compat": [3, 5, 6, 7, 9], "on_connection_shutdown": [3, 10], "reason": [3, 7, 8, 9, 10], "finish": [3, 5, 6, 8, 9, 10], "shut": [3, 5, 6, 8, 9, 10], "shutdown": [3, 5, 6, 7, 8, 9, 10], "on_protocol_messag": 3, "message_typ": 3, "binari": [3, 5, 6, 8, 10], "clientconnect": [3, 11], "host_nam": [3, 5, 7, 8], "port": [3, 5, 7, 8, 10], "them": [3, 6, 10], "host": [3, 5, 6, 8, 10], "shutdown_futur": [3, 5], "indic": [3, 5, 6, 7, 8, 9, 10], "why": [3, 5, 8, 9, 10], "occur": [3, 5, 10], "socket_opt": [3, 5, 7, 8, 10], "socketopt": [3, 5, 6, 7, 8, 10, 11], "tls_connection_opt": [3, 5, 9, 10], "tlsconnectionopt": [3, 5, 6, 9, 10, 11], "singleton": [3, 5, 7, 9, 10], "over": [3, 5, 6, 7, 8, 9], "plain": [3, 5], "text": [3, 5, 10], "succe": [3, 5, 7], "made": [3, 7, 8, 9], "avail": [3, 6, 8, 9], "hasn": 3, "t": [3, 8, 10], "end": [3, 5, 6, 8], "simpli": [3, 9], "becaus": [3, 8, 9], "is_open": [3, 5], "open": [3, 5, 7, 8], "usabl": [3, 5], "know": [3, 5, 10], "send_protocol_messag": 3, "on_flush": 3, "send": [3, 5, 6, 7, 8, 10], "inform": [3, 7, 8], "noth": [3, 5, 7, 8, 9, 10], "dict": [3, 5, 7, 9], "loop": [3, 5, 6], "new_stream": 3, "clientcontinuationhandl": [3, 11], "clientcontinu": [3, 11], "activ": [3, 5], "you": [3, 5, 6, 8, 9, 10], "re": [3, 5, 7, 8, 10], "readi": [3, 5, 10], "fire": [3, 5], "continu": [3, 8, 10], "state": [3, 7, 8], "chang": [3, 6, 8, 9], "closed_futur": 3, "its": [3, 5, 6, 7, 8, 9, 10], "onc": [3, 5, 7, 8, 9, 10], "send_messag": 3, "write": [3, 6, 7, 9, 11], "common": [3, 4, 6, 8, 11], "pattern": 3, "continuation_handl": 3, "on_continuation_messag": 3, "on_continuation_clos": 3, "more": [3, 7, 8, 9, 10], "from_cod": [4, 11], "code": [4, 5, 6, 7, 8, 9, 10], "runtim": [4, 8, 11], "python": [4, 6, 11], "appropri": [4, 8, 10], "aka": 4, "aws_error_oom": 4, "memoryerror": 4, "awscrterror": [4, 7, 8, 9, 11], "baseexcept": 4, "about": [4, 7, 8, 10], "httpversion": [5, 11], "unknown": [5, 9], "http1_0": 5, "http1_1": 5, "http2": 5, "httpclientconnect": [5, 11], "proxy_opt": [5, 7, 10], "hostnam": [5, 10], "on_respons": 5, "on_bodi": [5, 9], "httpclientstream": [5, 11], "carri": 5, "out": [5, 8, 9], "exchang": [5, 6, 8], "definit": [5, 8], "outgo": [5, 6, 9], "main": [5, 10], "http_stream": 5, "status_cod": [5, 9], "statu": [5, 9, 10], "caus": [5, 6, 7, 8, 10], "buffer": [5, 6, 9, 10], "necessarili": [5, 9, 10], "whole": [5, 9, 10], "garbag": [5, 10], "collect": [5, 6, 10], "completion_futur": 5, "response_status_cod": 5, "begin": [5, 6, 9, 10], "body_stream": [5, 9], "eventu": [5, 6], "verb": 5, "httpheader": [5, 11], "union": [5, 6, 7, 8], "inputstream": [5, 6, 11], "io": [5, 7, 11], "iobas": [5, 6], "name_value_pair": 5, "treat": [5, 6], "case": [5, 6, 9], "insensit": 5, "manner": [5, 10], "iter": 5, "add_pair": 5, "exist": [5, 7, 8], "remov": 5, "get_valu": 5, "ignor": [5, 6, 8, 9, 10], "addit": [5, 6, 8], "found": 5, "keyerror": 5, "remove_valu": 5, "clear": 5, "httpproxyconnectiontyp": [5, 11], "legaci": 5, "logic": 5, "would": [5, 7, 8], "tunnel": [5, 8], "ultim": 5, "httpproxyauthenticationtyp": [5, 11], "basic": [5, 8], "usernam": [5, 7, 8], "password": [5, 6, 7, 8], "auth_typ": 5, "auth_usernam": 5, "auth_password": 5, "connection_typ": 5, "server": [5, 6, 7, 8, 9, 10], "distinct": 5, "make": [5, 6, 8, 9, 10], "o": [6, 10], "long": 6, "loglevel": [6, 11], "nolog": 6, "fatal": 6, "warn": 6, "debug": 6, "init_log": [6, 11], "log_level": 6, "file_nam": 6, "log": 6, "displai": 6, "import": [6, 7], "higher": [6, 7, 10], "disabl": [6, 7, 8, 9], "destin": 6, "stdout": 6, "stderr": 6, "eventloopgroup": [6, 11], "num_thread": 6, "cpu_group": 6, "async": [6, 7, 8], "ask": [6, 8], "maximum": [6, 7, 8, 10], "unspecifi": 6, "machin": [6, 10], "pin": 6, "cap": [6, 10], "shutdown_ev": [6, 9], "signal": [6, 9], "destroi": [6, 8, 9], "hostresolverbas": [6, 11], "dn": 6, "resolv": [6, 9], "defaulthostresolv": [6, 11], "event_loop_group": 6, "max_host": 6, "max": [6, 7, 9, 10], "cach": [6, 8, 9], "host_resolv": 6, "creation": [6, 8], "socketdomain": [6, 11], "ipv4": 6, "ipv6": 6, "domain": 6, "least": [6, 7, 8, 9], "someth": [6, 7, 8, 10], "sockettyp": [6, 11], "reliabl": 6, "two": [6, 10], "mean": [6, 8, 10], "tcp": [6, 10], "dgram": 6, "datagram": 6, "connectionless": 6, "unreli": 6, "udp": 6, "connect_timeout_m": 6, "timeout": [6, 7, 8, 9], "millisecond": [6, 7], "keep_al": 6, "period": 6, "keepal": [6, 8, 10], "detect": [6, 9], "disconnect": [6, 7, 8], "peer": 6, "keep_alive_timeout_sec": 6, "durat": [6, 7], "between": [6, 7, 8, 9], "transmiss": 6, "idl": 6, "keep_alive_interval_sec": [6, 8], "retransmiss": [6, 8], "previou": [6, 7], "keep_alive_max_prob": 6, "probe": 6, "allow": [6, 7, 8, 10], "consid": 6, "lost": [6, 7, 10], "tlsversion": [6, 11], "sslv3": 6, "tlsv1": 6, "tlsv1_1": 6, "tlsv1_2": 6, "tlsv1_3": 6, "128": [6, 8], "tlscipherpref": [6, 11], "cipher": 6, "prefer": [6, 9], "negoti": [6, 8], "At": [6, 7], "abil": 6, "arbitrari": [6, 8], "curat": 6, "vet": 6, "expos": 6, "underli": [6, 7, 8, 9, 10], "best": [6, 9], "automat": [6, 7, 9, 10], "pq_tlsv1_0_2021_05": 6, "kyber": 6, "highest": [6, 7], "prioriti": [6, 8], "post": 6, "quantum": 6, "pq": 6, "hybrid": 6, "mode": [6, 9], "combin": [6, 8], "classic": 6, "ecdh": 6, "effort": 6, "fall": [6, 8], "back": 6, "singl": [6, 8, 9, 10], "nist": 6, "announc": 6, "plan": 6, "howev": [6, 10], "introduc": 6, "minor": 6, "could": [6, 8, 9, 10], "final": [6, 7, 8, 9, 10], "implement": [6, 7, 8, 10], "is_support": 6, "tlscontextopt": [6, 11], "create_x": 6, "verify_p": 6, "min_tls_ver": 6, "minimum": [6, 7, 8, 9], "cipher_pref": 6, "509": 6, "certif": 6, "alpn_list": 6, "layer": 6, "alpn": 6, "is_alpn_avail": [6, 11], "set_alpn_list": 6, "create_client_with_mtls_from_path": 6, "cert_filepath": 6, "pk_filepath": 6, "mutual": 6, "pkc": 6, "armor": 6, "disk": [6, 10], "create_client_with_mtl": 6, "cert_buff": 6, "key_buff": 6, "create_client_with_mtls_pkcs11": 6, "pkcs11_lib": 6, "pkcs11lib": [6, 11], "user_pin": 6, "slot_id": 6, "token_label": 6, "private_key_label": 6, "cert_file_path": 6, "cert_file_cont": 6, "11": 6, "devic": [6, 7], "protect": 6, "slot": 6, "chosen": 6, "criteria": 6, "label": 6, "create_client_with_mtls_pkcs12": 6, "pkcs12_filepath": 6, "pkcs12_password": 6, "appl": 6, "12": 6, "create_client_with_mtls_windows_cert_store_path": 6, "cert_path": 6, "window": [6, 10], "backslash": 6, "thumbprint": 6, "currentus": 6, "a11f8a9b5df5b98ba3508fbca575d09570e0d2c6": 6, "create_server_from_path": 6, "create_serv": 6, "create_server_pkcs12": 6, "override_default_trust_store_from_path": 6, "ca_dirpath": 6, "ca_filepath": 6, "trust": 6, "directori": 6, "ca": 6, "override_default_trust_stor": 6, "rootca_buff": 6, "expens": 6, "lifetim": 6, "wish": [6, 8], "new_connection_opt": 6, "while": [6, 7, 8, 9, 10], "cheap": [6, 9], "share": [6, 8], "mani": [6, 10], "set_server_nam": 6, "server_nam": 6, "sni": 6, "nativ": 6, "wrap": [6, 8], "allow_non": 6, "behavior": [6, 8, 10], "initializefinalizebehavior": 6, "your": [6, 8, 9, 10], "how": [6, 8, 9], "c_initi": 6, "c_final": 6, "relax": 6, "accommod": 6, "anoth": [6, 7, 8, 9, 10], "still": [6, 8, 10], "want": [6, 8, 10], "again": [6, 7, 8, 10], "strict": 6, "cleanup": 6, "report": [6, 9, 10], "perfect": 6, "valgrind": 6, "qo": [7, 8, 11], "qualiti": [7, 8], "at_most_onc": [7, 8], "deliveri": [7, 8], "capabl": [7, 8], "retri": [7, 8], "either": [7, 8, 9, 10], "at_least_onc": [7, 8], "ensur": [7, 8, 10], "exactly_onc": [7, 8], "exactli": [7, 8], "neither": 7, "loss": 7, "nor": 7, "duplic": 7, "There": [7, 10], "increas": [7, 10], "overhead": 7, "core": [7, 8], "2020": 7, "connectreturncod": [7, 11], "unacceptable_protocol_vers": 7, "refus": 7, "unaccept": 7, "level": [7, 8, 9, 10], "identifier_reject": 7, "correct": 7, "server_unavail": [7, 8], "unavail": 7, "bad_username_or_password": [7, 8], "bad": 7, "malform": 7, "not_author": [7, 8], "Will": [7, 8, 11], "topic": [7, 8], "retain": [7, 8], "publish": [7, 8], "unexpectedli": 7, "without": [7, 9, 10], "packet": [7, 8], "onconnectionsuccessdata": [7, 11], "return_cod": 7, "session_pres": [7, 8], "dataclass": [7, 8], "on_connection_success": 7, "resum": 7, "forgotten": 7, "subscript": [7, 8, 11], "resubscribe_existing_top": 7, "reconnect": [7, 8], "onconnectionfailuredata": [7, 11], "on_connection_failur": 7, "failur": [7, 8], "onconnectioncloseddata": [7, 11], "on_connection_clos": 7, "current": [7, 8, 9], "unencrypt": 7, "operationstatisticsdata": [7, 8, 11], "incomplete_operation_count": [7, 8], "incomplete_operation_s": [7, 8], "unacked_operation_count": [7, 8], "unacked_operation_s": [7, 8], "statist": [7, 8], "queue": [7, 8], "total": [7, 8], "submit": [7, 8], "yet": [7, 8, 10], "unack": [7, 8], "subset": [7, 8], "size": [7, 8, 9, 10], "wait": [7, 8, 10], "correspond": [7, 8], "ack": [7, 8], "client_id": [7, 8], "clean_sess": 7, "on_connection_interrupt": 7, "on_connection_resum": 7, "reconnect_min_timeout_sec": 7, "reconnect_max_timeout_sec": 7, "60": 7, "keep_alive_sec": 7, "1200": 7, "ping_timeout_m": [7, 8], "3000": 7, "protocol_operation_timeout_m": 7, "use_websocket": 7, "websocket_proxy_opt": 7, "websocket_handshake_transform": [7, 8], "spawn": 7, "place": [7, 8], "uniqu": [7, 8, 9], "across": 7, "start": [7, 8, 9, 10], "clean": [7, 8, 10], "forget": 7, "rememb": 7, "qos1": [7, 8], "offlin": 7, "whenev": [7, 10], "everi": [7, 8], "callback_data": 7, "min": 7, "reach": [7, 8, 9, 10], "keep": [7, 8, 10], "interv": [7, 8], "5x": 7, "than": [7, 8, 9, 10], "invalid": 7, "shorter": 7, "zero": [7, 8, 9], "amount": [7, 8, 10], "unsubscrib": [7, 8], "websocket": [7, 8, 11], "deprec": [7, 8, 9], "handshak": [7, 8, 10], "modifi": [7, 8, 10], "websockethandshaketransformarg": [7, 8, 11], "transform_arg": [7, 8], "member": 7, "subscrib": [7, 8], "filter": [7, 8], "respond": [7, 8, 9], "suback": [7, 8], "though": 7, "cannot": [7, 8, 10], "possibl": [7, 10], "includ": [7, 8, 10], "wildcard": [7, 8], "grant": 7, "lower": 7, "dup": 7, "earlier": 7, "packet_id": 7, "unsuccess": [7, 9, 10], "subscribeerror": [7, 11], "on_messag": 7, "unsuback": [7, 8], "help": [7, 8], "resubscrib": 7, "quota": [7, 8], "manual": [7, 8, 10], "desir": [7, 8], "exce": 7, "url": 7, "doc": [7, 9], "com": [7, 9, 11], "latest": [7, 9], "gr": 7, "html": [7, 9], "genref_max_subscriptions_per_subscribe_request": 7, "where": [7, 8, 9], "so": [7, 8, 10], "soon": 7, "puback": [7, 8], "pubcomp": 7, "get_stat": [7, 8], "incomplet": [7, 8], "mqtt_connect": 7, "done_futur": [7, 8], "fn": [7, 8], "set_don": [7, 8], "went": [7, 8, 10], "wrong": [7, 8, 10], "hang": [7, 8], "scope": [7, 8, 9], "mark": [7, 8], "plu": [7, 8], "sec": [7, 8, 10], "cancel": [7, 8], "mqtt": [8, 11], "enum": 8, "spec": 8, "august": 8, "2022": 8, "connectreasoncod": [8, 11], "unspecified_error": 8, "malformed_packet": 8, "129": 8, "correctli": 8, "pars": 8, "130": 8, "conform": 8, "implementation_specific_error": 8, "131": 8, "unsupported_protocol_vers": 8, "132": 8, "client_identifier_not_valid": 8, "133": 8, "134": 8, "135": 8, "136": 8, "server_busi": 8, "137": 8, "busi": 8, "recommend": [8, 9], "try": [8, 9, 10], "later": 8, "ban": 8, "138": 8, "bad_authentication_method": 8, "140": 8, "topic_name_invalid": 8, "144": 8, "form": 8, "packet_too_larg": 8, "149": 8, "exceed": 8, "permiss": 8, "quota_exceed": 8, "151": 8, "limit": [8, 9, 10], "met": 8, "payload_format_invalid": 8, "153": 8, "retain_not_support": 8, "154": 8, "had": 8, "enabl": [8, 9], "qos_not_support": 8, "155": 8, "use_another_serv": 8, "156": 8, "tell": 8, "temporarili": 8, "server_mov": 8, "157": 8, "perman": 8, "connection_rate_exceed": 8, "159": 8, "rate": 8, "disconnectreasoncod": [8, 11], "insid": 8, "normal_disconnect": 8, "trigger": 8, "disconnect_with_will_messag": 8, "unexpect": 8, "server_shutting_down": 8, "139": 8, "keep_alive_timeout": 8, "141": 8, "session_taken_ov": 8, "142": 8, "becom": 8, "topic_filter_invalid": 8, "143": 8, "receive_maximum_exceed": 8, "147": 8, "progress": [8, 9], "itself": 8, "topic_alias_invalid": 8, "148": 8, "greater": 8, "message_rate_too_high": 8, "150": 8, "incom": [8, 10], "high": 8, "administrative_act": 8, "152": 8, "due": [8, 10], "administr": 8, "action": 8, "did": 8, "shared_subscriptions_not_support": 8, "158": 8, "maximum_connect_tim": 8, "160": 8, "subscription_identifiers_not_support": 8, "161": 8, "wildcard_subscriptions_not_support": 8, "162": 8, "pubackreasoncod": [8, 11], "recipi": 8, "no_matching_subscrib": 8, "willing": 8, "packet_identifier_in_us": 8, "145": 8, "mismatch": 8, "subackreasoncod": [8, 11], "granted_qos_0": 8, "granted_qos_1": 8, "granted_qos_2": 8, "unsubackreasoncod": [8, 11], "no_subscription_exist": 8, "17": 8, "clientsessionbehaviortyp": [8, 11], "behav": 8, "respect": 8, "map": 8, "rejoin_post_success": 8, "rejoin": 8, "expiri": 8, "rejoin_alwai": 8, "durabl": 8, "persist": 8, "guarante": [8, 10], "compliant": 8, "unacknowledg": 8, "we": [8, 9], "resumpt": 8, "technic": 8, "break": 8, "payloadformatind": [8, 11], "aws_mqtt5_pfi_byt": 8, "aws_mqtt5_pfi_utf8": 8, "well": 8, "retainhandlingtyp": [8, 11], "send_on_subscrib": 8, "send_on_subscribe_if_new": 8, "dont_send": 8, "retainandhandlingtyp": [8, 11], "pleas": 8, "extendedvalidationandflowcontrolopt": [8, 11], "flow": [8, 11], "go": 8, "beyond": 8, "broker": 8, "aws_iot_core_default": 8, "slash": 8, "segment": 8, "count": 8, "prefix": 8, "less": [8, 9], "length": [8, 10], "outbound": 8, "throughput": [8, 9, 10], "throttl": 8, "512kb": 8, "tp": 8, "100": 8, "clientoperationqueuebehaviortyp": [8, 11], "affect": [8, 9, 10], "queu": 8, "track": [8, 10], "fail_qos0_publish_on_disconnect": 8, "fail_non_qos1_publish_on_disconnect": 8, "un": 8, "front": 8, "unprocess": 8, "head": [8, 9], "line": 8, "immedi": 8, "requeu": 8, "origin": 8, "behind": 8, "fail_all_on_disconnect": 8, "retransmit": 8, "exponentialbackoffjittermod": [8, 11], "delai": 8, "smooth": 8, "distribut": 8, "timepoint": 8, "larg": 8, "exponenti": 8, "backoff": 8, "jitter": 8, "random": [8, 10], "fulli": [8, 10], "decorrel": 8, "taken": 8, "randomli": 8, "scale": [8, 9], "userproperti": [8, 11], "outboundtopicaliasbehaviortyp": [8, 11], "alias": 8, "broken": 8, "problem": 8, "previous": 8, "disrupt": 8, "unpredict": 8, "properli": 8, "recent": [8, 10], "seen": 8, "lru": 8, "drive": 8, "usag": [8, 9, 10], "inboundtopicaliasbehaviortyp": [8, 11], "forbid": 8, "topicaliasingopt": [8, 11], "outbound_behavior": 8, "outbound_cache_max_s": 8, "inbound_behavior": 8, "inbound_cache_max_s": 8, "kind": 8, "directli": [8, 9], "manipul": 8, "left": [8, 10], "undefin": 8, "sensibl": 8, "25": 8, "inbound": 8, "up": [8, 9, 10], "choos": 8, "anyth": [8, 10], "topic_alias_maximum": 8, "field": [8, 9, 10], "negotiatedset": [8, 11], "maximum_qo": 8, "session_expiry_interval_sec": 8, "receive_maximum_from_serv": 8, "maximum_packet_size_to_serv": 8, "topic_alias_maximum_to_serv": 8, "topic_alias_maximum_to_cli": 8, "server_keep_alive_sec": 8, "retain_avail": 8, "wildcard_subscriptions_avail": 8, "subscription_identifiers_avail": 8, "shared_subscriptions_avail": 8, "rejoined_sess": 8, "dynam": 8, "connack": 8, "infer": 8, "emit": 8, "authorit": 8, "commun": 8, "flight": [8, 10], "pingreq": 8, "breach": 8, "inact": 8, "newli": 8, "assign": 8, "auto": 8, "connackpacket": [8, 11], "reason_cod": 8, "receive_maximum": 8, "maximum_packet_s": 8, "assigned_client_identifi": 8, "reason_str": 8, "user_properti": 8, "shared_subscription_avail": 8, "response_inform": 8, "server_refer": 8, "model": 8, "space": 8, "65535": 8, "impos": 8, "diagnost": 8, "server_keep_al": 8, "outsid": 8, "purview": 8, "altern": 8, "servermov": 8, "useanotherserv": 8, "disconnectpacket": [8, 11], "topic_filt": 8, "no_loc": 8, "retain_as_publish": 8, "retain_handling_typ": 8, "who": 8, "preserv": 8, "reaction": 8, "subscribepacket": [8, 11], "subscription_identifi": 8, "listen": 8, "posit": 8, "subackpacket": [8, 11], "individu": 8, "entri": 8, "unsubscribepacket": [8, 11], "unsubackpacket": [8, 11], "publishpacket": [8, 11], "payload_format_ind": 8, "message_expiry_interval_sec": 8, "topic_alia": 8, "response_top": 8, "correlation_data_byt": 8, "correlation_data": 8, "content_typ": 8, "enforc": 8, "meaning": 8, "elaps": 8, "delet": 8, "perspect": 8, "integ": 8, "opaqu": 8, "intend": 8, "assist": 8, "correl": 8, "potenti": 8, "utf8": 8, "didn": 8, "wasn": 8, "pubackpacket": [8, 11], "connectpacket": [8, 11], "request_response_inform": 8, "request_problem_inform": 8, "will_delay_interval_sec": 8, "permit": 8, "point": 8, "next": [8, 10], "maintain": [8, 10], "restor": 8, "subsequ": 8, "notifi": 8, "natur": [8, 10], "destruct": 8, "come": 8, "publishreceiveddata": [8, 11], "publish_packet": 8, "lifecyclestoppeddata": [8, 11], "stop": [8, 10], "lifecycl": 8, "lifecycleattemptingconnectdata": [8, 11], "lifecycleconnectsuccessdata": [8, 11], "connack_packet": 8, "negotiated_set": 8, "lifecycleconnectfailuredata": [8, 11], "error_cod": 8, "lifecycledisconnectdata": [8, 11], "disconnect_packet": 8, "publishcompletiondata": [8, 11], "clientopt": [8, 11], "connect_opt": 8, "session_behavior": 8, "extended_validation_and_flow_control_opt": 8, "offline_queue_behavior": 8, "retry_jitter_mod": 8, "min_reconnect_delay_m": 8, "max_reconnect_delay_m": 8, "min_connected_time_to_reset_reconnect_delay_m": 8, "connack_timeout_m": 8, "ack_timeout_sec": 8, "topic_aliasing_opt": 8, "on_publish_callback_fn": 8, "on_lifecycle_event_stopped_fn": 8, "on_lifecycle_event_attempting_connect_fn": 8, "on_lifecycle_event_connection_success_fn": 8, "on_lifecycle_event_connection_failure_fn": 8, "on_lifecycle_event_disconnection_fn": 8, "act": 8, "trivial": 8, "direct": 8, "These": [8, 10], "reset": 8, "allevi": 8, "bandwidth": 8, "wast": 8, "fast": [8, 10], "cycl": 8, "pingresp": 8, "client_opt": 8, "c": 8, "pub": 8, "sub": 8, "One": 8, "halt": 8, "pubackresult": 8, "vari": 8, "depend": 8, "subscribe_packet": 8, "unsubscribe_packet": 8, "crossprocesslock": [9, 11], "lock_scope_nam": 9, "exclus": 9, "lock": 9, "explicitli": 9, "acquir": 9, "releas": 9, "statement": 9, "throw": 9, "runtimeerror": 9, "aws_mutex_caller_not_own": 9, "exit": 9, "caller": 9, "hold": 9, "s3requesttyp": [9, 11], "get_object": 9, "put_object": 9, "put": 9, "s3requesttlsmod": [9, 11], "s3checksumalgorithm": [9, 11], "checksum": 9, "integr": 9, "amazons3": 9, "userguid": 9, "crc32c": 9, "crc32": 9, "sha1": 9, "s3checksumloc": [9, 11], "trailer": 9, "effici": 9, "s3checksumconfig": [9, 11], "locat": 9, "validate_respons": 9, "s3client": [9, 11], "retriev": 9, "tls_mode": 9, "credential_provid": [9, 11], "part_siz": 9, "multipart_upload_threshold": 9, "throughput_target_gbp": 9, "enable_s3express": 9, "memory_limit": 9, "bucket": 9, "live": 9, "unset": 9, "regardless": [9, 10], "create_default_s3_signing_config": [9, 11], "anonym": 9, "right": [9, 10], "sigv4_s3express": 9, "modif": 9, "unless": [9, 10], "download": 9, "upload": 9, "adjust": 9, "meet": 9, "10": [9, 10], "000": 9, "mib": 9, "threshold": 9, "multipart": 9, "strategi": 9, "maxim": 9, "float": 9, "target": 9, "gigabit": 9, "gbp": 9, "get_recommended_throughput_target_gbp": [9, 11], "let": [9, 10], "much": 9, "2gib": 9, "8gib": 9, "make_request": 9, "operation_nam": 9, "recv_filepath": 9, "send_filepath": 9, "checksum_config": 9, "on_head": 9, "on_don": 9, "on_progress": 9, "split": 9, "multi": 9, "under": 9, "hood": 9, "acceler": 9, "overal": [9, 10], "api": 9, "better": [9, 10], "createbucket": 9, "popul": 9, "fill": 9, "detail": [9, 10], "metric": 9, "give": 9, "aws_s3_client_config": 9, "offset": 9, "job": 9, "error_head": 9, "els": 9, "error_bodi": 9, "error_operation_nam": 9, "putobject": 9, "createmultipartupload": 9, "uploadpart": 9, "completemultipartupload": 9, "did_validate_checksum": 9, "compar": 9, "checksum_validation_algorithm": 9, "transfer": 9, "s3request": [9, 11], "finished_futur": 9, "happen": 9, "structur": 9, "s3responseerror": [9, 11], "subclass": 9, "xml": 9, "known": 9, "crt": [9, 11], "get_ec2_instance_typ": [9, 11], "dmi": 9, "imd": 9, "abl": 9, "stack": 9, "spun": 9, "background": 9, "easier": 9, "freed": 9, "modul": 9, "unload": 9, "is_optimized_for_system": [9, 11], "optim": 9, "get_optimized_platform": [9, 11], "pre": 9, "obtain": 9, "rfc": 10, "6455": 10, "develop": 10, "veri": 10, "low": 10, "forc": 10, "deal": 10, "fragment": 10, "easili": 10, "top": 10, "NOT": 10, "block": 10, "deadlock": 10, "frame": 10, "stuck": 10, "don": 10, "fine": 10, "safe": 10, "mix": 10, "hand": 10, "prevent": 10, "faster": 10, "balloon": 10, "explod": 10, "manag": 10, "simplest": 10, "on_incoming_fram": 10, "therefor": 10, "print": 10, "screen": 10, "etc": 10, "risk": 10, "complex": 10, "along": 10, "manage_read_window": 10, "initial_read_window": 10, "awai": 10, "shrink": 10, "increment_read_window": 10, "worri": 10, "increment": 10, "opcod": [10, 11], "pong": 10, "ll": 10, "probabl": 10, "pick": 10, "shrunk": 10, "larger": 10, "approach": 10, "send_fram": 10, "on_complet": 10, "Then": 10, "classifi": 10, "section": 10, "serv": 10, "is_data_fram": 10, "rest": 10, "thorough": 10, "explan": 10, "max_payload_length": [10, 11], "9223372036854775807": 10, "onconnectionsetupdata": [10, 11], "handshake_response_statu": 10, "handshake_response_head": 10, "handshake_response_bodi": 10, "explain": 10, "succeed": 10, "somewher": 10, "interest": 10, "101": 10, "onconnectionshutdowndata": [10, 11], "cleanli": 10, "incomingfram": [10, 11], "payload_length": 10, "fin": 10, "onincomingframebegindata": [10, 11], "on_incoming_frame_begin": 10, "on_incoming_frame_payload": 10, "on_incoming_frame_complet": 10, "onincomingframepayloaddata": [10, 11], "len": 10, "onincomingframecompletedata": [10, 11], "onsendframecompletedata": [10, 11], "healthi": 10, "middl": 10, "idempot": 10, "on_shutdown_complet": 10, "expert": 10, "stick": 10, "touch": 10, "learn": 10, "unsent": 10, "understand": 10, "But": 10, "doesn": 10, "Be": 10, "sure": 10, "handshake_request": 10, "drop": 10, "reli": 10, "easi": 10, "accident": 10, "around": 10, "realiz": 10, "443": 10, "80": 10, "upgrad": 10, "base64": 10, "13": 10, "create_handshake_request": [10, 11], "accordingli": 10, "github": 11, "awslab": 11, "pypi": 11, "org": 11, "project": 11, "auth": 11, "crypto": 11, "eventstream": 11, "mqtt5": 11, "index": 11, "search": 11, "page": 11}, "objects": {"awscrt": [[0, 0, 0, "-", "auth"], [1, 0, 0, "-", "common"], [2, 0, 0, "-", "crypto"], [3, 0, 0, "-", "eventstream"], [4, 0, 0, "-", "exceptions"], [5, 0, 0, "-", "http"], [6, 0, 0, "-", "io"], [7, 0, 0, "-", "mqtt"], [8, 0, 0, "-", "mqtt5"], [9, 0, 0, "-", "s3"], [10, 0, 0, "-", "websocket"]], "awscrt.auth": [[0, 1, 1, "", "AwsCredentials"], [0, 1, 1, "", "AwsCredentialsProvider"], [0, 1, 1, "", "AwsSignatureType"], [0, 1, 1, "", "AwsSignedBodyHeaderType"], [0, 1, 1, "", "AwsSignedBodyValue"], [0, 1, 1, "", "AwsSigningAlgorithm"], [0, 1, 1, "", "AwsSigningConfig"], [0, 5, 1, "", "aws_sign_request"]], "awscrt.auth.AwsCredentials": [[0, 2, 1, "", "access_key_id"], [0, 2, 1, "", "expiration"], [0, 2, 1, "", "secret_access_key"], [0, 2, 1, "", "session_token"]], "awscrt.auth.AwsCredentialsProvider": [[0, 3, 1, "", "get_credentials"], [0, 3, 1, "", "new_chain"], [0, 3, 1, "", "new_cognito"], [0, 3, 1, "", "new_default_chain"], [0, 3, 1, "", "new_delegate"], [0, 3, 1, "", "new_environment"], [0, 3, 1, "", "new_process"], [0, 3, 1, "", "new_profile"], [0, 3, 1, "", "new_static"], [0, 3, 1, "", "new_x509"]], "awscrt.auth.AwsSignatureType": [[0, 2, 1, "", "HTTP_REQUEST_HEADERS"], [0, 2, 1, "", "HTTP_REQUEST_QUERY_PARAMS"]], "awscrt.auth.AwsSignedBodyHeaderType": [[0, 2, 1, "", "NONE"], [0, 2, 1, "", "X_AMZ_CONTENT_SHA_256"]], "awscrt.auth.AwsSignedBodyValue": [[0, 2, 1, "", "EMPTY_SHA256"], [0, 2, 1, "", "STREAMING_AWS4_HMAC_SHA256_EVENTS"], [0, 2, 1, "", "STREAMING_AWS4_HMAC_SHA256_PAYLOAD"], [0, 2, 1, "", "UNSIGNED_PAYLOAD"]], "awscrt.auth.AwsSigningAlgorithm": [[0, 2, 1, "", "V4"], [0, 2, 1, "", "V4_ASYMMETRIC"], [0, 2, 1, "", "V4_S3EXPRESS"]], "awscrt.auth.AwsSigningConfig": [[0, 4, 1, "", "algorithm"], [0, 4, 1, "", "credentials_provider"], [0, 4, 1, "", "date"], [0, 4, 1, "", "expiration_in_seconds"], [0, 4, 1, "", "omit_session_token"], [0, 4, 1, "", "region"], [0, 3, 1, "", "replace"], [0, 4, 1, "", "service"], [0, 4, 1, "", "should_normalize_uri_path"], [0, 4, 1, "", "should_sign_header"], [0, 4, 1, "", "signature_type"], [0, 4, 1, "", "signed_body_header_type"], [0, 4, 1, "", "signed_body_value"], [0, 4, 1, "", "use_double_uri_encode"]], "awscrt.common": [[1, 5, 1, "", "get_cpu_count_for_group"], [1, 5, 1, "", "get_cpu_group_count"]], "awscrt.crypto": [[2, 1, 1, "", "RSA"], [2, 1, 1, "", "RSAEncryptionAlgorithm"], [2, 1, 1, "", "RSASignatureAlgorithm"]], "awscrt.crypto.RSA": [[2, 3, 1, "", "decrypt"], [2, 3, 1, "", "encrypt"], [2, 3, 1, "", "new_private_key_from_pem_data"], [2, 3, 1, "", "new_public_key_from_pem_data"], [2, 3, 1, "", "sign"], [2, 3, 1, "", "verify"]], "awscrt.crypto.RSAEncryptionAlgorithm": [[2, 2, 1, "", "OAEP_SHA256"], [2, 2, 1, "", "OAEP_SHA512"], [2, 2, 1, "", "PKCS1_5"]], "awscrt.crypto.RSASignatureAlgorithm": [[2, 2, 1, "", "PKCS1_5_SHA256"], [2, 2, 1, "", "PSS_SHA256"]], "awscrt.eventstream": [[3, 1, 1, "", "Header"], [3, 1, 1, "", "HeaderType"], [3, 0, 0, "-", "rpc"]], "awscrt.eventstream.Header": [[3, 3, 1, "", "from_bool"], [3, 3, 1, "", "from_byte"], [3, 3, 1, "", "from_byte_buf"], [3, 3, 1, "", "from_int16"], [3, 3, 1, "", "from_int32"], [3, 3, 1, "", "from_int64"], [3, 3, 1, "", "from_string"], [3, 3, 1, "", "from_timestamp"], [3, 3, 1, "", "from_uuid"], [3, 4, 1, "", "name"], [3, 4, 1, "", "type"], [3, 4, 1, "", "value"], [3, 3, 1, "", "value_as_bool"], [3, 3, 1, "", "value_as_byte"], [3, 3, 1, "", "value_as_byte_buf"], [3, 3, 1, "", "value_as_int16"], [3, 3, 1, "", "value_as_int32"], [3, 3, 1, "", "value_as_int64"], [3, 3, 1, "", "value_as_string"], [3, 3, 1, "", "value_as_timestamp"], [3, 3, 1, "", "value_as_uuid"]], "awscrt.eventstream.HeaderType": [[3, 2, 1, "", "BOOL_FALSE"], [3, 2, 1, "", "BOOL_TRUE"], [3, 2, 1, "", "BYTE"], [3, 2, 1, "", "BYTE_BUF"], [3, 2, 1, "", "INT16"], [3, 2, 1, "", "INT32"], [3, 2, 1, "", "INT64"], [3, 2, 1, "", "STRING"], [3, 2, 1, "", "TIMESTAMP"], [3, 2, 1, "", "UUID"]], "awscrt.eventstream.rpc": [[3, 1, 1, "", "ClientConnection"], [3, 1, 1, "", "ClientConnectionHandler"], [3, 1, 1, "", "ClientContinuation"], [3, 1, 1, "", "ClientContinuationHandler"], [3, 1, 1, "", "MessageFlag"], [3, 1, 1, "", "MessageType"]], "awscrt.eventstream.rpc.ClientConnection": [[3, 3, 1, "", "close"], [3, 3, 1, "", "connect"], [3, 2, 1, "", "host_name"], [3, 3, 1, "", "is_open"], [3, 3, 1, "", "new_stream"], [3, 2, 1, "", "port"], [3, 3, 1, "", "send_protocol_message"], [3, 2, 1, "", "shutdown_future"]], "awscrt.eventstream.rpc.ClientConnectionHandler": [[3, 3, 1, "", "on_connection_setup"], [3, 3, 1, "", "on_connection_shutdown"], [3, 3, 1, "", "on_protocol_message"]], "awscrt.eventstream.rpc.ClientContinuation": [[3, 3, 1, "", "activate"], [3, 2, 1, "", "closed_future"], [3, 2, 1, "", "connection"], [3, 3, 1, "", "send_message"]], "awscrt.eventstream.rpc.ClientContinuationHandler": [[3, 3, 1, "", "on_continuation_closed"], [3, 3, 1, "", "on_continuation_message"]], "awscrt.eventstream.rpc.MessageFlag": [[3, 2, 1, "", "CONNECTION_ACCEPTED"], [3, 2, 1, "", "NONE"], [3, 2, 1, "", "TERMINATE_STREAM"]], "awscrt.eventstream.rpc.MessageType": [[3, 2, 1, "", "APPLICATION_ERROR"], [3, 2, 1, "", "APPLICATION_MESSAGE"], [3, 2, 1, "", "CONNECT"], [3, 2, 1, "", "CONNECT_ACK"], [3, 2, 1, "", "INTERNAL_ERROR"], [3, 2, 1, "", "PING"], [3, 2, 1, "", "PING_RESPONSE"], [3, 2, 1, "", "PROTOCOL_ERROR"]], "awscrt.exceptions": [[4, 6, 1, "", "AwsCrtError"], [4, 5, 1, "", "from_code"]], "awscrt.exceptions.AwsCrtError": [[4, 2, 1, "", "code"], [4, 2, 1, "", "message"], [4, 2, 1, "", "name"]], "awscrt.http": [[5, 1, 1, "", "HttpClientConnection"], [5, 1, 1, "", "HttpClientStream"], [5, 1, 1, "", "HttpHeaders"], [5, 1, 1, "", "HttpProxyAuthenticationType"], [5, 1, 1, "", "HttpProxyConnectionType"], [5, 1, 1, "", "HttpProxyOptions"], [5, 1, 1, "", "HttpRequest"], [5, 1, 1, "", "HttpVersion"]], "awscrt.http.HttpClientConnection": [[5, 3, 1, "", "close"], [5, 4, 1, "", "host_name"], [5, 3, 1, "", "is_open"], [5, 3, 1, "", "new"], [5, 4, 1, "", "port"], [5, 3, 1, "", "request"], [5, 4, 1, "", "shutdown_future"], [5, 4, 1, "", "version"]], "awscrt.http.HttpClientStream": [[5, 3, 1, "", "activate"], [5, 2, 1, "", "completion_future"], [5, 2, 1, "", "connection"], [5, 4, 1, "", "response_status_code"]], "awscrt.http.HttpHeaders": [[5, 3, 1, "", "add"], [5, 3, 1, "", "add_pairs"], [5, 3, 1, "", "clear"], [5, 3, 1, "", "get"], [5, 3, 1, "", "get_values"], [5, 3, 1, "", "remove"], [5, 3, 1, "", "remove_value"], [5, 3, 1, "", "set"]], "awscrt.http.HttpProxyAuthenticationType": [[5, 2, 1, "", "Basic"], [5, 2, 1, "", "Nothing"]], "awscrt.http.HttpProxyConnectionType": [[5, 2, 1, "", "Forwarding"], [5, 2, 1, "", "Legacy"], [5, 2, 1, "", "Tunneling"]], "awscrt.http.HttpProxyOptions": [[5, 2, 1, "", "auth_password"], [5, 2, 1, "", "auth_type"], [5, 2, 1, "", "auth_username"], [5, 2, 1, "", "connection_type"], [5, 2, 1, "", "host_name"], [5, 2, 1, "", "port"], [5, 2, 1, "", "tls_connection_options"]], "awscrt.http.HttpRequest": [[5, 4, 1, "", "headers"], [5, 4, 1, "", "method"], [5, 4, 1, "", "path"]], "awscrt.http.HttpVersion": [[5, 2, 1, "", "Http1_0"], [5, 2, 1, "", "Http1_1"], [5, 2, 1, "", "Http2"], [5, 2, 1, "", "Unknown"]], "awscrt.io": [[6, 1, 1, "", "ClientBootstrap"], [6, 1, 1, "", "ClientTlsContext"], [6, 1, 1, "", "DefaultHostResolver"], [6, 1, 1, "", "EventLoopGroup"], [6, 1, 1, "", "HostResolverBase"], [6, 1, 1, "", "InputStream"], [6, 1, 1, "", "LogLevel"], [6, 1, 1, "", "Pkcs11Lib"], [6, 1, 1, "", "SocketDomain"], [6, 1, 1, "", "SocketOptions"], [6, 1, 1, "", "SocketType"], [6, 1, 1, "", "TlsCipherPref"], [6, 1, 1, "", "TlsConnectionOptions"], [6, 1, 1, "", "TlsContextOptions"], [6, 1, 1, "", "TlsVersion"], [6, 5, 1, "", "init_logging"], [6, 5, 1, "", "is_alpn_available"]], "awscrt.io.ClientBootstrap": [[6, 2, 1, "", "shutdown_event"]], "awscrt.io.ClientTlsContext": [[6, 3, 1, "", "new_connection_options"]], "awscrt.io.EventLoopGroup": [[6, 2, 1, "", "shutdown_event"]], "awscrt.io.InputStream": [[6, 3, 1, "", "wrap"]], "awscrt.io.LogLevel": [[6, 2, 1, "", "Debug"], [6, 2, 1, "", "Error"], [6, 2, 1, "", "Fatal"], [6, 2, 1, "", "Info"], [6, 2, 1, "", "NoLogs"], [6, 2, 1, "", "Trace"], [6, 2, 1, "", "Warn"]], "awscrt.io.Pkcs11Lib": [[6, 1, 1, "", "InitializeFinalizeBehavior"]], "awscrt.io.Pkcs11Lib.InitializeFinalizeBehavior": [[6, 2, 1, "", "DEFAULT"], [6, 2, 1, "", "OMIT"], [6, 2, 1, "", "STRICT"]], "awscrt.io.SocketDomain": [[6, 2, 1, "", "IPv4"], [6, 2, 1, "", "IPv6"], [6, 2, 1, "", "Local"]], "awscrt.io.SocketOptions": [[6, 2, 1, "", "connect_timeout_ms"], [6, 2, 1, "", "domain"], [6, 2, 1, "", "keep_alive"], [6, 2, 1, "", "keep_alive_interval_secs"], [6, 2, 1, "", "keep_alive_max_probes"], [6, 2, 1, "", "keep_alive_timeout_secs"], [6, 2, 1, "", "type"]], "awscrt.io.SocketType": [[6, 2, 1, "", "DGram"], [6, 2, 1, "", "Stream"]], "awscrt.io.TlsCipherPref": [[6, 2, 1, "", "DEFAULT"], [6, 2, 1, "", "PQ_TLSv1_0_2021_05"], [6, 3, 1, "", "is_supported"]], "awscrt.io.TlsConnectionOptions": [[6, 3, 1, "", "set_alpn_list"], [6, 3, 1, "", "set_server_name"], [6, 2, 1, "", "tls_ctx"]], "awscrt.io.TlsContextOptions": [[6, 2, 1, "", "alpn_list"], [6, 2, 1, "", "cipher_pref"], [6, 3, 1, "", "create_client_with_mtls"], [6, 3, 1, "", "create_client_with_mtls_from_path"], [6, 3, 1, "", "create_client_with_mtls_pkcs11"], [6, 3, 1, "", "create_client_with_mtls_pkcs12"], [6, 3, 1, "", "create_client_with_mtls_windows_cert_store_path"], [6, 3, 1, "", "create_server"], [6, 3, 1, "", "create_server_from_path"], [6, 3, 1, "", "create_server_pkcs12"], [6, 2, 1, "", "min_tls_ver"], [6, 3, 1, "", "override_default_trust_store"], [6, 3, 1, "", "override_default_trust_store_from_path"], [6, 2, 1, "", "verify_peer"]], "awscrt.io.TlsVersion": [[6, 2, 1, "", "DEFAULT"], [6, 2, 1, "", "SSLv3"], [6, 2, 1, "", "TLSv1"], [6, 2, 1, "", "TLSv1_1"], [6, 2, 1, "", "TLSv1_2"], [6, 2, 1, "", "TLSv1_3"]], "awscrt.mqtt": [[7, 1, 1, "", "Client"], [7, 1, 1, "", "ConnectReturnCode"], [7, 1, 1, "", "Connection"], [7, 1, 1, "", "OnConnectionClosedData"], [7, 1, 1, "", "OnConnectionFailureData"], [7, 1, 1, "", "OnConnectionSuccessData"], [7, 1, 1, "", "OperationStatisticsData"], [7, 1, 1, "", "QoS"], [7, 6, 1, "", "SubscribeError"], [7, 1, 1, "", "WebsocketHandshakeTransformArgs"], [7, 1, 1, "", "Will"]], "awscrt.mqtt.ConnectReturnCode": [[7, 2, 1, "", "ACCEPTED"], [7, 2, 1, "", "BAD_USERNAME_OR_PASSWORD"], [7, 2, 1, "", "IDENTIFIER_REJECTED"], [7, 2, 1, "", "NOT_AUTHORIZED"], [7, 2, 1, "", "SERVER_UNAVAILABLE"], [7, 2, 1, "", "UNACCEPTABLE_PROTOCOL_VERSION"]], "awscrt.mqtt.Connection": [[7, 3, 1, "", "connect"], [7, 3, 1, "", "disconnect"], [7, 3, 1, "", "get_stats"], [7, 3, 1, "", "on_message"], [7, 3, 1, "", "publish"], [7, 3, 1, "", "resubscribe_existing_topics"], [7, 3, 1, "", "subscribe"], [7, 3, 1, "", "unsubscribe"]], "awscrt.mqtt.QoS": [[7, 2, 1, "", "AT_LEAST_ONCE"], [7, 2, 1, "", "AT_MOST_ONCE"], [7, 2, 1, "", "EXACTLY_ONCE"]], "awscrt.mqtt.WebsocketHandshakeTransformArgs": [[7, 2, 1, "", "http_request"], [7, 2, 1, "", "mqtt_connection"], [7, 3, 1, "", "set_done"]], "awscrt.mqtt.Will": [[7, 2, 1, "", "payload"], [7, 2, 1, "", "qos"], [7, 2, 1, "", "retain"], [7, 2, 1, "", "topic"]], "awscrt.mqtt5": [[8, 1, 1, "", "Client"], [8, 1, 1, "", "ClientOperationQueueBehaviorType"], [8, 1, 1, "", "ClientOptions"], [8, 1, 1, "", "ClientSessionBehaviorType"], [8, 1, 1, "", "ConnackPacket"], [8, 1, 1, "", "ConnectPacket"], [8, 1, 1, "", "ConnectReasonCode"], [8, 1, 1, "", "DisconnectPacket"], [8, 1, 1, "", "DisconnectReasonCode"], [8, 1, 1, "", "ExponentialBackoffJitterMode"], [8, 1, 1, "", "ExtendedValidationAndFlowControlOptions"], [8, 1, 1, "", "InboundTopicAliasBehaviorType"], [8, 1, 1, "", "LifecycleAttemptingConnectData"], [8, 1, 1, "", "LifecycleConnectFailureData"], [8, 1, 1, "", "LifecycleConnectSuccessData"], [8, 1, 1, "", "LifecycleDisconnectData"], [8, 1, 1, "", "LifecycleStoppedData"], [8, 1, 1, "", "NegotiatedSettings"], [8, 1, 1, "", "OperationStatisticsData"], [8, 1, 1, "", "OutboundTopicAliasBehaviorType"], [8, 1, 1, "", "PayloadFormatIndicator"], [8, 1, 1, "", "PubackPacket"], [8, 1, 1, "", "PubackReasonCode"], [8, 1, 1, "", "PublishCompletionData"], [8, 1, 1, "", "PublishPacket"], [8, 1, 1, "", "PublishReceivedData"], [8, 1, 1, "", "QoS"], [8, 1, 1, "", "RetainAndHandlingType"], [8, 1, 1, "", "RetainHandlingType"], [8, 1, 1, "", "SubackPacket"], [8, 1, 1, "", "SubackReasonCode"], [8, 1, 1, "", "SubscribePacket"], [8, 1, 1, "", "Subscription"], [8, 1, 1, "", "TopicAliasingOptions"], [8, 1, 1, "", "UnsubackPacket"], [8, 1, 1, "", "UnsubackReasonCode"], [8, 1, 1, "", "UnsubscribePacket"], [8, 1, 1, "", "UserProperty"], [8, 1, 1, "", "WebsocketHandshakeTransformArgs"]], "awscrt.mqtt5.Client": [[8, 3, 1, "", "get_stats"], [8, 3, 1, "", "publish"], [8, 3, 1, "", "start"], [8, 3, 1, "", "stop"], [8, 3, 1, "", "subscribe"], [8, 3, 1, "", "unsubscribe"]], "awscrt.mqtt5.ClientOperationQueueBehaviorType": [[8, 2, 1, "", "DEFAULT"], [8, 2, 1, "", "FAIL_ALL_ON_DISCONNECT"], [8, 2, 1, "", "FAIL_NON_QOS1_PUBLISH_ON_DISCONNECT"], [8, 2, 1, "", "FAIL_QOS0_PUBLISH_ON_DISCONNECT"]], "awscrt.mqtt5.ClientSessionBehaviorType": [[8, 2, 1, "", "CLEAN"], [8, 2, 1, "", "DEFAULT"], [8, 2, 1, "", "REJOIN_ALWAYS"], [8, 2, 1, "", "REJOIN_POST_SUCCESS"]], "awscrt.mqtt5.ConnectReasonCode": [[8, 2, 1, "", "BAD_AUTHENTICATION_METHOD"], [8, 2, 1, "", "BAD_USERNAME_OR_PASSWORD"], [8, 2, 1, "", "BANNED"], [8, 2, 1, "", "CLIENT_IDENTIFIER_NOT_VALID"], [8, 2, 1, "", "CONNECTION_RATE_EXCEEDED"], [8, 2, 1, "", "IMPLEMENTATION_SPECIFIC_ERROR"], [8, 2, 1, "", "MALFORMED_PACKET"], [8, 2, 1, "", "NOT_AUTHORIZED"], [8, 2, 1, "", "PACKET_TOO_LARGE"], [8, 2, 1, "", "PAYLOAD_FORMAT_INVALID"], [8, 2, 1, "", "PROTOCOL_ERROR"], [8, 2, 1, "", "QOS_NOT_SUPPORTED"], [8, 2, 1, "", "QUOTA_EXCEEDED"], [8, 2, 1, "", "RETAIN_NOT_SUPPORTED"], [8, 2, 1, "", "SERVER_BUSY"], [8, 2, 1, "", "SERVER_MOVED"], [8, 2, 1, "", "SERVER_UNAVAILABLE"], [8, 2, 1, "", "SUCCESS"], [8, 2, 1, "", "TOPIC_NAME_INVALID"], [8, 2, 1, "", "UNSPECIFIED_ERROR"], [8, 2, 1, "", "UNSUPPORTED_PROTOCOL_VERSION"], [8, 2, 1, "", "USE_ANOTHER_SERVER"]], "awscrt.mqtt5.DisconnectReasonCode": [[8, 2, 1, "", "ADMINISTRATIVE_ACTION"], [8, 2, 1, "", "CONNECTION_RATE_EXCEEDED"], [8, 2, 1, "", "DISCONNECT_WITH_WILL_MESSAGE"], [8, 2, 1, "", "IMPLEMENTATION_SPECIFIC_ERROR"], [8, 2, 1, "", "KEEP_ALIVE_TIMEOUT"], [8, 2, 1, "", "MALFORMED_PACKET"], [8, 2, 1, "", "MAXIMUM_CONNECT_TIME"], [8, 2, 1, "", "MESSAGE_RATE_TOO_HIGH"], [8, 2, 1, "", "NORMAL_DISCONNECTION"], [8, 2, 1, "", "NOT_AUTHORIZED"], [8, 2, 1, "", "PACKET_TOO_LARGE"], [8, 2, 1, "", "PAYLOAD_FORMAT_INVALID"], [8, 2, 1, "", "PROTOCOL_ERROR"], [8, 2, 1, "", "QOS_NOT_SUPPORTED"], [8, 2, 1, "", "QUOTA_EXCEEDED"], [8, 2, 1, "", "RECEIVE_MAXIMUM_EXCEEDED"], [8, 2, 1, "", "RETAIN_NOT_SUPPORTED"], [8, 2, 1, "", "SERVER_BUSY"], [8, 2, 1, "", "SERVER_MOVED"], [8, 2, 1, "", "SERVER_SHUTTING_DOWN"], [8, 2, 1, "", "SESSION_TAKEN_OVER"], [8, 2, 1, "", "SHARED_SUBSCRIPTIONS_NOT_SUPPORTED"], [8, 2, 1, "", "SUBSCRIPTION_IDENTIFIERS_NOT_SUPPORTED"], [8, 2, 1, "", "TOPIC_ALIAS_INVALID"], [8, 2, 1, "", "TOPIC_FILTER_INVALID"], [8, 2, 1, "", "TOPIC_NAME_INVALID"], [8, 2, 1, "", "UNSPECIFIED_ERROR"], [8, 2, 1, "", "USE_ANOTHER_SERVER"], [8, 2, 1, "", "WILDCARD_SUBSCRIPTIONS_NOT_SUPPORTED"]], "awscrt.mqtt5.ExponentialBackoffJitterMode": [[8, 2, 1, "", "DECORRELATED"], [8, 2, 1, "", "DEFAULT"], [8, 2, 1, "", "FULL"], [8, 2, 1, "", "NONE"]], "awscrt.mqtt5.ExtendedValidationAndFlowControlOptions": [[8, 2, 1, "", "AWS_IOT_CORE_DEFAULTS"], [8, 2, 1, "", "NONE"]], "awscrt.mqtt5.InboundTopicAliasBehaviorType": [[8, 2, 1, "", "DEFAULT"], [8, 2, 1, "", "DISABLED"], [8, 2, 1, "", "ENABLED"]], "awscrt.mqtt5.OutboundTopicAliasBehaviorType": [[8, 2, 1, "", "DEFAULT"], [8, 2, 1, "", "DISABLED"], [8, 2, 1, "", "LRU"], [8, 2, 1, "", "MANUAL"]], "awscrt.mqtt5.PayloadFormatIndicator": [[8, 2, 1, "", "AWS_MQTT5_PFI_BYTES"], [8, 2, 1, "", "AWS_MQTT5_PFI_UTF8"]], "awscrt.mqtt5.PubackReasonCode": [[8, 2, 1, "", "IMPLEMENTATION_SPECIFIC_ERROR"], [8, 2, 1, "", "NOT_AUTHORIZED"], [8, 2, 1, "", "NO_MATCHING_SUBSCRIBERS"], [8, 2, 1, "", "PACKET_IDENTIFIER_IN_USE"], [8, 2, 1, "", "PAYLOAD_FORMAT_INVALID"], [8, 2, 1, "", "QUOTA_EXCEEDED"], [8, 2, 1, "", "SUCCESS"], [8, 2, 1, "", "TOPIC_NAME_INVALID"], [8, 2, 1, "", "UNSPECIFIED_ERROR"]], "awscrt.mqtt5.QoS": [[8, 2, 1, "", "AT_LEAST_ONCE"], [8, 2, 1, "", "AT_MOST_ONCE"], [8, 2, 1, "", "EXACTLY_ONCE"]], "awscrt.mqtt5.RetainAndHandlingType": [[8, 2, 1, "", "DONT_SEND"], [8, 2, 1, "", "SEND_ON_SUBSCRIBE"], [8, 2, 1, "", "SEND_ON_SUBSCRIBE_IF_NEW"]], "awscrt.mqtt5.RetainHandlingType": [[8, 2, 1, "", "DONT_SEND"], [8, 2, 1, "", "SEND_ON_SUBSCRIBE"], [8, 2, 1, "", "SEND_ON_SUBSCRIBE_IF_NEW"]], "awscrt.mqtt5.SubackReasonCode": [[8, 2, 1, "", "GRANTED_QOS_0"], [8, 2, 1, "", "GRANTED_QOS_1"], [8, 2, 1, "", "GRANTED_QOS_2"], [8, 2, 1, "", "IMPLEMENTATION_SPECIFIC_ERROR"], [8, 2, 1, "", "NOT_AUTHORIZED"], [8, 2, 1, "", "PACKET_IDENTIFIER_IN_USE"], [8, 2, 1, "", "QUOTA_EXCEEDED"], [8, 2, 1, "", "SHARED_SUBSCRIPTIONS_NOT_SUPPORTED"], [8, 2, 1, "", "SUBSCRIPTION_IDENTIFIERS_NOT_SUPPORTED"], [8, 2, 1, "", "TOPIC_FILTER_INVALID"], [8, 2, 1, "", "UNSPECIFIED_ERROR"], [8, 2, 1, "", "WILDCARD_SUBSCRIPTIONS_NOT_SUPPORTED"]], "awscrt.mqtt5.UnsubackReasonCode": [[8, 2, 1, "", "IMPLEMENTATION_SPECIFIC_ERROR"], [8, 2, 1, "", "NOT_AUTHORIZED"], [8, 2, 1, "", "NO_SUBSCRIPTION_EXISTED"], [8, 2, 1, "", "PACKET_IDENTIFIER_IN_USE"], [8, 2, 1, "", "SUCCESS"], [8, 2, 1, "", "TOPIC_FILTER_INVALID"], [8, 2, 1, "", "UNSPECIFIED_ERROR"]], "awscrt.mqtt5.WebsocketHandshakeTransformArgs": [[8, 2, 1, "", "client"], [8, 2, 1, "", "http_request"], [8, 3, 1, "", "set_done"]], "awscrt.s3": [[9, 1, 1, "", "CrossProcessLock"], [9, 1, 1, "", "S3ChecksumAlgorithm"], [9, 1, 1, "", "S3ChecksumConfig"], [9, 1, 1, "", "S3ChecksumLocation"], [9, 1, 1, "", "S3Client"], [9, 1, 1, "", "S3Request"], [9, 1, 1, "", "S3RequestTlsMode"], [9, 1, 1, "", "S3RequestType"], [9, 6, 1, "", "S3ResponseError"], [9, 5, 1, "", "create_default_s3_signing_config"], [9, 2, 1, "", "credential_provider"], [9, 5, 1, "", "get_ec2_instance_type"], [9, 5, 1, "", "get_optimized_platforms"], [9, 5, 1, "", "get_recommended_throughput_target_gbps"], [9, 5, 1, "", "is_optimized_for_system"], [9, 2, 1, "", "region"]], "awscrt.s3.S3ChecksumAlgorithm": [[9, 2, 1, "", "CRC32"], [9, 2, 1, "", "CRC32C"], [9, 2, 1, "", "SHA1"], [9, 2, 1, "", "SHA256"]], "awscrt.s3.S3ChecksumConfig": [[9, 2, 1, "", "algorithm"], [9, 2, 1, "", "location"], [9, 2, 1, "", "validate_response"]], "awscrt.s3.S3ChecksumLocation": [[9, 2, 1, "", "HEADER"], [9, 2, 1, "", "TRAILER"]], "awscrt.s3.S3Client": [[9, 3, 1, "", "make_request"]], "awscrt.s3.S3Request": [[9, 2, 1, "", "finished_future"], [9, 2, 1, "", "shutdown_event"]], "awscrt.s3.S3RequestTlsMode": [[9, 2, 1, "", "DISABLED"], [9, 2, 1, "", "ENABLED"]], "awscrt.s3.S3RequestType": [[9, 2, 1, "", "DEFAULT"], [9, 2, 1, "", "GET_OBJECT"], [9, 2, 1, "", "PUT_OBJECT"]], "awscrt.s3.S3ResponseError": [[9, 2, 1, "", "body"], [9, 2, 1, "", "code"], [9, 2, 1, "", "headers"], [9, 2, 1, "", "message"], [9, 2, 1, "", "name"], [9, 2, 1, "", "operation_name"], [9, 2, 1, "", "status_code"]], "awscrt.websocket": [[10, 1, 1, "", "IncomingFrame"], [10, 7, 1, "", "MAX_PAYLOAD_LENGTH"], [10, 1, 1, "", "OnConnectionSetupData"], [10, 1, 1, "", "OnConnectionShutdownData"], [10, 1, 1, "", "OnIncomingFrameBeginData"], [10, 1, 1, "", "OnIncomingFrameCompleteData"], [10, 1, 1, "", "OnIncomingFramePayloadData"], [10, 1, 1, "", "OnSendFrameCompleteData"], [10, 1, 1, "", "Opcode"], [10, 1, 1, "", "WebSocket"], [10, 5, 1, "", "connect"], [10, 5, 1, "", "create_handshake_request"]], "awscrt.websocket.IncomingFrame": [[10, 2, 1, "", "fin"], [10, 3, 1, "", "is_data_frame"], [10, 2, 1, "", "opcode"], [10, 2, 1, "", "payload_length"]], "awscrt.websocket.OnConnectionSetupData": [[10, 2, 1, "", "exception"], [10, 2, 1, "", "handshake_response_body"], [10, 2, 1, "", "handshake_response_headers"], [10, 2, 1, "", "handshake_response_status"], [10, 2, 1, "", "websocket"]], "awscrt.websocket.OnConnectionShutdownData": [[10, 2, 1, "", "exception"]], "awscrt.websocket.OnIncomingFrameBeginData": [[10, 2, 1, "", "frame"]], "awscrt.websocket.OnIncomingFrameCompleteData": [[10, 2, 1, "", "exception"], [10, 2, 1, "", "frame"]], "awscrt.websocket.OnIncomingFramePayloadData": [[10, 2, 1, "", "data"], [10, 2, 1, "", "frame"]], "awscrt.websocket.OnSendFrameCompleteData": [[10, 2, 1, "", "exception"]], "awscrt.websocket.Opcode": [[10, 2, 1, "", "BINARY"], [10, 2, 1, "", "CLOSE"], [10, 2, 1, "", "CONTINUATION"], [10, 2, 1, "", "PING"], [10, 2, 1, "", "PONG"], [10, 2, 1, "", "TEXT"], [10, 3, 1, "", "is_data_frame"]], "awscrt.websocket.WebSocket": [[10, 3, 1, "", "close"], [10, 3, 1, "", "increment_read_window"], [10, 3, 1, "", "send_frame"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:attribute", "3": "py:method", "4": "py:property", "5": "py:function", "6": "py:exception", "7": "py:data"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "attribute", "Python attribute"], "3": ["py", "method", "Python method"], "4": ["py", "property", "Python property"], "5": ["py", "function", "Python function"], "6": ["py", "exception", "Python exception"], "7": ["py", "data", "Python data"]}, "titleterms": {"awscrt": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11], "auth": 0, "common": 1, "crypto": 2, "eventstream": 3, "except": 4, "http": 5, "io": 6, "mqtt": 7, "mqtt5": 8, "s3": 9, "websocket": 10, "author": 10, "callback": 10, "flow": 10, "control": 10, "read": 10, "write": 10, "api": [10, 11], "welcom": 11, "": 11, "document": 11, "refer": 11, "indic": 11, "tabl": 11}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx": 60}, "alltitles": {"awscrt.auth": [[0, "module-awscrt.auth"]], "awscrt.common": [[1, "module-awscrt.common"]], "awscrt.crypto": [[2, "module-awscrt.crypto"]], "awscrt.eventstream": [[3, "module-awscrt.eventstream"]], "awscrt.exceptions": [[4, "module-awscrt.exceptions"]], "awscrt.http": [[5, "module-awscrt.http"]], "awscrt.io": [[6, "module-awscrt.io"]], "awscrt.mqtt": [[7, "module-awscrt.mqtt"]], "awscrt.mqtt5": [[8, "module-awscrt.mqtt5"]], "awscrt.s3": [[9, "module-awscrt.s3"]], "awscrt.websocket": [[10, "module-awscrt.websocket"]], "Authoring Callbacks": [[10, "authoring-callbacks"]], "Flow Control (reading)": [[10, "flow-control-reading"]], "Flow Control (writing)": [[10, "flow-control-writing"]], "API": [[10, "api"]], "Welcome to awscrt\u2019s documentation!": [[11, "welcome-to-awscrt-s-documentation"]], "API Reference": [[11, "api-reference"]], "Indices and tables": [[11, "indices-and-tables"]]}, "indexentries": {"awscredentials (class in awscrt.auth)": [[0, "awscrt.auth.AwsCredentials"]], "awscredentialsprovider (class in awscrt.auth)": [[0, "awscrt.auth.AwsCredentialsProvider"]], "awssignaturetype (class in awscrt.auth)": [[0, "awscrt.auth.AwsSignatureType"]], "awssignedbodyheadertype (class in awscrt.auth)": [[0, "awscrt.auth.AwsSignedBodyHeaderType"]], "awssignedbodyvalue (class in awscrt.auth)": [[0, "awscrt.auth.AwsSignedBodyValue"]], "awssigningalgorithm (class in awscrt.auth)": [[0, "awscrt.auth.AwsSigningAlgorithm"]], "awssigningconfig (class in awscrt.auth)": [[0, "awscrt.auth.AwsSigningConfig"]], "empty_sha256 (awscrt.auth.awssignedbodyvalue attribute)": [[0, "awscrt.auth.AwsSignedBodyValue.EMPTY_SHA256"]], "http_request_headers (awscrt.auth.awssignaturetype attribute)": [[0, "awscrt.auth.AwsSignatureType.HTTP_REQUEST_HEADERS"]], "http_request_query_params (awscrt.auth.awssignaturetype attribute)": [[0, "awscrt.auth.AwsSignatureType.HTTP_REQUEST_QUERY_PARAMS"]], "none (awscrt.auth.awssignedbodyheadertype attribute)": [[0, "awscrt.auth.AwsSignedBodyHeaderType.NONE"]], "streaming_aws4_hmac_sha256_events (awscrt.auth.awssignedbodyvalue attribute)": [[0, "awscrt.auth.AwsSignedBodyValue.STREAMING_AWS4_HMAC_SHA256_EVENTS"]], "streaming_aws4_hmac_sha256_payload (awscrt.auth.awssignedbodyvalue attribute)": [[0, "awscrt.auth.AwsSignedBodyValue.STREAMING_AWS4_HMAC_SHA256_PAYLOAD"]], "unsigned_payload (awscrt.auth.awssignedbodyvalue attribute)": [[0, "awscrt.auth.AwsSignedBodyValue.UNSIGNED_PAYLOAD"]], "v4 (awscrt.auth.awssigningalgorithm attribute)": [[0, "awscrt.auth.AwsSigningAlgorithm.V4"]], "v4_asymmetric (awscrt.auth.awssigningalgorithm attribute)": [[0, "awscrt.auth.AwsSigningAlgorithm.V4_ASYMMETRIC"]], "v4_s3express (awscrt.auth.awssigningalgorithm attribute)": [[0, "awscrt.auth.AwsSigningAlgorithm.V4_S3EXPRESS"]], "x_amz_content_sha_256 (awscrt.auth.awssignedbodyheadertype attribute)": [[0, "awscrt.auth.AwsSignedBodyHeaderType.X_AMZ_CONTENT_SHA_256"]], "access_key_id (awscrt.auth.awscredentials attribute)": [[0, "awscrt.auth.AwsCredentials.access_key_id"]], "algorithm (awscrt.auth.awssigningconfig property)": [[0, "awscrt.auth.AwsSigningConfig.algorithm"]], "aws_sign_request() (in module awscrt.auth)": [[0, "awscrt.auth.aws_sign_request"]], "awscrt.auth": [[0, "module-awscrt.auth"]], "credentials_provider (awscrt.auth.awssigningconfig property)": [[0, "awscrt.auth.AwsSigningConfig.credentials_provider"]], "date (awscrt.auth.awssigningconfig property)": [[0, "awscrt.auth.AwsSigningConfig.date"]], "expiration (awscrt.auth.awscredentials attribute)": [[0, "awscrt.auth.AwsCredentials.expiration"]], "expiration_in_seconds (awscrt.auth.awssigningconfig property)": [[0, "awscrt.auth.AwsSigningConfig.expiration_in_seconds"]], "get_credentials() (awscrt.auth.awscredentialsprovider method)": [[0, "awscrt.auth.AwsCredentialsProvider.get_credentials"]], "module": [[0, "module-awscrt.auth"], [1, "module-awscrt.common"], [2, "module-awscrt.crypto"], [3, "module-awscrt.eventstream"], [3, "module-awscrt.eventstream.rpc"], [4, "module-awscrt.exceptions"], [5, "module-awscrt.http"], [6, "module-awscrt.io"], [7, "module-awscrt.mqtt"], [8, "module-awscrt.mqtt5"], [9, "module-awscrt.s3"], [10, "module-awscrt.websocket"]], "new_chain() (awscrt.auth.awscredentialsprovider class method)": [[0, "awscrt.auth.AwsCredentialsProvider.new_chain"]], "new_cognito() (awscrt.auth.awscredentialsprovider class method)": [[0, "awscrt.auth.AwsCredentialsProvider.new_cognito"]], "new_default_chain() (awscrt.auth.awscredentialsprovider class method)": [[0, "awscrt.auth.AwsCredentialsProvider.new_default_chain"]], "new_delegate() (awscrt.auth.awscredentialsprovider class method)": [[0, "awscrt.auth.AwsCredentialsProvider.new_delegate"]], "new_environment() (awscrt.auth.awscredentialsprovider class method)": [[0, "awscrt.auth.AwsCredentialsProvider.new_environment"]], "new_process() (awscrt.auth.awscredentialsprovider class method)": [[0, "awscrt.auth.AwsCredentialsProvider.new_process"]], "new_profile() (awscrt.auth.awscredentialsprovider class method)": [[0, "awscrt.auth.AwsCredentialsProvider.new_profile"]], "new_static() (awscrt.auth.awscredentialsprovider class method)": [[0, "awscrt.auth.AwsCredentialsProvider.new_static"]], "new_x509() (awscrt.auth.awscredentialsprovider class method)": [[0, "awscrt.auth.AwsCredentialsProvider.new_x509"]], "omit_session_token (awscrt.auth.awssigningconfig property)": [[0, "awscrt.auth.AwsSigningConfig.omit_session_token"]], "region (awscrt.auth.awssigningconfig property)": [[0, "awscrt.auth.AwsSigningConfig.region"]], "replace() (awscrt.auth.awssigningconfig method)": [[0, "awscrt.auth.AwsSigningConfig.replace"]], "secret_access_key (awscrt.auth.awscredentials attribute)": [[0, "awscrt.auth.AwsCredentials.secret_access_key"]], "service (awscrt.auth.awssigningconfig property)": [[0, "awscrt.auth.AwsSigningConfig.service"]], "session_token (awscrt.auth.awscredentials attribute)": [[0, "awscrt.auth.AwsCredentials.session_token"]], "should_normalize_uri_path (awscrt.auth.awssigningconfig property)": [[0, "awscrt.auth.AwsSigningConfig.should_normalize_uri_path"]], "should_sign_header (awscrt.auth.awssigningconfig property)": [[0, "awscrt.auth.AwsSigningConfig.should_sign_header"]], "signature_type (awscrt.auth.awssigningconfig property)": [[0, "awscrt.auth.AwsSigningConfig.signature_type"]], "signed_body_header_type (awscrt.auth.awssigningconfig property)": [[0, "awscrt.auth.AwsSigningConfig.signed_body_header_type"]], "signed_body_value (awscrt.auth.awssigningconfig property)": [[0, "awscrt.auth.AwsSigningConfig.signed_body_value"]], "use_double_uri_encode (awscrt.auth.awssigningconfig property)": [[0, "awscrt.auth.AwsSigningConfig.use_double_uri_encode"]], "awscrt.common": [[1, "module-awscrt.common"]], "get_cpu_count_for_group() (in module awscrt.common)": [[1, "awscrt.common.get_cpu_count_for_group"]], "get_cpu_group_count() (in module awscrt.common)": [[1, "awscrt.common.get_cpu_group_count"]], "oaep_sha256 (awscrt.crypto.rsaencryptionalgorithm attribute)": [[2, "awscrt.crypto.RSAEncryptionAlgorithm.OAEP_SHA256"]], "oaep_sha512 (awscrt.crypto.rsaencryptionalgorithm attribute)": [[2, "awscrt.crypto.RSAEncryptionAlgorithm.OAEP_SHA512"]], "pkcs1_5 (awscrt.crypto.rsaencryptionalgorithm attribute)": [[2, "awscrt.crypto.RSAEncryptionAlgorithm.PKCS1_5"]], "pkcs1_5_sha256 (awscrt.crypto.rsasignaturealgorithm attribute)": [[2, "awscrt.crypto.RSASignatureAlgorithm.PKCS1_5_SHA256"]], "pss_sha256 (awscrt.crypto.rsasignaturealgorithm attribute)": [[2, "awscrt.crypto.RSASignatureAlgorithm.PSS_SHA256"]], "rsa (class in awscrt.crypto)": [[2, "awscrt.crypto.RSA"]], "rsaencryptionalgorithm (class in awscrt.crypto)": [[2, "awscrt.crypto.RSAEncryptionAlgorithm"]], "rsasignaturealgorithm (class in awscrt.crypto)": [[2, "awscrt.crypto.RSASignatureAlgorithm"]], "awscrt.crypto": [[2, "module-awscrt.crypto"]], "decrypt() (awscrt.crypto.rsa method)": [[2, "awscrt.crypto.RSA.decrypt"]], "encrypt() (awscrt.crypto.rsa method)": [[2, "awscrt.crypto.RSA.encrypt"]], "new_private_key_from_pem_data() (awscrt.crypto.rsa static method)": [[2, "awscrt.crypto.RSA.new_private_key_from_pem_data"]], "new_public_key_from_pem_data() (awscrt.crypto.rsa static method)": [[2, "awscrt.crypto.RSA.new_public_key_from_pem_data"]], "sign() (awscrt.crypto.rsa method)": [[2, "awscrt.crypto.RSA.sign"]], "verify() (awscrt.crypto.rsa method)": [[2, "awscrt.crypto.RSA.verify"]], "application_error (awscrt.eventstream.rpc.messagetype attribute)": [[3, "awscrt.eventstream.rpc.MessageType.APPLICATION_ERROR"]], "application_message (awscrt.eventstream.rpc.messagetype attribute)": [[3, "awscrt.eventstream.rpc.MessageType.APPLICATION_MESSAGE"]], "bool_false (awscrt.eventstream.headertype attribute)": [[3, "awscrt.eventstream.HeaderType.BOOL_FALSE"]], "bool_true (awscrt.eventstream.headertype attribute)": [[3, "awscrt.eventstream.HeaderType.BOOL_TRUE"]], "byte (awscrt.eventstream.headertype attribute)": [[3, "awscrt.eventstream.HeaderType.BYTE"]], "byte_buf (awscrt.eventstream.headertype attribute)": [[3, "awscrt.eventstream.HeaderType.BYTE_BUF"]], "connect (awscrt.eventstream.rpc.messagetype attribute)": [[3, "awscrt.eventstream.rpc.MessageType.CONNECT"]], "connection_accepted (awscrt.eventstream.rpc.messageflag attribute)": [[3, "awscrt.eventstream.rpc.MessageFlag.CONNECTION_ACCEPTED"]], "connect_ack (awscrt.eventstream.rpc.messagetype attribute)": [[3, "awscrt.eventstream.rpc.MessageType.CONNECT_ACK"]], "clientconnection (class in awscrt.eventstream.rpc)": [[3, "awscrt.eventstream.rpc.ClientConnection"]], "clientconnectionhandler (class in awscrt.eventstream.rpc)": [[3, "awscrt.eventstream.rpc.ClientConnectionHandler"]], "clientcontinuation (class in awscrt.eventstream.rpc)": [[3, "awscrt.eventstream.rpc.ClientContinuation"]], "clientcontinuationhandler (class in awscrt.eventstream.rpc)": [[3, "awscrt.eventstream.rpc.ClientContinuationHandler"]], "header (class in awscrt.eventstream)": [[3, "awscrt.eventstream.Header"]], "headertype (class in awscrt.eventstream)": [[3, "awscrt.eventstream.HeaderType"]], "int16 (awscrt.eventstream.headertype attribute)": [[3, "awscrt.eventstream.HeaderType.INT16"]], "int32 (awscrt.eventstream.headertype attribute)": [[3, "awscrt.eventstream.HeaderType.INT32"]], "int64 (awscrt.eventstream.headertype attribute)": [[3, "awscrt.eventstream.HeaderType.INT64"]], "internal_error (awscrt.eventstream.rpc.messagetype attribute)": [[3, "awscrt.eventstream.rpc.MessageType.INTERNAL_ERROR"]], "messageflag (class in awscrt.eventstream.rpc)": [[3, "awscrt.eventstream.rpc.MessageFlag"]], "messagetype (class in awscrt.eventstream.rpc)": [[3, "awscrt.eventstream.rpc.MessageType"]], "none (awscrt.eventstream.rpc.messageflag attribute)": [[3, "awscrt.eventstream.rpc.MessageFlag.NONE"]], "ping (awscrt.eventstream.rpc.messagetype attribute)": [[3, "awscrt.eventstream.rpc.MessageType.PING"]], "ping_response (awscrt.eventstream.rpc.messagetype attribute)": [[3, "awscrt.eventstream.rpc.MessageType.PING_RESPONSE"]], "protocol_error (awscrt.eventstream.rpc.messagetype attribute)": [[3, "awscrt.eventstream.rpc.MessageType.PROTOCOL_ERROR"]], "string (awscrt.eventstream.headertype attribute)": [[3, "awscrt.eventstream.HeaderType.STRING"]], "terminate_stream (awscrt.eventstream.rpc.messageflag attribute)": [[3, "awscrt.eventstream.rpc.MessageFlag.TERMINATE_STREAM"]], "timestamp (awscrt.eventstream.headertype attribute)": [[3, "awscrt.eventstream.HeaderType.TIMESTAMP"]], "uuid (awscrt.eventstream.headertype attribute)": [[3, "awscrt.eventstream.HeaderType.UUID"]], "activate() (awscrt.eventstream.rpc.clientcontinuation method)": [[3, "awscrt.eventstream.rpc.ClientContinuation.activate"]], "awscrt.eventstream": [[3, "module-awscrt.eventstream"]], "awscrt.eventstream.rpc": [[3, "module-awscrt.eventstream.rpc"]], "close() (awscrt.eventstream.rpc.clientconnection method)": [[3, "awscrt.eventstream.rpc.ClientConnection.close"]], "closed_future (awscrt.eventstream.rpc.clientcontinuation attribute)": [[3, "awscrt.eventstream.rpc.ClientContinuation.closed_future"]], "connect() (awscrt.eventstream.rpc.clientconnection class method)": [[3, "awscrt.eventstream.rpc.ClientConnection.connect"]], "connection (awscrt.eventstream.rpc.clientcontinuation attribute)": [[3, "awscrt.eventstream.rpc.ClientContinuation.connection"]], "from_bool() (awscrt.eventstream.header class method)": [[3, "awscrt.eventstream.Header.from_bool"]], "from_byte() (awscrt.eventstream.header class method)": [[3, "awscrt.eventstream.Header.from_byte"]], "from_byte_buf() (awscrt.eventstream.header class method)": [[3, "awscrt.eventstream.Header.from_byte_buf"]], "from_int16() (awscrt.eventstream.header class method)": [[3, "awscrt.eventstream.Header.from_int16"]], "from_int32() (awscrt.eventstream.header class method)": [[3, "awscrt.eventstream.Header.from_int32"]], "from_int64() (awscrt.eventstream.header class method)": [[3, "awscrt.eventstream.Header.from_int64"]], "from_string() (awscrt.eventstream.header class method)": [[3, "awscrt.eventstream.Header.from_string"]], "from_timestamp() (awscrt.eventstream.header class method)": [[3, "awscrt.eventstream.Header.from_timestamp"]], "from_uuid() (awscrt.eventstream.header class method)": [[3, "awscrt.eventstream.Header.from_uuid"]], "host_name (awscrt.eventstream.rpc.clientconnection attribute)": [[3, "awscrt.eventstream.rpc.ClientConnection.host_name"]], "is_open() (awscrt.eventstream.rpc.clientconnection method)": [[3, "awscrt.eventstream.rpc.ClientConnection.is_open"]], "name (awscrt.eventstream.header property)": [[3, "awscrt.eventstream.Header.name"]], "new_stream() (awscrt.eventstream.rpc.clientconnection method)": [[3, "awscrt.eventstream.rpc.ClientConnection.new_stream"]], "on_connection_setup() (awscrt.eventstream.rpc.clientconnectionhandler method)": [[3, "awscrt.eventstream.rpc.ClientConnectionHandler.on_connection_setup"]], "on_connection_shutdown() (awscrt.eventstream.rpc.clientconnectionhandler method)": [[3, "awscrt.eventstream.rpc.ClientConnectionHandler.on_connection_shutdown"]], "on_continuation_closed() (awscrt.eventstream.rpc.clientcontinuationhandler method)": [[3, "awscrt.eventstream.rpc.ClientContinuationHandler.on_continuation_closed"]], "on_continuation_message() (awscrt.eventstream.rpc.clientcontinuationhandler method)": [[3, "awscrt.eventstream.rpc.ClientContinuationHandler.on_continuation_message"]], "on_protocol_message() (awscrt.eventstream.rpc.clientconnectionhandler method)": [[3, "awscrt.eventstream.rpc.ClientConnectionHandler.on_protocol_message"]], "port (awscrt.eventstream.rpc.clientconnection attribute)": [[3, "awscrt.eventstream.rpc.ClientConnection.port"]], "send_message() (awscrt.eventstream.rpc.clientcontinuation method)": [[3, "awscrt.eventstream.rpc.ClientContinuation.send_message"]], "send_protocol_message() (awscrt.eventstream.rpc.clientconnection method)": [[3, "awscrt.eventstream.rpc.ClientConnection.send_protocol_message"]], "shutdown_future (awscrt.eventstream.rpc.clientconnection attribute)": [[3, "awscrt.eventstream.rpc.ClientConnection.shutdown_future"]], "type (awscrt.eventstream.header property)": [[3, "awscrt.eventstream.Header.type"]], "value (awscrt.eventstream.header property)": [[3, "awscrt.eventstream.Header.value"]], "value_as_bool() (awscrt.eventstream.header method)": [[3, "awscrt.eventstream.Header.value_as_bool"]], "value_as_byte() (awscrt.eventstream.header method)": [[3, "awscrt.eventstream.Header.value_as_byte"]], "value_as_byte_buf() (awscrt.eventstream.header method)": [[3, "awscrt.eventstream.Header.value_as_byte_buf"]], "value_as_int16() (awscrt.eventstream.header method)": [[3, "awscrt.eventstream.Header.value_as_int16"]], "value_as_int32() (awscrt.eventstream.header method)": [[3, "awscrt.eventstream.Header.value_as_int32"]], "value_as_int64() (awscrt.eventstream.header method)": [[3, "awscrt.eventstream.Header.value_as_int64"]], "value_as_string() (awscrt.eventstream.header method)": [[3, "awscrt.eventstream.Header.value_as_string"]], "value_as_timestamp() (awscrt.eventstream.header method)": [[3, "awscrt.eventstream.Header.value_as_timestamp"]], "value_as_uuid() (awscrt.eventstream.header method)": [[3, "awscrt.eventstream.Header.value_as_uuid"]], "awscrterror": [[4, "awscrt.exceptions.AwsCrtError"]], "awscrt.exceptions": [[4, "module-awscrt.exceptions"]], "code (awscrt.exceptions.awscrterror attribute)": [[4, "awscrt.exceptions.AwsCrtError.code"]], "from_code() (in module awscrt.exceptions)": [[4, "awscrt.exceptions.from_code"]], "message (awscrt.exceptions.awscrterror attribute)": [[4, "awscrt.exceptions.AwsCrtError.message"]], "name (awscrt.exceptions.awscrterror attribute)": [[4, "awscrt.exceptions.AwsCrtError.name"]], "basic (awscrt.http.httpproxyauthenticationtype attribute)": [[5, "awscrt.http.HttpProxyAuthenticationType.Basic"]], "forwarding (awscrt.http.httpproxyconnectiontype attribute)": [[5, "awscrt.http.HttpProxyConnectionType.Forwarding"]], "http1_0 (awscrt.http.httpversion attribute)": [[5, "awscrt.http.HttpVersion.Http1_0"]], "http1_1 (awscrt.http.httpversion attribute)": [[5, "awscrt.http.HttpVersion.Http1_1"]], "http2 (awscrt.http.httpversion attribute)": [[5, "awscrt.http.HttpVersion.Http2"]], "httpclientconnection (class in awscrt.http)": [[5, "awscrt.http.HttpClientConnection"]], "httpclientstream (class in awscrt.http)": [[5, "awscrt.http.HttpClientStream"]], "httpheaders (class in awscrt.http)": [[5, "awscrt.http.HttpHeaders"]], "httpproxyauthenticationtype (class in awscrt.http)": [[5, "awscrt.http.HttpProxyAuthenticationType"]], "httpproxyconnectiontype (class in awscrt.http)": [[5, "awscrt.http.HttpProxyConnectionType"]], "httpproxyoptions (class in awscrt.http)": [[5, "awscrt.http.HttpProxyOptions"]], "httprequest (class in awscrt.http)": [[5, "awscrt.http.HttpRequest"]], "httpversion (class in awscrt.http)": [[5, "awscrt.http.HttpVersion"]], "legacy (awscrt.http.httpproxyconnectiontype attribute)": [[5, "awscrt.http.HttpProxyConnectionType.Legacy"]], "nothing (awscrt.http.httpproxyauthenticationtype attribute)": [[5, "awscrt.http.HttpProxyAuthenticationType.Nothing"]], "tunneling (awscrt.http.httpproxyconnectiontype attribute)": [[5, "awscrt.http.HttpProxyConnectionType.Tunneling"]], "unknown (awscrt.http.httpversion attribute)": [[5, "awscrt.http.HttpVersion.Unknown"]], "activate() (awscrt.http.httpclientstream method)": [[5, "awscrt.http.HttpClientStream.activate"]], "add() (awscrt.http.httpheaders method)": [[5, "awscrt.http.HttpHeaders.add"]], "add_pairs() (awscrt.http.httpheaders method)": [[5, "awscrt.http.HttpHeaders.add_pairs"]], "auth_password (awscrt.http.httpproxyoptions attribute)": [[5, "awscrt.http.HttpProxyOptions.auth_password"]], "auth_type (awscrt.http.httpproxyoptions attribute)": [[5, "awscrt.http.HttpProxyOptions.auth_type"]], "auth_username (awscrt.http.httpproxyoptions attribute)": [[5, "awscrt.http.HttpProxyOptions.auth_username"]], "awscrt.http": [[5, "module-awscrt.http"]], "clear() (awscrt.http.httpheaders method)": [[5, "awscrt.http.HttpHeaders.clear"]], "close() (awscrt.http.httpclientconnection method)": [[5, "awscrt.http.HttpClientConnection.close"]], "completion_future (awscrt.http.httpclientstream attribute)": [[5, "awscrt.http.HttpClientStream.completion_future"]], "connection (awscrt.http.httpclientstream attribute)": [[5, "awscrt.http.HttpClientStream.connection"]], "connection_type (awscrt.http.httpproxyoptions attribute)": [[5, "awscrt.http.HttpProxyOptions.connection_type"]], "get() (awscrt.http.httpheaders method)": [[5, "awscrt.http.HttpHeaders.get"]], "get_values() (awscrt.http.httpheaders method)": [[5, "awscrt.http.HttpHeaders.get_values"]], "headers (awscrt.http.httprequest property)": [[5, "awscrt.http.HttpRequest.headers"]], "host_name (awscrt.http.httpclientconnection property)": [[5, "awscrt.http.HttpClientConnection.host_name"]], "host_name (awscrt.http.httpproxyoptions attribute)": [[5, "awscrt.http.HttpProxyOptions.host_name"]], "is_open() (awscrt.http.httpclientconnection method)": [[5, "awscrt.http.HttpClientConnection.is_open"]], "method (awscrt.http.httprequest property)": [[5, "awscrt.http.HttpRequest.method"]], "new() (awscrt.http.httpclientconnection class method)": [[5, "awscrt.http.HttpClientConnection.new"]], "path (awscrt.http.httprequest property)": [[5, "awscrt.http.HttpRequest.path"]], "port (awscrt.http.httpclientconnection property)": [[5, "awscrt.http.HttpClientConnection.port"]], "port (awscrt.http.httpproxyoptions attribute)": [[5, "awscrt.http.HttpProxyOptions.port"]], "remove() (awscrt.http.httpheaders method)": [[5, "awscrt.http.HttpHeaders.remove"]], "remove_value() (awscrt.http.httpheaders method)": [[5, "awscrt.http.HttpHeaders.remove_value"]], "request() (awscrt.http.httpclientconnection method)": [[5, "awscrt.http.HttpClientConnection.request"]], "response_status_code (awscrt.http.httpclientstream property)": [[5, "awscrt.http.HttpClientStream.response_status_code"]], "set() (awscrt.http.httpheaders method)": [[5, "awscrt.http.HttpHeaders.set"]], "shutdown_future (awscrt.http.httpclientconnection property)": [[5, "awscrt.http.HttpClientConnection.shutdown_future"]], "tls_connection_options (awscrt.http.httpproxyoptions attribute)": [[5, "awscrt.http.HttpProxyOptions.tls_connection_options"]], "version (awscrt.http.httpclientconnection property)": [[5, "awscrt.http.HttpClientConnection.version"]], "clientbootstrap (class in awscrt.io)": [[6, "awscrt.io.ClientBootstrap"]], "clienttlscontext (class in awscrt.io)": [[6, "awscrt.io.ClientTlsContext"]], "default (awscrt.io.pkcs11lib.initializefinalizebehavior attribute)": [[6, "awscrt.io.Pkcs11Lib.InitializeFinalizeBehavior.DEFAULT"]], "default (awscrt.io.tlscipherpref attribute)": [[6, "awscrt.io.TlsCipherPref.DEFAULT"]], "default (awscrt.io.tlsversion attribute)": [[6, "awscrt.io.TlsVersion.DEFAULT"]], "dgram (awscrt.io.sockettype attribute)": [[6, "awscrt.io.SocketType.DGram"]], "debug (awscrt.io.loglevel attribute)": [[6, "awscrt.io.LogLevel.Debug"]], "defaulthostresolver (class in awscrt.io)": [[6, "awscrt.io.DefaultHostResolver"]], "error (awscrt.io.loglevel attribute)": [[6, "awscrt.io.LogLevel.Error"]], "eventloopgroup (class in awscrt.io)": [[6, "awscrt.io.EventLoopGroup"]], "fatal (awscrt.io.loglevel attribute)": [[6, "awscrt.io.LogLevel.Fatal"]], "hostresolverbase (class in awscrt.io)": [[6, "awscrt.io.HostResolverBase"]], "ipv4 (awscrt.io.socketdomain attribute)": [[6, "awscrt.io.SocketDomain.IPv4"]], "ipv6 (awscrt.io.socketdomain attribute)": [[6, "awscrt.io.SocketDomain.IPv6"]], "info (awscrt.io.loglevel attribute)": [[6, "awscrt.io.LogLevel.Info"]], "inputstream (class in awscrt.io)": [[6, "awscrt.io.InputStream"]], "local (awscrt.io.socketdomain attribute)": [[6, "awscrt.io.SocketDomain.Local"]], "loglevel (class in awscrt.io)": [[6, "awscrt.io.LogLevel"]], "nologs (awscrt.io.loglevel attribute)": [[6, "awscrt.io.LogLevel.NoLogs"]], "omit (awscrt.io.pkcs11lib.initializefinalizebehavior attribute)": [[6, "awscrt.io.Pkcs11Lib.InitializeFinalizeBehavior.OMIT"]], "pq_tlsv1_0_2021_05 (awscrt.io.tlscipherpref attribute)": [[6, "awscrt.io.TlsCipherPref.PQ_TLSv1_0_2021_05"]], "pkcs11lib (class in awscrt.io)": [[6, "awscrt.io.Pkcs11Lib"]], "pkcs11lib.initializefinalizebehavior (class in awscrt.io)": [[6, "awscrt.io.Pkcs11Lib.InitializeFinalizeBehavior"]], "sslv3 (awscrt.io.tlsversion attribute)": [[6, "awscrt.io.TlsVersion.SSLv3"]], "strict (awscrt.io.pkcs11lib.initializefinalizebehavior attribute)": [[6, "awscrt.io.Pkcs11Lib.InitializeFinalizeBehavior.STRICT"]], "socketdomain (class in awscrt.io)": [[6, "awscrt.io.SocketDomain"]], "socketoptions (class in awscrt.io)": [[6, "awscrt.io.SocketOptions"]], "sockettype (class in awscrt.io)": [[6, "awscrt.io.SocketType"]], "stream (awscrt.io.sockettype attribute)": [[6, "awscrt.io.SocketType.Stream"]], "tlsv1 (awscrt.io.tlsversion attribute)": [[6, "awscrt.io.TlsVersion.TLSv1"]], "tlsv1_1 (awscrt.io.tlsversion attribute)": [[6, "awscrt.io.TlsVersion.TLSv1_1"]], "tlsv1_2 (awscrt.io.tlsversion attribute)": [[6, "awscrt.io.TlsVersion.TLSv1_2"]], "tlsv1_3 (awscrt.io.tlsversion attribute)": [[6, "awscrt.io.TlsVersion.TLSv1_3"]], "tlscipherpref (class in awscrt.io)": [[6, "awscrt.io.TlsCipherPref"]], "tlsconnectionoptions (class in awscrt.io)": [[6, "awscrt.io.TlsConnectionOptions"]], "tlscontextoptions (class in awscrt.io)": [[6, "awscrt.io.TlsContextOptions"]], "tlsversion (class in awscrt.io)": [[6, "awscrt.io.TlsVersion"]], "trace (awscrt.io.loglevel attribute)": [[6, "awscrt.io.LogLevel.Trace"]], "warn (awscrt.io.loglevel attribute)": [[6, "awscrt.io.LogLevel.Warn"]], "alpn_list (awscrt.io.tlscontextoptions attribute)": [[6, "awscrt.io.TlsContextOptions.alpn_list"]], "awscrt.io": [[6, "module-awscrt.io"]], "cipher_pref (awscrt.io.tlscontextoptions attribute)": [[6, "awscrt.io.TlsContextOptions.cipher_pref"]], "connect_timeout_ms (awscrt.io.socketoptions attribute)": [[6, "awscrt.io.SocketOptions.connect_timeout_ms"]], "create_client_with_mtls() (awscrt.io.tlscontextoptions static method)": [[6, "awscrt.io.TlsContextOptions.create_client_with_mtls"]], "create_client_with_mtls_from_path() (awscrt.io.tlscontextoptions static method)": [[6, "awscrt.io.TlsContextOptions.create_client_with_mtls_from_path"]], "create_client_with_mtls_pkcs11() (awscrt.io.tlscontextoptions static method)": [[6, "awscrt.io.TlsContextOptions.create_client_with_mtls_pkcs11"]], "create_client_with_mtls_pkcs12() (awscrt.io.tlscontextoptions static method)": [[6, "awscrt.io.TlsContextOptions.create_client_with_mtls_pkcs12"]], "create_client_with_mtls_windows_cert_store_path() (awscrt.io.tlscontextoptions static method)": [[6, "awscrt.io.TlsContextOptions.create_client_with_mtls_windows_cert_store_path"]], "create_server() (awscrt.io.tlscontextoptions static method)": [[6, "awscrt.io.TlsContextOptions.create_server"]], "create_server_from_path() (awscrt.io.tlscontextoptions static method)": [[6, "awscrt.io.TlsContextOptions.create_server_from_path"]], "create_server_pkcs12() (awscrt.io.tlscontextoptions static method)": [[6, "awscrt.io.TlsContextOptions.create_server_pkcs12"]], "domain (awscrt.io.socketoptions attribute)": [[6, "awscrt.io.SocketOptions.domain"]], "init_logging() (in module awscrt.io)": [[6, "awscrt.io.init_logging"]], "is_alpn_available() (in module awscrt.io)": [[6, "awscrt.io.is_alpn_available"]], "is_supported() (awscrt.io.tlscipherpref method)": [[6, "awscrt.io.TlsCipherPref.is_supported"]], "keep_alive (awscrt.io.socketoptions attribute)": [[6, "awscrt.io.SocketOptions.keep_alive"]], "keep_alive_interval_secs (awscrt.io.socketoptions attribute)": [[6, "awscrt.io.SocketOptions.keep_alive_interval_secs"]], "keep_alive_max_probes (awscrt.io.socketoptions attribute)": [[6, "awscrt.io.SocketOptions.keep_alive_max_probes"]], "keep_alive_timeout_secs (awscrt.io.socketoptions attribute)": [[6, "awscrt.io.SocketOptions.keep_alive_timeout_secs"]], "min_tls_ver (awscrt.io.tlscontextoptions attribute)": [[6, "awscrt.io.TlsContextOptions.min_tls_ver"]], "new_connection_options() (awscrt.io.clienttlscontext method)": [[6, "awscrt.io.ClientTlsContext.new_connection_options"]], "override_default_trust_store() (awscrt.io.tlscontextoptions method)": [[6, "awscrt.io.TlsContextOptions.override_default_trust_store"]], "override_default_trust_store_from_path() (awscrt.io.tlscontextoptions method)": [[6, "awscrt.io.TlsContextOptions.override_default_trust_store_from_path"]], "set_alpn_list() (awscrt.io.tlsconnectionoptions method)": [[6, "awscrt.io.TlsConnectionOptions.set_alpn_list"]], "set_server_name() (awscrt.io.tlsconnectionoptions method)": [[6, "awscrt.io.TlsConnectionOptions.set_server_name"]], "shutdown_event (awscrt.io.clientbootstrap attribute)": [[6, "awscrt.io.ClientBootstrap.shutdown_event"]], "shutdown_event (awscrt.io.eventloopgroup attribute)": [[6, "awscrt.io.EventLoopGroup.shutdown_event"]], "tls_ctx (awscrt.io.tlsconnectionoptions attribute)": [[6, "awscrt.io.TlsConnectionOptions.tls_ctx"]], "type (awscrt.io.socketoptions attribute)": [[6, "awscrt.io.SocketOptions.type"]], "verify_peer (awscrt.io.tlscontextoptions attribute)": [[6, "awscrt.io.TlsContextOptions.verify_peer"]], "wrap() (awscrt.io.inputstream class method)": [[6, "awscrt.io.InputStream.wrap"]], "accepted (awscrt.mqtt.connectreturncode attribute)": [[7, "awscrt.mqtt.ConnectReturnCode.ACCEPTED"]], "at_least_once (awscrt.mqtt.qos attribute)": [[7, "awscrt.mqtt.QoS.AT_LEAST_ONCE"]], "at_most_once (awscrt.mqtt.qos attribute)": [[7, "awscrt.mqtt.QoS.AT_MOST_ONCE"]], "bad_username_or_password (awscrt.mqtt.connectreturncode attribute)": [[7, "awscrt.mqtt.ConnectReturnCode.BAD_USERNAME_OR_PASSWORD"]], "client (class in awscrt.mqtt)": [[7, "awscrt.mqtt.Client"]], "connectreturncode (class in awscrt.mqtt)": [[7, "awscrt.mqtt.ConnectReturnCode"]], "connection (class in awscrt.mqtt)": [[7, "awscrt.mqtt.Connection"]], "exactly_once (awscrt.mqtt.qos attribute)": [[7, "awscrt.mqtt.QoS.EXACTLY_ONCE"]], "identifier_rejected (awscrt.mqtt.connectreturncode attribute)": [[7, "awscrt.mqtt.ConnectReturnCode.IDENTIFIER_REJECTED"]], "not_authorized (awscrt.mqtt.connectreturncode attribute)": [[7, "awscrt.mqtt.ConnectReturnCode.NOT_AUTHORIZED"]], "onconnectioncloseddata (class in awscrt.mqtt)": [[7, "awscrt.mqtt.OnConnectionClosedData"]], "onconnectionfailuredata (class in awscrt.mqtt)": [[7, "awscrt.mqtt.OnConnectionFailureData"]], "onconnectionsuccessdata (class in awscrt.mqtt)": [[7, "awscrt.mqtt.OnConnectionSuccessData"]], "operationstatisticsdata (class in awscrt.mqtt)": [[7, "awscrt.mqtt.OperationStatisticsData"]], "qos (class in awscrt.mqtt)": [[7, "awscrt.mqtt.QoS"]], "server_unavailable (awscrt.mqtt.connectreturncode attribute)": [[7, "awscrt.mqtt.ConnectReturnCode.SERVER_UNAVAILABLE"]], "subscribeerror": [[7, "awscrt.mqtt.SubscribeError"]], "unacceptable_protocol_version (awscrt.mqtt.connectreturncode attribute)": [[7, "awscrt.mqtt.ConnectReturnCode.UNACCEPTABLE_PROTOCOL_VERSION"]], "websockethandshaketransformargs (class in awscrt.mqtt)": [[7, "awscrt.mqtt.WebsocketHandshakeTransformArgs"]], "will (class in awscrt.mqtt)": [[7, "awscrt.mqtt.Will"]], "awscrt.mqtt": [[7, "module-awscrt.mqtt"]], "connect() (awscrt.mqtt.connection method)": [[7, "awscrt.mqtt.Connection.connect"]], "disconnect() (awscrt.mqtt.connection method)": [[7, "awscrt.mqtt.Connection.disconnect"]], "get_stats() (awscrt.mqtt.connection method)": [[7, "awscrt.mqtt.Connection.get_stats"]], "http_request (awscrt.mqtt.websockethandshaketransformargs attribute)": [[7, "awscrt.mqtt.WebsocketHandshakeTransformArgs.http_request"]], "mqtt_connection (awscrt.mqtt.websockethandshaketransformargs attribute)": [[7, "awscrt.mqtt.WebsocketHandshakeTransformArgs.mqtt_connection"]], "on_message() (awscrt.mqtt.connection method)": [[7, "awscrt.mqtt.Connection.on_message"]], "payload (awscrt.mqtt.will attribute)": [[7, "awscrt.mqtt.Will.payload"]], "publish() (awscrt.mqtt.connection method)": [[7, "awscrt.mqtt.Connection.publish"]], "qos (awscrt.mqtt.will attribute)": [[7, "awscrt.mqtt.Will.qos"]], "resubscribe_existing_topics() (awscrt.mqtt.connection method)": [[7, "awscrt.mqtt.Connection.resubscribe_existing_topics"]], "retain (awscrt.mqtt.will attribute)": [[7, "awscrt.mqtt.Will.retain"]], "set_done() (awscrt.mqtt.websockethandshaketransformargs method)": [[7, "awscrt.mqtt.WebsocketHandshakeTransformArgs.set_done"]], "subscribe() (awscrt.mqtt.connection method)": [[7, "awscrt.mqtt.Connection.subscribe"]], "topic (awscrt.mqtt.will attribute)": [[7, "awscrt.mqtt.Will.topic"]], "unsubscribe() (awscrt.mqtt.connection method)": [[7, "awscrt.mqtt.Connection.unsubscribe"]], "administrative_action (awscrt.mqtt5.disconnectreasoncode attribute)": [[8, "awscrt.mqtt5.DisconnectReasonCode.ADMINISTRATIVE_ACTION"]], "at_least_once (awscrt.mqtt5.qos attribute)": [[8, "awscrt.mqtt5.QoS.AT_LEAST_ONCE"]], "at_most_once (awscrt.mqtt5.qos attribute)": [[8, "awscrt.mqtt5.QoS.AT_MOST_ONCE"]], "aws_iot_core_defaults (awscrt.mqtt5.extendedvalidationandflowcontroloptions attribute)": [[8, "awscrt.mqtt5.ExtendedValidationAndFlowControlOptions.AWS_IOT_CORE_DEFAULTS"]], "aws_mqtt5_pfi_bytes (awscrt.mqtt5.payloadformatindicator attribute)": [[8, "awscrt.mqtt5.PayloadFormatIndicator.AWS_MQTT5_PFI_BYTES"]], "aws_mqtt5_pfi_utf8 (awscrt.mqtt5.payloadformatindicator attribute)": [[8, "awscrt.mqtt5.PayloadFormatIndicator.AWS_MQTT5_PFI_UTF8"]], "bad_authentication_method (awscrt.mqtt5.connectreasoncode attribute)": [[8, "awscrt.mqtt5.ConnectReasonCode.BAD_AUTHENTICATION_METHOD"]], "bad_username_or_password (awscrt.mqtt5.connectreasoncode attribute)": [[8, "awscrt.mqtt5.ConnectReasonCode.BAD_USERNAME_OR_PASSWORD"]], "banned (awscrt.mqtt5.connectreasoncode attribute)": [[8, "awscrt.mqtt5.ConnectReasonCode.BANNED"]], "clean (awscrt.mqtt5.clientsessionbehaviortype attribute)": [[8, "awscrt.mqtt5.ClientSessionBehaviorType.CLEAN"]], "client_identifier_not_valid (awscrt.mqtt5.connectreasoncode attribute)": [[8, "awscrt.mqtt5.ConnectReasonCode.CLIENT_IDENTIFIER_NOT_VALID"]], "connection_rate_exceeded (awscrt.mqtt5.connectreasoncode attribute)": [[8, "awscrt.mqtt5.ConnectReasonCode.CONNECTION_RATE_EXCEEDED"]], "connection_rate_exceeded (awscrt.mqtt5.disconnectreasoncode attribute)": [[8, "awscrt.mqtt5.DisconnectReasonCode.CONNECTION_RATE_EXCEEDED"]], "client (class in awscrt.mqtt5)": [[8, "awscrt.mqtt5.Client"]], "clientoperationqueuebehaviortype (class in awscrt.mqtt5)": [[8, "awscrt.mqtt5.ClientOperationQueueBehaviorType"]], "clientoptions (class in awscrt.mqtt5)": [[8, "awscrt.mqtt5.ClientOptions"]], "clientsessionbehaviortype (class in awscrt.mqtt5)": [[8, "awscrt.mqtt5.ClientSessionBehaviorType"]], "connackpacket (class in awscrt.mqtt5)": [[8, "awscrt.mqtt5.ConnackPacket"]], "connectpacket (class in awscrt.mqtt5)": [[8, "awscrt.mqtt5.ConnectPacket"]], "connectreasoncode (class in awscrt.mqtt5)": [[8, "awscrt.mqtt5.ConnectReasonCode"]], "decorrelated (awscrt.mqtt5.exponentialbackoffjittermode attribute)": [[8, "awscrt.mqtt5.ExponentialBackoffJitterMode.DECORRELATED"]], "default (awscrt.mqtt5.clientoperationqueuebehaviortype attribute)": [[8, "awscrt.mqtt5.ClientOperationQueueBehaviorType.DEFAULT"]], "default (awscrt.mqtt5.clientsessionbehaviortype attribute)": [[8, "awscrt.mqtt5.ClientSessionBehaviorType.DEFAULT"]], "default (awscrt.mqtt5.exponentialbackoffjittermode attribute)": [[8, "awscrt.mqtt5.ExponentialBackoffJitterMode.DEFAULT"]], "default (awscrt.mqtt5.inboundtopicaliasbehaviortype attribute)": [[8, "awscrt.mqtt5.InboundTopicAliasBehaviorType.DEFAULT"]], "default (awscrt.mqtt5.outboundtopicaliasbehaviortype attribute)": [[8, "awscrt.mqtt5.OutboundTopicAliasBehaviorType.DEFAULT"]], "disabled (awscrt.mqtt5.inboundtopicaliasbehaviortype attribute)": [[8, "awscrt.mqtt5.InboundTopicAliasBehaviorType.DISABLED"]], "disabled (awscrt.mqtt5.outboundtopicaliasbehaviortype attribute)": [[8, "awscrt.mqtt5.OutboundTopicAliasBehaviorType.DISABLED"]], "disconnect_with_will_message (awscrt.mqtt5.disconnectreasoncode attribute)": [[8, "awscrt.mqtt5.DisconnectReasonCode.DISCONNECT_WITH_WILL_MESSAGE"]], "dont_send (awscrt.mqtt5.retainandhandlingtype attribute)": [[8, "awscrt.mqtt5.RetainAndHandlingType.DONT_SEND"]], "dont_send (awscrt.mqtt5.retainhandlingtype attribute)": [[8, "awscrt.mqtt5.RetainHandlingType.DONT_SEND"]], "disconnectpacket (class in awscrt.mqtt5)": [[8, "awscrt.mqtt5.DisconnectPacket"]], "disconnectreasoncode (class in awscrt.mqtt5)": [[8, "awscrt.mqtt5.DisconnectReasonCode"]], "enabled (awscrt.mqtt5.inboundtopicaliasbehaviortype attribute)": [[8, "awscrt.mqtt5.InboundTopicAliasBehaviorType.ENABLED"]], "exactly_once (awscrt.mqtt5.qos attribute)": [[8, "awscrt.mqtt5.QoS.EXACTLY_ONCE"]], "exponentialbackoffjittermode (class in awscrt.mqtt5)": [[8, "awscrt.mqtt5.ExponentialBackoffJitterMode"]], "extendedvalidationandflowcontroloptions (class in awscrt.mqtt5)": [[8, "awscrt.mqtt5.ExtendedValidationAndFlowControlOptions"]], "fail_all_on_disconnect (awscrt.mqtt5.clientoperationqueuebehaviortype attribute)": [[8, "awscrt.mqtt5.ClientOperationQueueBehaviorType.FAIL_ALL_ON_DISCONNECT"]], "fail_non_qos1_publish_on_disconnect (awscrt.mqtt5.clientoperationqueuebehaviortype attribute)": [[8, "awscrt.mqtt5.ClientOperationQueueBehaviorType.FAIL_NON_QOS1_PUBLISH_ON_DISCONNECT"]], "fail_qos0_publish_on_disconnect (awscrt.mqtt5.clientoperationqueuebehaviortype attribute)": [[8, "awscrt.mqtt5.ClientOperationQueueBehaviorType.FAIL_QOS0_PUBLISH_ON_DISCONNECT"]], "full (awscrt.mqtt5.exponentialbackoffjittermode attribute)": [[8, "awscrt.mqtt5.ExponentialBackoffJitterMode.FULL"]], "granted_qos_0 (awscrt.mqtt5.subackreasoncode attribute)": [[8, "awscrt.mqtt5.SubackReasonCode.GRANTED_QOS_0"]], "granted_qos_1 (awscrt.mqtt5.subackreasoncode attribute)": [[8, "awscrt.mqtt5.SubackReasonCode.GRANTED_QOS_1"]], "granted_qos_2 (awscrt.mqtt5.subackreasoncode attribute)": [[8, "awscrt.mqtt5.SubackReasonCode.GRANTED_QOS_2"]], "implementation_specific_error (awscrt.mqtt5.connectreasoncode attribute)": [[8, "awscrt.mqtt5.ConnectReasonCode.IMPLEMENTATION_SPECIFIC_ERROR"]], "implementation_specific_error (awscrt.mqtt5.disconnectreasoncode attribute)": [[8, "awscrt.mqtt5.DisconnectReasonCode.IMPLEMENTATION_SPECIFIC_ERROR"]], "implementation_specific_error (awscrt.mqtt5.pubackreasoncode attribute)": [[8, "awscrt.mqtt5.PubackReasonCode.IMPLEMENTATION_SPECIFIC_ERROR"]], "implementation_specific_error (awscrt.mqtt5.subackreasoncode attribute)": [[8, "awscrt.mqtt5.SubackReasonCode.IMPLEMENTATION_SPECIFIC_ERROR"]], "implementation_specific_error (awscrt.mqtt5.unsubackreasoncode attribute)": [[8, "awscrt.mqtt5.UnsubackReasonCode.IMPLEMENTATION_SPECIFIC_ERROR"]], "inboundtopicaliasbehaviortype (class in awscrt.mqtt5)": [[8, "awscrt.mqtt5.InboundTopicAliasBehaviorType"]], "keep_alive_timeout (awscrt.mqtt5.disconnectreasoncode attribute)": [[8, "awscrt.mqtt5.DisconnectReasonCode.KEEP_ALIVE_TIMEOUT"]], "lru (awscrt.mqtt5.outboundtopicaliasbehaviortype attribute)": [[8, "awscrt.mqtt5.OutboundTopicAliasBehaviorType.LRU"]], "lifecycleattemptingconnectdata (class in awscrt.mqtt5)": [[8, "awscrt.mqtt5.LifecycleAttemptingConnectData"]], "lifecycleconnectfailuredata (class in awscrt.mqtt5)": [[8, "awscrt.mqtt5.LifecycleConnectFailureData"]], "lifecycleconnectsuccessdata (class in awscrt.mqtt5)": [[8, "awscrt.mqtt5.LifecycleConnectSuccessData"]], "lifecycledisconnectdata (class in awscrt.mqtt5)": [[8, "awscrt.mqtt5.LifecycleDisconnectData"]], "lifecyclestoppeddata (class in awscrt.mqtt5)": [[8, "awscrt.mqtt5.LifecycleStoppedData"]], "malformed_packet (awscrt.mqtt5.connectreasoncode attribute)": [[8, "awscrt.mqtt5.ConnectReasonCode.MALFORMED_PACKET"]], "malformed_packet (awscrt.mqtt5.disconnectreasoncode attribute)": [[8, "awscrt.mqtt5.DisconnectReasonCode.MALFORMED_PACKET"]], "manual (awscrt.mqtt5.outboundtopicaliasbehaviortype attribute)": [[8, "awscrt.mqtt5.OutboundTopicAliasBehaviorType.MANUAL"]], "maximum_connect_time (awscrt.mqtt5.disconnectreasoncode attribute)": [[8, "awscrt.mqtt5.DisconnectReasonCode.MAXIMUM_CONNECT_TIME"]], "message_rate_too_high (awscrt.mqtt5.disconnectreasoncode attribute)": [[8, "awscrt.mqtt5.DisconnectReasonCode.MESSAGE_RATE_TOO_HIGH"]], "none (awscrt.mqtt5.exponentialbackoffjittermode attribute)": [[8, "awscrt.mqtt5.ExponentialBackoffJitterMode.NONE"]], "none (awscrt.mqtt5.extendedvalidationandflowcontroloptions attribute)": [[8, "awscrt.mqtt5.ExtendedValidationAndFlowControlOptions.NONE"]], "normal_disconnection (awscrt.mqtt5.disconnectreasoncode attribute)": [[8, "awscrt.mqtt5.DisconnectReasonCode.NORMAL_DISCONNECTION"]], "not_authorized (awscrt.mqtt5.connectreasoncode attribute)": [[8, "awscrt.mqtt5.ConnectReasonCode.NOT_AUTHORIZED"]], "not_authorized (awscrt.mqtt5.disconnectreasoncode attribute)": [[8, "awscrt.mqtt5.DisconnectReasonCode.NOT_AUTHORIZED"]], "not_authorized (awscrt.mqtt5.pubackreasoncode attribute)": [[8, "awscrt.mqtt5.PubackReasonCode.NOT_AUTHORIZED"]], "not_authorized (awscrt.mqtt5.subackreasoncode attribute)": [[8, "awscrt.mqtt5.SubackReasonCode.NOT_AUTHORIZED"]], "not_authorized (awscrt.mqtt5.unsubackreasoncode attribute)": [[8, "awscrt.mqtt5.UnsubackReasonCode.NOT_AUTHORIZED"]], "no_matching_subscribers (awscrt.mqtt5.pubackreasoncode attribute)": [[8, "awscrt.mqtt5.PubackReasonCode.NO_MATCHING_SUBSCRIBERS"]], "no_subscription_existed (awscrt.mqtt5.unsubackreasoncode attribute)": [[8, "awscrt.mqtt5.UnsubackReasonCode.NO_SUBSCRIPTION_EXISTED"]], "negotiatedsettings (class in awscrt.mqtt5)": [[8, "awscrt.mqtt5.NegotiatedSettings"]], "operationstatisticsdata (class in awscrt.mqtt5)": [[8, "awscrt.mqtt5.OperationStatisticsData"]], "outboundtopicaliasbehaviortype (class in awscrt.mqtt5)": [[8, "awscrt.mqtt5.OutboundTopicAliasBehaviorType"]], "packet_identifier_in_use (awscrt.mqtt5.pubackreasoncode attribute)": [[8, "awscrt.mqtt5.PubackReasonCode.PACKET_IDENTIFIER_IN_USE"]], "packet_identifier_in_use (awscrt.mqtt5.subackreasoncode attribute)": [[8, "awscrt.mqtt5.SubackReasonCode.PACKET_IDENTIFIER_IN_USE"]], "packet_identifier_in_use (awscrt.mqtt5.unsubackreasoncode attribute)": [[8, "awscrt.mqtt5.UnsubackReasonCode.PACKET_IDENTIFIER_IN_USE"]], "packet_too_large (awscrt.mqtt5.connectreasoncode attribute)": [[8, "awscrt.mqtt5.ConnectReasonCode.PACKET_TOO_LARGE"]], "packet_too_large (awscrt.mqtt5.disconnectreasoncode attribute)": [[8, "awscrt.mqtt5.DisconnectReasonCode.PACKET_TOO_LARGE"]], "payload_format_invalid (awscrt.mqtt5.connectreasoncode attribute)": [[8, "awscrt.mqtt5.ConnectReasonCode.PAYLOAD_FORMAT_INVALID"]], "payload_format_invalid (awscrt.mqtt5.disconnectreasoncode attribute)": [[8, "awscrt.mqtt5.DisconnectReasonCode.PAYLOAD_FORMAT_INVALID"]], "payload_format_invalid (awscrt.mqtt5.pubackreasoncode attribute)": [[8, "awscrt.mqtt5.PubackReasonCode.PAYLOAD_FORMAT_INVALID"]], "protocol_error (awscrt.mqtt5.connectreasoncode attribute)": [[8, "awscrt.mqtt5.ConnectReasonCode.PROTOCOL_ERROR"]], "protocol_error (awscrt.mqtt5.disconnectreasoncode attribute)": [[8, "awscrt.mqtt5.DisconnectReasonCode.PROTOCOL_ERROR"]], "payloadformatindicator (class in awscrt.mqtt5)": [[8, "awscrt.mqtt5.PayloadFormatIndicator"]], "pubackpacket (class in awscrt.mqtt5)": [[8, "awscrt.mqtt5.PubackPacket"]], "pubackreasoncode (class in awscrt.mqtt5)": [[8, "awscrt.mqtt5.PubackReasonCode"]], "publishcompletiondata (class in awscrt.mqtt5)": [[8, "awscrt.mqtt5.PublishCompletionData"]], "publishpacket (class in awscrt.mqtt5)": [[8, "awscrt.mqtt5.PublishPacket"]], "publishreceiveddata (class in awscrt.mqtt5)": [[8, "awscrt.mqtt5.PublishReceivedData"]], "qos_not_supported (awscrt.mqtt5.connectreasoncode attribute)": [[8, "awscrt.mqtt5.ConnectReasonCode.QOS_NOT_SUPPORTED"]], "qos_not_supported (awscrt.mqtt5.disconnectreasoncode attribute)": [[8, "awscrt.mqtt5.DisconnectReasonCode.QOS_NOT_SUPPORTED"]], "quota_exceeded (awscrt.mqtt5.connectreasoncode attribute)": [[8, "awscrt.mqtt5.ConnectReasonCode.QUOTA_EXCEEDED"]], "quota_exceeded (awscrt.mqtt5.disconnectreasoncode attribute)": [[8, "awscrt.mqtt5.DisconnectReasonCode.QUOTA_EXCEEDED"]], "quota_exceeded (awscrt.mqtt5.pubackreasoncode attribute)": [[8, "awscrt.mqtt5.PubackReasonCode.QUOTA_EXCEEDED"]], "quota_exceeded (awscrt.mqtt5.subackreasoncode attribute)": [[8, "awscrt.mqtt5.SubackReasonCode.QUOTA_EXCEEDED"]], "qos (class in awscrt.mqtt5)": [[8, "awscrt.mqtt5.QoS"]], "receive_maximum_exceeded (awscrt.mqtt5.disconnectreasoncode attribute)": [[8, "awscrt.mqtt5.DisconnectReasonCode.RECEIVE_MAXIMUM_EXCEEDED"]], "rejoin_always (awscrt.mqtt5.clientsessionbehaviortype attribute)": [[8, "awscrt.mqtt5.ClientSessionBehaviorType.REJOIN_ALWAYS"]], "rejoin_post_success (awscrt.mqtt5.clientsessionbehaviortype attribute)": [[8, "awscrt.mqtt5.ClientSessionBehaviorType.REJOIN_POST_SUCCESS"]], "retain_not_supported (awscrt.mqtt5.connectreasoncode attribute)": [[8, "awscrt.mqtt5.ConnectReasonCode.RETAIN_NOT_SUPPORTED"]], "retain_not_supported (awscrt.mqtt5.disconnectreasoncode attribute)": [[8, "awscrt.mqtt5.DisconnectReasonCode.RETAIN_NOT_SUPPORTED"]], "retainandhandlingtype (class in awscrt.mqtt5)": [[8, "awscrt.mqtt5.RetainAndHandlingType"]], "retainhandlingtype (class in awscrt.mqtt5)": [[8, "awscrt.mqtt5.RetainHandlingType"]], "send_on_subscribe (awscrt.mqtt5.retainandhandlingtype attribute)": [[8, "awscrt.mqtt5.RetainAndHandlingType.SEND_ON_SUBSCRIBE"]], "send_on_subscribe (awscrt.mqtt5.retainhandlingtype attribute)": [[8, "awscrt.mqtt5.RetainHandlingType.SEND_ON_SUBSCRIBE"]], "send_on_subscribe_if_new (awscrt.mqtt5.retainandhandlingtype attribute)": [[8, "awscrt.mqtt5.RetainAndHandlingType.SEND_ON_SUBSCRIBE_IF_NEW"]], "send_on_subscribe_if_new (awscrt.mqtt5.retainhandlingtype attribute)": [[8, "awscrt.mqtt5.RetainHandlingType.SEND_ON_SUBSCRIBE_IF_NEW"]], "server_busy (awscrt.mqtt5.connectreasoncode attribute)": [[8, "awscrt.mqtt5.ConnectReasonCode.SERVER_BUSY"]], "server_busy (awscrt.mqtt5.disconnectreasoncode attribute)": [[8, "awscrt.mqtt5.DisconnectReasonCode.SERVER_BUSY"]], "server_moved (awscrt.mqtt5.connectreasoncode attribute)": [[8, "awscrt.mqtt5.ConnectReasonCode.SERVER_MOVED"]], "server_moved (awscrt.mqtt5.disconnectreasoncode attribute)": [[8, "awscrt.mqtt5.DisconnectReasonCode.SERVER_MOVED"]], "server_shutting_down (awscrt.mqtt5.disconnectreasoncode attribute)": [[8, "awscrt.mqtt5.DisconnectReasonCode.SERVER_SHUTTING_DOWN"]], "server_unavailable (awscrt.mqtt5.connectreasoncode attribute)": [[8, "awscrt.mqtt5.ConnectReasonCode.SERVER_UNAVAILABLE"]], "session_taken_over (awscrt.mqtt5.disconnectreasoncode attribute)": [[8, "awscrt.mqtt5.DisconnectReasonCode.SESSION_TAKEN_OVER"]], "shared_subscriptions_not_supported (awscrt.mqtt5.disconnectreasoncode attribute)": [[8, "awscrt.mqtt5.DisconnectReasonCode.SHARED_SUBSCRIPTIONS_NOT_SUPPORTED"]], "shared_subscriptions_not_supported (awscrt.mqtt5.subackreasoncode attribute)": [[8, "awscrt.mqtt5.SubackReasonCode.SHARED_SUBSCRIPTIONS_NOT_SUPPORTED"]], "subscription_identifiers_not_supported (awscrt.mqtt5.disconnectreasoncode attribute)": [[8, "awscrt.mqtt5.DisconnectReasonCode.SUBSCRIPTION_IDENTIFIERS_NOT_SUPPORTED"]], "subscription_identifiers_not_supported (awscrt.mqtt5.subackreasoncode attribute)": [[8, "awscrt.mqtt5.SubackReasonCode.SUBSCRIPTION_IDENTIFIERS_NOT_SUPPORTED"]], "success (awscrt.mqtt5.connectreasoncode attribute)": [[8, "awscrt.mqtt5.ConnectReasonCode.SUCCESS"]], "success (awscrt.mqtt5.pubackreasoncode attribute)": [[8, "awscrt.mqtt5.PubackReasonCode.SUCCESS"]], "success (awscrt.mqtt5.unsubackreasoncode attribute)": [[8, "awscrt.mqtt5.UnsubackReasonCode.SUCCESS"]], "subackpacket (class in awscrt.mqtt5)": [[8, "awscrt.mqtt5.SubackPacket"]], "subackreasoncode (class in awscrt.mqtt5)": [[8, "awscrt.mqtt5.SubackReasonCode"]], "subscribepacket (class in awscrt.mqtt5)": [[8, "awscrt.mqtt5.SubscribePacket"]], "subscription (class in awscrt.mqtt5)": [[8, "awscrt.mqtt5.Subscription"]], "topic_alias_invalid (awscrt.mqtt5.disconnectreasoncode attribute)": [[8, "awscrt.mqtt5.DisconnectReasonCode.TOPIC_ALIAS_INVALID"]], "topic_filter_invalid (awscrt.mqtt5.disconnectreasoncode attribute)": [[8, "awscrt.mqtt5.DisconnectReasonCode.TOPIC_FILTER_INVALID"]], "topic_filter_invalid (awscrt.mqtt5.subackreasoncode attribute)": [[8, "awscrt.mqtt5.SubackReasonCode.TOPIC_FILTER_INVALID"]], "topic_filter_invalid (awscrt.mqtt5.unsubackreasoncode attribute)": [[8, "awscrt.mqtt5.UnsubackReasonCode.TOPIC_FILTER_INVALID"]], "topic_name_invalid (awscrt.mqtt5.connectreasoncode attribute)": [[8, "awscrt.mqtt5.ConnectReasonCode.TOPIC_NAME_INVALID"]], "topic_name_invalid (awscrt.mqtt5.disconnectreasoncode attribute)": [[8, "awscrt.mqtt5.DisconnectReasonCode.TOPIC_NAME_INVALID"]], "topic_name_invalid (awscrt.mqtt5.pubackreasoncode attribute)": [[8, "awscrt.mqtt5.PubackReasonCode.TOPIC_NAME_INVALID"]], "topicaliasingoptions (class in awscrt.mqtt5)": [[8, "awscrt.mqtt5.TopicAliasingOptions"]], "unspecified_error (awscrt.mqtt5.connectreasoncode attribute)": [[8, "awscrt.mqtt5.ConnectReasonCode.UNSPECIFIED_ERROR"]], "unspecified_error (awscrt.mqtt5.disconnectreasoncode attribute)": [[8, "awscrt.mqtt5.DisconnectReasonCode.UNSPECIFIED_ERROR"]], "unspecified_error (awscrt.mqtt5.pubackreasoncode attribute)": [[8, "awscrt.mqtt5.PubackReasonCode.UNSPECIFIED_ERROR"]], "unspecified_error (awscrt.mqtt5.subackreasoncode attribute)": [[8, "awscrt.mqtt5.SubackReasonCode.UNSPECIFIED_ERROR"]], "unspecified_error (awscrt.mqtt5.unsubackreasoncode attribute)": [[8, "awscrt.mqtt5.UnsubackReasonCode.UNSPECIFIED_ERROR"]], "unsupported_protocol_version (awscrt.mqtt5.connectreasoncode attribute)": [[8, "awscrt.mqtt5.ConnectReasonCode.UNSUPPORTED_PROTOCOL_VERSION"]], "use_another_server (awscrt.mqtt5.connectreasoncode attribute)": [[8, "awscrt.mqtt5.ConnectReasonCode.USE_ANOTHER_SERVER"]], "use_another_server (awscrt.mqtt5.disconnectreasoncode attribute)": [[8, "awscrt.mqtt5.DisconnectReasonCode.USE_ANOTHER_SERVER"]], "unsubackpacket (class in awscrt.mqtt5)": [[8, "awscrt.mqtt5.UnsubackPacket"]], "unsubackreasoncode (class in awscrt.mqtt5)": [[8, "awscrt.mqtt5.UnsubackReasonCode"]], "unsubscribepacket (class in awscrt.mqtt5)": [[8, "awscrt.mqtt5.UnsubscribePacket"]], "userproperty (class in awscrt.mqtt5)": [[8, "awscrt.mqtt5.UserProperty"]], "wildcard_subscriptions_not_supported (awscrt.mqtt5.disconnectreasoncode attribute)": [[8, "awscrt.mqtt5.DisconnectReasonCode.WILDCARD_SUBSCRIPTIONS_NOT_SUPPORTED"]], "wildcard_subscriptions_not_supported (awscrt.mqtt5.subackreasoncode attribute)": [[8, "awscrt.mqtt5.SubackReasonCode.WILDCARD_SUBSCRIPTIONS_NOT_SUPPORTED"]], "websockethandshaketransformargs (class in awscrt.mqtt5)": [[8, "awscrt.mqtt5.WebsocketHandshakeTransformArgs"]], "awscrt.mqtt5": [[8, "module-awscrt.mqtt5"]], "client (awscrt.mqtt5.websockethandshaketransformargs attribute)": [[8, "awscrt.mqtt5.WebsocketHandshakeTransformArgs.client"]], "get_stats() (awscrt.mqtt5.client method)": [[8, "awscrt.mqtt5.Client.get_stats"]], "http_request (awscrt.mqtt5.websockethandshaketransformargs attribute)": [[8, "awscrt.mqtt5.WebsocketHandshakeTransformArgs.http_request"]], "publish() (awscrt.mqtt5.client method)": [[8, "awscrt.mqtt5.Client.publish"]], "set_done() (awscrt.mqtt5.websockethandshaketransformargs method)": [[8, "awscrt.mqtt5.WebsocketHandshakeTransformArgs.set_done"]], "start() (awscrt.mqtt5.client method)": [[8, "awscrt.mqtt5.Client.start"]], "stop() (awscrt.mqtt5.client method)": [[8, "awscrt.mqtt5.Client.stop"]], "subscribe() (awscrt.mqtt5.client method)": [[8, "awscrt.mqtt5.Client.subscribe"]], "unsubscribe() (awscrt.mqtt5.client method)": [[8, "awscrt.mqtt5.Client.unsubscribe"]], "crc32 (awscrt.s3.s3checksumalgorithm attribute)": [[9, "awscrt.s3.S3ChecksumAlgorithm.CRC32"]], "crc32c (awscrt.s3.s3checksumalgorithm attribute)": [[9, "awscrt.s3.S3ChecksumAlgorithm.CRC32C"]], "crossprocesslock (class in awscrt.s3)": [[9, "awscrt.s3.CrossProcessLock"]], "default (awscrt.s3.s3requesttype attribute)": [[9, "awscrt.s3.S3RequestType.DEFAULT"]], "disabled (awscrt.s3.s3requesttlsmode attribute)": [[9, "awscrt.s3.S3RequestTlsMode.DISABLED"]], "enabled (awscrt.s3.s3requesttlsmode attribute)": [[9, "awscrt.s3.S3RequestTlsMode.ENABLED"]], "get_object (awscrt.s3.s3requesttype attribute)": [[9, "awscrt.s3.S3RequestType.GET_OBJECT"]], "header (awscrt.s3.s3checksumlocation attribute)": [[9, "awscrt.s3.S3ChecksumLocation.HEADER"]], "put_object (awscrt.s3.s3requesttype attribute)": [[9, "awscrt.s3.S3RequestType.PUT_OBJECT"]], "s3checksumalgorithm (class in awscrt.s3)": [[9, "awscrt.s3.S3ChecksumAlgorithm"]], "s3checksumconfig (class in awscrt.s3)": [[9, "awscrt.s3.S3ChecksumConfig"]], "s3checksumlocation (class in awscrt.s3)": [[9, "awscrt.s3.S3ChecksumLocation"]], "s3client (class in awscrt.s3)": [[9, "awscrt.s3.S3Client"]], "s3request (class in awscrt.s3)": [[9, "awscrt.s3.S3Request"]], "s3requesttlsmode (class in awscrt.s3)": [[9, "awscrt.s3.S3RequestTlsMode"]], "s3requesttype (class in awscrt.s3)": [[9, "awscrt.s3.S3RequestType"]], "s3responseerror": [[9, "awscrt.s3.S3ResponseError"]], "sha1 (awscrt.s3.s3checksumalgorithm attribute)": [[9, "awscrt.s3.S3ChecksumAlgorithm.SHA1"]], "sha256 (awscrt.s3.s3checksumalgorithm attribute)": [[9, "awscrt.s3.S3ChecksumAlgorithm.SHA256"]], "trailer (awscrt.s3.s3checksumlocation attribute)": [[9, "awscrt.s3.S3ChecksumLocation.TRAILER"]], "algorithm (awscrt.s3.s3checksumconfig attribute)": [[9, "awscrt.s3.S3ChecksumConfig.algorithm"]], "awscrt.s3": [[9, "module-awscrt.s3"]], "body (awscrt.s3.s3responseerror attribute)": [[9, "awscrt.s3.S3ResponseError.body"]], "code (awscrt.s3.s3responseerror attribute)": [[9, "awscrt.s3.S3ResponseError.code"]], "create_default_s3_signing_config() (in module awscrt.s3)": [[9, "awscrt.s3.create_default_s3_signing_config"]], "credential_provider (in module awscrt.s3)": [[9, "awscrt.s3.credential_provider"]], "finished_future (awscrt.s3.s3request attribute)": [[9, "awscrt.s3.S3Request.finished_future"]], "get_ec2_instance_type() (in module awscrt.s3)": [[9, "awscrt.s3.get_ec2_instance_type"]], "get_optimized_platforms() (in module awscrt.s3)": [[9, "awscrt.s3.get_optimized_platforms"]], "get_recommended_throughput_target_gbps() (in module awscrt.s3)": [[9, "awscrt.s3.get_recommended_throughput_target_gbps"]], "headers (awscrt.s3.s3responseerror attribute)": [[9, "awscrt.s3.S3ResponseError.headers"]], "is_optimized_for_system() (in module awscrt.s3)": [[9, "awscrt.s3.is_optimized_for_system"]], "location (awscrt.s3.s3checksumconfig attribute)": [[9, "awscrt.s3.S3ChecksumConfig.location"]], "make_request() (awscrt.s3.s3client method)": [[9, "awscrt.s3.S3Client.make_request"]], "message (awscrt.s3.s3responseerror attribute)": [[9, "awscrt.s3.S3ResponseError.message"]], "name (awscrt.s3.s3responseerror attribute)": [[9, "awscrt.s3.S3ResponseError.name"]], "operation_name (awscrt.s3.s3responseerror attribute)": [[9, "awscrt.s3.S3ResponseError.operation_name"]], "region (in module awscrt.s3)": [[9, "awscrt.s3.region"]], "shutdown_event (awscrt.s3.s3request attribute)": [[9, "awscrt.s3.S3Request.shutdown_event"]], "status_code (awscrt.s3.s3responseerror attribute)": [[9, "awscrt.s3.S3ResponseError.status_code"]], "validate_response (awscrt.s3.s3checksumconfig attribute)": [[9, "awscrt.s3.S3ChecksumConfig.validate_response"]], "binary (awscrt.websocket.opcode attribute)": [[10, "awscrt.websocket.Opcode.BINARY"]], "close (awscrt.websocket.opcode attribute)": [[10, "awscrt.websocket.Opcode.CLOSE"]], "continuation (awscrt.websocket.opcode attribute)": [[10, "awscrt.websocket.Opcode.CONTINUATION"]], "incomingframe (class in awscrt.websocket)": [[10, "awscrt.websocket.IncomingFrame"]], "max_payload_length (in module awscrt.websocket)": [[10, "awscrt.websocket.MAX_PAYLOAD_LENGTH"]], "onconnectionsetupdata (class in awscrt.websocket)": [[10, "awscrt.websocket.OnConnectionSetupData"]], "onconnectionshutdowndata (class in awscrt.websocket)": [[10, "awscrt.websocket.OnConnectionShutdownData"]], "onincomingframebegindata (class in awscrt.websocket)": [[10, "awscrt.websocket.OnIncomingFrameBeginData"]], "onincomingframecompletedata (class in awscrt.websocket)": [[10, "awscrt.websocket.OnIncomingFrameCompleteData"]], "onincomingframepayloaddata (class in awscrt.websocket)": [[10, "awscrt.websocket.OnIncomingFramePayloadData"]], "onsendframecompletedata (class in awscrt.websocket)": [[10, "awscrt.websocket.OnSendFrameCompleteData"]], "opcode (class in awscrt.websocket)": [[10, "awscrt.websocket.Opcode"]], "ping (awscrt.websocket.opcode attribute)": [[10, "awscrt.websocket.Opcode.PING"]], "pong (awscrt.websocket.opcode attribute)": [[10, "awscrt.websocket.Opcode.PONG"]], "text (awscrt.websocket.opcode attribute)": [[10, "awscrt.websocket.Opcode.TEXT"]], "websocket (class in awscrt.websocket)": [[10, "awscrt.websocket.WebSocket"]], "awscrt.websocket": [[10, "module-awscrt.websocket"]], "close() (awscrt.websocket.websocket method)": [[10, "awscrt.websocket.WebSocket.close"]], "connect() (in module awscrt.websocket)": [[10, "awscrt.websocket.connect"]], "create_handshake_request() (in module awscrt.websocket)": [[10, "awscrt.websocket.create_handshake_request"]], "data (awscrt.websocket.onincomingframepayloaddata attribute)": [[10, "awscrt.websocket.OnIncomingFramePayloadData.data"]], "exception (awscrt.websocket.onconnectionsetupdata attribute)": [[10, "awscrt.websocket.OnConnectionSetupData.exception"]], "exception (awscrt.websocket.onconnectionshutdowndata attribute)": [[10, "awscrt.websocket.OnConnectionShutdownData.exception"]], "exception (awscrt.websocket.onincomingframecompletedata attribute)": [[10, "awscrt.websocket.OnIncomingFrameCompleteData.exception"]], "exception (awscrt.websocket.onsendframecompletedata attribute)": [[10, "awscrt.websocket.OnSendFrameCompleteData.exception"]], "fin (awscrt.websocket.incomingframe attribute)": [[10, "awscrt.websocket.IncomingFrame.fin"]], "frame (awscrt.websocket.onincomingframebegindata attribute)": [[10, "awscrt.websocket.OnIncomingFrameBeginData.frame"]], "frame (awscrt.websocket.onincomingframecompletedata attribute)": [[10, "awscrt.websocket.OnIncomingFrameCompleteData.frame"]], "frame (awscrt.websocket.onincomingframepayloaddata attribute)": [[10, "awscrt.websocket.OnIncomingFramePayloadData.frame"]], "handshake_response_body (awscrt.websocket.onconnectionsetupdata attribute)": [[10, "awscrt.websocket.OnConnectionSetupData.handshake_response_body"]], "handshake_response_headers (awscrt.websocket.onconnectionsetupdata attribute)": [[10, "awscrt.websocket.OnConnectionSetupData.handshake_response_headers"]], "handshake_response_status (awscrt.websocket.onconnectionsetupdata attribute)": [[10, "awscrt.websocket.OnConnectionSetupData.handshake_response_status"]], "increment_read_window() (awscrt.websocket.websocket method)": [[10, "awscrt.websocket.WebSocket.increment_read_window"]], "is_data_frame() (awscrt.websocket.incomingframe method)": [[10, "awscrt.websocket.IncomingFrame.is_data_frame"]], "is_data_frame() (awscrt.websocket.opcode method)": [[10, "awscrt.websocket.Opcode.is_data_frame"]], "opcode (awscrt.websocket.incomingframe attribute)": [[10, "awscrt.websocket.IncomingFrame.opcode"]], "payload_length (awscrt.websocket.incomingframe attribute)": [[10, "awscrt.websocket.IncomingFrame.payload_length"]], "send_frame() (awscrt.websocket.websocket method)": [[10, "awscrt.websocket.WebSocket.send_frame"]], "websocket (awscrt.websocket.onconnectionsetupdata attribute)": [[10, "awscrt.websocket.OnConnectionSetupData.websocket"]]}})
\ No newline at end of file