diff --git a/lex-web-ui/README.md b/lex-web-ui/README.md index cad1ae24..e748831c 100644 --- a/lex-web-ui/README.md +++ b/lex-web-ui/README.md @@ -54,6 +54,7 @@ You can import the library as a module and use it in your code: lex: { initialText: 'How can I help you?', botName: 'helpBot', + botAlias: '$LATEST', }, ui: { toolbarTitle: 'Help Bot', @@ -208,7 +209,6 @@ Once signed in, three tokens are managed by the lex-web-ui and provided on reque to Lex. These are the accesstoken, the idtoken, and a refreshtoken. These tokens are passed as Lex session attributes on each request to Lex. - Configured Fulfillment lambda handlers can utilize these tokens by accessing them from session attributes. They can be used to validate access or lookup attributes / assertions from the SSO provider. @@ -219,6 +219,11 @@ The session attributes are * session.idtokenjwt * session.refreshtokenjwt +The Lex Web UI initially will use the unauth role until a user logs in. +After login processing fully completes, an event fires in the browser indicating tokens +are now available. At that time, the Lex Web UI will switch to using auth based role by +using new temporary credentials. + ### Adjusting existing Identity Pools to be used with the lex-web-ui If you want to manually use your own Cognito Identity Pool, diff --git a/templates/README.md b/templates/README.md index 77862c22..892d9ac4 100644 --- a/templates/README.md +++ b/templates/README.md @@ -104,6 +104,10 @@ with an existing page, you may want to modify the following parameters: bot in the Lex [Getting Started](http://docs.aws.amazon.com/lex/latest/dg/gs-console.html) documentation. +- `BotAlias`: Lex Bot Alias to use. This parameter defines the alias + to be used by the Lex Web UI. It defaults to a value of '$LATEST'. You can set + this attribute to values which have been defined for the bot and are visible in the + Amazon Lex Console. Typical values might be 'PROD' or 'DEV'. - `CognitoIdentityPoolId`: Id of an existing Cognito Identity Pool. This is an optional parameter. If left empty, a Cognito Identity Pool will be automatically created. The pool ID is used by the web ui to