Skip to content

Commit 10c6d74

Browse files
rlhagermrlhagerm
committed
Metadata and readme.
1 parent 57e8385 commit 10c6d74

File tree

2 files changed

+246
-0
lines changed

2 files changed

+246
-0
lines changed

‎.doc_gen/metadata/iot_metadata.yaml‎

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,14 @@ iot_Hello:
2222
- description:
2323
snippet_tags:
2424
- iot.java2.hello_iot.main
25+
.NET:
26+
versions:
27+
- sdk_version: 4
28+
github: dotnetv4/IoT
29+
excerpts:
30+
- description:
31+
snippet_tags:
32+
- iot.dotnetv4.Hello
2533
C++:
2634
versions:
2735
- sdk_version: 1
@@ -55,6 +63,14 @@ iot_DescribeEndpoint:
5563
- description:
5664
snippet_tags:
5765
- iot.java2.describe.endpoint.main
66+
.NET:
67+
versions:
68+
- sdk_version: 4
69+
github: dotnetv4/IoT
70+
excerpts:
71+
- description:
72+
snippet_tags:
73+
- iot.dotnetv4.DescribeEndpoint
5874
Rust:
5975
versions:
6076
- sdk_version: 1
@@ -75,6 +91,14 @@ iot_DescribeEndpoint:
7591
iot: {DescribeEndpoint}
7692
iot_ListThings:
7793
languages:
94+
.NET:
95+
versions:
96+
- sdk_version: 4
97+
github: dotnetv4/IoT
98+
excerpts:
99+
- description:
100+
snippet_tags:
101+
- iot.dotnetv4.ListThings
78102
Rust:
79103
versions:
80104
- sdk_version: 1
@@ -104,6 +128,14 @@ iot_ListCertificates:
104128
- description:
105129
snippet_tags:
106130
- iot.java2.list.certs.main
131+
.NET:
132+
versions:
133+
- sdk_version: 4
134+
github: dotnetv4/IoT
135+
excerpts:
136+
- description:
137+
snippet_tags:
138+
- iot.dotnetv4.ListCertificates
107139
C++:
108140
versions:
109141
- sdk_version: 1
@@ -133,6 +165,14 @@ iot_CreateKeysAndCertificate:
133165
- description:
134166
snippet_tags:
135167
- iot.java2.create.cert.main
168+
.NET:
169+
versions:
170+
- sdk_version: 4
171+
github: dotnetv4/IoT
172+
excerpts:
173+
- description:
174+
snippet_tags:
175+
- iot.dotnetv4.CreateKeysAndCertificate
136176
C++:
137177
versions:
138178
- sdk_version: 1
@@ -162,6 +202,14 @@ iot_DeleteCertificate:
162202
- description:
163203
snippet_tags:
164204
- iot.java2.delete.cert.main
205+
.NET:
206+
versions:
207+
- sdk_version: 4
208+
github: dotnetv4/IoT
209+
excerpts:
210+
- description:
211+
snippet_tags:
212+
- iot.dotnetv4.DeleteCertificate
165213
C++:
166214
versions:
167215
- sdk_version: 1
@@ -191,6 +239,14 @@ iot_SearchIndex:
191239
- description:
192240
snippet_tags:
193241
- iot.java2.search.thing.main
242+
.NET:
243+
versions:
244+
- sdk_version: 4
245+
github: dotnetv4/IoT
246+
excerpts:
247+
- description:
248+
snippet_tags:
249+
- iot.dotnetv4.SearchIndex
194250
C++:
195251
versions:
196252
- sdk_version: 1
@@ -232,6 +288,14 @@ iot_DeleteThing:
232288
- description:
233289
snippet_tags:
234290
- iot.java2.delete.thing.main
291+
.NET:
292+
versions:
293+
- sdk_version: 4
294+
github: dotnetv4/IoT
295+
excerpts:
296+
- description:
297+
snippet_tags:
298+
- iot.dotnetv4.DeleteThing
235299
C++:
236300
versions:
237301
- sdk_version: 1
@@ -290,6 +354,14 @@ iot_AttachThingPrincipal:
290354
- description:
291355
snippet_tags:
292356
- iot.java2.attach.thing.main
357+
.NET:
358+
versions:
359+
- sdk_version: 4
360+
github: dotnetv4/IoT
361+
excerpts:
362+
- description:
363+
snippet_tags:
364+
- iot.dotnetv4.AttachThingPrincipal
293365
C++:
294366
versions:
295367
- sdk_version: 1
@@ -319,6 +391,14 @@ iot_DetachThingPrincipal:
319391
- description:
320392
snippet_tags:
321393
- iot.java2.detach.thing.main
394+
.NET:
395+
versions:
396+
- sdk_version: 4
397+
github: dotnetv4/IoT
398+
excerpts:
399+
- description:
400+
snippet_tags:
401+
- iot.dotnetv4.DetachThingPrincipal
322402
C++:
323403
versions:
324404
- sdk_version: 1
@@ -348,6 +428,14 @@ iot_UpdateThing:
348428
- description:
349429
snippet_tags:
350430
- iot.java2.update.shadow.thing.main
431+
.NET:
432+
versions:
433+
- sdk_version: 4
434+
github: dotnetv4/IoT
435+
excerpts:
436+
- description:
437+
snippet_tags:
438+
- iot.dotnetv4.UpdateThing
351439
C++:
352440
versions:
353441
- sdk_version: 1
@@ -377,6 +465,14 @@ iot_CreateTopicRule:
377465
- description:
378466
snippet_tags:
379467
- iot.java2.create.rule.main
468+
.NET:
469+
versions:
470+
- sdk_version: 4
471+
github: dotnetv4/IoT
472+
excerpts:
473+
- description:
474+
snippet_tags:
475+
- iot.dotnetv4.CreateTopicRule
380476
C++:
381477
versions:
382478
- sdk_version: 1
@@ -418,6 +514,14 @@ iot_CreateThing:
418514
- description:
419515
snippet_tags:
420516
- iot.java2.create.thing.main
517+
.NET:
518+
versions:
519+
- sdk_version: 4
520+
github: dotnetv4/IoT
521+
excerpts:
522+
- description:
523+
snippet_tags:
524+
- iot.dotnetv4.CreateThing
421525
C++:
422526
versions:
423527
- sdk_version: 1
@@ -464,6 +568,17 @@ iot_Scenario:
464568
- description: A wrapper class for &IoT; SDK methods.
465569
snippet_tags:
466570
- iot.java2.scenario.actions.main
571+
.NET:
572+
versions:
573+
- sdk_version: 4
574+
github: dotnetv4/IoT
575+
excerpts:
576+
- description: Run an interactive scenario demonstrating &IoT; features.
577+
snippet_tags:
578+
- iot.dotnetv4.IoTScenario
579+
- description: A wrapper class for &IoT; SDK methods.
580+
snippet_tags:
581+
- iot.dotnetv4.IoTWrapper
467582
C++:
468583
versions:
469584
- sdk_version: 1

