Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add more inline structural type hints for blobs and streaming blobs #5864

Merged
merged 4 commits into from
Mar 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
48 changes: 24 additions & 24 deletions clients/client-accessanalyzer/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
},
Expand Down
48 changes: 24 additions & 24 deletions clients/client-account/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
50 changes: 25 additions & 25 deletions clients/client-acm-pca/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
50 changes: 25 additions & 25 deletions clients/client-acm/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down
6 changes: 3 additions & 3 deletions clients/client-acm/src/commands/ImportCertificateCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
48 changes: 24 additions & 24 deletions clients/client-alexa-for-business/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
},
Expand Down
50 changes: 25 additions & 25 deletions clients/client-amp/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down