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

…lobs (#5864) * chore(codegen): update smithy version, blob documentation hints * chore(codegen): codegen sync * chore: update smithy versions in packages * chore: update lockfile
aws · Mar 12, 2024 · 2ed0a11 · 2ed0a11
1 parent facc91d
commit 2ed0a11
Show file tree

Hide file tree

Showing 811 changed files with 10,572 additions and 10,600 deletions.
diff --git a/clients/client-accessanalyzer/package.json b/clients/client-accessanalyzer/package.json
@@ -32,31 +32,31 @@
     "@aws-sdk/util-endpoints": "*",
     "@aws-sdk/util-user-agent-browser": "*",
     "@aws-sdk/util-user-agent-node": "*",
-    "@smithy/config-resolver": "^2.1.4",
-    "@smithy/core": "^1.3.5",
-    "@smithy/fetch-http-handler": "^2.4.3",
-    "@smithy/hash-node": "^2.1.3",
-    "@smithy/invalid-dependency": "^2.1.3",
-    "@smithy/middleware-content-length": "^2.1.3",
-    "@smithy/middleware-endpoint": "^2.4.4",
-    "@smithy/middleware-retry": "^2.1.4",
-    "@smithy/middleware-serde": "^2.1.3",
-    "@smithy/middleware-stack": "^2.1.3",
-    "@smithy/node-config-provider": "^2.2.4",
-    "@smithy/node-http-handler": "^2.4.1",
-    "@smithy/protocol-http": "^3.2.1",
-    "@smithy/smithy-client": "^2.4.2",
-    "@smithy/types": "^2.10.1",
-    "@smithy/url-parser": "^2.1.3",
-    "@smithy/util-base64": "^2.1.1",
+    "@smithy/config-resolver": "^2.1.5",
+    "@smithy/core": "^1.3.8",
+    "@smithy/fetch-http-handler": "^2.4.5",
+    "@smithy/hash-node": "^2.1.4",
+    "@smithy/invalid-dependency": "^2.1.4",
+    "@smithy/middleware-content-length": "^2.1.4",
+    "@smithy/middleware-endpoint": "^2.4.6",
+    "@smithy/middleware-retry": "^2.1.7",
+    "@smithy/middleware-serde": "^2.2.1",
+    "@smithy/middleware-stack": "^2.1.4",
+    "@smithy/node-config-provider": "^2.2.5",
+    "@smithy/node-http-handler": "^2.4.3",
+    "@smithy/protocol-http": "^3.2.2",
+    "@smithy/smithy-client": "^2.4.5",
+    "@smithy/types": "^2.11.0",
+    "@smithy/url-parser": "^2.1.4",
+    "@smithy/util-base64": "^2.2.1",
     "@smithy/util-body-length-browser": "^2.1.1",
-    "@smithy/util-body-length-node": "^2.2.1",
-    "@smithy/util-defaults-mode-browser": "^2.1.4",
-    "@smithy/util-defaults-mode-node": "^2.2.3",
-    "@smithy/util-endpoints": "^1.1.4",
-    "@smithy/util-middleware": "^2.1.3",
-    "@smithy/util-retry": "^2.1.3",
-    "@smithy/util-utf8": "^2.1.1",
+    "@smithy/util-body-length-node": "^2.2.2",
+    "@smithy/util-defaults-mode-browser": "^2.1.7",
+    "@smithy/util-defaults-mode-node": "^2.2.7",
+    "@smithy/util-endpoints": "^1.1.5",
+    "@smithy/util-middleware": "^2.1.4",
+    "@smithy/util-retry": "^2.1.4",
+    "@smithy/util-utf8": "^2.2.0",
     "tslib": "^2.5.0",
     "uuid": "^9.0.1"
   },

diff --git a/clients/client-account/package.json b/clients/client-account/package.json
@@ -32,31 +32,31 @@
     "@aws-sdk/util-endpoints": "*",
     "@aws-sdk/util-user-agent-browser": "*",
     "@aws-sdk/util-user-agent-node": "*",
