diff --git a/.circleci/config.yml b/.circleci/config.yml index 6978303b8a2..280e8ae043d 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -1592,15 +1592,25 @@ jobs: - amplify-ssh-deps-{{ .Branch }} - amplify-ssh-deps - run: - name: 'Post-release steps' + name: 'Update roll-back infrastructure' command: | git config --global user.email $GITHUB_EMAIL git config --global user.name $GITHUB_USER git pull origin release - yarn workspace @aws-amplify/core build - git add ./packages/core/src/Platform/version.ts - git commit -m "chore(release): update version.ts [ci skip]" + PUBLISH_COMMIT_HASH=$(git log -n 1 --pretty=format:"%H") + RELEASE_COMMIT_MESSAGE=$(git log -n 1 --skip 1 --pretty=oneline) + if [[ $RELEASE_COMMIT_MESSAGE = *release\(required\)* ]]; then git tag -f required-release $PUBLISH_COMMIT_HASH; fi + - run: + name: 'Update API documentation' + command: | + yarn run docs + git add ./docs/api/ + git commit -m "chore(release): update API docs [ci skip]" + - run: + name: 'Push post release changes' + command: | git push origin release + git push -f origin required-release git push --force-with-lease origin release:main # Specifies the branches that can be considered releasable. @@ -2325,16 +2335,18 @@ workflows: - getting-started-smoke-test/web: name: Next.js - latest npx-command: create-next-app + npx-post: --use-npm --ts --tailwind --no-eslint --no-src-dir --no-app --import-alias "@/*"` framework: nextjs - main-file-path: pages/_app.js + main-file-path: pages/_app.tsx dev-start: dev build-dir: build ssr: true - getting-started-smoke-test/web: name: Next.js - next npx-command: create-next-app@canary + npx-post: --use-npm --ts --tailwind --no-eslint --no-src-dir --no-app --import-alias "@/*"` framework: nextjs - main-file-path: pages/_app.js + main-file-path: pages/_app.tsx dev-start: dev build-dir: build ssr: true @@ -2510,7 +2522,10 @@ orbs: no_output_timeout: 2m - run-with-retry: label: Install AmplifyJS - command: npm i -S aws-amplify && npm i -g wait-on serve + command: | + npm i -S aws-amplify + npm i -g wait-on serve + ~/amplify-js/.circleci/duplicates-npm.sh - run: name: Call Amplify library in code command: | diff --git a/.circleci/duplicates-npm.sh b/.circleci/duplicates-npm.sh new file mode 100644 index 00000000000..fb54ab6f690 --- /dev/null +++ b/.circleci/duplicates-npm.sh @@ -0,0 +1,17 @@ +#!/usr/bin/env bash + +# This script detects duplicated Amplify dependencies in the dependency graph (with NPM) +duplicatedDependencies=$( + npm ls -all 2>/dev/null | \ + grep -o -e '@\?aws-amplify[^ ]*' | \ + sort | uniq | \ + sed -E 's/^(@?[^@]+).*$/\1/g' | \ + uniq -d | sort +) + +if [ ! "$duplicatedDependencies" ]; then + echo "No duplicated Amplify dependencies detected." +else + echo "Duplicated Amplify dependencies detected: $duplicatedDependencies" + false +fi diff --git a/.github/ISSUE_TEMPLATE/1.bug_report.yaml b/.github/ISSUE_TEMPLATE/1.bug_report.yaml index 3e890e53ee9..ec21d2b2b40 100644 --- a/.github/ISSUE_TEMPLATE/1.bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/1.bug_report.yaml @@ -21,10 +21,7 @@ body: | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | | `amazon-cognito-identity-js` | [![version](https://img.shields.io/npm/v/amazon-cognito-identity-js/latest.svg)](https://www.npmjs.com/package/amazon-cognito-identity-js) | | `aws-amplify` | [![version](https://img.shields.io/npm/v/aws-amplify/latest.svg)](https://www.npmjs.com/package/aws-amplify) | - | `aws-amplify-angular` | [![version](https://img.shields.io/npm/v/aws-amplify-angular/latest.svg)](https://www.npmjs.com/package/aws-amplify-angular) | - | `aws-amplify-react` | [![version](https://img.shields.io/npm/v/aws-amplify-react/latest.svg)](https://www.npmjs.com/package/aws-amplify-react) | | `aws-amplify-react-native` | [![version](https://img.shields.io/npm/v/aws-amplify-react-native/latest.svg)](https://www.npmjs.com/package/aws-amplify-react-native) | - | `aws-amplify-vue` | [![version](https://img.shields.io/npm/v/aws-amplify-vue/latest.svg)](https://www.npmjs.com/package/aws-amplify-vue) | | `@aws-amplify/analytics` | [![version](https://img.shields.io/npm/v/@aws-amplify/analytics/latest.svg)](https://www.npmjs.com/package/@aws-amplify/analytics) | | `@aws-amplify/api` | [![version](https://img.shields.io/npm/v/@aws-amplify/api/latest.svg)](https://www.npmjs.com/package/@aws-amplify/api) | | `@aws-amplify/api-graphql` | [![version](https://img.shields.io/npm/v/@aws-amplify/api-graphql/latest.svg)](https://www.npmjs.com/package/@aws-amplify/api-graphql) | @@ -38,12 +35,6 @@ body: | `@aws-amplify/pubsub` | [![version](https://img.shields.io/npm/v/@aws-amplify/pubsub/latest.svg)](https://www.npmjs.com/package/@aws-amplify/pubsub) | | `@aws-amplify/pushnotification` | [![version](https://img.shields.io/npm/v/@aws-amplify/pushnotification/latest.svg)](https://www.npmjs.com/package/@aws-amplify/pushnotification) | | `@aws-amplify/storage` | [![version](https://img.shields.io/npm/v/@aws-amplify/storage/latest.svg)](https://www.npmjs.com/package/@aws-amplify/storage) | - | `@aws-amplify/ui` | [![version](https://img.shields.io/npm/v/@aws-amplify/ui/latest.svg)](https://www.npmjs.com/package/@aws-amplify/ui) | - | `@aws-amplify/ui-angular` | [![version](https://img.shields.io/npm/v/@aws-amplify/ui-angular/latest.svg)](https://www.npmjs.com/package/@aws-amplify/ui-angular) | - | `@aws-amplify/ui-components` | [![version](https://img.shields.io/npm/v/@aws-amplify/ui-components/latest.svg)](https://www.npmjs.com/package/@aws-amplify/ui-components) | - | `@aws-amplify/ui-react` | [![version](https://img.shields.io/npm/v/@aws-amplify/ui-react/latest.svg)](https://www.npmjs.com/package/@aws-amplify/ui-react) | - | `@aws-amplify/ui-vue` | [![version](https://img.shields.io/npm/v/@aws-amplify/ui-vue/latest.svg)](https://www.npmjs.com/package/@aws-amplify/ui-vue) | - | `@aws-amplify/xr` | [![version](https://img.shields.io/npm/v/@aws-amplify/xr/latest.svg)](https://www.npmjs.com/package/@aws-amplify/xr) | @@ -118,7 +109,6 @@ body: - notifications - interactions - predictions - - xr - Not applicable - type: textarea attributes: diff --git a/.github/workflows/issue-pending-response.yml b/.github/workflows/issue-pending-response.yml new file mode 100644 index 00000000000..d69cd643bcd --- /dev/null +++ b/.github/workflows/issue-pending-response.yml @@ -0,0 +1,15 @@ +name: issue-pending-response +on: + issue_comment: + types: [created] +permissions: + issues: write +jobs: + issue_commented: + if: ${{ !github.event.issue.pull_request && contains(github.event.issue.labels.*.name, 'pending-response') }} + runs-on: ubuntu-latest + steps: + - uses: siegerts/pending-author-response@v1 + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + pending-response-label: pending-response diff --git a/.github/workflows/snyk-security.yml b/.github/workflows/snyk-security.yml new file mode 100644 index 00000000000..c1000a48191 --- /dev/null +++ b/.github/workflows/snyk-security.yml @@ -0,0 +1,36 @@ +name: 'Snyk Security' + +on: + push: + branches: ['release'] + schedule: + - cron: '0 0 * * *' # run daily at midnight GMT + +permissions: + contents: read + +jobs: + snyk: + if: github.repository == 'aws-amplify/amplify-js' + permissions: + contents: read # for actions/checkout to fetch code + security-events: write # for github/codeql-action/upload-sarif to upload SARIF results + actions: read # only required for a private repository by github/codeql-action/upload-sarif to get the Action run status + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - name: Set up Snyk CLI to check for security issues + uses: snyk/actions/setup@806182742461562b67788a64410098c9d9b96adb + - name: Build + run: yarn install || true + # Using `|| true` to not fail the pipeline + - name: Snyk test + env: + SNYK_TOKEN: ${{secrets.SNYK_TOKEN}} + run: snyk test --sarif | tee snyk-code.sarif # || true + + # Push the Snyk Code results into GitHub Code Scanning tab + - name: Upload result to GitHub Code Scanning + uses: github/codeql-action/upload-sarif@v2 + with: + sarif_file: snyk-code.sarif diff --git a/.gitignore b/.gitignore index ebf4d950ae4..ea82d0b8e71 100644 --- a/.gitignore +++ b/.gitignore @@ -20,6 +20,9 @@ package-lock.json packages/*/.watchmanconfig dual-publish-tmp +### Version file - core build artifact +packages/core/src/Platform/version.ts + ### Gradle ### .gradle/ local.properties diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock index 1417008e883..bceea9f2f0c 100644 --- a/docs/Gemfile.lock +++ b/docs/Gemfile.lock @@ -13,7 +13,7 @@ GEM execjs coffee-script-source (1.11.1) colorator (1.1.0) - commonmarker (0.23.8) + commonmarker (0.23.9) concurrent-ruby (1.2.2) dnsruby (1.61.9) simpleidn (~> 0.1) @@ -211,7 +211,7 @@ GEM jekyll-feed (~> 0.9) jekyll-seo-tag (~> 2.1) minitest (5.18.0) - nokogiri (1.13.10) + nokogiri (1.14.3) mini_portile2 (~> 2.8.0) racc (~> 1.4) octokit (4.25.1) diff --git a/docs/_config.yml b/docs/_config.yml index 55771997bd8..b848fe11fce 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -9,6 +9,7 @@ # 'bundle exec jekyll serve'. If you change this file, please restart the server process. # Site settings +# # These are used to personalize your new site. If you look in the HTML files, # you will see them accessed via {{ site.title }}, {{ site.email }}, and so on. # You can create any custom variable you would like, and they will be accessible @@ -341,4 +342,4 @@ js_libraries: - title: Ionic url: '?platform=ionic' - title: JavaScript - url: '?platform=purejs' \ No newline at end of file + url: '?platform=purejs' diff --git a/docs/amplify-theme/_includes/site-head.html b/docs/amplify-theme/_includes/site-head.html index f146b3b33ad..243481d5ea3 100755 --- a/docs/amplify-theme/_includes/site-head.html +++ b/docs/amplify-theme/_includes/site-head.html @@ -9,8 +9,8 @@ {% if page.keywords %} {% endif %} - - + + - \ No newline at end of file + diff --git a/docs/amplify-theme/_includes/site-header.html b/docs/amplify-theme/_includes/site-header.html index d3aaffcef26..a2e8b3cfda2 100755 --- a/docs/amplify-theme/_includes/site-header.html +++ b/docs/amplify-theme/_includes/site-header.html @@ -54,13 +54,13 @@ {% if site.amplify.header.logo.text %}
{% elsif site.amplify.header.logo.image %} {% endif %} {% if site.amplify.header.nav %} @@ -152,4 +152,4 @@ setBackgroundImage(); -{% endif %} \ No newline at end of file +{% endif %} diff --git a/docs/amplify-theme/typedoc/layouts/default.hbs b/docs/amplify-theme/typedoc/layouts/default.hbs index 8f87b9a0816..2f0b2cf0b0f 100644 --- a/docs/amplify-theme/typedoc/layouts/default.hbs +++ b/docs/amplify-theme/typedoc/layouts/default.hbs @@ -6,6 +6,7 @@ {{model.name}} | {{project.name}} + + + +
+
+
+
+ +
+ AWS Amplify JS Dev Center +
+
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + + + +
+
+Menu +
+
+
+
+
+ +
+
+
+

