Skip to content

Commit

Permalink
Merge branch 'main' into patch-1
Browse files Browse the repository at this point in the history
  • Loading branch information
beqqrry-aws authored Dec 5, 2024
2 parents 942c0e4 + 429e4a0 commit 1b8ac1c
Show file tree
Hide file tree
Showing 20 changed files with 362 additions and 84 deletions.
2 changes: 1 addition & 1 deletion .doc_gen/metadata/bedrock-runtime_metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1219,7 +1219,7 @@ bedrock-runtime_Scenario_ToolUseDemo_AnthropicClaude:
- 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."
snippet_tags:
- rust.bedrock-runtime.Converse_AnthropicClaude.tool-use.weather-tool
- description: "Utilities to print the Message Content Blocks"
- description: "Utilities to print the Message Content Blocks."
snippet_tags:
- rust.bedrock-runtime.Converse_AnthropicClaude.tool-use.user-interface
- description: "Use statements, Error utility, and constants."
Expand Down
1 change: 0 additions & 1 deletion .doc_gen/metadata/cross_metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -826,7 +826,6 @@ cross_CognitoAutoConfirmUser:
versions:
- sdk_version: 3
github: javascriptv3/example_code/cross-services/wkflw-pools-triggers
sdk_guide:
excerpts:
- description: |
Configure an interactive "Scenario" run. The JavaScript (v3) examples
Expand Down
4 changes: 2 additions & 2 deletions .doc_gen/metadata/dynamodb_metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -205,10 +205,10 @@ dynamodb_BatchGetItem:
- sdk_version: 2
github: javav2/example_code/dynamodb
excerpts:
- description: shows how to get batch items using the service client.
- description: Shows how to get batch items using the service client.
snippet_tags:
- dynamodb.java2.batch.get.items.main
- description: shows how to get batch items using the service client and a paginator.
- description: Shows how to get batch items using the service client and a paginator.
snippet_tags:
- dynamodb.java2.batch.get.items.paginator.main
.NET:
Expand Down
2 changes: 1 addition & 1 deletion .doc_gen/metadata/iot_sitewise_metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ iotsitewise_CreateAssetModel:
services:
iotsitewise: {CreateAssetModel}
iotsitewise_Scenario:
synopsis: Learn core operations for &ITSWlong; using an &AWS; SDK.
synopsis: learn core operations for &ITSWlong; using an &AWS; SDK.
category: Basics
languages:
Java:
Expand Down
16 changes: 8 additions & 8 deletions .doc_gen/metadata/medical-imaging_metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1232,28 +1232,28 @@ medical-imaging_Scenario_ImageSetsAndFrames:
github: javascriptv3/example_code/medical-imaging
github_note_at_bottom: true
excerpts:
- description: <noloc>index.js</noloc> - Orchestrate steps.
- description: Orchestrate steps (<noloc>index.js</noloc>).
snippet_files:
- javascriptv3/example_code/medical-imaging/scenarios/health-image-sets/index.js
- description: <noloc>deploy-steps.js</noloc> - Deploy resources.
- description: Deploy resources (<noloc>deploy-steps.js</noloc>).
snippet_files:
- javascriptv3/example_code/medical-imaging/scenarios/health-image-sets/deploy-steps.js
- description: <noloc>dataset-steps.js</noloc> - Copy DICOM files.
- description: Copy DICOM files (<noloc>dataset-steps.js</noloc>).
snippet_files:
- javascriptv3/example_code/medical-imaging/scenarios/health-image-sets/dataset-steps.js
- description: <noloc>import-steps.js</noloc> - Start import into datastore.
- description: Start import into datastore (<noloc>import-steps.js</noloc>).
snippet_files:
- javascriptv3/example_code/medical-imaging/scenarios/health-image-sets/import-steps.js
- description: <noloc>image-set-steps.js</noloc> - Get image set IDs.
- description: Get image set IDs (<noloc>image-set-steps.js</noloc> - ).
snippet_files:
- javascriptv3/example_code/medical-imaging/scenarios/health-image-sets/image-set-steps.js
- description: <noloc>image-frame-steps.js</noloc> - Get image frame IDs.
- description: Get image frame IDs (<noloc>image-frame-steps.js</noloc>).
snippet_files:
- javascriptv3/example_code/medical-imaging/scenarios/health-image-sets/image-frame-steps.js
- 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.
- 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.
snippet_files:
- javascriptv3/example_code/medical-imaging/scenarios/health-image-sets/verify-steps.js
- description: <noloc>clean-up-steps.js</noloc> - Destroy resources.
- description: Destroy resources (<noloc>clean-up-steps.js</noloc>).
snippet_files:
- javascriptv3/example_code/medical-imaging/scenarios/health-image-sets/clean-up-steps.js
services:
Expand Down
2 changes: 1 addition & 1 deletion .doc_gen/metadata/redshift_metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ redshift_Hello:
versions:
- sdk_version: 2
github: gov2/redshift
genai: some
excerpts:
- description:
genai: some
snippet_tags:
- gov2.redshift.Hello
Java:
Expand Down
6 changes: 3 additions & 3 deletions .doc_gen/metadata/s3-control_metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
s3-control_Hello:
title: Hello &S3Control;
title_abbrev: Hello '&S3Control;'
synopsis: get started using '&S3Control;'
title_abbrev: Hello &S3Control;
synopsis: get started using &S3Control;.
category: Hello
languages:
Java:
Expand Down Expand Up @@ -117,7 +117,7 @@ s3-control_UpdateJobPriority:
services:
s3-control: {UpdateJobPriority}
s3-control_Basics:
synopsis: learn core operations for'&S3Control;'.
synopsis: learn core operations for &S3Control;.
category: Basics
languages:
Java:
Expand Down
16 changes: 8 additions & 8 deletions .doc_gen/metadata/s3-directory-buckets_metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -393,14 +393,14 @@ s3-directory-buckets_UploadPart:

