Add metadata for the binary streaming examples

awsdocs · Dec 10, 2024 · ab0d3b8 · ab0d3b8
1 parent 576c0c5
commit ab0d3b8
Show file tree

Hide file tree

Showing 2 changed files with 59 additions and 2 deletions.
diff --git a/.doc_gen/metadata/s3_metadata.yaml b/.doc_gen/metadata/s3_metadata.yaml
@@ -3262,7 +3262,32 @@ s3_Scenario_UploadStream:
               snippet_tags:
                 - s3.tm.java2.upload_stream.import
                 - s3.tm.java2.upload_stream.main
-
+    Swift:
+      versions:
+        - sdk_version: 1
+          github: swift/example_code/s3/binary-streaming
+          excerpts:
+            - description:
+              snippet_tags:
+                - swift.s3.streaming-up.imports
+                - swift.s3.streaming-up
+  services:
+    s3: {}
+s3_Scenario_DownloadStream:
+  title: Download a stream of unknown size from an &S3; object using an &AWS; SDK
+  title_abbrev: Download stream of unknown size
+  synopsis: download a stream of unknown size from an &S3; object.
+  category: Scenarios
+  languages:
+    Swift:
+      versions:
+        - sdk_version: 1
+          github: swift/example_code/s3/binary-streaming
+          excerpts:
+            - description:
+              snippet_tags:
+                - swift.s3.streaming-down.imports
+                - swift.s3.streaming-down
   services:
     s3: {}
 s3_Scenario_UseChecksums:

diff --git a/swift/example_code/s3/README.md b/swift/example_code/s3/README.md
@@ -50,6 +50,14 @@ Code excerpts that show you how to call individual service functions.
 - [ListObjectsV2](basics/Sources/ServiceHandler/ServiceHandler.swift#L280)
 - [PutObject](basics/Sources/ServiceHandler/ServiceHandler.swift#L107)
 
+### Scenarios
+
+Code examples that show you how to accomplish a specific task by calling multiple
+functions within the same service.
+
+- [Download stream of unknown size](binary-streaming/Sources/streamdown/streamdown.swift)
+- [Upload stream of unknown size](binary-streaming/Sources/streamup/streamup.swift)
+
 
 <!--custom.examples.start-->
 <!--custom.examples.end-->
@@ -92,6 +100,30 @@ This example shows you how to do the following:
 <!--custom.basics.s3_Scenario_GettingStarted.end-->
 
 
+#### Download stream of unknown size
+
+This example shows you how to download a stream of unknown size from an Amazon S3 object.
+
+
+<!--custom.scenario_prereqs.s3_Scenario_DownloadStream.start-->
+<!--custom.scenario_prereqs.s3_Scenario_DownloadStream.end-->
+
+
+<!--custom.scenarios.s3_Scenario_DownloadStream.start-->
+<!--custom.scenarios.s3_Scenario_DownloadStream.end-->
+
+#### Upload stream of unknown size
+
+This example shows you how to upload a stream of unknown size to an Amazon S3 object.
+
+
+<!--custom.scenario_prereqs.s3_Scenario_UploadStream.start-->
+<!--custom.scenario_prereqs.s3_Scenario_UploadStream.end-->
+
+
+<!--custom.scenarios.s3_Scenario_UploadStream.start-->
+<!--custom.scenarios.s3_Scenario_UploadStream.end-->
+
 ### Tests
 
 ⚠ Running tests might result in charges to your AWS account.
@@ -118,4 +150,4 @@ in the `swift` folder.
 
 Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 
-SPDX-License-Identifier: Apache-2.0
+SPDX-License-Identifier: Apache-2.0