Hierarchy

+
    +
  • + Error +
      +
    • + PlatformNotSupportedError +
      • +
    +
    • +
+
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

message

+
message: string
+ +
+
+ +

name

+
name: string
+ +
+
+ +

Optional stack

+
stack: string
+ +
+
+ +

Static Error

+
Error: ErrorConstructor
+ +
+
+ +
+
+ + + + + + \ No newline at end of file diff --git a/docs/api/classes/predicateinternalskey.html b/docs/api/classes/predicateinternalskey.html index c4371ea040c..e9c761e3e66 100644 --- a/docs/api/classes/predicateinternalskey.html +++ b/docs/api/classes/predicateinternalskey.html @@ -6,6 +6,7 @@ PredicateInternalsKey | amplify-js + - - -
-
-
-
- -
- AWS Amplify Home -
-
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - - -
-
-Menu -
-
-
-
-
- -
-
-
-
-
-
deprecated
-

The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be - available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function - and as a result, will no longer be available.

-
-
-
-
-
-

Hierarchy

- -
-
-

Implements

- -
-
-

Index

-
-
-
-

Constructors

- -
-
-

Accessors

- -
-
-

Methods

- -
-
-
-
-
-

Constructors

-
- -

constructor

- -
    -
  • - -
    -
    -
    deprecated
    -

    The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be - available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function - and as a result, will no longer be available.

    -
    -
    -
    -

    Parameters

    -
      -
    • -
      Default value options: ProviderOptions = {}
      -
      • -
    -

    Returns SumerianProvider

    -
    • -
