Skip to content

Commit 0db1c3b

Browse files
committed
docs: add more inline structural type hints for blobs and streaming blobs
1 parent 304ca3e commit 0db1c3b

File tree

9 files changed

+7
-10
lines changed

9 files changed

+7
-10
lines changed

clients/client-s3/src/commands/GetObjectCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,7 @@ export interface GetObjectCommandOutput extends Omit<GetObjectOutput, "Body">, _
220220
* const command = new GetObjectCommand(input);
221221
* const response = await client.send(command);
222222
* // { // GetObjectOutput
223-
* // Body: "STREAMING_BLOB_VALUE",
223+
* // Body: "<SdkStream>", // see @smithy/types -> StreamingBlobPayloadOutputTypes
224224
* // DeleteMarker: true || false,
225225
* // AcceptRanges: "STRING_VALUE",
226226
* // Expiration: "STRING_VALUE",

clients/client-s3/src/commands/GetObjectTorrentCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ export interface GetObjectTorrentCommandOutput extends Omit<GetObjectTorrentOutp
6969
* const command = new GetObjectTorrentCommand(input);
7070
* const response = await client.send(command);
7171
* // { // GetObjectTorrentOutput
72-
* // Body: "STREAMING_BLOB_VALUE",
72+
* // Body: "<SdkStream>", // see @smithy/types -> StreamingBlobPayloadOutputTypes
7373
* // RequestCharged: "requester",
7474
* // };
7575
*

clients/client-s3/src/commands/PutObjectCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ export interface PutObjectCommandOutput extends PutObjectOutput, __MetadataBeare
175175
* const client = new S3Client(config);
176176
* const input = { // PutObjectRequest
177177
* ACL: "private" || "public-read" || "public-read-write" || "authenticated-read" || "aws-exec-read" || "bucket-owner-read" || "bucket-owner-full-control",
178-
* Body: "STREAMING_BLOB_VALUE",
178+
* Body: "MULTIPLE_TYPES_ACCEPTED", // see @smithy/types -> StreamingBlobPayloadInputTypes
179179
* Bucket: "STRING_VALUE", // required
180180
* CacheControl: "STRING_VALUE",
181181
* ContentDisposition: "STRING_VALUE",

clients/client-s3/src/commands/SelectObjectContentCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ export interface SelectObjectContentCommandOutput extends SelectObjectContentOut
212212
* // { // SelectObjectContentOutput
213213
* // Payload: { // SelectObjectContentEventStream Union: only one key present
214214
* // Records: { // RecordsEvent
215-
* // Payload: "BLOB_VALUE",
215+
* // Payload: new Uint8Array(),
216216
* // },
217217
* // Stats: { // StatsEvent
218218
* // Details: { // Stats

clients/client-s3/src/commands/UploadPartCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ export interface UploadPartCommandOutput extends UploadPartOutput, __MetadataBea
208208
* // const { S3Client, UploadPartCommand } = require("@aws-sdk/client-s3"); // CommonJS import
209209
* const client = new S3Client(config);
210210
* const input = { // UploadPartRequest
211-
* Body: "STREAMING_BLOB_VALUE",
211+
* Body: "MULTIPLE_TYPES_ACCEPTED", // see @smithy/types -> StreamingBlobPayloadInputTypes
212212
* Bucket: "STRING_VALUE", // required
213213
* ContentLength: Number("long"),
214214
* ContentMD5: "STRING_VALUE",

clients/client-s3/src/commands/WriteGetObjectResponseCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ export interface WriteGetObjectResponseCommandOutput extends __MetadataBearer {}
7777
* const input = { // WriteGetObjectResponseRequest
7878
* RequestRoute: "STRING_VALUE", // required
7979
* RequestToken: "STRING_VALUE", // required
80-
* Body: "STREAMING_BLOB_VALUE",
80+
* Body: "MULTIPLE_TYPES_ACCEPTED", // see @smithy/types -> StreamingBlobPayloadInputTypes
8181
* StatusCode: Number("int"),
8282
* ErrorCode: "STRING_VALUE",
8383
* ErrorMessage: "STRING_VALUE",

clients/client-s3/src/models/models_0.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
// smithy-typescript generated code
22
import { ExceptionOptionType as __ExceptionOptionType, SENSITIVE_STRING } from "@smithy/smithy-client";
3-
43
import { StreamingBlobTypes } from "@smithy/types";
54

65
import { S3ServiceException as __BaseException } from "./S3ServiceException";

clients/client-s3/src/models/models_1.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
// smithy-typescript generated code
22
import { ExceptionOptionType as __ExceptionOptionType, SENSITIVE_STRING } from "@smithy/smithy-client";
3-
43
import { StreamingBlobTypes } from "@smithy/types";
54

65
import {
@@ -28,7 +27,6 @@ import {
2827
StorageClass,
2928
Tag,
3029
} from "./models_0";
31-
3230
import { S3ServiceException as __BaseException } from "./S3ServiceException";
3331

3432
/**

clients/client-ses/src/commands/SendRawEmailCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ export interface SendRawEmailCommandOutput extends SendRawEmailResponse, __Metad
141141
* "STRING_VALUE",
142142
* ],
143143
* RawMessage: { // RawMessage
144-
* Data: "BLOB_VALUE", // required
144+
* Data: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("") // required
145145
* },
146146
* FromArn: "STRING_VALUE",
147147
* SourceArn: "STRING_VALUE",

0 commit comments

Comments
 (0)