Skip to content

Commit 8ddb3cf

Browse files
shepazonrlhagerm
authored andcommitted
Add metadata for the binary streaming examples
1 parent cc12119 commit 8ddb3cf

File tree

2 files changed

+59
-2
lines changed

2 files changed

+59
-2
lines changed

.doc_gen/metadata/s3_metadata.yaml

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3262,7 +3262,32 @@ s3_Scenario_UploadStream:
32623262
snippet_tags:
32633263
- s3.tm.java2.upload_stream.import
32643264
- s3.tm.java2.upload_stream.main
3265-
3265+
Swift:
3266+
versions:
3267+
- sdk_version: 1
3268+
github: swift/example_code/s3/binary-streaming
3269+
excerpts:
3270+
- description:
3271+
snippet_tags:
3272+
- swift.s3.streaming-up.imports
3273+
- swift.s3.streaming-up
3274+
services:
3275+
s3: {}
3276+
s3_Scenario_DownloadStream:
3277+
title: Download a stream of unknown size from an &S3; object using an &AWS; SDK
3278+
title_abbrev: Download stream of unknown size
3279+
synopsis: download a stream of unknown size from an &S3; object.
3280+
category: Scenarios
3281+
languages:
3282+
Swift:
3283+
versions:
3284+
- sdk_version: 1
3285+
github: swift/example_code/s3/binary-streaming
3286+
excerpts:
3287+
- description:
3288+
snippet_tags:
3289+
- swift.s3.streaming-down.imports
3290+
- swift.s3.streaming-down
32663291
services:
32673292
s3: {}
32683293
s3_Scenario_UseChecksums:

swift/example_code/s3/README.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,14 @@ Code excerpts that show you how to call individual service functions.
5050
- [ListObjectsV2](basics/Sources/ServiceHandler/ServiceHandler.swift#L280)
5151
- [PutObject](basics/Sources/ServiceHandler/ServiceHandler.swift#L107)
5252

53+
### Scenarios
54+
55+
Code examples that show you how to accomplish a specific task by calling multiple
56+
functions within the same service.
57+
58+
- [Download stream of unknown size](binary-streaming/Sources/streamdown/streamdown.swift)
59+
- [Upload stream of unknown size](binary-streaming/Sources/streamup/streamup.swift)
60+
5361

5462
<!--custom.examples.start-->
5563
<!--custom.examples.end-->
@@ -92,6 +100,30 @@ This example shows you how to do the following:
92100
<!--custom.basics.s3_Scenario_GettingStarted.end-->
93101

94102

103+
#### Download stream of unknown size
104+
105+
This example shows you how to download a stream of unknown size from an Amazon S3 object.
106+
107+
108+
<!--custom.scenario_prereqs.s3_Scenario_DownloadStream.start-->
109+
<!--custom.scenario_prereqs.s3_Scenario_DownloadStream.end-->
110+
111+
112+
<!--custom.scenarios.s3_Scenario_DownloadStream.start-->
113+
<!--custom.scenarios.s3_Scenario_DownloadStream.end-->
114+
115+
#### Upload stream of unknown size
116+
117+
This example shows you how to upload a stream of unknown size to an Amazon S3 object.
118+
119+
120+
<!--custom.scenario_prereqs.s3_Scenario_UploadStream.start-->
121+
<!--custom.scenario_prereqs.s3_Scenario_UploadStream.end-->
122+
123+
124+
<!--custom.scenarios.s3_Scenario_UploadStream.start-->
125+
<!--custom.scenarios.s3_Scenario_UploadStream.end-->
126+
95127
### Tests
96128

97129
⚠ Running tests might result in charges to your AWS account.
@@ -118,4 +150,4 @@ in the `swift` folder.
118150

119151
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
120152

121-
SPDX-License-Identifier: Apache-2.0
153+
SPDX-License-Identifier: Apache-2.0

0 commit comments

Comments
 (0)