‎dotnetv4/IoT/README.md‎

Lines changed: 131 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
# Amazon IoT code examples for the SDK for .NET (v4)
2+
3+
## Overview
4+
5+
Shows how to use the AWS SDK for .NET (v4) to work with AWS IoT Core.
6+
7+
<!--custom.overview.start-->
8+
<!--custom.overview.end-->
9+
10+
_AWS IoT Core is a managed cloud service that lets connected devices easily and securely interact with cloud applications and other devices._
11+
12+
## ⚠ Important
13+
14+
* Running this code might result in charges to your AWS account. For more details, see [AWS Pricing](https://aws.amazon.com/pricing/) and [Free Tier](https://aws.amazon.com/free/).
15+
* Running the tests might result in charges to your AWS account.
16+
* We recommend that you grant your code least privilege. At most, grant only the minimum permissions required to perform the task. For more information, see [Grant least privilege](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege).
17+
* This code is not tested in every AWS Region. For more information, see [AWS Regional Services](https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services).
18+
19+
<!--custom.important.start-->
20+
<!--custom.important.end-->
21+
22+
## Code examples
23+
24+
### Prerequisites
25+
26+
For prerequisites, see the [README](../README.md#Prerequisites) in the `dotnetv4` folder.
27+
28+
29+
<!--custom.prerequisites.start-->
30+
<!--custom.prerequisites.end-->
31+
32+
### Get started
33+
34+
- [Hello AWS IoT](Actions/HelloIoT.cs#L20) (`ListThings`)
35+
36+
37+
### Basics
38+
39+
Code examples that show you how to perform the essential operations within a service.
40+
41+
- [Learn the basics](Scenarios/IoTBasics.cs)
42+
43+
44+
### Single actions
45+
46+
Code excerpts that show you how to call individual service functions.
47+
48+
- [AttachThingPrincipal](Actions/IoTWrapper.cs#L156)
49+
- [CreateKeysAndCertificate](Actions/IoTWrapper.cs#L84)
50+
- [CreateThing](Actions/IoTWrapper.cs#L34)
51+
- [CreateTopicRule](Actions/IoTWrapper.cs#L336)
52+
- [DeleteCertificate](Actions/IoTWrapper.cs#L556)
53+
- [DeleteThing](Actions/IoTWrapper.cs#L589)
54+
- [DescribeEndpoint](Actions/IoTWrapper.cs#L213)
55+
- [DetachThingPrincipal](Actions/IoTWrapper.cs#L526)
56+
- [GetThingShadow](Actions/IoTWrapper.cs#L312)
57+
- [ListCertificates](Actions/IoTWrapper.cs#L243)
58+
- [ListThings](Actions/IoTWrapper.cs#L614)
59+
- [ListTopicRules](Actions/IoTWrapper.cs#L373)
60+
- [SearchIndex](Actions/IoTWrapper.cs#L402)
61+
- [UpdateThing](Actions/IoTWrapper.cs#L119)
62+
- [UpdateThingShadow](Actions/IoTWrapper.cs#L280)
63+
64+
65+
<!--custom.examples.start-->
66+
<!--custom.examples.end-->
67+
68+
## Run the examples
69+
70+
### Instructions
71+
72+
73+
<!--custom.instructions.start-->
74+
<!--custom.instructions.end-->
75+
76+
#### Hello AWS IoT
77+
78+
This example shows you how to get started using AWS IoT Core.
79+
80+
81+
#### Learn the basics
82+
83+
This example shows you how to do the following:
84+
85+
- Create an AWS IoT Thing.
86+
- Generate a device certificate.
87+
- Update an AWS IoT Thing with Attributes.
88+
- Return a unique endpoint specific to the Amazon Web Services account.
89+
- List your AWS IoT certificates.
90+
- Create an AWS IoT shadow that refers to a digital representation or virtual twin of a physical IoT device.
91+
- Write out the state information, in JSON format.
92+
- Creates a rule that is an administrator-level action.
93+
- List your rules.
94+
- Search things using the Thing name.
95+
- Clean up resources.
96+
97+
<!--custom.basic_prereqs.iot_Scenario.start-->
98+
<!--custom.basic_prereqs.iot_Scenario.end-->
99+
100+
101+
<!--custom.basics.iot_Scenario.start-->
102+
<!--custom.basics.iot_Scenario.end-->
103+
104+
105+
### Tests
106+
107+
⚠ Running tests might result in charges to your AWS account.
108+
109+
110+
To find instructions for running these tests, see the [README](../README.md#Tests)
111+
in the `dotnetv4` folder.
112+
113+
114+
115+
<!--custom.tests.start-->
116+
<!--custom.tests.end-->
117+
118+
## Additional resources
119+
120+
- [AWS IoT Core Developer Guide](https://docs.aws.amazon.com/iot/latest/developerguide/what-is-aws-iot.html)
121+
- [AWS IoT Core API Reference](https://docs.aws.amazon.com/iot/latest/apireference/Welcome.html)
122+
- [SDK for .NET (v4) AWS IoT reference](https://docs.aws.amazon.com/sdkfornet/v4/apidocs/items/IoT/NIoT.html)
123+
124+
<!--custom.resources.start-->
125+
<!--custom.resources.end-->
126+
127+
---
128+
129+
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
130+
131+
SPDX-License-Identifier: Apache-2.0

0 commit comments

Comments
 (0)