-
-
-
-

Accessors

-
- -

Protected options

-
options:
- -
-
-
-

Methods

-
- -

configure

-
    -
  • configure(config?: ProviderOptions): ProviderOptions
    • -
- -
-
- -

enableAudio

-
    -
  • enableAudio(sceneName: string): void
    • -
-
    -
  • - -
    -
    -
    deprecated
    -

    The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be - available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function - and as a result, will no longer be available.

    -
    -
    -
    -

    Parameters

    -
      -
    • -
      sceneName: string
      -
      • -
    -

    Returns void

    -
    • -
-
-
- -

enterVR

-
    -
  • enterVR(sceneName: string): void
    • -
-
    -
  • - -
    -
    -
    deprecated
    -

    The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be - available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function - and as a result, will no longer be available.

    -
    -
    -
    -

    Parameters

    -
      -
    • -
      sceneName: string
      -
      • -
    -

    Returns void

    -
    • -
-
-
- -

exitVR

-
    -
  • exitVR(sceneName: string): void
    • -
-
    -
  • - -
    -
    -
    deprecated
    -

    The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be - available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function - and as a result, will no longer be available.

    -
    -
    -
    -

    Parameters

    -
      -
    • -
      sceneName: string
      -
      • -
    -

    Returns void

    -
    • -
-
-
- -

getCategory

-
    -
  • getCategory(): string
    • -
- -
-
- -

getProviderName

-
    -
  • getProviderName(): string
    • -
- -
-
- -

getSceneController

-
    -
  • getSceneController(sceneName: string): any
    • -
- -
-
- -

isMuted

-
    -
  • isMuted(sceneName: string): boolean
    • -
-
    -
  • - -
    -
    -
    deprecated
    -

    The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be - available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function - and as a result, will no longer be available.

    -
    -
    -
    -

    Parameters

    -
      -
    • -
      sceneName: string
      -
      • -
    -

    Returns boolean

    -
    • -
-
-
- -

isSceneLoaded

-
    -
  • isSceneLoaded(sceneName: string): any
    • -
-
    -
  • - -
    -
    -
    deprecated
    -

    The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be - available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function - and as a result, will no longer be available.

    -
    -
    -
    -

    Parameters

    -
      -
    • -
      sceneName: string
      -
      • -
    -

    Returns any

    -
    • -
