chore: Merge release into main (#13087)

aws-amplify · Mar 5, 2024 · dc4ef5e · dc4ef5e
2 parents adb5876 + 8366f5f
commit dc4ef5e
Show file tree

Hide file tree

Showing 321 changed files with 963 additions and 780 deletions.
diff --git a/docs/api/assets/navigation.js b/docs/api/assets/navigation.js
diff --git a/docs/api/assets/search.js b/docs/api/assets/search.js
diff --git a/docs/api/classes/_aws_amplify_adapter_nextjs.api._Reference_Types_.AmplifyClass.html b/docs/api/classes/_aws_amplify_adapter_nextjs.api._Reference_Types_.AmplifyClass.html
diff --git a/docs/api/classes/aws_amplify.adapterCore._Reference_Types_.AuthClass.html b/docs/api/classes/aws_amplify.adapterCore._Reference_Types_.AuthClass.html
diff --git a/docs/api/classes/aws_amplify.auth_cognito.DefaultTokenStore.html b/docs/api/classes/aws_amplify.auth_cognito.DefaultTokenStore.html
diff --git a/docs/api/classes/aws_amplify.auth_cognito.TokenOrchestrator.html b/docs/api/classes/aws_amplify.auth_cognito.TokenOrchestrator.html
diff --git a/...api/classes/aws_amplify.auth_cognito._Reference_Types_.CognitoUserPoolsTokenProvider.html b/...api/classes/aws_amplify.auth_cognito._Reference_Types_.CognitoUserPoolsTokenProvider.html
diff --git a/...s.index._Reference_Types_.AuthConfig.html → ...ference_Types_.CodeGenConnectionType.html b/...s.index._Reference_Types_.AuthConfig.html → ...ference_Types_.CodeGenConnectionType.html
diff --git a/docs/api/functions/_aws_amplify_adapter_nextjs.index.createServerRunner.html b/docs/api/functions/_aws_amplify_adapter_nextjs.index.createServerRunner.html
@@ -1,7 +1,7 @@
 <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>createServerRunner | Amplify JS API Documentation</title><meta name="description" content="Documentation for Amplify JS API Documentation"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><link rel="stylesheet" href="../assets/custom.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><link rel="icon" href="../favicon.ico" />
-</head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="https://docs.amplify.aws/">Library Documentation</a><a href="https://www.npmjs.com/package/aws-amplify">NPM</a><a href="https://github.com/aws-amplify/amplify-js">GitHub</a></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Amplify JS API Documentation</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">Amplify JS API Documentation</a></li><li><a href="../modules/_aws_amplify_adapter_nextjs.html">@aws-amplify/adapter-nextjs</a></li><li><a href="../modules/_aws_amplify_adapter_nextjs.index.html">index</a></li><li><a href="_aws_amplify_adapter_nextjs.index.createServerRunner.html">createServerRunner</a></li></ul><h1>Function createServerRunner</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createServerRunner" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Server<wbr/>Runner</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_aws_amplify_adapter_nextjs.index._Reference_Types_.CreateServerRunnerOutput.html" class="tsd-signature-type tsd-kind-interface">CreateServerRunnerOutput</a><a href="#createServerRunner" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates the <code>runWithAmplifyServerContext</code> function to run Amplify server side APIs in an isolated request context.</p>
-</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">input</span>: <a href="../interfaces/_aws_amplify_adapter_nextjs.index._Reference_Types_.CreateServerRunnerInput.html" class="tsd-signature-type tsd-kind-interface">CreateServerRunnerInput</a></h5><div class="tsd-comment tsd-typography"><p>The input used to create the <code>runWithAmplifyServerContext</code> function.</p>
-</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/_aws_amplify_adapter_nextjs.index._Reference_Types_.CreateServerRunnerOutput.html" class="tsd-signature-type tsd-kind-interface">CreateServerRunnerOutput</a></h4><p>An object that contains the <code>runWithAmplifyServerContext</code> function.</p>
+</head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="https://docs.amplify.aws/">Library Documentation</a><a href="https://www.npmjs.com/package/aws-amplify">NPM</a><a href="https://github.com/aws-amplify/amplify-js">GitHub</a></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Amplify JS API Documentation</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">Amplify JS API Documentation</a></li><li><a href="../modules/_aws_amplify_adapter_nextjs.html">@aws-amplify/adapter-nextjs</a></li><li><a href="../modules/_aws_amplify_adapter_nextjs.index.html">index</a></li><li><a href="_aws_amplify_adapter_nextjs.index.createServerRunner.html">createServerRunner</a></li></ul><h1>Function createServerRunner</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createServerRunner" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Server<wbr/>Runner</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_aws_amplify_adapter_nextjs.index.NextServer.CreateServerRunnerOutput.html" class="tsd-signature-type tsd-kind-interface">CreateServerRunnerOutput</a><a href="#createServerRunner" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates the <code>runWithAmplifyServerContext</code> function to run Amplify server side APIs in an isolated request context.</p>
+</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">input</span>: <a href="../interfaces/_aws_amplify_adapter_nextjs.index.NextServer.CreateServerRunnerInput.html" class="tsd-signature-type tsd-kind-interface">CreateServerRunnerInput</a></h5><div class="tsd-comment tsd-typography"><p>The input used to create the <code>runWithAmplifyServerContext</code> function.</p>
+</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/_aws_amplify_adapter_nextjs.index.NextServer.CreateServerRunnerOutput.html" class="tsd-signature-type tsd-kind-interface">CreateServerRunnerOutput</a></h4><p>An object that contains the <code>runWithAmplifyServerContext</code> function.</p>
 <div class="tsd-comment tsd-typography"><h4>Remarks</h4><p>This function should be called only once; you can use the returned <code>runWithAmplifyServerContext</code> across
 your codebase.</p>
 <h4>Example</h4><pre><code class="language-ts"><span class="hl-1">import</span><span class="hl-2"> { </span><span class="hl-4">createServerRunner</span><span class="hl-2"> } </span><span class="hl-1">from</span><span class="hl-2"> </span><span class="hl-5">&#39;@aws-amplify/adapter-nextjs&#39;</span><span class="hl-2">;</span><br/><span class="hl-1">import</span><span class="hl-2"> </span><span class="hl-4">config</span><span class="hl-2"> </span><span class="hl-1">from</span><span class="hl-2"> </span><span class="hl-5">&#39;./amplifyconfiguration.json&#39;</span><span class="hl-2">;</span><br/><br/><span class="hl-1">export</span><span class="hl-2"> </span><span class="hl-6">const</span><span class="hl-2"> { </span><span class="hl-7">runWithAmplifyServerContext</span><span class="hl-2"> } = </span><span class="hl-3">createServerRunner</span><span class="hl-2">({ </span><span class="hl-4">config</span><span class="hl-2"> })</span>

diff --git a/docs/api/functions/_aws_amplify_adapter_nextjs.utils.createRunWithAmplifyServerContext.html b/docs/api/functions/_aws_amplify_adapter_nextjs.utils.createRunWithAmplifyServerContext.html
diff --git a/docs/api/functions/_aws_amplify_adapter_nextjs.utils.getAmplifyConfig.html b/docs/api/functions/_aws_amplify_adapter_nextjs.utils.getAmplifyConfig.html
diff --git a/docs/api/functions/aws_amplify.api.get.html b/docs/api/functions/aws_amplify.api.get.html
diff --git a/docs/api/functions/aws_amplify.api.patch.html b/docs/api/functions/aws_amplify.api.patch.html
diff --git a/docs/api/functions/aws_amplify.api.post.html b/docs/api/functions/aws_amplify.api.post.html
diff --git a/docs/api/functions/aws_amplify.api.put.html b/docs/api/functions/aws_amplify.api.put.html
diff --git a/docs/api/functions/aws_amplify.auth.fetchAuthSession.html b/docs/api/functions/aws_amplify.auth.fetchAuthSession.html
diff --git a/docs/api/functions/aws_amplify.auth.fetchMFAPreference.html b/docs/api/functions/aws_amplify.auth.fetchMFAPreference.html
@@ -1,6 +1,6 @@
 <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>fetchMFAPreference | Amplify JS API Documentation</title><meta name="description" content="Documentation for Amplify JS API Documentation"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><link rel="stylesheet" href="../assets/custom.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><link rel="icon" href="../favicon.ico" />
-</head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="https://docs.amplify.aws/">Library Documentation</a><a href="https://www.npmjs.com/package/aws-amplify">NPM</a><a href="https://github.com/aws-amplify/amplify-js">GitHub</a></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Amplify JS API Documentation</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">Amplify JS API Documentation</a></li><li><a href="../modules/aws_amplify.html">aws-amplify</a></li><li><a href="../modules/aws_amplify.auth.html">auth</a></li><li><a href="aws_amplify.auth.fetchMFAPreference.html">fetchMFAPreference</a></li></ul><h1>Function fetchMFAPreference</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="fetchMFAPreference" class="tsd-anchor"></a><span class="tsd-kind-call-signature">fetchMFAPreference</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/aws_amplify.auth.FetchMFAPreferenceOutput.html" class="tsd-signature-type tsd-kind-type-alias">FetchMFAPreferenceOutput</a><span class="tsd-signature-symbol">&gt;</span><a href="#fetchMFAPreference" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Fetches the preferred MFA setting and enabled MFA settings for the user.</p>
-</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/aws_amplify.auth.FetchMFAPreferenceOutput.html" class="tsd-signature-type tsd-kind-type-alias">FetchMFAPreferenceOutput</a><span class="tsd-signature-symbol">&gt;</span></h4><p>FetchMFAPreferenceOutput</p>
+</head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="https://docs.amplify.aws/">Library Documentation</a><a href="https://www.npmjs.com/package/aws-amplify">NPM</a><a href="https://github.com/aws-amplify/amplify-js">GitHub</a></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Amplify JS API Documentation</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">Amplify JS API Documentation</a></li><li><a href="../modules/aws_amplify.html">aws-amplify</a></li><li><a href="../modules/aws_amplify.auth.html">auth</a></li><li><a href="aws_amplify.auth.fetchMFAPreference.html">fetchMFAPreference</a></li></ul><h1>Function fetchMFAPreference</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="fetchMFAPreference" class="tsd-anchor"></a><span class="tsd-kind-call-signature">fetchMFAPreference</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/aws_amplify.auth.FetchMFAPreferenceOutput.html" class="tsd-signature-type tsd-kind-interface">FetchMFAPreferenceOutput</a><span class="tsd-signature-symbol">&gt;</span><a href="#fetchMFAPreference" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Fetches the preferred MFA setting and enabled MFA settings for the user.</p>
+</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/aws_amplify.auth.FetchMFAPreferenceOutput.html" class="tsd-signature-type tsd-kind-interface">FetchMFAPreferenceOutput</a><span class="tsd-signature-symbol">&gt;</span></h4><p>FetchMFAPreferenceOutput</p>
 <div class="tsd-comment tsd-typography"><h4>Throws</h4><p>-GetUserException : error thrown when the service fails to fetch MFA preference
 and settings.</p>
 <h4>Throws</h4><p>AuthTokenConfigException - Thrown when the token provider config is invalid.</p>