docs: add more inline structural type hints for blobs and streaming b…

…lobs
aws · Mar 7, 2024 · 0db1c3b · 0db1c3b
1 parent 304ca3e
commit 0db1c3b
Show file tree

Hide file tree

Showing 9 changed files with 7 additions and 10 deletions.
diff --git a/clients/client-s3/src/commands/GetObjectCommand.ts b/clients/client-s3/src/commands/GetObjectCommand.ts
@@ -220,7 +220,7 @@ export interface GetObjectCommandOutput extends Omit<GetObjectOutput, "Body">, _
  * const command = new GetObjectCommand(input);
  * const response = await client.send(command);
  * // { // GetObjectOutput
- * //   Body: "STREAMING_BLOB_VALUE",
+ * //   Body: "<SdkStream>", // see @smithy/types -> StreamingBlobPayloadOutputTypes
  * //   DeleteMarker: true || false,
  * //   AcceptRanges: "STRING_VALUE",
  * //   Expiration: "STRING_VALUE",

diff --git a/clients/client-s3/src/commands/GetObjectTorrentCommand.ts b/clients/client-s3/src/commands/GetObjectTorrentCommand.ts
@@ -69,7 +69,7 @@ export interface GetObjectTorrentCommandOutput extends Omit<GetObjectTorrentOutp
  * const command = new GetObjectTorrentCommand(input);
  * const response = await client.send(command);
  * // { // GetObjectTorrentOutput
- * //   Body: "STREAMING_BLOB_VALUE",
+ * //   Body: "<SdkStream>", // see @smithy/types -> StreamingBlobPayloadOutputTypes
  * //   RequestCharged: "requester",
  * // };
  *

diff --git a/clients/client-s3/src/commands/PutObjectCommand.ts b/clients/client-s3/src/commands/PutObjectCommand.ts
@@ -175,7 +175,7 @@ export interface PutObjectCommandOutput extends PutObjectOutput, __MetadataBeare
  * const client = new S3Client(config);
  * const input = { // PutObjectRequest
  *   ACL: "private" || "public-read" || "public-read-write" || "authenticated-read" || "aws-exec-read" || "bucket-owner-read" || "bucket-owner-full-control",
- *   Body: "STREAMING_BLOB_VALUE",
+ *   Body: "MULTIPLE_TYPES_ACCEPTED", // see @smithy/types -> StreamingBlobPayloadInputTypes
  *   Bucket: "STRING_VALUE", // required
  *   CacheControl: "STRING_VALUE",
  *   ContentDisposition: "STRING_VALUE",

diff --git a/clients/client-s3/src/commands/SelectObjectContentCommand.ts b/clients/client-s3/src/commands/SelectObjectContentCommand.ts
@@ -212,7 +212,7 @@ export interface SelectObjectContentCommandOutput extends SelectObjectContentOut
  * // { // SelectObjectContentOutput
  * //   Payload: { // SelectObjectContentEventStream Union: only one key present
  * //     Records: { // RecordsEvent
- * //       Payload: "BLOB_VALUE",
+ * //       Payload: new Uint8Array(),
  * //     },
  * //     Stats: { // StatsEvent
  * //       Details: { // Stats

diff --git a/clients/client-s3/src/commands/UploadPartCommand.ts b/clients/client-s3/src/commands/UploadPartCommand.ts
@@ -208,7 +208,7 @@ export interface UploadPartCommandOutput extends UploadPartOutput, __MetadataBea
  * // const { S3Client, UploadPartCommand } = require("@aws-sdk/client-s3"); // CommonJS import
  * const client = new S3Client(config);
  * const input = { // UploadPartRequest
- *   Body: "STREAMING_BLOB_VALUE",
+ *   Body: "MULTIPLE_TYPES_ACCEPTED", // see @smithy/types -> StreamingBlobPayloadInputTypes
  *   Bucket: "STRING_VALUE", // required
  *   ContentLength: Number("long"),
  *   ContentMD5: "STRING_VALUE",

diff --git a/clients/client-s3/src/commands/WriteGetObjectResponseCommand.ts b/clients/client-s3/src/commands/WriteGetObjectResponseCommand.ts
@@ -77,7 +77,7 @@ export interface WriteGetObjectResponseCommandOutput extends __MetadataBearer {}
  * const input = { // WriteGetObjectResponseRequest
  *   RequestRoute: "STRING_VALUE", // required
  *   RequestToken: "STRING_VALUE", // required
- *   Body: "STREAMING_BLOB_VALUE",
+ *   Body: "MULTIPLE_TYPES_ACCEPTED", // see @smithy/types -> StreamingBlobPayloadInputTypes
  *   StatusCode: Number("int"),
  *   ErrorCode: "STRING_VALUE",
  *   ErrorMessage: "STRING_VALUE",

diff --git a/clients/client-s3/src/models/models_0.ts b/clients/client-s3/src/models/models_0.ts
@@ -1,6 +1,5 @@
 // smithy-typescript generated code
 import { ExceptionOptionType as __ExceptionOptionType, SENSITIVE_STRING } from "@smithy/smithy-client";
-
 import { StreamingBlobTypes } from "@smithy/types";
 
 import { S3ServiceException as __BaseException } from "./S3ServiceException";

diff --git a/clients/client-s3/src/models/models_1.ts b/clients/client-s3/src/models/models_1.ts
@@ -1,6 +1,5 @@
 // smithy-typescript generated code
 import { ExceptionOptionType as __ExceptionOptionType, SENSITIVE_STRING } from "@smithy/smithy-client";
-
 import { StreamingBlobTypes } from "@smithy/types";
 
 import {
@@ -28,7 +27,6 @@ import {
   StorageClass,
   Tag,
 } from "./models_0";
-
 import { S3ServiceException as __BaseException } from "./S3ServiceException";
 
 /**

diff --git a/clients/client-ses/src/commands/SendRawEmailCommand.ts b/clients/client-ses/src/commands/SendRawEmailCommand.ts
@@ -141,7 +141,7 @@ export interface SendRawEmailCommandOutput extends SendRawEmailResponse, __Metad
  *     "STRING_VALUE",
  *   ],
  *   RawMessage: { // RawMessage
- *     Data: "BLOB_VALUE", // required
+ *     Data: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")     // required
  *   },
  *   FromArn: "STRING_VALUE",
  *   SourceArn: "STRING_VALUE",