-
-
- -

isVRCapable

-
    -
  • isVRCapable(sceneName: string): boolean
    • -
-
    -
  • - -
    -
    -
    deprecated
    -

    The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be - available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function - and as a result, will no longer be available.

    -
    -
    -
    -

    Parameters

    -
      -
    • -
      sceneName: string
      -
      • -
    -

    Returns boolean

    -
    • -
-
-
- -

isVRPresentationActive

-
    -
  • isVRPresentationActive(sceneName: string): boolean
    • -
- -
-
- -

loadScene

- -
    -
  • - -
    -
    -
    deprecated
    -

    The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be - available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function - and as a result, will no longer be available.

    -
    -
    -
    -

    Parameters

    - -

    Returns Promise<void>

    -
    • -
-
-
- -

onSceneEvent

-
    -
  • onSceneEvent(sceneName: string, eventName: string, eventHandler: Function): void
    • -
-
    -
  • - -
    -
    -
    deprecated
    -

    The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be - available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function - and as a result, will no longer be available.

    -
    -
    -
    -

    Parameters

    -
      -
    • -
      sceneName: string
      -
      • -
    • -
      eventName: string
      -
      • -
    • -
      eventHandler: Function
      -
      • -
    -

    Returns void

    -
    • -
-
-
- -

setMuted

-
    -
  • setMuted(sceneName: string, muted: boolean): void
    • -
-
    -
  • - -
    -
    -
    deprecated
    -

    The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be - available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function - and as a result, will no longer be available.

    -
    -
    -
    -

    Parameters

    -
      -
    • -
      sceneName: string
      -
      • -
    • -
      muted: boolean
      -
      • -
    -

    Returns void

    -
    • -
-
-
- -

start

-
    -
  • start(sceneName: string): void
    • -
-
    -
  • - -
    -
    -
    deprecated
    -

    The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be - available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function - and as a result, will no longer be available.

    -
    -
    -
    -

    Parameters

    -
      -
    • -
      sceneName: string
      -
      • -
    -

    Returns void

    -
    • -
-
-
- -
-
- - - - - - \ No newline at end of file diff --git a/docs/api/classes/syncengine.html b/docs/api/classes/syncengine.html index d5ff4cd30ae..1156673ca3b 100644 --- a/docs/api/classes/syncengine.html +++ b/docs/api/classes/syncengine.html @@ -6,6 +6,7 @@ SyncEngine | amplify-js + - - -
-
-
-
- -
- AWS Amplify Home -
-
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - - -
-
-Menu -
-
-
-
-
- -
-
-
-
-
-
deprecated
-

The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be - available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function - and as a result, will no longer be available.

-
-
-
-
-
-

Hierarchy

-
    -
  • - XRClass -
    • -
-
-
-

Index

-
-
-
-

Constructors

- -
-
-

Methods

- -
-
-
-
-
-

Constructors

-
- -

constructor

- -
    -
  • - -
    -
    -

    Initialize XR with AWS configurations

    -
    -
    -
    deprecated
    -

    The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be - available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function - and as a result, will no longer be available.

    -
    -
    -
    -

    Parameters

    -
      -
    • -
      options: XROptions
      -
      -
      -

      Configuration object for XR

      -
      -
      -
      • -
    -

    Returns XRClass

    -
    • -
-
-
-
-

Methods

-
- -

addPluggable

- -
    -
  • - -
    -
    -

    add plugin into XR category

    -
    -
    -
    deprecated
    -

    The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be - available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function - and as a result, will no longer be available.

    -
    -
    -
    -

    Parameters

    -
      -
    • -
      pluggable: XRProvider
      -
      -

      an instance of the plugin

      -
      -
      • -
    -

    Returns Promise<object>

    -
    • -
-
-
- -

configure

- -
    -
  • - -
    -
    -

    Configure XR part with configurations

    -
    -
    -
    deprecated
    -

    The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be - available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function - and as a result, will no longer be available.

    -
    -
    -
    -

    Parameters

    - -

    Returns XROptions

    -
      -
    • The current configuration
      • -
    -
    • -
-
-
- -

enableAudio

-
    -
  • enableAudio(sceneName: string, provider?: string): void
    • -
-
    -
  • - -
    -
    -
    deprecated
    -

    The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be - available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function - and as a result, will no longer be available.

    -
    -
    -
    -

    Parameters

    -
      -
    • -
      sceneName: string
      -
      • -
    • -
      Default value provider: string = this._defaultProvider
      -
      • -
    -

    Returns void

    -
    • -
-
-
- -

enterVR

-
    -
  • enterVR(sceneName: string, provider?: string): void
    • -
-
    -
  • - -
    -
    -
    deprecated
    -

    The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be - available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function - and as a result, will no longer be available.

    -
    -
    -
    -

    Parameters

    -
      -
    • -
      sceneName: string
      -
      • -
    • -
      Default value provider: string = this._defaultProvider
      -
      • -
    -

    Returns void

    -
    • -
-
-
- -

exitVR

-
    -
  • exitVR(sceneName: string, provider?: string): void
    • -
-
    -
  • - -
    -
    -
    deprecated
    -

    The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be - available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function - and as a result, will no longer be available.

    -
    -
    -
    -

    Parameters

    -
      -
    • -
      sceneName: string
      -
      • -
    • -
      Default value provider: string = this._defaultProvider
      -
      • -
    -

    Returns void

    -
    • -