-    "@smithy/config-resolver": "^2.1.4",
-    "@smithy/core": "^1.3.5",
-    "@smithy/fetch-http-handler": "^2.4.3",
-    "@smithy/hash-node": "^2.1.3",
-    "@smithy/invalid-dependency": "^2.1.3",
-    "@smithy/middleware-content-length": "^2.1.3",
-    "@smithy/middleware-endpoint": "^2.4.4",
-    "@smithy/middleware-retry": "^2.1.4",
-    "@smithy/middleware-serde": "^2.1.3",
-    "@smithy/middleware-stack": "^2.1.3",
-    "@smithy/node-config-provider": "^2.2.4",
-    "@smithy/node-http-handler": "^2.4.1",
-    "@smithy/protocol-http": "^3.2.1",
-    "@smithy/smithy-client": "^2.4.2",
-    "@smithy/types": "^2.10.1",
-    "@smithy/url-parser": "^2.1.3",
-    "@smithy/util-base64": "^2.1.1",
+    "@smithy/config-resolver": "^2.1.5",
+    "@smithy/core": "^1.3.8",
+    "@smithy/fetch-http-handler": "^2.4.5",
+    "@smithy/hash-node": "^2.1.4",
+    "@smithy/invalid-dependency": "^2.1.4",
+    "@smithy/middleware-content-length": "^2.1.4",
+    "@smithy/middleware-endpoint": "^2.4.6",
+    "@smithy/middleware-retry": "^2.1.7",
+    "@smithy/middleware-serde": "^2.2.1",
+    "@smithy/middleware-stack": "^2.1.4",
+    "@smithy/node-config-provider": "^2.2.5",
+    "@smithy/node-http-handler": "^2.4.3",
+    "@smithy/protocol-http": "^3.2.2",
+    "@smithy/smithy-client": "^2.4.5",
+    "@smithy/types": "^2.11.0",
+    "@smithy/url-parser": "^2.1.4",
+    "@smithy/util-base64": "^2.2.1",
     "@smithy/util-body-length-browser": "^2.1.1",
