Skip to content

Commit c32ed3c

Browse files
scmacdonscmacdon
authored
Basic scenario metadata update (#7200)
* updated the Sitewise YAML * updated the Sitewise YAML * updated the IoT YAML * updated the IoT YAML * updated the Redshift YAML * updated the SSM YAML * updated the SSM YAML * updated the SSM YAML * updated the SSM YAML * updated the SSM YAML * updated the SSM YAML * updated the Batch YAML * updated SSM Readme * updated Batch \Readme * updated Iot YAML * updated Readme * updated Readmes * updated Sitewise Readme
1 parent c886f9d commit c32ed3c

File tree

18 files changed

+182
-48
lines changed

18 files changed

+182
-48
lines changed

Diff for: ‎.doc_gen/metadata/batch_metadata.yaml

+1-3
Original file line numberDiff line numberDiff line change
@@ -174,8 +174,6 @@ batch_CreateComputeEnvironment:
174174
services:
175175
batch: {CreateComputeEnvironment}
176176
batch_Scenario:
177-
title: Learn core operations for'&BATCHlong; using an &AWS; SDK
178-
title_abbrev: Learn &BATCH; core operations
179177
synopsis_list:
180178
- Create an &BATCH; compute environment.
181179
- Check the status of the compute environment.
@@ -185,7 +183,7 @@ batch_Scenario:
185183
- Get a list of jobs applicable to the job queue.
186184
- Check the status of job.
187185
- Delete &BATCH; resources.
188-
category: Scenarios
186+
category: Basics
189187
languages:
190188
Java:
191189
versions:

Diff for: ‎.doc_gen/metadata/iot_metadata.yaml

+12-1
Original file line numberDiff line numberDiff line change
@@ -429,7 +429,18 @@ iot_CreateThing:
429429
services:
430430
iot: {CreateThing}
431431
iot_Scenario:
432-
synopsis: work with &IoT; device management.
432+
synopsis_list:
433+
- Create an &IoT; Thing.
434+
- Generate a device certificate.
435+
- Update an &IoT; Thing with Attributes.
436+
- Return a unique endpoint.
437+
- List your &IoT; certificates.
438+
- Create an &IoT; shadow.
439+
- Write out state information.
440+
- Creates a rule.
441+
- List your rules.
442+
- Search things using the Thing name.
443+
- Delete an &IoT; Thing.
433444
category: Basics
434445
languages:
435446
Kotlin:

Diff for: ‎.doc_gen/metadata/iot_sitewise_metadata.yaml

+10-1
Original file line numberDiff line numberDiff line change
@@ -444,7 +444,16 @@ iotsitewise_CreateAssetModel:
444444
services:
445445
iotsitewise: {CreateAssetModel}
446446
iotsitewise_Scenario:
447-
synopsis: learn core operations for &ITSWlong; using an &AWS; SDK.
447+
synopsis_list:
448+
- Create an &ITSWlong; Asset Model.
449+
- Create an &ITSWlong; Asset.
450+
- Retrieve the property ID values.
451+
- Send data to an &ITSWlong; Asset.
452+
- Retrieve the value of the &ITSWlong; Asset property.
453+
- Create an &ITSWlong; Portal.
454+
- Create an &ITSWlong; Gateway.
455+
- Describe the &ITSWlong; Gateway.
456+
- Delete the &ITSWlong; Assets.
448457
category: Basics
449458
languages:
450459
Java:

Diff for: ‎.doc_gen/metadata/redshift_metadata.yaml

+8-1
Original file line numberDiff line numberDiff line change
@@ -346,7 +346,14 @@ redshift_ExecuteStatement:
346346
services:
347347
redshift: {ExecuteStatement}
348348
redshift_Scenario:
349-
synopsis: learn core operations for &RS; using an &AWS; SDK.
349+
synopsis_list:
350+
- Create a Redshift cluster.
351+
- List databases in the cluster.
352+
- Create a table named Movies.
353+
- Populate the Movies table.
354+
- Query the Movies table by year.
355+
- Modify the Redshift cluster.
356+
- Delete the Amazon Redshift cluster.
350357
category: Basics
351358
languages:
352359
Go:

Diff for: ‎.doc_gen/metadata/ssm_metadata.yaml

+8-1
Original file line numberDiff line numberDiff line change
@@ -412,7 +412,14 @@ ssm_UpdateOpsItem:
412412
services:
413413
ssm: {UpdateOpsItem}
414414
ssm_Scenario:
415-
synopsis: work with &SYS; maintenance windows, documents, and OpsItems.
415+
synopsis_list:
416+
- Create a maintenance window.
417+
- Modify the maintenance window schedule.
418+
- Create a document.
419+
- Send a command to a specified EC2 instance.
420+
- Create an OpsItem.
421+
- Update and resolve the OpsItem.
422+
- Delete the maintenance window, OpsItem, and document.
416423
category: Basics
417424
languages:
418425
Java:

Diff for: ‎cpp/example_code/iot/README.md

+14-3
Original file line numberDiff line numberDiff line change
@@ -99,8 +99,19 @@ This example shows you how to get started using AWS IoT.
9999

100100
#### Learn the basics
101101

102-
This example shows you how to work with AWS IoT device management.
103-
102+
This example shows you how to do the following:
103+
104+
- Create an AWS IoT Thing.
105+
- Generate a device certificate.
106+
- Update an AWS IoT Thing with Attributes.
107+
- Return a unique endpoint.
108+
- List your AWS IoT certificates.
109+
- Create an AWS IoT shadow.
110+
- Write out state information.
111+
- Creates a rule.
112+
- List your rules.
113+
- Search things using the Thing name.
114+
- Delete an AWS IoT Thing.
104115

105116
<!--custom.basic_prereqs.iot_Scenario.start-->
106117
<!--custom.basic_prereqs.iot_Scenario.end-->
@@ -140,4 +151,4 @@ This example shows you how to work with AWS IoT device management.
140151

141152
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
142153

143-
SPDX-License-Identifier: Apache-2.0
154+
SPDX-License-Identifier: Apache-2.0

Diff for: ‎gov2/redshift/README.md

+9-2
Original file line numberDiff line numberDiff line change
@@ -80,8 +80,15 @@ go run ./cmd -h
8080
```
8181
#### Learn the basics
8282

83-
This example shows you how to learn core operations for Amazon Redshift using an AWS SDK.
83+
This example shows you how to do the following:
8484

85+
- Create a Redshift cluster.
86+
- List databases in the cluster.
87+
- Create a table named Movies.
88+
- Populate the Movies table.
89+
- Query the Movies table by year.
90+
- Modify the Redshift cluster.
91+
- Delete the Amazon Redshift cluster.
8592

8693
<!--custom.basic_prereqs.redshift_Scenario.start-->
8794
<!--custom.basic_prereqs.redshift_Scenario.end-->
@@ -117,4 +124,4 @@ in the `gov2` folder.
117124

118125
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
119126

120-
SPDX-License-Identifier: Apache-2.0
127+
SPDX-License-Identifier: Apache-2.0

Diff for: ‎javascriptv3/example_code/iotsitewise/README.md

+11-2
Original file line numberDiff line numberDiff line change
@@ -107,8 +107,17 @@ node ./hello.js
107107

108108
#### Learn the basics
109109

110-
This example shows you how to learn core operations for AWS IoT SiteWise using an AWS SDK.
111-
110+
This example shows you how to do the following:
111+
112+
- Create an AWS IoT SiteWise Asset Model.
113+
- Create an AWS IoT SiteWise Asset.
114+
- Retrieve the property ID values.
115+
- Send data to an AWS IoT SiteWise Asset.
116+
- Retrieve the value of the AWS IoT SiteWise Asset property.
117+
- Create an AWS IoT SiteWise Portal.
118+
- Create an AWS IoT SiteWise Gateway.
119+
- Describe the AWS IoT SiteWise Gateway.
120+
- Delete the AWS IoT SiteWise Assets.
112121

113122
<!--custom.basic_prereqs.iotsitewise_Scenario.start-->
114123
<!--custom.basic_prereqs.iotsitewise_Scenario.end-->

Diff for: ‎javascriptv3/example_code/ssm/README.md

+9-2
Original file line numberDiff line numberDiff line change
@@ -103,8 +103,15 @@ node ./hello.js
103103

104104
#### Learn the basics
105105

106-
This example shows you how to work with Systems Manager maintenance windows, documents, and OpsItems.
106+
This example shows you how to do the following:
107107

108+
- Create a maintenance window.
109+
- Modify the maintenance window schedule.
110+
- Create a document.
111+
- Send a command to a specified EC2 instance.
112+
- Create an OpsItem.
113+
- Update and resolve the OpsItem.
114+
- Delete the maintenance window, OpsItem, and document.
108115

109116
<!--custom.basic_prereqs.ssm_Scenario.start-->
110117
<!--custom.basic_prereqs.ssm_Scenario.end-->
@@ -140,4 +147,4 @@ in the `javascriptv3` folder.
140147

141148
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
142149

143-
SPDX-License-Identifier: Apache-2.0
150+
SPDX-License-Identifier: Apache-2.0

Diff for: ‎javav2/example_code/batch/README.md

+14-14
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,13 @@ For prerequisites, see the [README](../../README.md#Prerequisites) in the `javav
3434
- [Hello AWS Batch](src/main/java/com/example/batch/HelloBatch.java#L6) (`listJobsPaginator`)
3535

3636

37+
### Basics
38+
39+
Code examples that show you how to perform the essential operations within a service.
40+
41+
- [Learn the basics](src/main/java/com/example/batch/scenario/BatchScenario.java)
42+
43+
3744
### Single actions
3845

3946
Code excerpts that show you how to call individual service functions.
@@ -52,13 +59,6 @@ Code excerpts that show you how to call individual service functions.
5259
- [UpdateComputeEnvironment](src/main/java/com/example/batch/scenario/BatchActions.java#L439)
5360
- [UpdateJobQueue](src/main/java/com/example/batch/scenario/BatchActions.java#L347)
5461

55-
### Scenarios
56-
57-
Code examples that show you how to accomplish a specific task by calling multiple
58-
functions within the same service.
59-
60-
- [Learn AWS Batch core operations](src/main/java/com/example/batch/scenario/BatchScenario.java)
61-
6262

6363
<!--custom.examples.start-->
6464
<!--custom.examples.end-->
@@ -76,8 +76,7 @@ functions within the same service.
7676
This example shows you how to get started using AWS Batch.
7777

7878

79-
80-
#### Learn AWS Batch core operations
79+
#### Learn the basics
8180

8281
This example shows you how to do the following:
8382

@@ -90,12 +89,13 @@ This example shows you how to do the following:
9089
- Check the status of job.
9190
- Delete AWS Batch resources.
9291

93-
<!--custom.scenario_prereqs.batch_Scenario.start-->
94-
<!--custom.scenario_prereqs.batch_Scenario.end-->
92+
<!--custom.basic_prereqs.batch_Scenario.start-->
93+
<!--custom.basic_prereqs.batch_Scenario.end-->
94+
9595

96+
<!--custom.basics.batch_Scenario.start-->
97+
<!--custom.basics.batch_Scenario.end-->
9698

97-
<!--custom.scenarios.batch_Scenario.start-->
98-
<!--custom.scenarios.batch_Scenario.end-->
9999

100100
### Tests
101101

@@ -123,4 +123,4 @@ in the `javav2` folder.
123123

124124
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
125125

126-
SPDX-License-Identifier: Apache-2.0
126+
SPDX-License-Identifier: Apache-2.0

Diff for: ‎javav2/example_code/iot/README.md

+14-3
Original file line numberDiff line numberDiff line change
@@ -77,8 +77,19 @@ This example shows you how to get started using AWS IoT.
7777

7878
#### Learn the basics
7979

80-
This example shows you how to work with AWS IoT device management.
81-
80+
This example shows you how to do the following:
81+
82+
- Create an AWS IoT Thing.
83+
- Generate a device certificate.
84+
- Update an AWS IoT Thing with Attributes.
85+
- Return a unique endpoint.
86+
- List your AWS IoT certificates.
87+
- Create an AWS IoT shadow.
88+
- Write out state information.
89+
- Creates a rule.
90+
- List your rules.
91+
- Search things using the Thing name.
92+
- Delete an AWS IoT Thing.
8293

8394
<!--custom.basic_prereqs.iot_Scenario.start-->
8495
<!--custom.basic_prereqs.iot_Scenario.end-->
@@ -114,4 +125,4 @@ in the `javav2` folder.
114125

115126
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
116127

117-
SPDX-License-Identifier: Apache-2.0
128+
SPDX-License-Identifier: Apache-2.0

Diff for: ‎javav2/example_code/iotsitewise/README.md

+11-2
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,17 @@ This example shows you how to get started using AWS IoT SiteWise.
7979

8080
#### Learn the basics
8181

82-
This example shows you how to learn core operations for AWS IoT SiteWise using an AWS SDK.
83-
82+
This example shows you how to do the following:
83+
84+
- Create an AWS IoT SiteWise Asset Model.
85+
- Create an AWS IoT SiteWise Asset.
86+
- Retrieve the property ID values.
87+
- Send data to an AWS IoT SiteWise Asset.
88+
- Retrieve the value of the AWS IoT SiteWise Asset property.
89+
- Create an AWS IoT SiteWise Portal.
90+
- Create an AWS IoT SiteWise Gateway.
91+
- Describe the AWS IoT SiteWise Gateway.
92+
- Delete the AWS IoT SiteWise Assets.
8493

8594
<!--custom.basic_prereqs.iotsitewise_Scenario.start-->
8695
<!--custom.basic_prereqs.iotsitewise_Scenario.end-->

Diff for: ‎javav2/example_code/redshift/README.md

+9-2
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,15 @@ This example shows you how to get started using Amazon Redshift.
7373

7474
#### Learn the basics
7575

76-
This example shows you how to learn core operations for Amazon Redshift using an AWS SDK.
76+
This example shows you how to do the following:
7777

78+
- Create a Redshift cluster.
79+
- List databases in the cluster.
80+
- Create a table named Movies.
81+
- Populate the Movies table.
82+
- Query the Movies table by year.
83+
- Modify the Redshift cluster.
84+
- Delete the Amazon Redshift cluster.
7885

7986
<!--custom.basic_prereqs.redshift_Scenario.start-->
8087
<!--custom.basic_prereqs.redshift_Scenario.end-->
@@ -110,4 +117,4 @@ in the `javav2` folder.
110117

111118
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
112119

113-
SPDX-License-Identifier: Apache-2.0
120+
SPDX-License-Identifier: Apache-2.0

Diff for: ‎javav2/example_code/ssm/README.md

+9-2
Original file line numberDiff line numberDiff line change
@@ -89,8 +89,15 @@ This example shows you how to get started using Systems Manager.
8989

9090
#### Learn the basics
9191

92-
This example shows you how to work with Systems Manager maintenance windows, documents, and OpsItems.
92+
This example shows you how to do the following:
9393

94+
- Create a maintenance window.
95+
- Modify the maintenance window schedule.
96+
- Create a document.
97+
- Send a command to a specified EC2 instance.
98+
- Create an OpsItem.
99+
- Update and resolve the OpsItem.
100+
- Delete the maintenance window, OpsItem, and document.
94101

95102
<!--custom.basic_prereqs.ssm_Scenario.start-->
96103
<!--custom.basic_prereqs.ssm_Scenario.end-->
@@ -126,4 +133,4 @@ in the `javav2` folder.
126133

127134
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
128135

129-
SPDX-License-Identifier: Apache-2.0
136+
SPDX-License-Identifier: Apache-2.0

Diff for: ‎kotlin/services/iot/README.md

+14-3
Original file line numberDiff line numberDiff line change
@@ -77,8 +77,19 @@ This example shows you how to get started using AWS IoT.
7777

7878
#### Learn the basics
7979

80-
This example shows you how to work with AWS IoT device management.
81-
80+
This example shows you how to do the following:
81+
82+
- Create an AWS IoT Thing.
83+
- Generate a device certificate.
84+
- Update an AWS IoT Thing with Attributes.
85+
- Return a unique endpoint.
86+
- List your AWS IoT certificates.
87+
- Create an AWS IoT shadow.
88+
- Write out state information.
89+
- Creates a rule.
90+
- List your rules.
91+
- Search things using the Thing name.
92+
- Delete an AWS IoT Thing.
8293

8394
<!--custom.basic_prereqs.iot_Scenario.start-->
8495
<!--custom.basic_prereqs.iot_Scenario.end-->
@@ -114,4 +125,4 @@ in the `kotlin` folder.
114125

115126
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
116127

117-
SPDX-License-Identifier: Apache-2.0
128+
SPDX-License-Identifier: Apache-2.0

Diff for: ‎python/example_code/iotsitewise/README.md

+11-2
Original file line numberDiff line numberDiff line change
@@ -86,8 +86,17 @@ python hello/hello_iot_sitewise.py
8686

8787
#### Learn the basics
8888

89-
This example shows you how to learn core operations for AWS IoT SiteWise using an AWS SDK.
90-
89+
This example shows you how to do the following:
90+
91+
- Create an AWS IoT SiteWise Asset Model.
92+
- Create an AWS IoT SiteWise Asset.
93+
- Retrieve the property ID values.
94+
- Send data to an AWS IoT SiteWise Asset.
95+
- Retrieve the value of the AWS IoT SiteWise Asset property.
96+
- Create an AWS IoT SiteWise Portal.
97+
- Create an AWS IoT SiteWise Gateway.
98+
- Describe the AWS IoT SiteWise Gateway.
99+
- Delete the AWS IoT SiteWise Assets.
91100

92101
<!--custom.basic_prereqs.iotsitewise_Scenario.start-->
93102
<!--custom.basic_prereqs.iotsitewise_Scenario.end-->

0 commit comments

Comments
 (0)