-
-
- -

getSceneController

-
    -
  • getSceneController(sceneName: string, provider?: string): any
    • -
-
    -
  • - -
    -
    -
    deprecated
    -

    The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be - available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function - and as a result, will no longer be available.

    -
    -
    -
    -

    Parameters

    -
      -
    • -
      sceneName: string
      -
      • -
    • -
      Default value provider: string = this._defaultProvider
      -
      • -
    -

    Returns any

    -
    • -
-
-
- -

isMuted

-
    -
  • isMuted(sceneName: string, provider?: string): boolean
    • -
-
    -
  • - -
    -
    -
    deprecated
    -

    The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be - available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function - and as a result, will no longer be available.

    -
    -
    -
    -

    Parameters

    -
      -
    • -
      sceneName: string
      -
      • -
    • -
      Default value provider: string = this._defaultProvider
      -
      • -
    -

    Returns boolean

    -
    • -
-
-
- -

isSceneLoaded

-
    -
  • isSceneLoaded(sceneName: string, provider?: string): boolean
    • -
-
    -
  • - -
    -
    -
    deprecated
    -

    The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be - available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function - and as a result, will no longer be available.

    -
    -
    -
    -

    Parameters

    -
      -
    • -
      sceneName: string
      -
      • -
    • -
      Default value provider: string = this._defaultProvider
      -
      • -
    -

    Returns boolean

    -
    • -
-
-
- -

isVRCapable

-
    -
  • isVRCapable(sceneName: string, provider?: string): boolean
    • -
-
    -
  • - -
    -
    -
    deprecated
    -

    The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be - available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function - and as a result, will no longer be available.

    -
    -
    -
    -

    Parameters

    -
      -
    • -
      sceneName: string
      -
      • -
    • -
      Default value provider: string = this._defaultProvider
      -
      • -
    -

    Returns boolean

    -
    • -
-
-
- -

isVRPresentationActive

-
    -
  • isVRPresentationActive(sceneName: string, provider?: string): boolean
    • -
-
    -
  • - -
    -
    -
    deprecated
    -

    The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be - available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function - and as a result, will no longer be available.

    -
    -
    -
    -

    Parameters

    -
      -
    • -
      sceneName: string
      -
      • -
    • -
      Default value provider: string = this._defaultProvider
      -
      • -
    -

    Returns boolean

    -
    • -
-
-
- -

loadScene

-
    -
  • loadScene(sceneName: string, domElementId: string, sceneOptions?: SceneOptions, provider?: string): Promise<any>
    • -
-
    -
  • - -
    -
    -
    deprecated
    -

    The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be - available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function - and as a result, will no longer be available.

    -
    -
    -
    -

    Parameters

    -
      -
    • -
      sceneName: string
      -
      • -
    • -
      domElementId: string
      -
      • -
    • -
      Default value sceneOptions: SceneOptions = {}
      -
      • -
    • -
      Default value provider: string = this._defaultProvider
      -
      • -
    -

    Returns Promise<any>

    -
    • -
-
-
- -

onSceneEvent

-
    -
  • onSceneEvent(sceneName: string, eventName: string, eventHandler: Function, provider?: string): void
    • -
-
    -
  • - -
    -
    -
    deprecated
    -

    The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be - available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function - and as a result, will no longer be available.

    -
    -
    -
    -

    Parameters

    -
      -
    • -
      sceneName: string
      -
      • -
    • -
      eventName: string
      -
      • -
    • -
      eventHandler: Function
      -
      • -
    • -
      Default value provider: string = this._defaultProvider
      -
      • -
    -

    Returns void

    -
    • -
-
-
- -

setMuted

-
    -
  • setMuted(sceneName: string, muted: boolean, provider?: string): void
    • -
-
    -
  • - -
    -
    -
    deprecated
    -

    The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be - available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function - and as a result, will no longer be available.

    -
    -
    -
    -

    Parameters

    -
      -
    • -
      sceneName: string
      -
      • -
    • -
      muted: boolean
      -
      • -
    • -
      Default value provider: string = this._defaultProvider
      -
      • -
    -

    Returns void

    -
    • -
-
-
- -

start

-
    -
  • start(sceneName: string, provider?: string): void
    • -
-
    -
  • - -
    -
    -
    deprecated
    -

    The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be - available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function - and as a result, will no longer be available.

    -
    -
    -
    -

    Parameters

    -
      -
    • -
      sceneName: string
      -
      • -
    • -
      Default value provider: string = this._defaultProvider
      -
      • -
    -

    Returns void

    -
    • -
-
-
- -
-
- - - - - - \ No newline at end of file diff --git a/docs/api/classes/xrsceneloadfailure.html b/docs/api/classes/xrsceneloadfailure.html deleted file mode 100644 index 85dee5d4324..00000000000 --- a/docs/api/classes/xrsceneloadfailure.html +++ /dev/null @@ -1,1078 +0,0 @@ - - - - - - XRSceneLoadFailure | amplify-js - - - - - -
-
-
-
- -
- AWS Amplify Home -
-
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - - -
-
-Menu -
-
-
-
-
- -
-
-
-

Hierarchy

-
    -
  • - XRError -
      -
    • - XRSceneLoadFailure -
      • -
    -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

message

-
message: string
- -
-
- -

name

-
name: string
- -
-
- -

Optional stack

