From 050c5ac8202f4a44177b11620220dd228fc0f462 Mon Sep 17 00:00:00 2001 From: Chase Coalwell Date: Mon, 7 Jan 2019 11:08:11 -0800 Subject: [PATCH] improved documentation on S3 getSignedUrl operation --- .changes/next-release/feature-s3-8b0c0656.json | 5 +++++ lib/services/s3.js | 3 +++ 2 files changed, 8 insertions(+) create mode 100644 .changes/next-release/feature-s3-8b0c0656.json diff --git a/.changes/next-release/feature-s3-8b0c0656.json b/.changes/next-release/feature-s3-8b0c0656.json new file mode 100644 index 0000000000..df3aa0be91 --- /dev/null +++ b/.changes/next-release/feature-s3-8b0c0656.json @@ -0,0 +1,5 @@ +{ + "type": "feature", + "category": "s3", + "description": "Improved sigv4 documentation on getSignedUrl operation" +} \ No newline at end of file diff --git a/lib/services/s3.js b/lib/services/s3.js index 3dcd8ff615..e959b42f69 100644 --- 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