Skip to content

Commit 429e4a0

Browse files
authored
Meta: Metadata fixes for yamale and tools release (#7125)
* Update metadata to standard now that yamale validation is back on. * Update to official tools release tag. * Generate README for meta updates.
1 parent 054c03e commit 429e4a0

File tree

14 files changed

+69
-85
lines changed

14 files changed

+69
-85
lines changed

.doc_gen/metadata/bedrock-runtime_metadata.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1219,7 +1219,7 @@ bedrock-runtime_Scenario_ToolUseDemo_AnthropicClaude:
12191219
- description: "The weather tool used by the demo. This script defines the tool specification and implements the logic to retrieve weather data using from the Open-Meteo API."
12201220
snippet_tags:
12211221
- rust.bedrock-runtime.Converse_AnthropicClaude.tool-use.weather-tool
1222-
- description: "Utilities to print the Message Content Blocks"
1222+
- description: "Utilities to print the Message Content Blocks."
12231223
snippet_tags:
12241224
- rust.bedrock-runtime.Converse_AnthropicClaude.tool-use.user-interface
12251225
- description: "Use statements, Error utility, and constants."

.doc_gen/metadata/cross_metadata.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -826,7 +826,6 @@ cross_CognitoAutoConfirmUser:
826826
versions:
827827
- sdk_version: 3
828828
github: javascriptv3/example_code/cross-services/wkflw-pools-triggers
829-
sdk_guide:
830829
excerpts:
831830
- description: |
832831
Configure an interactive "Scenario" run. The JavaScript (v3) examples

.doc_gen/metadata/dynamodb_metadata.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -205,10 +205,10 @@ dynamodb_BatchGetItem:
205205
- sdk_version: 2
206206
github: javav2/example_code/dynamodb
207207
excerpts:
208-
- description: shows how to get batch items using the service client.
208+
- description: Shows how to get batch items using the service client.
209209
snippet_tags:
210210
- dynamodb.java2.batch.get.items.main
211-
- description: shows how to get batch items using the service client and a paginator.
211+
- description: Shows how to get batch items using the service client and a paginator.
212212
snippet_tags:
213213
- dynamodb.java2.batch.get.items.paginator.main
214214
.NET:

.doc_gen/metadata/iot_sitewise_metadata.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ iotsitewise_CreateAssetModel:
185185
services:
186186
iotsitewise: {CreateAssetModel}
187187
iotsitewise_Scenario:
188-
synopsis: Learn core operations for &ITSWlong; using an &AWS; SDK.
188+
synopsis: learn core operations for &ITSWlong; using an &AWS; SDK.
189189
category: Basics
190190
languages:
191191
Java:

.doc_gen/metadata/medical-imaging_metadata.yaml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1232,28 +1232,28 @@ medical-imaging_Scenario_ImageSetsAndFrames:
12321232
github: javascriptv3/example_code/medical-imaging
12331233
github_note_at_bottom: true
12341234
excerpts:
1235-
- description: <noloc>index.js</noloc> - Orchestrate steps.
1235+
- description: Orchestrate steps (<noloc>index.js</noloc>).
12361236
snippet_files:
12371237
- javascriptv3/example_code/medical-imaging/scenarios/health-image-sets/index.js
1238-
- description: <noloc>deploy-steps.js</noloc> - Deploy resources.
1238+
- description: Deploy resources (<noloc>deploy-steps.js</noloc>).
12391239
snippet_files:
12401240
- javascriptv3/example_code/medical-imaging/scenarios/health-image-sets/deploy-steps.js
1241-
- description: <noloc>dataset-steps.js</noloc> - Copy DICOM files.
1241+
- description: Copy DICOM files (<noloc>dataset-steps.js</noloc>).
12421242
snippet_files:
12431243
- javascriptv3/example_code/medical-imaging/scenarios/health-image-sets/dataset-steps.js
1244-
- description: <noloc>import-steps.js</noloc> - Start import into datastore.
1244+
- description: Start import into datastore (<noloc>import-steps.js</noloc>).
12451245
snippet_files:
12461246
- javascriptv3/example_code/medical-imaging/scenarios/health-image-sets/import-steps.js
1247-
- description: <noloc>image-set-steps.js</noloc> - Get image set IDs.
1247+
- description: Get image set IDs (<noloc>image-set-steps.js</noloc> - ).
12481248
snippet_files:
12491249
- javascriptv3/example_code/medical-imaging/scenarios/health-image-sets/image-set-steps.js
1250-
- description: <noloc>image-frame-steps.js</noloc> - Get image frame IDs.
1250+
- description: Get image frame IDs (<noloc>image-frame-steps.js</noloc>).
12511251
snippet_files:
12521252
- javascriptv3/example_code/medical-imaging/scenarios/health-image-sets/image-frame-steps.js
1253-
- description: <noloc>verify-steps.js</noloc> - Verify image frames. The <ulink url="https://github.com/aws-samples/aws-healthimaging-samples/tree/main/pixel-data-verification">&AWS; HealthImaging Pixel Data Verification</ulink> library was used for verification.
1253+
- description: Verify image frames (<noloc>verify-steps.js</noloc>). The <ulink url="https://github.com/aws-samples/aws-healthimaging-samples/tree/main/pixel-data-verification">&AWS; HealthImaging Pixel Data Verification</ulink> library was used for verification.
12541254
snippet_files:
12551255
- javascriptv3/example_code/medical-imaging/scenarios/health-image-sets/verify-steps.js
1256-
- description: <noloc>clean-up-steps.js</noloc> - Destroy resources.
1256+
- description: Destroy resources (<noloc>clean-up-steps.js</noloc>).
12571257
snippet_files:
12581258
- javascriptv3/example_code/medical-imaging/scenarios/health-image-sets/clean-up-steps.js
12591259
services:

.doc_gen/metadata/redshift_metadata.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ redshift_Hello:
99
versions:
1010
- sdk_version: 2
1111
github: gov2/redshift
12-
genai: some
1312
excerpts:
1413
- description:
14+
genai: some
1515
snippet_tags:
1616
- gov2.redshift.Hello
1717
Java:

.doc_gen/metadata/s3-control_metadata.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
s3-control_Hello:
22
title: Hello &S3Control;
3-
title_abbrev: Hello '&S3Control;'
4-
synopsis: get started using '&S3Control;'
3+
title_abbrev: Hello &S3Control;
4+
synopsis: get started using &S3Control;.
55
category: Hello
66
languages:
77
Java:
@@ -117,7 +117,7 @@ s3-control_UpdateJobPriority:
117117
services:
118118
s3-control: {UpdateJobPriority}
119119
s3-control_Basics:
120-
synopsis: learn core operations for'&S3Control;'.
120+
synopsis: learn core operations for &S3Control;.
121121
category: Basics
122122
languages:
123123
Java:

.doc_gen/metadata/s3-directory-buckets_metadata.yaml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -393,14 +393,14 @@ s3-directory-buckets_UploadPart:
393393

394394
s3-directory-buckets_Scenario_ExpressBasics:
395395
synopsis_list:
396-
- Set up a VPC and VPC Endpoint
397-
- Set up the Policies, Roles, and User to work with S3 directory buckets and the S3 Express One Zone storage class
398-
- Create two S3 Clients
399-
- Create two buckets
400-
- Create an object and copy it over
401-
- Demonstrate performance difference
402-
- Populate the buckets to show the lexicographical difference
403-
- Prompt the user to see if they want to clean up the resources
396+
- Set up a VPC and VPC Endpoint.
397+
- Set up the Policies, Roles, and User to work with S3 directory buckets and the S3 Express One Zone storage class.
398+
- Create two S3 Clients.
399+
- Create two buckets.
400+
- Create an object and copy it over.
401+
- Demonstrate performance difference.
402+
- Populate the buckets to show the lexicographical difference.
403+
- Prompt the user to see if they want to clean up the resources.
404404
category: Basics
405405
languages:
406406
PHP:

.doc_gen/metadata/s3_metadata.yaml

Lines changed: 12 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ s3_Hello:
7474
excerpts:
7575
- snippet_tags:
7676
- s3.rust.s3-helloworld
77-
- description: S3ExampleError utilities
77+
- description: S3ExampleError utilities.
7878
- snippet_tags:
7979
- s3.rust.s3-example-error
8080
services:
@@ -2704,25 +2704,7 @@ s3_Scenario_PresignedUrl:
27042704
github: javav2/example_code/s3
27052705
sdkguide:
27062706
excerpts:
2707-
- description: >-
2708-
<para>The following shows three example of how to create presigned URLs and use the URLs with
2709-
HTTP client libraries:</para>
2710-
<itemizedlist>
2711-
<listitem>
2712-
<para>An HTTP GET request that uses the URL with three HTTP client libraries</para>
2713-
</listitem>
2714-
<listitem>
2715-
<para>An HTTP PUT request with metadata in headers that uses the URL with three HTTP client
2716-
libraries</para>
2717-
</listitem>
2718-
<listitem>
2719-
<para>An HTTP PUT request with query parameters that uses the URL with one HTTP client
2720-
library</para>
2721-
</listitem>
2722-
</itemizedlist>
2723-
<para>
2724-
<emphasis role="bold">Generate a pre-signed URL for an object, then download it (GET request).</emphasis>
2725-
</para>
2707+
- description: Generate a pre-signed URL for an object, then download it (GET request).
27262708
- description: Imports.
27272709
snippet_tags:
27282710
- presigned.java2.generatepresignedgeturlandretrieve.import
@@ -2740,7 +2722,7 @@ s3_Scenario_PresignedUrl:
27402722
snippet_tags:
27412723
- presigned.java2.generatepresignedgeturlandretrieve.sdkhttpclient
27422724

2743-
- description: <emphasis role="bold">Generate a pre-signed URL with metadata in headers for an upload, then upload a file (PUT request).</emphasis>
2725+
- description: Generate a pre-signed URL with metadata in headers for an upload, then upload a file (PUT request).
27442726
- description: Imports.
27452727
snippet_tags:
27462728
- presigned.java2.generatepresignedurlandputfilewithmetadata.import
@@ -2758,7 +2740,7 @@ s3_Scenario_PresignedUrl:
27582740
snippet_tags:
27592741
- presigned.java2.generatepresignedurlandputfilewithmetadata.sdkhttpclient
27602742

2761-
- description: <emphasis role="bold">Generate a pre-signed URL with query parameters for an upload, then upload a file (PUT request).</emphasis>
2743+
- description: Generate a pre-signed URL with query parameters for an upload, then upload a file (PUT request).
27622744
- description: Imports.
27632745
snippet_tags:
27642746
- presigned.java2.generatepresignedurlandputfilewithqueryparams.import
@@ -3372,20 +3354,20 @@ s3_Scenario_ObjectLock:
33723354
sdkguide:
33733355
excerpts:
33743356
- description: |
3375-
<noloc>index.js</noloc> - Entrypoint for the workflow. This orchestrates all of the steps.
3357+
Entrypoint for the workflow (<noloc>index.js</noloc>). This orchestrates all of the steps.
33763358
Visit GitHub to see the implementation details for Scenario, ScenarioInput, ScenarioOutput, and ScenarioAction.
33773359
snippet_files:
33783360
- javascriptv3/example_code/s3/scenarios/object-locking/index.js
3379-
- description: <noloc>welcome.steps.js</noloc> - Output welcome messages to the console.
3361+
- description: Output welcome messages to the console (<noloc>welcome.steps.js</noloc>).
33803362
snippet_files:
33813363
- javascriptv3/example_code/s3/scenarios/object-locking/welcome.steps.js
3382-
- description: <noloc>setup.steps.js</noloc> - Deploy buckets, objects, and file settings.
3364+
- description: Deploy buckets, objects, and file settings (<noloc>setup.steps.js</noloc>).
33833365
snippet_files:
33843366
- javascriptv3/example_code/s3/scenarios/object-locking/setup.steps.js
3385-
- description: <noloc>repl.steps.js</noloc> - View and delete files in the buckets.
3367+
- description: View and delete files in the buckets (<noloc>repl.steps.js</noloc>).
33863368
snippet_files:
33873369
- javascriptv3/example_code/s3/scenarios/object-locking/repl.steps.js
3388-
- description: <noloc>clean.steps.js</noloc> - Destroy all created resources.
3370+
- description: Destroy all created resources (<noloc>clean.steps.js</noloc>).
33893371
snippet_files:
33903372
- javascriptv3/example_code/s3/scenarios/object-locking/clean.steps.js
33913373
services:
@@ -3476,7 +3458,7 @@ s3_Scenario_AbortMultipartUpload:
34763458
services:
34773459
s3: {ListMultipartUploads, AbortMultipartUpload, PutBucketLifecycleConfiguration}
34783460
s3_Scenario_ProcessS3EventNotification:
3479-
title: Receive and process &S3; event notifications by using an &AWS; SDK.
3461+
title: Receive and process &S3; event notifications by using an &AWS; SDK
34803462
title_abbrev: Process S3 event notifications
34813463
synopsis: work with S3 event notifications in an object-oriented way.
34823464
category: Scenarios
@@ -3494,7 +3476,7 @@ s3_Scenario_ProcessS3EventNotification:
34943476
s3: {PutBucketNotificationConfiguration}
34953477
sqs: {ReceiveMessage, GetQueueAttributes, DeleteMessageBatch}
34963478
s3_Scenario_DeleteAllObjects:
3497-
title: Delete all objects in a given &S3; bucket using an &AWS; SDK.
3479+
title: Delete all objects in a given &S3; bucket using an &AWS; SDK
34983480
title_abbrev: Delete all objects in a bucket
34993481
synopsis: delete all of the objects in an &S3; bucket.
35003482
category: Scenarios
@@ -3511,7 +3493,7 @@ s3_Scenario_DeleteAllObjects:
35113493
services:
35123494
s3: {DeleteObjects, ListObjectsV2}
35133495
s3_Scenario_ConditionalRequests:
3514-
title: Make &S3; conditional requests using an &AWS; SDK.
3496+
title: Make &S3; conditional requests using an &AWS; SDK
35153497
title_abbrev: Make conditional requests
35163498
synopsis: add preconditions to &S3; requests.
35173499
category: Scenarios

0 commit comments

Comments
 (0)