-
stack: string
- -
-
- -
-
- - - - - - \ No newline at end of file diff --git a/docs/api/classes/xrscenenotloadederror.html b/docs/api/classes/xrscenenotloadederror.html deleted file mode 100644 index 8dae74504a5..00000000000 --- a/docs/api/classes/xrscenenotloadederror.html +++ /dev/null @@ -1,1078 +0,0 @@ - - - - - - XRSceneNotLoadedError | amplify-js - - - - - -
-
-
-
- -
- AWS Amplify Home -
-
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - - -
-
-Menu -
-
-
-
-
- -
-
-
-

Hierarchy

-
    -
  • - XRError -
      -
    • - XRSceneNotLoadedError -
      • -
    -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

message

-
message: string
- -
-
- -

name

-
name: string
- -
-
- -

Optional stack

-
stack: string
- -
-
- -
-
- - - - - - \ No newline at end of file diff --git a/docs/api/enums/autherrorstrings.html b/docs/api/enums/autherrorstrings.html index 87de0f45989..4ef9c1eef6d 100644 --- a/docs/api/enums/autherrorstrings.html +++ b/docs/api/enums/autherrorstrings.html @@ -6,6 +6,7 @@ AuthErrorStrings | amplify-js + + + +
+
+
+
+ +
+ AWS Amplify JS Dev Center +
+
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + + + +
+
+Menu +
+
+
+
+
+ +
+
+
+

Index

+
+
+
+

Enumeration members

+ +
+
+
+
+
+

Enumeration members

+
+ +

CAMPAIGN

+
CAMPAIGN: = "_campaign"
+ +
+
+ +

JOURNEY

+
JOURNEY: = "_journey"
+ +
+
+ +
+
+ + + + + + \ No newline at end of file diff --git a/docs/api/enums/awss3providermultipartcopiererrors.html b/docs/api/enums/awss3providermultipartcopiererrors.html index 6ad5ff63d26..c1e28929717 100644 --- a/docs/api/enums/awss3providermultipartcopiererrors.html +++ b/docs/api/enums/awss3providermultipartcopiererrors.html @@ -6,6 +6,7 @@ AWSS3ProviderMultipartCopierErrors | amplify-js + + + +
+
+
+
+ +
+ AWS Amplify JS Dev Center +
+
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + + + +
+
+Menu +
+
+
+
+
+ +
+
+
+

Index

+
+
+
+

Enumeration members

+ +
+
+
+
+
+

Enumeration members

+
+ +

BACKGROUND_MESSAGE_RECEIVED

+
BACKGROUND_MESSAGE_RECEIVED:
+ +
+
+ +

FOREGROUND_MESSAGE_RECEIVED

+
FOREGROUND_MESSAGE_RECEIVED:
+ +
+
+ +

LAUNCH_NOTIFICATION_OPENED

+
LAUNCH_NOTIFICATION_OPENED:
+ +
+
+ +

NOTIFICATION_OPENED

+
NOTIFICATION_OPENED:
+ +
+
+ +

TOKEN_RECEIVED

+
TOKEN_RECEIVED:
+ +
+
+ +
+
+ + + + + + \ No newline at end of file diff --git a/docs/api/enums/pushnotificationpermissionstatus.html b/docs/api/enums/pushnotificationpermissionstatus.html new file mode 100644 index 00000000000..22c886e92d2 --- /dev/null +++ b/docs/api/enums/pushnotificationpermissionstatus.html @@ -0,0 +1,1077 @@ + + + + + + PushNotificationPermissionStatus | amplify-js + + + + + + +
+
+
+
+ +
+ AWS Amplify JS Dev Center +
+
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + + + +
+
+Menu +
+
+
+
+
+ +
+
+
+

Index

+
+
+
+

Enumeration members

+ +
+
+
+
+
+

Enumeration members

+
+ +

DENIED

+
DENIED: = "DENIED"
+ +
+
+ +

GRANTED

+
GRANTED: = "GRANTED"
+ +
+
+ +

SHOULD_EXPLAIN_THEN_REQUEST

+
SHOULD_EXPLAIN_THEN_REQUEST: = "SHOULD_EXPLAIN_THEN_REQUEST"
+ +
+
+ +

SHOULD_REQUEST

+
SHOULD_REQUEST: = "SHOULD_REQUEST"
+ +
+
+ +
+
+ + + + + + \ No newline at end of file diff --git a/docs/api/enums/queryone.html b/docs/api/enums/queryone.html index dab09fb72a7..88785640cd0 100644 --- a/docs/api/enums/queryone.html +++ b/docs/api/enums/queryone.html @@ -6,6 +6,7 @@ QueryOne | amplify-js + + + +
+
+
+
+ +
+ AWS Amplify JS Dev Center +
+
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + + + +
+
+Menu +
+
+
+
+
+ +
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

longDate

+
longDate: string
+ +
+
+ +

shortDate

+
shortDate: string
+ +
+
+ +
+
+ + + + + + \ No newline at end of file diff --git a/docs/api/interfaces/geoconfig.html b/docs/api/interfaces/geoconfig.html index 8bd3cffe43f..90e8a955533 100644 --- a/docs/api/interfaces/geoconfig.html +++ b/docs/api/interfaces/geoconfig.html @@ -6,6 +6,7 @@ GeoConfig | amplify-js + + + +
+
+
+
+ +
+ AWS Amplify JS Dev Center +
+
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + + + +
+
+Menu +
+
+
+
+
+ +
+
+
+

Hierarchy

+
    +
  • + Request +
      +
    • + HttpRequest +
      • +
    +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional body

