From d05c0ca67c12e04fa2792d8456ea92954f34be76 Mon Sep 17 00:00:00 2001
From: AllanFly120 <zheallan@amazon.com>
Date: Tue, 9 Jul 2019 11:51:27 -0700
Subject: [PATCH] doc: not to use object stream in managed upload (#2761)

---
 lib/s3/managed_upload.js | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/lib/s3/managed_upload.js b/lib/s3/managed_upload.js
index 40355d4f30..0c65bd081d 100644
--- a/lib/s3/managed_upload.js
+++ b/lib/s3/managed_upload.js
@@ -41,6 +41,8 @@ AWS.S3.ManagedUpload = AWS.util.inherit({
    * Creates a managed upload object with a set of configuration options.
    *
    * @note A "Body" parameter is required to be set prior to calling {send}.
+   * @note In Node.js, sending "Body" as {https://nodejs.org/dist/latest/docs/api/stream.html#stream_object_mode object-mode stream}
+   *   may result in upload hangs. Using buffer stream is preferable.
    * @option options params [map] a map of parameters to pass to the upload
    *   requests. The "Body" parameter is required to be specified either on
    *   the service or in the params option.