s3-directory-buckets_Scenario_ExpressBasics:
synopsis_list:
- Set up a VPC and VPC Endpoint
- Set up the Policies, Roles, and User to work with S3 directory buckets and the S3 Express One Zone storage class
- Create two S3 Clients
- Create two buckets
- Create an object and copy it over
- Demonstrate performance difference
- Populate the buckets to show the lexicographical difference
- Prompt the user to see if they want to clean up the resources
- Set up a VPC and VPC Endpoint.
- Set up the Policies, Roles, and User to work with S3 directory buckets and the S3 Express One Zone storage class.
- Create two S3 Clients.
- Create two buckets.
- Create an object and copy it over.
- Demonstrate performance difference.
- Populate the buckets to show the lexicographical difference.
- Prompt the user to see if they want to clean up the resources.
category: Basics
languages:
PHP:
Expand Down
31 changes: 21 additions & 10 deletions .doc_gen/metadata/s3_metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ s3_Hello:
excerpts:
- snippet_tags:
- s3.rust.s3-helloworld
- description: S3ExampleError utilities
- description: S3ExampleError utilities.
- snippet_tags:
- s3.rust.s3-example-error
services:
Expand Down Expand Up @@ -2722,7 +2722,7 @@ s3_Scenario_PresignedUrl:
snippet_tags:
- presigned.java2.generatepresignedgeturlandretrieve.sdkhttpclient

- description: Generate a pre-signed URL for an upload, then upload a file (PUT request).
- description: Generate a pre-signed URL with metadata in headers for an upload, then upload a file (PUT request).
- description: Imports.
snippet_tags:
- presigned.java2.generatepresignedurlandputfilewithmetadata.import
Expand All @@ -2739,6 +2739,17 @@ s3_Scenario_PresignedUrl:
- description: Use the &AWS; for Java V2 <code>SdkHttpClient</code> class to do the upload.
snippet_tags:
- presigned.java2.generatepresignedurlandputfilewithmetadata.sdkhttpclient