+
body: BodyInit
+ +
+
+ +

headers

+
headers: Headers
+ +
+
+ +

method

+
method: string
+ +
+
+ +

url

+
url: URL
+ +
+
+ +
+
+ + + + + + \ No newline at end of file diff --git a/docs/api/classes/xrnosceneconfigurederror.html b/docs/api/interfaces/httpresponse.html similarity index 98% rename from docs/api/classes/xrnosceneconfigurederror.html rename to docs/api/interfaces/httpresponse.html index 955b079a6e8..7003f1998b8 100644 --- a/docs/api/classes/xrnosceneconfigurederror.html +++ b/docs/api/interfaces/httpresponse.html @@ -3,9 +3,10 @@ - XRNoSceneConfiguredError | amplify-js + HttpResponse | amplify-js + + + +
+
+
+
+ +
+ AWS Amplify JS Dev Center +
+
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + + + +
+
+Menu +
+
+
+
+
+ +
+
+
+

Hierarchy

+
    +
  • + NormalizedValues +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional action

+
action: Pick<PushNotificationMessage, "goToUrl" | "deeplinkUrl">
+ +
+
+ +

Optional body

+
body: string
+ +
+
+ +

Optional data

+
data: Record<string, unknown>
+ +
+
+ +

Optional imageUrl

+
imageUrl: string
+ +
+
+ +

Optional options

+
options: Pick<PushNotificationMessage, "apnsOptions" | "fcmOptions">
+ +
+
+ +

Optional title

+
title: string
+ +
+
+ +
+
+ + + + + + \ No newline at end of file diff --git a/docs/api/interfaces/notificationsconfig.html b/docs/api/interfaces/notificationsconfig.html index d23eba0b53e..279d9cc3e18 100644 --- a/docs/api/interfaces/notificationsconfig.html +++ b/docs/api/interfaces/notificationsconfig.html @@ -6,6 +6,7 @@ NotificationsConfig | amplify-js + + + +
+
+
+
+ +
+ AWS Amplify JS Dev Center +
+
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + + + +
+
+Menu +
+
+
+
+
+ +
+
+
+

Hierarchy

+ +
+
+

Implemented by

+ +
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

configure

+
    +
  • configure(config: object): object
    • +
+ +
+
+ +

getCategory

+ + +
+
+ +

getProviderName

+
    +
  • getProviderName(): string
    • +
+ +
+
+ +

getSubCategory

+ + +
+
+ +

identifyUser

+ + +
+
+ +
+
+ + + + + + \ No newline at end of file diff --git a/docs/api/interfaces/pageviewtrackopts.html b/docs/api/interfaces/pageviewtrackopts.html index eb28ec51ece..faf7f48527b 100644 --- a/docs/api/interfaces/pageviewtrackopts.html +++ b/docs/api/interfaces/pageviewtrackopts.html @@ -6,6 +6,7 @@ pageViewTrackOpts | amplify-js + + + +
+
+
+
+ +
+ AWS Amplify JS Dev Center +
+
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + + + +
+
+Menu +
+
+
+
+
+ +
+
+
+

Hierarchy

+
    +
  • + object +
      +
    • + Presignable +
      • +
    +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional method

+
method: HttpRequest["method"]
+ +
+
+ +
+
+ + + + + + \ No newline at end of file diff --git a/docs/api/interfaces/presignurloptions.html b/docs/api/interfaces/presignurloptions.html new file mode 100644 index 00000000000..711bf97cf62 --- /dev/null +++ b/docs/api/interfaces/presignurloptions.html @@ -0,0 +1,1108 @@ + + + + + + PresignUrlOptions | amplify-js + + + + + + +
+
+
+
+ +
+ AWS Amplify JS Dev Center +
+
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + + + +
+
+Menu +
+
+
+
+
+ +
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

credentials

+
credentials: Credentials
+ +
+
+ +

Optional expiration

+
expiration: number
+ +
+
+ +

Optional signingDate

+
signingDate: Date
+ +
+
+ +

signingRegion

+
signingRegion: string
+ +
+
+ +

signingService

+
signingService: string
+ +
+
+ +
+
+ + + + + + \ No newline at end of file diff --git a/docs/api/interfaces/promisehandlers.html b/docs/api/interfaces/promisehandlers.html index 73ac6904341..08364f07ffa 100644 --- a/docs/api/interfaces/promisehandlers.html +++ b/docs/api/interfaces/promisehandlers.html @@ -6,6 +6,7 @@ PromiseHandlers | amplify-js + + + +
+
+
+
+ +
+ AWS Amplify JS Dev Center +
+
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + + + +
+
+Menu +
+
+
+
+
+ +
+
+
+

Hierarchy

+
    +
  • + PushNotificationConfig +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional AWSPinpoint

+
AWSPinpoint: AWSPinpointProviderConfig
+ +
+
+ +
+
+ + + + + + \ No newline at end of file diff --git a/docs/api/classes/abstractxrprovider.html b/docs/api/interfaces/pushnotificationinterface.html similarity index 88% rename from docs/api/classes/abstractxrprovider.html rename to docs/api/interfaces/pushnotificationinterface.html index 7aa432afdf4..1f37715e61c 100644 --- a/docs/api/classes/abstractxrprovider.html +++ b/docs/api/interfaces/pushnotificationinterface.html @@ -3,9 +3,10 @@ - AbstractXRProvider | amplify-js + PushNotificationInterface | amplify-js + + + +
+
+
+
+ +
+ AWS Amplify JS Dev Center +
+
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + + + +
+
+Menu +
+
+
+
+
+ +
+
+
+