-    "@smithy/util-body-length-node": "^2.2.1",
-    "@smithy/util-defaults-mode-browser": "^2.1.4",
-    "@smithy/util-defaults-mode-node": "^2.2.3",
-    "@smithy/util-endpoints": "^1.1.4",
-    "@smithy/util-middleware": "^2.1.3",
-    "@smithy/util-retry": "^2.1.3",
-    "@smithy/util-utf8": "^2.1.1",
+    "@smithy/util-body-length-node": "^2.2.2",
+    "@smithy/util-defaults-mode-browser": "^2.1.7",
+    "@smithy/util-defaults-mode-node": "^2.2.7",
+    "@smithy/util-endpoints": "^1.1.5",
+    "@smithy/util-middleware": "^2.1.4",
+    "@smithy/util-retry": "^2.1.4",
+    "@smithy/util-utf8": "^2.2.0",
     "tslib": "^2.5.0"
   },
   "devDependencies": {

diff --git a/clients/client-acm-pca/package.json b/clients/client-acm-pca/package.json
@@ -32,32 +32,32 @@
     "@aws-sdk/util-endpoints": "*",
     "@aws-sdk/util-user-agent-browser": "*",
     "@aws-sdk/util-user-agent-node": "*",
-    "@smithy/config-resolver": "^2.1.4",
-    "@smithy/core": "^1.3.5",
-    "@smithy/fetch-http-handler": "^2.4.3",
-    "@smithy/hash-node": "^2.1.3",
-    "@smithy/invalid-dependency": "^2.1.3",
-    "@smithy/middleware-content-length": "^2.1.3",
-    "@smithy/middleware-endpoint": "^2.4.4",
-    "@smithy/middleware-retry": "^2.1.4",
-    "@smithy/middleware-serde": "^2.1.3",
-    "@smithy/middleware-stack": "^2.1.3",
-    "@smithy/node-config-provider": "^2.2.4",
-    "@smithy/node-http-handler": "^2.4.1",
-    "@smithy/protocol-http": "^3.2.1",
-    "@smithy/smithy-client": "^2.4.2",
-    "@smithy/types": "^2.10.1",
-    "@smithy/url-parser": "^2.1.3",
-    "@smithy/util-base64": "^2.1.1",
+    "@smithy/config-resolver": "^2.1.5",
+    "@smithy/core": "^1.3.8",
+    "@smithy/fetch-http-handler": "^2.4.5",
+    "@smithy/hash-node": "^2.1.4",
+    "@smithy/invalid-dependency": "^2.1.4",
+    "@smithy/middleware-content-length": "^2.1.4",
+    "@smithy/middleware-endpoint": "^2.4.6",
+    "@smithy/middleware-retry": "^2.1.7",
+    "@smithy/middleware-serde": "^2.2.1",
+    "@smithy/middleware-stack": "^2.1.4",
+    "@smithy/node-config-provider": "^2.2.5",
+    "@smithy/node-http-handler": "^2.4.3",
+    "@smithy/protocol-http": "^3.2.2",
+    "@smithy/smithy-client": "^2.4.5",
+    "@smithy/types": "^2.11.0",
+    "@smithy/url-parser": "^2.1.4",
+    "@smithy/util-base64": "^2.2.1",
     "@smithy/util-body-length-browser": "^2.1.1",
-    "@smithy/util-body-length-node": "^2.2.1",
-    "@smithy/util-defaults-mode-browser": "^2.1.4",
-    "@smithy/util-defaults-mode-node": "^2.2.3",
-    "@smithy/util-endpoints": "^1.1.4",
-    "@smithy/util-middleware": "^2.1.3",
-    "@smithy/util-retry": "^2.1.3",
-    "@smithy/util-utf8": "^2.1.1",
-    "@smithy/util-waiter": "^2.1.3",
+    "@smithy/util-body-length-node": "^2.2.2",
+    "@smithy/util-defaults-mode-browser": "^2.1.7",
+    "@smithy/util-defaults-mode-node": "^2.2.7",
+    "@smithy/util-endpoints": "^1.1.5",
+    "@smithy/util-middleware": "^2.1.4",
+    "@smithy/util-retry": "^2.1.4",
+    "@smithy/util-utf8": "^2.2.0",
+    "@smithy/util-waiter": "^2.1.4",
     "tslib": "^2.5.0"
   },
   "devDependencies": {

diff --git a/clients/client-acm-pca/src/commands/ImportCertificateAuthorityCertificateCommand.ts b/clients/client-acm-pca/src/commands/ImportCertificateAuthorityCertificateCommand.ts
@@ -168,8 +168,8 @@ export interface ImportCertificateAuthorityCertificateCommandOutput extends __Me
  * const client = new ACMPCAClient(config);
  * const input = { // ImportCertificateAuthorityCertificateRequest
  *   CertificateAuthorityArn: "STRING_VALUE", // required
- *   Certificate: "BLOB_VALUE", // required
- *   CertificateChain: "BLOB_VALUE",
+ *   Certificate: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")   // required
+ *   CertificateChain: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
  * };
  * const command = new ImportCertificateAuthorityCertificateCommand(input);
  * const response = await client.send(command);

diff --git a/clients/client-acm-pca/src/commands/IssueCertificateCommand.ts b/clients/client-acm-pca/src/commands/IssueCertificateCommand.ts
@@ -146,7 +146,7 @@ export interface IssueCertificateCommandOutput extends IssueCertificateResponse,
  *     },
  *   },
  *   CertificateAuthorityArn: "STRING_VALUE", // required