- description: Generate a pre-signed URL with query parameters for an upload, then upload a file (PUT request).
- description: Imports.
snippet_tags:
- presigned.java2.generatepresignedurlandputfilewithqueryparams.import
- description: Generate the URL.
snippet_tags:
- presigned.java2.generatepresignedurlandputfilewithqueryparams.createpresignedurl
- description: Use the &AWS; for Java V2 <code>SdkHttpClient</code> class to do the upload.
snippet_tags:
- presigned.java2.generatepresignedurlandputfilewithqueryparams.sdkhttpclient
Python:
versions:
- sdk_version: 3
Expand Down Expand Up @@ -3343,20 +3354,20 @@ s3_Scenario_ObjectLock:
sdkguide:
excerpts:
- description: |
<noloc>index.js</noloc> - Entrypoint for the workflow. This orchestrates all of the steps.
Entrypoint for the workflow (<noloc>index.js</noloc>). This orchestrates all of the steps.
Visit GitHub to see the implementation details for Scenario, ScenarioInput, ScenarioOutput, and ScenarioAction.
snippet_files:
- javascriptv3/example_code/s3/scenarios/object-locking/index.js
- description: <noloc>welcome.steps.js</noloc> - Output welcome messages to the console.
- description: Output welcome messages to the console (<noloc>welcome.steps.js</noloc>).
snippet_files:
- javascriptv3/example_code/s3/scenarios/object-locking/welcome.steps.js
- description: <noloc>setup.steps.js</noloc> - Deploy buckets, objects, and file settings.
- description: Deploy buckets, objects, and file settings (<noloc>setup.steps.js</noloc>).
snippet_files:
- javascriptv3/example_code/s3/scenarios/object-locking/setup.steps.js
- description: <noloc>repl.steps.js</noloc> - View and delete files in the buckets.
- description: View and delete files in the buckets (<noloc>repl.steps.js</noloc>).
snippet_files:
- javascriptv3/example_code/s3/scenarios/object-locking/repl.steps.js
- description: <noloc>clean.steps.js</noloc> - Destroy all created resources.
- description: Destroy all created resources (<noloc>clean.steps.js</noloc>).
snippet_files:
- javascriptv3/example_code/s3/scenarios/object-locking/clean.steps.js
services:
Expand Down Expand Up @@ -3447,7 +3458,7 @@ s3_Scenario_AbortMultipartUpload:
services:
s3: {ListMultipartUploads, AbortMultipartUpload, PutBucketLifecycleConfiguration}
s3_Scenario_ProcessS3EventNotification:
title: Receive and process &S3; event notifications by using an &AWS; SDK.
title: Receive and process &S3; event notifications by using an &AWS; SDK
title_abbrev: Process S3 event notifications
synopsis: work with S3 event notifications in an object-oriented way.
category: Scenarios
Expand All @@ -3465,7 +3476,7 @@ s3_Scenario_ProcessS3EventNotification:
s3: {PutBucketNotificationConfiguration}
sqs: {ReceiveMessage, GetQueueAttributes, DeleteMessageBatch}
s3_Scenario_DeleteAllObjects:
title: Delete all objects in a given &S3; bucket using an &AWS; SDK.
title: Delete all objects in a given &S3; bucket using an &AWS; SDK
title_abbrev: Delete all objects in a bucket
synopsis: delete all of the objects in an &S3; bucket.
category: Scenarios
Expand All @@ -3482,7 +3493,7 @@ s3_Scenario_DeleteAllObjects:
services:
s3: {DeleteObjects, ListObjectsV2}
s3_Scenario_ConditionalRequests:
title: Make &S3; conditional requests using an &AWS; SDK.
title: Make &S3; conditional requests using an &AWS; SDK
title_abbrev: Make conditional requests
synopsis: add preconditions to &S3; requests.
category: Scenarios
Expand Down
31 changes: 17 additions & 14 deletions .doc_gen/metadata/ssm_metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ ssm_Hello:
versions:
- sdk_version: 3
github: python/example_code/ssm
genai: some
excerpts:
- description:
genai: some
snippet_tags:
- python.example_code.ssm.Hello
services:
Expand Down Expand Up @@ -110,9 +110,9 @@ ssm_CreateOpsItem:
versions:
- sdk_version: 3
github: python/example_code/ssm
genai: some
excerpts:
- description:
genai: some
snippet_tags:
- python.example_code.ssm.OpsItemWrapper.decl
- python.example_code.ssm.CreateOpsItem
Expand Down Expand Up @@ -142,9 +142,9 @@ ssm_UpdateMaintenanceWindow:
versions:
- sdk_version: 3
github: python/example_code/ssm
genai: some
excerpts:
- description:
genai: some
snippet_tags:
- python.example_code.ssm.MaintenanceWindowWrapper.decl
- python.example_code.ssm.UpdateMaintenanceWindow
Expand Down Expand Up @@ -174,9 +174,9 @@ ssm_CreateMaintenanceWindow:
versions:
- sdk_version: 3
github: python/example_code/ssm
genai: some
excerpts:
- description:
genai: some
snippet_tags:
- python.example_code.ssm.MaintenanceWindowWrapper.decl
- python.example_code.ssm.CreateMaintenanceWindow
Expand Down Expand Up @@ -206,9 +206,9 @@ ssm_SendCommand:
versions:
- sdk_version: 3
github: python/example_code/ssm
genai: some
excerpts:
- description:
genai: some
snippet_tags:
- python.example_code.ssm.DocumentWrapper.decl
- python.example_code.ssm.SendCommand
Expand All @@ -229,9 +229,9 @@ ssm_ListCommandInvocations:
versions:
- sdk_version: 3
github: python/example_code/ssm
genai: some
excerpts:
- description:
genai: some
snippet_tags:
- python.example_code.ssm.DocumentWrapper.decl
- python.example_code.ssm.ListCommandInvocations
Expand Down Expand Up @@ -261,9 +261,9 @@ ssm_CreateDocument:
versions:
- sdk_version: 3
github: python/example_code/ssm
genai: some
excerpts:
- description:
genai: some
snippet_tags:
- python.example_code.ssm.DocumentWrapper.decl
- python.example_code.ssm.CreateDocument
Expand Down Expand Up @@ -293,9 +293,9 @@ ssm_DescribeOpsItems:
versions:
- sdk_version: 3
github: python/example_code/ssm
genai: some
excerpts:
- description:
genai: some
snippet_tags:
- python.example_code.ssm.OpsItemWrapper.decl
- python.example_code.ssm.DescribeOpsItem
Expand All @@ -307,9 +307,9 @@ ssm_DeleteOpsItem:
versions:
- sdk_version: 3
github: python/example_code/ssm
genai: some
excerpts:
- description:
genai: some
snippet_tags:
- python.example_code.ssm.OpsItemWrapper.decl
- python.example_code.ssm.DeleteOpsItem
Expand Down Expand Up @@ -339,9 +339,9 @@ ssm_DeleteMaintenanceWindow:
versions:
- sdk_version: 3
github: python/example_code/ssm
genai: some
excerpts:
- description:
genai: some
snippet_tags:
- python.example_code.ssm.MaintenanceWindowWrapper.decl
- python.example_code.ssm.DeleteMaintenanceWindow
Expand Down Expand Up @@ -371,9 +371,9 @@ ssm_DeleteDocument:
versions:
- sdk_version: 3
github: python/example_code/ssm
genai: some
excerpts:
- description:
genai: some
snippet_tags:
- python.example_code.ssm.DocumentWrapper.decl
- python.example_code.ssm.DeleteDocument
Expand Down Expand Up @@ -403,9 +403,9 @@ ssm_UpdateOpsItem:
versions:
- sdk_version: 3
github: python/example_code/ssm
genai: some
excerpts:
- description:
genai: some
snippet_tags:
- python.example_code.ssm.OpsItemWrapper.decl
- python.example_code.ssm.UpdateOpsItem
Expand All @@ -432,27 +432,30 @@ ssm_Scenario:
- sdk_version: 3
github: javascriptv3/example_code/ssm
sdkguide:
genai: some
excerpts:
- description:
genai: some
snippet_tags:
- ssm.JavaScript.Basics.scenario
Python:
versions:
- sdk_version: 3
github: python/example_code/ssm
genai: some
excerpts:
- description: Run an interactive scenario at a command prompt.
genai: some
snippet_tags:
- python.example_code.ssm.Scenario_GetStartedSSM
- description: Define a class that wraps document and command actions.
genai: some
snippet_tags:
- python.example_code.ssm.DocumentWrapper.class
- description: Define a class that wraps ops item actions.
genai: some
snippet_tags:
- python.example_code.ssm.OpsItemWrapper.class
- description: Define a class that wraps maintenance window actions.
genai: some
snippet_tags:
- python.example_code.ssm.MaintenanceWindowWrapper.class
services:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/validate-doc-metadata.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
- name: checkout repo content
uses: actions/checkout@v4
- name: validate metadata
uses: awsdocs/aws-doc-sdk-examples-tools@2024.47.3
uses: awsdocs/aws-doc-sdk-examples-tools@2024.49.0
with:
doc_gen_only: "False"
strict_titles: "True"
Loading

0 comments on commit 1b8ac1c

Please sign in to comment.