create a type alias for http payloads

[kuhe]

Describe the feature

Currently payloads' runtime-acceptable type depends on the request handler implementation. To allow for multiple possible implementations we have a wide http payload type, e.g.

string | Blob | Uint8Array | Readable | ReadableStream<any> | Buffer | undefined

for PutObjectCommandInput.Body.

This is confusing for users, and more-so now that Node.js has made many previously browser-only types available.

Use Case

improve documentation ease of use for http payload types

Proposed Solution

Create a type alias for the union of blob types.

The type alias will have attached documentation describing when each of the union types is acceptable or preferred.

Similar to: https://github.com/aws/aws-sdk-js-v3/blob/main/packages/types/src/blob/blob-types.ts

/**

Write docs here explaining what types are available in what environments (corresponding to request handlers).
 
*/
export type StreamingPayloadTypes = string | Blob | Uint8Array | Readable | ReadableStream<any> | Buffer

Codegen the alias to operations with streaming body inputs so that the documentation is easy to access.

Other Information

No response

Acknowledgements

• I may be able to implement this feature request
• This feature might incur a breaking change

SDK version used

Environment details (OS name and version, etc.)

[kuhe]

Related: #4930

[kuhe]

related #4973

[kuhe]

related request to allow transformation to node stream: #4720

[kuhe]

PRs:
smithy-lang/smithy-typescript#835
smithy-lang/smithy-typescript#836

TBD: JSv3 codegen

[github-actions]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs and link to relevant comments in this thread.