From cfcaea3bd3f836dddc547288fb57691d7fbe21db Mon Sep 17 00:00:00 2001 From: Nikolai Biriukov Date: Tue, 3 Oct 2023 20:10:50 +0200 Subject: [PATCH] Added docs for edge case in Sigv4Signer (#622) * Added docs for edge case in Sigv4Signer Signed-off-by: nikolai biriukov * Added PR to changelog Signed-off-by: nikolai biriukov --------- Signed-off-by: nikolai biriukov --- CHANGELOG.md | 1 + USER_GUIDE.md | 1 + 2 files changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index ad6b0afeb..6972949ed 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) ## [Unreleased] ### Added - Added Security API +- Documentation for edge-case in Sigv4Signer ([#622](https://github.com/opensearch-project/opensearch-js/pull/622)) ### Dependencies - Bumps `rimraf` from 5.0.0 to 5.0.5 - Bumps `eslint` from 8.41.0 to 8.50.0 diff --git a/USER_GUIDE.md b/USER_GUIDE.md index 0f2e52dca..344cc694c 100644 --- a/USER_GUIDE.md +++ b/USER_GUIDE.md @@ -65,6 +65,7 @@ const client = new Client({ getCredentials: () => new Promise((resolve, reject) => { // Any other method to acquire a new Credentials object can be used. + // If you use profiles, make sure to pass role assumer, or use default provider fromNodeProviderChain AWS.config.getCredentials((err, credentials) => { if (err) { reject(err);