improved documentation on S3 getSignedUrl operation

aws · Jan 7, 2019 · 050c5ac · 050c5ac
1 parent c211d41
commit 050c5ac
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/.changes/next-release/feature-s3-8b0c0656.json b/.changes/next-release/feature-s3-8b0c0656.json
@@ -0,0 +1,5 @@
+{
+  "type": "feature",
+  "category": "s3",
+  "description": "Improved sigv4 documentation on getSignedUrl operation"
+}
diff --git a/lib/services/s3.js b/lib/services/s3.js
@@ -744,6 +744,9 @@ AWS.util.update(AWS.S3.prototype, {
    *   `ContentLength`, or `Tagging` must be provided as headers when sending a
    *   request. If you are using pre-signed URLs to upload from a browser and
    *   need to use these fields, see {createPresignedPost}.
+   * @note signatureVersion v4 is required for Range to be included as a signed
+   *   header. You must use signatureVersion v4 to enforce the inclusion and
+   *   exact matching of header and signed URL for the Range operation parameter.
    * @param operation [String] the name of the operation to call
    * @param params [map] parameters to pass to the operation. See the given
    *   operation for the expected operation parameters. In addition, you can