Skip to content

Commit c23328c

Browse files
authored
Remove developer preview warning from Greengrass V2 Client (#311)
1 parent 0bc101f commit c23328c

File tree

8 files changed

+754
-172
lines changed

8 files changed

+754
-172
lines changed

awsiot/greengrasscoreipc/clientv2.py

-4
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,6 @@ class GreengrassCoreIPCClientV2:
1616
"""
1717
V2 client for the GreengrassCoreIPC service.
1818
19-
!! Developer Preview !! - This class is currently in developer preview.
20-
The interface is not guaranteed to be stable yet.
21-
Please report any issues or make suggestions in https://github.com/aws/aws-iot-device-sdk-python-v2/issues
22-
2319
Args:
2420
client: Connection that this client will use. If you do not provide one, it will be made automatically.
2521
executor: Executor used to run on_stream_event and on_stream_closed callbacks to avoid blocking the networking

docs/awsiot/eventstreamrpc.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -196,13 +196,13 @@ <h3>Navigation</h3>
196196
</dl>
197197
<dl class="py attribute">
198198
<dt class="sig sig-object py" id="awsiot.eventstreamrpc.MessageAmendment.headers">
199-
<span class="sig-name descname"><span class="pre">headers</span></span><a class="headerlink" href="#awsiot.eventstreamrpc.MessageAmendment.headers" title="Permalink to this definition"></a></dt>
199+
<span class="sig-name descname"><span class="pre">headers</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://awslabs.github.io/aws-crt-python/api/eventstream.html#awscrt.eventstream.Header" title="(in awscrt)"><span class="pre">awscrt.eventstream.Header</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#awsiot.eventstreamrpc.MessageAmendment.headers" title="Permalink to this definition"></a></dt>
200200
<dd><p>Headers to add</p>
201201
</dd></dl>
202202

203203
<dl class="py attribute">
204204
<dt class="sig sig-object py" id="awsiot.eventstreamrpc.MessageAmendment.payload">
205-
<span class="sig-name descname"><span class="pre">payload</span></span><a class="headerlink" href="#awsiot.eventstreamrpc.MessageAmendment.payload" title="Permalink to this definition"></a></dt>
205+
<span class="sig-name descname"><span class="pre">payload</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.10)"><span class="pre">bytes</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#awsiot.eventstreamrpc.MessageAmendment.payload" title="Permalink to this definition"></a></dt>
206206
<dd><p>Binary payload data</p>
207207
</dd></dl>
208208

@@ -221,7 +221,7 @@ <h3>Navigation</h3>
221221
<cite>connect_message_amender</cite> init arg.</p>
222222
</dd>
223223
<dt class="field-odd">Return type</dt>
224-
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.10)"><em>Callable</em></a>[<a class="reference internal" href="#awsiot.eventstreamrpc.MessageAmendment" title="awsiot.eventstreamrpc.MessageAmendment">awsiot.eventstreamrpc.MessageAmendment</a>]</p>
224+
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.10)"><em>Callable</em></a>[[], <a class="reference internal" href="#awsiot.eventstreamrpc.MessageAmendment" title="awsiot.eventstreamrpc.MessageAmendment">awsiot.eventstreamrpc.MessageAmendment</a>]</p>
225225
</dd>
226226
</dl>
227227
</dd></dl>
@@ -250,7 +250,7 @@ <h3>Navigation</h3>
250250
<li><p><strong>tls_connection_options</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.10)"><em>Optional</em></a><em>[</em><a class="reference external" href="https://awslabs.github.io/aws-crt-python/api/io.html#awscrt.io.TlsConnectionOptions" title="(in awscrt)"><em>awscrt.io.TlsConnectionOptions</em></a><em>]</em>) – Optional TLS connection options.
251251
If None is provided, then the connection will be attempted over
252252
plain-text.</p></li>
253-
<li><p><strong>connect_message_amender</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.10)"><em>Optional</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.10)"><em>Callable</em></a><em>[</em><a class="reference internal" href="#awsiot.eventstreamrpc.MessageAmendment" title="awsiot.eventstreamrpc.MessageAmendment"><em>awsiot.eventstreamrpc.MessageAmendment</em></a><em>]</em><em>]</em>) – Optional callable that should return a
253+
<li><p><strong>connect_message_amender</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.10)"><em>Optional</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.10)"><em>Callable</em></a><em>[</em><em>[</em><em>]</em><em>, </em><a class="reference internal" href="#awsiot.eventstreamrpc.MessageAmendment" title="awsiot.eventstreamrpc.MessageAmendment"><em>awsiot.eventstreamrpc.MessageAmendment</em></a><em>]</em><em>]</em>) – Optional callable that should return a
254254
<a class="reference internal" href="#awsiot.eventstreamrpc.MessageAmendment" title="awsiot.eventstreamrpc.MessageAmendment"><code class="xref py py-class docutils literal notranslate"><span class="pre">MessageAmendment</span></code></a> for the
255255
<a class="reference external" href="https://awslabs.github.io/aws-crt-python/api/eventstream.html#awscrt.eventstream.rpc.MessageType.CONNECT" title="(in awscrt)"><code class="xref py py-attr docutils literal notranslate"><span class="pre">CONNECT</span></code></a> message.
256256
This callable will be invoked whenever a network connection is

docs/awsiot/greengrass_discovery.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -104,13 +104,13 @@ <h3>Navigation</h3>
104104
</dl>
105105
<dl class="py attribute">
106106
<dt class="sig sig-object py" id="awsiot.greengrass_discovery.DiscoveryException.http_response_code">
107-
<span class="sig-name descname"><span class="pre">http_response_code</span></span><a class="headerlink" href="#awsiot.greengrass_discovery.DiscoveryException.http_response_code" title="Permalink to this definition"></a></dt>
107+
<span class="sig-name descname"><span class="pre">http_response_code</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.10)"><span class="pre">int</span></a></em><a class="headerlink" href="#awsiot.greengrass_discovery.DiscoveryException.http_response_code" title="Permalink to this definition"></a></dt>
108108
<dd><p>HTTP response code</p>
109109
</dd></dl>
110110

111111
<dl class="py attribute">
112112
<dt class="sig sig-object py" id="awsiot.greengrass_discovery.DiscoveryException.message">
113-
<span class="sig-name descname"><span class="pre">message</span></span><a class="headerlink" href="#awsiot.greengrass_discovery.DiscoveryException.message" title="Permalink to this definition"></a></dt>
113+
<span class="sig-name descname"><span class="pre">message</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.10)"><span class="pre">str</span></a></em><a class="headerlink" href="#awsiot.greengrass_discovery.DiscoveryException.message" title="Permalink to this definition"></a></dt>
114114
<dd><p>Message</p>
115115
</dd></dl>
116116

@@ -198,7 +198,7 @@ <h3>Navigation</h3>
198198
<p>Discovery response</p>
199199
<dl class="py attribute">
200200
<dt class="sig sig-object py" id="awsiot.greengrass_discovery.DiscoverResponse.gg_groups">
201-
<span class="sig-name descname"><span class="pre">gg_groups</span></span><a class="headerlink" href="#awsiot.greengrass_discovery.DiscoverResponse.gg_groups" title="Permalink to this definition"></a></dt>
201+
<span class="sig-name descname"><span class="pre">gg_groups</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#awsiot.greengrass_discovery.GGGroup" title="awsiot.greengrass_discovery.GGGroup"><span class="pre">awsiot.greengrass_discovery.GGGroup</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#awsiot.greengrass_discovery.DiscoverResponse.gg_groups" title="Permalink to this definition"></a></dt>
202202
<dd><p>List of <a class="reference internal" href="#awsiot.greengrass_discovery.GGGroup" title="awsiot.greengrass_discovery.GGGroup"><code class="xref py py-class docutils literal notranslate"><span class="pre">GGGroup</span></code></a></p>
203203
</dd></dl>
204204

0 commit comments

Comments
 (0)