- *   Csr: "BLOB_VALUE", // required
+ *   Csr: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")   // required
  *   SigningAlgorithm: "SHA256WITHECDSA" || "SHA384WITHECDSA" || "SHA512WITHECDSA" || "SHA256WITHRSA" || "SHA384WITHRSA" || "SHA512WITHRSA", // required
  *   TemplateArn: "STRING_VALUE",
  *   Validity: { // Validity

diff --git a/clients/client-acm/package.json b/clients/client-acm/package.json
@@ -32,32 +32,32 @@
     "@aws-sdk/util-endpoints": "*",
     "@aws-sdk/util-user-agent-browser": "*",
     "@aws-sdk/util-user-agent-node": "*",
-    "@smithy/config-resolver": "^2.1.4",
-    "@smithy/core": "^1.3.5",
-    "@smithy/fetch-http-handler": "^2.4.3",
-    "@smithy/hash-node": "^2.1.3",
-    "@smithy/invalid-dependency": "^2.1.3",
-    "@smithy/middleware-content-length": "^2.1.3",
-    "@smithy/middleware-endpoint": "^2.4.4",
-    "@smithy/middleware-retry": "^2.1.4",
-    "@smithy/middleware-serde": "^2.1.3",
-    "@smithy/middleware-stack": "^2.1.3",
-    "@smithy/node-config-provider": "^2.2.4",
-    "@smithy/node-http-handler": "^2.4.1",
-    "@smithy/protocol-http": "^3.2.1",
-    "@smithy/smithy-client": "^2.4.2",
-    "@smithy/types": "^2.10.1",
-    "@smithy/url-parser": "^2.1.3",
-    "@smithy/util-base64": "^2.1.1",
+    "@smithy/config-resolver": "^2.1.5",
+    "@smithy/core": "^1.3.8",
+    "@smithy/fetch-http-handler": "^2.4.5",
+    "@smithy/hash-node": "^2.1.4",
+    "@smithy/invalid-dependency": "^2.1.4",
+    "@smithy/middleware-content-length": "^2.1.4",
+    "@smithy/middleware-endpoint": "^2.4.6",
+    "@smithy/middleware-retry": "^2.1.7",
+    "@smithy/middleware-serde": "^2.2.1",
+    "@smithy/middleware-stack": "^2.1.4",
+    "@smithy/node-config-provider": "^2.2.5",
+    "@smithy/node-http-handler": "^2.4.3",
+    "@smithy/protocol-http": "^3.2.2",
+    "@smithy/smithy-client": "^2.4.5",
+    "@smithy/types": "^2.11.0",
+    "@smithy/url-parser": "^2.1.4",
+    "@smithy/util-base64": "^2.2.1",
     "@smithy/util-body-length-browser": "^2.1.1",
-    "@smithy/util-body-length-node": "^2.2.1",
-    "@smithy/util-defaults-mode-browser": "^2.1.4",
-    "@smithy/util-defaults-mode-node": "^2.2.3",
-    "@smithy/util-endpoints": "^1.1.4",
-    "@smithy/util-middleware": "^2.1.3",
-    "@smithy/util-retry": "^2.1.3",
-    "@smithy/util-utf8": "^2.1.1",
-    "@smithy/util-waiter": "^2.1.3",
+    "@smithy/util-body-length-node": "^2.2.2",
+    "@smithy/util-defaults-mode-browser": "^2.1.7",
+    "@smithy/util-defaults-mode-node": "^2.2.7",
+    "@smithy/util-endpoints": "^1.1.5",
+    "@smithy/util-middleware": "^2.1.4",
+    "@smithy/util-retry": "^2.1.4",
+    "@smithy/util-utf8": "^2.2.0",
+    "@smithy/util-waiter": "^2.1.4",
     "tslib": "^2.5.0"
   },
   "devDependencies": {

diff --git a/clients/client-acm/src/commands/ExportCertificateCommand.ts b/clients/client-acm/src/commands/ExportCertificateCommand.ts
@@ -48,7 +48,7 @@ export interface ExportCertificateCommandOutput extends ExportCertificateRespons
  * const client = new ACMClient(config);
  * const input = { // ExportCertificateRequest
  *   CertificateArn: "STRING_VALUE", // required
- *   Passphrase: "BLOB_VALUE", // required
+ *   Passphrase: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")   // required
  * };
  * const command = new ExportCertificateCommand(input);
  * const response = await client.send(command);

diff --git a/clients/client-acm/src/commands/ImportCertificateCommand.ts b/clients/client-acm/src/commands/ImportCertificateCommand.ts
@@ -108,9 +108,9 @@ export interface ImportCertificateCommandOutput extends ImportCertificateRespons
  * const client = new ACMClient(config);
  * const input = { // ImportCertificateRequest
  *   CertificateArn: "STRING_VALUE",
- *   Certificate: "BLOB_VALUE", // required
- *   PrivateKey: "BLOB_VALUE", // required
- *   CertificateChain: "BLOB_VALUE",
+ *   Certificate: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")   // required
+ *   PrivateKey: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")   // required
+ *   CertificateChain: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
  *   Tags: [ // TagList
  *     { // Tag
  *       Key: "STRING_VALUE", // required

diff --git a/clients/client-alexa-for-business/package.json b/clients/client-alexa-for-business/package.json
@@ -32,31 +32,31 @@
     "@aws-sdk/util-endpoints": "*",
     "@aws-sdk/util-user-agent-browser": "*",
     "@aws-sdk/util-user-agent-node": "*",
-    "@smithy/config-resolver": "^2.1.4",
-    "@smithy/core": "^1.3.5",
-    "@smithy/fetch-http-handler": "^2.4.3",
-    "@smithy/hash-node": "^2.1.3",
-    "@smithy/invalid-dependency": "^2.1.3",
-    "@smithy/middleware-content-length": "^2.1.3",
-    "@smithy/middleware-endpoint": "^2.4.4",
-    "@smithy/middleware-retry": "^2.1.4",
-    "@smithy/middleware-serde": "^2.1.3",
-    "@smithy/middleware-stack": "^2.1.3",
-    "@smithy/node-config-provider": "^2.2.4",
-    "@smithy/node-http-handler": "^2.4.1",
-    "@smithy/protocol-http": "^3.2.1",
-    "@smithy/smithy-client": "^2.4.2",
-    "@smithy/types": "^2.10.1",
-    "@smithy/url-parser": "^2.1.3",
-    "@smithy/util-base64": "^2.1.1",
+    "@smithy/config-resolver": "^2.1.5",
+    "@smithy/core": "^1.3.8",
+    "@smithy/fetch-http-handler": "^2.4.5",
+    "@smithy/hash-node": "^2.1.4",
+    "@smithy/invalid-dependency": "^2.1.4",
+    "@smithy/middleware-content-length": "^2.1.4",
+    "@smithy/middleware-endpoint": "^2.4.6",
+    "@smithy/middleware-retry": "^2.1.7",
+    "@smithy/middleware-serde": "^2.2.1",
+    "@smithy/middleware-stack": "^2.1.4",
+    "@smithy/node-config-provider": "^2.2.5",
+    "@smithy/node-http-handler": "^2.4.3",
+    "@smithy/protocol-http": "^3.2.2",
+    "@smithy/smithy-client": "^2.4.5",
+    "@smithy/types": "^2.11.0",
+    "@smithy/url-parser": "^2.1.4",
+    "@smithy/util-base64": "^2.2.1",
     "@smithy/util-body-length-browser": "^2.1.1",
-    "@smithy/util-body-length-node": "^2.2.1",
-    "@smithy/util-defaults-mode-browser": "^2.1.4",
-    "@smithy/util-defaults-mode-node": "^2.2.3",
-    "@smithy/util-endpoints": "^1.1.4",
-    "@smithy/util-middleware": "^2.1.3",
-    "@smithy/util-retry": "^2.1.3",
-    "@smithy/util-utf8": "^2.1.1",
+    "@smithy/util-body-length-node": "^2.2.2",
+    "@smithy/util-defaults-mode-browser": "^2.1.7",
+    "@smithy/util-defaults-mode-node": "^2.2.7",
+    "@smithy/util-endpoints": "^1.1.5",
+    "@smithy/util-middleware": "^2.1.4",
+    "@smithy/util-retry": "^2.1.4",
+    "@smithy/util-utf8": "^2.2.0",
     "tslib": "^2.5.0",
     "uuid": "^9.0.1"
   },

diff --git a/clients/client-amp/package.json b/clients/client-amp/package.json
@@ -32,32 +32,32 @@
     "@aws-sdk/util-endpoints": "*",
     "@aws-sdk/util-user-agent-browser": "*",
     "@aws-sdk/util-user-agent-node": "*",
-    "@smithy/config-resolver": "^2.1.4",
-    "@smithy/core": "^1.3.5",
-    "@smithy/fetch-http-handler": "^2.4.3",
-    "@smithy/hash-node": "^2.1.3",
-    "@smithy/invalid-dependency": "^2.1.3",
-    "@smithy/middleware-content-length": "^2.1.3",
-    "@smithy/middleware-endpoint": "^2.4.4",
-    "@smithy/middleware-retry": "^2.1.4",
-    "@smithy/middleware-serde": "^2.1.3",
-    "@smithy/middleware-stack": "^2.1.3",
-    "@smithy/node-config-provider": "^2.2.4",
-    "@smithy/node-http-handler": "^2.4.1",
-    "@smithy/protocol-http": "^3.2.1",
-    "@smithy/smithy-client": "^2.4.2",
-    "@smithy/types": "^2.10.1",
-    "@smithy/url-parser": "^2.1.3",
-    "@smithy/util-base64": "^2.1.1",
+    "@smithy/config-resolver": "^2.1.5",
+    "@smithy/core": "^1.3.8",
+    "@smithy/fetch-http-handler": "^2.4.5",
+    "@smithy/hash-node": "^2.1.4",
+    "@smithy/invalid-dependency": "^2.1.4",
+    "@smithy/middleware-content-length": "^2.1.4",
+    "@smithy/middleware-endpoint": "^2.4.6",
+    "@smithy/middleware-retry": "^2.1.7",
+    "@smithy/middleware-serde": "^2.2.1",
+    "@smithy/middleware-stack": "^2.1.4",
+    "@smithy/node-config-provider": "^2.2.5",
+    "@smithy/node-http-handler": "^2.4.3",
+    "@smithy/protocol-http": "^3.2.2",
+    "@smithy/smithy-client": "^2.4.5",
+    "@smithy/types": "^2.11.0",
+    "@smithy/url-parser": "^2.1.4",
+    "@smithy/util-base64": "^2.2.1",
     "@smithy/util-body-length-browser": "^2.1.1",
-    "@smithy/util-body-length-node": "^2.2.1",
-    "@smithy/util-defaults-mode-browser": "^2.1.4",
-    "@smithy/util-defaults-mode-node": "^2.2.3",
-    "@smithy/util-endpoints": "^1.1.4",
-    "@smithy/util-middleware": "^2.1.3",
-    "@smithy/util-retry": "^2.1.3",
-    "@smithy/util-utf8": "^2.1.1",
-    "@smithy/util-waiter": "^2.1.3",
+    "@smithy/util-body-length-node": "^2.2.2",
+    "@smithy/util-defaults-mode-browser": "^2.1.7",
+    "@smithy/util-defaults-mode-node": "^2.2.7",
+    "@smithy/util-endpoints": "^1.1.5",
+    "@smithy/util-middleware": "^2.1.4",
+    "@smithy/util-retry": "^2.1.4",
+    "@smithy/util-utf8": "^2.2.0",
+    "@smithy/util-waiter": "^2.1.4",
     "tslib": "^2.5.0",
     "uuid": "^9.0.1"
   },

diff --git a/clients/client-amp/src/commands/CreateAlertManagerDefinitionCommand.ts b/clients/client-amp/src/commands/CreateAlertManagerDefinitionCommand.ts
@@ -45,7 +45,7 @@ export interface CreateAlertManagerDefinitionCommandOutput
  * const client = new AmpClient(config);
  * const input = { // CreateAlertManagerDefinitionRequest
  *   workspaceId: "STRING_VALUE", // required
- *   data: "BLOB_VALUE", // required
+ *   data: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")   // required
  *   clientToken: "STRING_VALUE",
  * };
  * const command = new CreateAlertManagerDefinitionCommand(input);