Hierarchy

+
    +
  • + PushNotificationMessage +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional apnsOptions

+
apnsOptions: ApnsPlatformOptions
+ +
+
+ +

Optional body

+
body: string
+ +
+
+ +

Optional data

+
data: Record<string, unknown>
+ +
+
+ +

Optional deeplinkUrl

+
deeplinkUrl: string
+ +
+
+ +

Optional fcmOptions

+
fcmOptions: FcmPlatformOptions
+ +
+
+ +

Optional goToUrl

+
goToUrl: string
+ +
+
+ +

Optional imageUrl

+
imageUrl: string
+ +
+
+ +

Optional title

+
title: string
+ +
+
+ +
+
+ + + + + + \ No newline at end of file diff --git a/docs/api/classes/xrscenenotfounderror.html b/docs/api/interfaces/pushnotificationnativemodule.html similarity index 94% rename from docs/api/classes/xrscenenotfounderror.html rename to docs/api/interfaces/pushnotificationnativemodule.html index 0111d24068d..002d74a6912 100644 --- a/docs/api/classes/xrscenenotfounderror.html +++ b/docs/api/interfaces/pushnotificationnativemodule.html @@ -3,9 +3,10 @@ - XRSceneNotFoundError | amplify-js + PushNotificationNativeModule | amplify-js + + + +
+
+
+
+ +
+ AWS Amplify JS Dev Center +
+
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + + + +
+
+Menu +
+
+
+
+
+ +
+
+
+

Hierarchy

+ +
+
+

Implemented by

+ +
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

configure

+
    +
  • configure(config: object): object
    • +
+ +
+
+ +

getCategory

+ + +
+
+ +

getProviderName

+
    +
  • getProviderName(): string
    • +
+ +
+
+ +

getSubCategory

+ + +
+
+ +

identifyUser

+ + +
+
+ +

registerDevice

+
    +
  • registerDevice(token: string): Promise<void>
    • +
+ +
+
+ +
+
+ + + + + + \ No newline at end of file diff --git a/docs/api/interfaces/reachability.html b/docs/api/interfaces/reachability.html index e8b063beb31..b8127215fa3 100644 --- a/docs/api/interfaces/reachability.html +++ b/docs/api/interfaces/reachability.html @@ -6,6 +6,7 @@ Reachability | amplify-js + + + +
+
+
+
+ +
+ AWS Amplify JS Dev Center +
+
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + + + +
+
+Menu +
+
+
+
+
+ +
+
+
+
+
+

General None HTTP-specific request interface

+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional body

+
body: unknown
+ +
+
+ +

url

+
url: URL
+ +
+
+ +
+
+ + + + + + \ No newline at end of file diff --git a/docs/api/interfaces/requestparams.html b/docs/api/interfaces/requestparams.html index 99439f6db21..32adcb19551 100644 --- a/docs/api/interfaces/requestparams.html +++ b/docs/api/interfaces/requestparams.html @@ -6,6 +6,7 @@ RequestParams | amplify-js + + + +
+
+
+
+ +
+ AWS Amplify JS Dev Center +
+
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + + + +
+
+Menu +
+
+
+
+
+ +
+
+
+

Hierarchy

+
    +
  • + Credentials +
    • +
  • + FormattedDates +
    • +
  • + object +
      +
    • + SigningValues +
      • +
    +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Readonly accessKeyId

+
accessKeyId: string
+ +
+
+

AWS access key ID

+
+
+
+
+ +

credentialScope

+
credentialScope: string
+ +
+
+ +

Optional Readonly expiration

+
expiration: Date
+ +
+
+

A {Date} when these credentials will no longer be accepted.

+
+
+
+
+ +

longDate

+
longDate: string
+ +
+
+ +

Readonly secretAccessKey

+
secretAccessKey: string
+ +
+
+

AWS secret access key

+
+
+
+
+ +

Optional Readonly sessionToken

+
sessionToken: string
+ +
+
+

A security or session token to use with these credentials. Usually + present for temporary credentials.

+
+
+
+
+ +

shortDate

+
shortDate: string
+ +
+
+ +
+
+ + + + + + \ No newline at end of file diff --git a/docs/api/interfaces/signoutopts.html b/docs/api/interfaces/signoutopts.html index 3f60f20eb94..0494da2963f 100644 --- a/docs/api/interfaces/signoutopts.html +++ b/docs/api/interfaces/signoutopts.html @@ -6,6 +6,7 @@ SignOutOpts | amplify-js + + + +
+
+
+
+ +
+ AWS Amplify JS Dev Center +
+
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + + + +
+
+Menu +
+
+
+
+
+ +
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

credentials

+
credentials: Credentials
+ +
+
+ +

Optional signingDate

+
signingDate: Date
+ +
+
+ +

signingRegion

+
signingRegion: string
+ +
+
+ +

signingService

+
signingService: string
+ +
+
+ +
+
+ + + + + + \ No newline at end of file diff --git a/docs/api/interfaces/signupparams.html b/docs/api/interfaces/signupparams.html index f52d808185d..189331bd2bf 100644 --- a/docs/api/interfaces/signupparams.html +++ b/docs/api/interfaces/signupparams.html @@ -6,6 +6,7 @@ SignUpParams | amplify-js +