Skip to content

Commit e575ff9

Browse files
authored
SOS: Recategorize examples REQUIRES TANDEM INTERNAL MERGE (#6754)
* Recategorize Scenarios as Basics where appropriate. * Remove titles from Basics examples. * Refactor SOS templates for recategorization. * Add basics to WRITEME code and templates. * Run WRITEME for recategorization. * Update validate-doc-metadata to tagged release.
1 parent 4d9be85 commit e575ff9

File tree

149 files changed

+2539
-1613
lines changed

Some content is hidden

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

149 files changed

+2539
-1613
lines changed

Diff for: .doc_gen/metadata/acm_metadata.yaml

+1-3
Original file line numberDiff line numberDiff line change
@@ -264,14 +264,12 @@ acm_UpdateCertificateOptions:
264264
services:
265265
acm: {UpdateCertificateOptions}
266266
acm_Usage_ImportListRemove:
267-
title: Manage &ACM; certificates using an &AWS; SDK
268-
title_abbrev: Manage certificates
269267
synopsis_list:
270268
- Request a certificate from &ACM;.
271269
- Import a self-signed certificate.
272270
- List and describe certificates.
273271
- Remove certificates.
274-
category: Scenarios
272+
category: Basics
275273
languages:
276274
Python:
277275
versions:

Diff for: .doc_gen/metadata/aurora_metadata.yaml

+1-3
Original file line numberDiff line numberDiff line change
@@ -1093,14 +1093,12 @@ aurora_DeleteDBInstance:
10931093
services:
10941094
aurora: {DeleteDBInstance}
10951095
aurora_Scenario_GetStartedClusters:
1096-
title: Get started with &AUR; DB clusters using an &AWS; SDK
1097-
title_abbrev: Get started with DB clusters
10981096
synopsis_list:
10991097
- Create a custom &AUR; DB cluster parameter group and set parameter values.
11001098
- Create a DB cluster that uses the parameter group.
11011099
- Create a DB instance that contains a database.
11021100
- Take a snapshot of the DB cluster, then clean up resources.
1103-
category: Scenarios
1101+
category: Basics
11041102
languages:
11051103
.NET:
11061104
versions:

Diff for: .doc_gen/metadata/auto-scaling_metadata.yaml

+1-3
Original file line numberDiff line numberDiff line change
@@ -756,16 +756,14 @@ auto-scaling_AttachLoadBalancerTargetGroups:
756756
services:
757757
auto-scaling: {AttachLoadBalancerTargetGroups}
758758
auto-scaling_Scenario_GroupsAndInstances:
759-
title: Manage &AS; groups and instances using an &AWS; SDK
760-
title_abbrev: Manage groups and instances
761759
synopsis_list:
762760
- Create an &ASlong; group with a launch template and Availability Zones, and get information about running instances.
763761
- Enable &CWlong; metrics collection.
764762
- Update the group's desired capacity and wait for an instance to start.
765763
- Terminate an instance in the group.
766764
- List scaling activities that occur in response to user requests and capacity changes.
767765
- Get statistics for &CW; metrics, then clean up resources.
768-
category: Scenarios
766+
category: Basics
769767
languages:
770768
.NET:
771769
versions:

Diff for: .doc_gen/metadata/cloudwatch_metadata.yaml

+1-3
Original file line numberDiff line numberDiff line change
@@ -1026,8 +1026,6 @@ cloudwatch_PutMetricData:
10261026
services:
10271027
cloudwatch: {PutMetricData}
10281028
cloudwatch_GetStartedMetricsDashboardsAlarms:
1029-
title: Get started with &CW; metrics, dashboards, and alarms using an &AWS; SDK
1030-
title_abbrev: Get started with metrics, dashboards, and alarms
10311029
synopsis_list:
10321030
- List &CW; namespaces and metrics.
10331031
- Get statistics for a metric and for estimated billing.
@@ -1036,7 +1034,7 @@ cloudwatch_GetStartedMetricsDashboardsAlarms:
10361034
- Create and trigger an alarm, then view alarm history.
10371035
- Add an anomaly detector.
10381036
- Get a metric image, then clean up resources.
1039-
category: Scenarios
1037+
category: Basics
10401038
languages:
10411039
Kotlin:
10421040
versions:

Diff for: .doc_gen/metadata/cross_metadata.yaml

+30-4
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ cross_MessageProcessingFrameworkTutorial:
33
title: Use the &AWS; Message Processing Framework for .NET to publish and receive &SQS; messages
44
title_abbrev: Use the &AWS; Message Processing Framework for .NET with &SQS;
55
synopsis: create applications that publish and receive &SQS; messages using the &AWS; Message Processing Framework for .NET.
6-
category: Cross-service examples
6+
category: Scenarios
77
languages:
88
.NET:
99
versions:
@@ -18,6 +18,7 @@ cross_FSA:
1818
title_abbrev: Create an application to analyze customer feedback
1919
synopsis: create an application that analyzes customer comment cards, translates them from their original language, determines
2020
their sentiment, and generates an audio file from the translated text.
21+
category: Scenarios
2122
languages:
2223
.NET:
2324
versions:
@@ -47,6 +48,7 @@ cross_PAM:
4748
title: Create a photo asset management application that lets users manage photos using labels
4849
title_abbrev: Create a serverless application to manage photos
4950
synopsis: create a serverless application that lets users manage photos using labels.
51+
category: Scenarios
5052
languages:
5153
Java:
5254
versions:
@@ -91,6 +93,7 @@ cross_RedshiftDataTracker:
9193
title: Create an &RSlong; item tracker
9294
title_abbrev: Create a web application to track &RS; data
9395
synopsis: create a web application that tracks and reports on work items using an &RSlong; database.
96+
category: Scenarios
9497
languages:
9598
Java:
9699
versions:
@@ -108,6 +111,7 @@ cross_SQSMessageApp:
108111
title: Create a web application that sends and retrieves messages by using &SQS;
109112
title_abbrev: Create a messaging application
110113
synopsis: create a messaging application by using &SQS;.
114+
category: Scenarios
111115
languages:
112116
Kotlin:
113117
versions:
@@ -126,6 +130,7 @@ cross_RDSDataTracker:
126130
title_abbrev: Create an &AUR; Serverless work item tracker
127131
synopsis: create a web application that tracks work items in an &AURlong; Serverless database and uses &SESlong; (&SES;)
128132
to send reports.
133+
category: Scenarios
129134
languages:
130135
.NET:
131136
versions:
@@ -168,6 +173,7 @@ cross_SnsPublishSubscription:
168173
title: Build a publish and subscription application that translates messages
169174
title_abbrev: Building an &SNS; application
170175
synopsis: create an application that has subscription and publish functionality and translates messages.
176+
category: Scenarios
171177
languages:
172178
Kotlin:
173179
versions:
@@ -190,6 +196,7 @@ cross_LexChatbotLanguages:
190196
title: Create an &LEX2; chatbot to engage your website visitors
191197
title_abbrev: Building an &LEX2; chatbot
192198
synopsis: create a chatbot to engage your website visitors.
199+
category: Scenarios
193200
languages:
194201
Java:
195202
versions:
@@ -208,6 +215,7 @@ cross_DynamoDBDataTracker:
208215
title: Create a web application to track &DDB; data
209216
title_abbrev: Create a web application to track &DDB; data
210217
synopsis: create a web application that tracks work items in an &DDBlong; table and uses &SESlong; (&SES;) to send reports.
218+
category: Scenarios
211219
languages:
212220
Java:
213221
versions:
@@ -240,6 +248,7 @@ cross_ApiGatewayDataTracker:
240248
title_abbrev: Create a REST API to track COVID-19 data
241249
synopsis: create a REST API that simulates a system to track daily cases of COVID-19 in the United States, using fictional
242250
data.
251+
category: Scenarios
243252
languages:
244253
Python:
245254
versions:
@@ -256,6 +265,7 @@ cross_ApiGatewayWebsocketChat:
256265
title: Create a websocket chat application with &ABP;
257266
title_abbrev: Create a websocket chat application
258267
synopsis: create a chat application that is served by a websocket API built on &ABPlong;.
268+
category: Scenarios
259269
languages:
260270
Python:
261271
versions:
@@ -272,6 +282,7 @@ cross_AuroraRestLendingLibrary:
272282
title_abbrev: Create a lending library REST API
273283
synopsis: create a lending library where patrons can borrow and return books by using a REST API backed by an &AURlong;
274284
database.
285+
category: Scenarios
275286
languages:
276287
Python:
277288
versions:
@@ -288,6 +299,7 @@ cross_StepFunctionsMessenger:
288299
title: Create a messenger application with &SFN;
289300
title_abbrev: Create a messenger application
290301
synopsis: create an &SFNlong; messenger application that retrieves message records from a database table.
302+
category: Scenarios
291303
languages:
292304
Python:
293305
versions:
@@ -304,6 +316,7 @@ cross_TextractExplorer:
304316
title: Create an &TEXTRACT; explorer application
305317
title_abbrev: Create an &TEXTRACT; explorer application
306318
synopsis: explore &TEXTRACTlong; output through an interactive application.
319+
category: Scenarios
307320
languages:
308321
JavaScript:
309322
versions:
@@ -326,7 +339,7 @@ cross_TextractComprehendDetectEntities:
326339
title: Detect entities in text extracted from an image using an &AWS; SDK
327340
title_abbrev: Detect entities in text extracted from an image
328341
synopsis: use &CMP; to detect entities in text extracted by &TEXTRACT; from an image that is stored in &S3;.
329-
category:
342+
category: Scenarios
330343
languages:
331344
Python:
332345
versions:
@@ -342,6 +355,7 @@ cross_SubmitDataApp:
342355
title: Build an application to submit data to a &DDB; table
343356
title_abbrev: Build an app to submit data to a &DDB; table
344357
synopsis: build an application that submits data to an &DDBlong; table and notifies you when a user updates the table.
358+
category: Scenarios
345359
languages:
346360
Kotlin:
347361
versions:
@@ -363,6 +377,7 @@ cross_LambdaAPIGateway:
363377
title: Use &ABP; to invoke a &LAM; function
364378
title_abbrev: Use &ABP; to invoke a &LAM; function
365379
synopsis: create an &LAMlong; function invoked by &ABPlong;.
380+
category: Scenarios
366381
languages:
367382
Java:
368383
versions:
@@ -391,6 +406,7 @@ cross_LambdaScheduledEvents:
391406
title: Use scheduled events to invoke a &LAM; function
392407
title_abbrev: Use scheduled events to invoke a &LAM; function
393408
synopsis: create an &LAMlong; function invoked by an &EVlong; scheduled event.
409+
category: Scenarios
394410
languages:
395411
Java:
396412
versions:
@@ -421,6 +437,7 @@ cross_ServerlessWorkflows:
421437
title: Use &SFN; to invoke &LAM; functions
422438
title_abbrev: Use &SFN; to invoke &LAM; functions
423439
synopsis: create an &SFNlong; state machine that invokes &LAMlong; functions in sequence.
440+
category: Scenarios
424441
languages:
425442
Java:
426443
versions:
@@ -441,6 +458,7 @@ cross_TranscriptionApp:
441458
title: Build an &TSC; app
442459
title_abbrev: Build an &TSC; app
443460
synopsis: use &TSClong; to transcribe and display voice recordings in the browser.
461+
category: Scenarios
444462
languages:
445463
JavaScript:
446464
versions:
@@ -455,6 +473,7 @@ cross_TranscriptionStreamingApp:
455473
title: Build an &TSC; streaming app
456474
title_abbrev: Build an &TSC; streaming app
457475
synopsis: build an app that records, transcribes, and translates live audio in real-time, and emails the results.
476+
category: Scenarios
458477
languages:
459478
JavaScript:
460479
versions:
@@ -470,6 +489,7 @@ cross_RekognitionPhotoAnalyzerPPE:
470489
title: Detect PPE in images with &REK; using an &AWS; SDK
471490
title_abbrev: Detect PPE in images
472491
synopsis: build an app that uses &REK; to detect Personal Protective Equipment (PPE) in images.
492+
category: Scenarios
473493
languages:
474494
Java:
475495
versions:
@@ -489,6 +509,7 @@ cross_RekognitionPhotoAnalyzer:
489509
title: Detect objects in images with &REK; using an &AWS; SDK
490510
title_abbrev: Detect objects in images
491511
synopsis: build an app that uses &REK; to detect objects by category in images.
512+
category: Scenarios
492513
languages:
493514
Kotlin:
494515
versions:
@@ -521,7 +542,7 @@ cross_RekognitionVideoDetection:
521542
title: Detect people and objects in a video with &REK; using an &AWS; SDK
522543
title_abbrev: Detect people and objects in a video
523544
synopsis: detect people and objects in a video with &REK;.
524-
category: Cross-service examples
545+
category: Scenarios
525546
languages:
526547
Java:
527548
versions:
@@ -555,6 +576,7 @@ cross_DetectFaces:
555576
- Save an image in an &S3; bucket.
556577
- Use &REKlong; to detect facial details, such as age range, gender, and emotion (such as smiling).
557578
- Display those details.
579+
category: Scenarios
558580
languages:
559581
Rust:
560582
versions:
@@ -572,6 +594,7 @@ cross_DetectLabels:
572594
- Upload the image file to an &S3; bucket.
573595
- Use &REKlong; to identify the three top attributes (labels) in the file.
574596
- Add the EXIF and label information to an &DDBlong; table in the Region.
597+
category: Scenarios
575598
languages:
576599
Rust:
577600
versions:
@@ -590,6 +613,7 @@ cross_Telephone:
590613
- Upload the audio file to an &S3; bucket.
591614
- Use &TSClong; to convert the audio file to text.
592615
- Display the text.
616+
category: Scenarios
593617
languages:
594618
Rust:
595619
versions:
@@ -604,6 +628,7 @@ cross_LambdaForBrowser:
604628
title: Invoke a &LAM; function from a browser
605629
title_abbrev: Invoke a &LAM; function from a browser
606630
synopsis: invoke an &LAMlong; function from a browser.
631+
category: Scenarios
607632
languages:
608633
JavaScript:
609634
versions:
@@ -780,7 +805,7 @@ cross_ServerlessS3DataTransformation:
780805
title: Transform data for your application with S3 Object Lambda
781806
title_abbrev: Transform data with S3 Object Lambda
782807
synopsis: transform data for your application with S3 Object Lambda.
783-
category: Cross-service examples
808+
category: Scenarios
784809
languages:
785810
.NET:
786811
versions:
@@ -929,6 +954,7 @@ cross_MonitorDynamoDB:
929954
title: Monitor performance of &DDBlong; using an &AWS; SDK
930955
title_abbrev: Monitor &DDB; performance
931956
synopsis: configure an application's use of &DDB; to monitor performance.
957+
category: Scenarios
932958
languages:
933959
Java:
934960
versions:

Diff for: .doc_gen/metadata/dynamodb_metadata.yaml

+1-3
Original file line numberDiff line numberDiff line change
@@ -1804,16 +1804,14 @@ dynamodb_Usage_DaxDemo:
18041804
services:
18051805
dynamodb: {CreateTable, PutItem, GetItem, Query, Scan, DeleteTable}
18061806
dynamodb_Scenario_GettingStartedMovies:
1807-
title: Get started with &DDB; tables, items, and queries using an &AWS; SDK
1808-
title_abbrev: Get started with tables, items, and queries
18091807
synopsis_list:
18101808
- Create a table that can hold movie data.
18111809
- Put, get, and update a single movie in the table.
18121810
- Write movie data to the table from a sample JSON file.
18131811
- Query for movies that were released in a given year.
18141812
- Scan for movies that were released in a range of years.
18151813
- Delete a movie from the table, then delete the table.
1816-
category: Scenarios
1814+
category: Basics
18171815
languages:
18181816
.NET:
18191817
versions:

Diff for: .doc_gen/metadata/ec2_metadata.yaml

+1-3
Original file line numberDiff line numberDiff line change
@@ -2150,15 +2150,13 @@ ec2_DescribeSubnets:
21502150
services:
21512151
ec2: {DescribeSubnets}
21522152
ec2_Scenario_GetStartedInstances:
2153-
title: Get started with &EC2; instances using an &AWS; SDK
2154-
title_abbrev: Get started with instances
21552153
synopsis_list:
21562154
- Create a key pair and security group.
21572155
- Select an Amazon Machine Image (AMI) and compatible instance type, then create an instance.
21582156
- Stop and restart the instance.
21592157
- Associate an Elastic IP address with your instance.
21602158
- Connect to your instance with SSH, then clean up resources.
2161-
category: Scenarios
2159+
category: Basics
21622160
languages:
21632161
.NET:
21642162
versions:

Diff for: .doc_gen/metadata/ecr_metadata.yaml

+1-3
Original file line numberDiff line numberDiff line change
@@ -246,8 +246,6 @@ ecr_ListImages:
246246
services:
247247
ecr: {ListImages}
248248
ecr_Scenario_RepositoryManagement:
249-
title: Learn core operations for &ECR; using an &AWS; SDK
250-
title_abbrev: Learn &ECR; core operations
251249
synopsis_list:
252250
- Create an &ECR; repository.
253251
- Set repository policies.
@@ -258,7 +256,7 @@ ecr_Scenario_RepositoryManagement:
258256
- Verify the existence of an image in an &ECR; repository.
259257
- List &ECR; repositories for your account and get details about them.
260258
- Delete &ECR; repositories.
261-
category: Scenarios
259+
category: Basics
262260
languages:
263261
Kotlin:
264262
versions:

Diff for: .doc_gen/metadata/eventbridge_metadata.yaml

+1-3
Original file line numberDiff line numberDiff line change
@@ -478,14 +478,12 @@ eventbridge_RemoveTargets:
478478
services:
479479
eventbridge: {RemoveTargets}
480480
eventbridge_Scenario_GettingStarted:
481-
title: Get started with &EV; rules and targets using an &AWS; SDK
482-
title_abbrev: Get started with rules and targets
483481
synopsis_list:
484482
- Create a rule and add a target to it.
485483
- Enable and disable rules.
486484
- List and update rules and targets.
487485
- Send events, then clean up resources.
488-
category: Scenarios
486+
category: Basics
489487
languages:
490488
Kotlin:
491489
versions:

Diff for: .doc_gen/metadata/glue_metadata.yaml

+1-3
Original file line numberDiff line numberDiff line change
@@ -1120,15 +1120,13 @@ glue_GetJob:
11201120
services:
11211121
glue: {GetJob}
11221122
glue_Scenario_GetStartedCrawlersJobs:
1123-
title: Get started running &GLU; crawlers and jobs using an &AWS; SDK
1124-
title_abbrev: Get started with crawlers and jobs
11251123
synopsis_list:
11261124
- Create a crawler that crawls a public &S3; bucket and generates a database of CSV-formatted metadata.
11271125
- List information about databases and tables in your &GLUDCLong;.
11281126
- Create a job to extract CSV data from the S3 bucket, transform the data, and load JSON-formatted output into another
11291127
S3 bucket.
11301128
- List information about job runs, view transformed data, and clean up resources.
1131-
category: Scenarios
1129+
category: Basics
11321130
guide_topic:
11331131
title: 'Tutorial: Getting started with &GLU; Studio'
11341132
url: glue/latest/ug/tutorial-create-job.html

0 commit comments

Comments
 (0)