Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added .DS_Store
Binary file not shown.
4 changes: 2 additions & 2 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ category_list:
excerpt: Connect your app to message-oriented middleware on the cloud.
cta: Read more
class: aws-icon-ps-60-circular-circuit
url: '/js/pub_sub_guide'
url: '/js/pubsub'
icon: '/images/icons/Misc/Cloud.svg'
services:
- title: AWS IoT,
Expand Down Expand Up @@ -243,7 +243,7 @@ category_list:
excerpt: Build AR/VR enabled web applications.
cta: Read more
class: aws-icon-ps-60-file-box
url: '/js/xr_guide'
url: '/js/xr'
icon: '/images/icons/Misc/Cloud.svg'
services:
- title: Amazon S3
Expand Down
Binary file added images/.DS_Store
Binary file not shown.
Binary file added images/xr/amplify_published_dialog.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/xr/sumerian_host_privately_button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/xr/sumerian_publish_button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion js/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -594,7 +594,7 @@ const oauth = {

// 'code' for Authorization code grant,
// 'token' for Implicit grant
responseType: 'code'
responseType: 'code',

// optional, for Cognito hosted ui specified options
options: {
Expand Down
29 changes: 21 additions & 8 deletions js/xr.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,31 @@ The XR category enables you to work with augmented reality (AR) and virtual real

## Configuration

To download your scene configuration file, visit <a href="https://console.aws.amazon.com/sumerian/home" target="_blank">Amazon Sumerian console</a>, create/open a scene, and select *Publish* from the top right of the console. Add the following code to your application to configure the XR category:
To download the required scene configuration for your Sumerian scene, visit <a href="https://console.aws.amazon.com/sumerian/home" target="_blank">Amazon Sumerian console</a>, create or open the scene you would like to use with AWS Amplify, click *Publish* dropdown from the top right corner of the Sumerian console, then click *Host privately*:

Amazon Sumerian private scenes do not currently support Unauthenticated access roles when using Amazon Cognito and AWS Amplify Authentication. If you are publishing a private scene, be sure to only include an Authenticated Role/Policy with your Cognito Identity Pool. <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/iam-roles.html" target="_blank"> Learn more</a> about IAM Roles with Cognito Identity Pools.
If your scene was already published publicly, you will need to unpublish then publish again using the instructions below.
{: .callout .callout--info}

![XR]({%if jekyll.environment == 'production'%}{{site.amplify.docs_baseurl}}{%endif%}/images/xr/sumerian_host_privately_button.png){: class="screencap" style="max-height:600px;"}


You will then be prompted with the following dialog. Click the *Publish* button:
![XR]({%if jekyll.environment == 'production'%}{{site.amplify.docs_baseurl}}{%endif%}/images/xr/sumerian_publish_button.png){: class="screencap" style="max-height:600px;"}

Now click the *Download JSON configuration* button to download the scene configuration JSON that will be used for configuring your scene within AWS Amplify:
![XR]({%if jekyll.environment == 'production'%}{{site.amplify.docs_baseurl}}{%endif%}/images/xr/amplify_published_dialog.png){: class="screencap" style="max-height:600px;"}

Amazon Sumerian private scenes do not currently support Unauthenticated access roles when using Amazon Cognito and AWS Amplify Authentication. If you are publishing a private scene, be sure to only include an Authenticated Role/Policy with your Cognito Identity Pool. To understand how to configure your Authenticated Role/Policy for Sumerian scene access go to the <a href="https://docs.aws.amazon.com/sumerian/latest/userguide/sumerian-permissions.html">Amazon Sumerian Permissions</a> documentation page. <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/iam-roles.html" target="_blank"> Learn more</a> about IAM Roles with Cognito Identity Pools.
{: .callout .callout--info}

Add the following code to your application to configure the XR category:
```js
import { XR } from 'aws-amplify';
import scene1Config from './sumerian-exports'; // This file will be generated by the Sumerian AWS Console
import scene1Config from './sumerian_exports_<sceneId>'; // This file will be generated by the Sumerian AWS Console

XR.configure({ // XR category configuration
SumerianProvider: { // Sumerian specific configuration
region: 'us-west-2' // Sumerian region
region: 'us-west-2', // Sumerian region
scenes: {
"scene1": { // Friendly scene name
sceneConfig: scene1Config // Scene configuration from Sumerian publish
Expand All @@ -32,11 +45,11 @@ XR.configure({ // XR category configuration

```js
import XR from '@aws-amplify/xr';
import scene1Config from './sumerian-exports'; // This file will be generated by the Sumerian AWS Console
import scene1Config from './sumerian_exports_<sceneId>'; // This file will be generated by the Sumerian AWS Console

XR.configure({ // XR category configuration
SumerianProvider: { // Sumerian specific configuration
region: 'us-west-2'
region: 'us-west-2',
scenes: {
"scene1": { // Friendly scene name
sceneConfig: scene1Config // Scene configuration from Sumerian publish }
Expand All @@ -49,11 +62,11 @@ XR.configure({ // XR category configuration

```js
import XR from '@aws-amplify/xr';
import scene1Config from './sumerian-exports'; // This file will be generated by the Sumerian AWS Console
import scene1Config from './sumerian_exports_<sceneId>'; // This file will be generated by the Sumerian AWS Console

XR.configure({ // XR category configuration
SumerianProvider: { // Sumerian specific configuration
region: 'us-west-2'
region: 'us-west-2',
scenes: {
"scene1": { // Friendly scene name
sceneConfig: scene1Config,
Expand Down