Skip to content

Commit 52a60be

Browse files
author
AWS
committed
Amazon QuickSight Update: Added QSearchBar option for GenerateEmbedUrlForRegisteredUser ExperienceConfiguration to support Q search bar embedding
1 parent da53f77 commit 52a60be

File tree

2 files changed

+22
-2
lines changed

2 files changed

+22
-2
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "Amazon QuickSight",
4+
"contributor": "",
5+
"description": "Added QSearchBar option for GenerateEmbedUrlForRegisteredUser ExperienceConfiguration to support Q search bar embedding"
6+
}

services/quicksight/src/main/resources/codegen-resources/service-2.json

+16-2
Original file line numberDiff line numberDiff line change
@@ -7051,7 +7051,7 @@
70517051
},
70527052
"ExperienceConfiguration":{
70537053
"shape":"RegisteredUserEmbeddingExperienceConfiguration",
7054-
"documentation":"<p>The experience you are embedding. For registered users, you can embed Amazon QuickSight dashboards or the entire Amazon QuickSight console.</p>"
7054+
"documentation":"<p>The experience you are embedding. For registered users, you can embed Amazon QuickSight dashboards, the entire Amazon QuickSight console, or the Amazon QuickSight Q search bar.</p>"
70557055
}
70567056
}
70577057
},
@@ -7065,7 +7065,7 @@
70657065
"members":{
70667066
"EmbedUrl":{
70677067
"shape":"EmbeddingUrl",
7068-
"documentation":"<p>The embed URL for the Amazon QuickSight dashboard or console.</p>"
7068+
"documentation":"<p>The embed URL for the Amazon QuickSight dashboard, console, or Q search bar.</p>"
70697069
},
70707070
"Status":{
70717071
"shape":"StatusCode",
@@ -9583,10 +9583,24 @@
95839583
"QuickSightConsole":{
95849584
"shape":"RegisteredUserQuickSightConsoleEmbeddingConfiguration",
95859585
"documentation":"<p>The configuration details for providing an Amazon QuickSight console embedding experience. This can be used along with custom permissions to restrict access to certain features. For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html\">Customizing Access to the Amazon QuickSight Console</a> in the <i>Amazon QuickSight User Guide</i>.</p> <p>Use <code>GenerateEmbedUrlForRegisteredUser</code> where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who accesses an embedded Amazon QuickSight console needs to belong to the author or admin security cohort. If you want to restrict permissions to some of these features, add a custom permissions profile to the user with the <code> <a>UpdateUser</a> </code> API operation. Use <code> <a>RegisterUser</a> </code> API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the <i>Amazon QuickSight User Guide</i>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics-full-console-for-authenticated-users.html\">Embedding the Full Functionality of the Amazon QuickSight Console for Authenticated Users</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html\">Customizing Access to the Amazon QuickSight Console</a> </p> </li> </ul> <p>For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html\">Amazon QuickSight Developer Portal</a>.</p>"
9586+
},
9587+
"QSearchBar":{
9588+
"shape":"RegisteredUserQSearchBarEmbeddingConfiguration",
9589+
"documentation":"<p>The configuration details for embedding the Q search bar.</p> <p>For more information about embedding the Q search bar, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/embedding-overview.html\">Embedding Overview</a>.</p>"
95869590
}
95879591
},
95889592
"documentation":"<p>The type of experience you want to embed. For registered users, you can embed an Amazon QuickSight dashboard or the Amazon QuickSight console.</p> <note> <p>Exactly one of the experience configurations is required. You can choose <code>Dashboard</code> or <code>QuickSightConsole</code>. You cannot choose more than one experience configuraton.</p> </note>"
95899593
},
9594+
"RegisteredUserQSearchBarEmbeddingConfiguration":{
9595+
"type":"structure",
9596+
"members":{
9597+
"InitialTopicId":{
9598+
"shape":"RestrictiveResourceId",
9599+
"documentation":"<p>The ID of the Q topic that you want to make the starting topic in the Q search bar. You can find a topic ID by navigating to the Topics pane in the Amazon QuickSight application and opening a topic. The ID is in the URL for the topic that you open.</p> <p>If you don't specify an initial topic, a list of all shared topics is shown in the Q bar for your readers. When you select an initial topic, you can specify whether or not readers are allowed to select other topics from the available ones in the list.</p>"
9600+
}
9601+
},
9602+
"documentation":"<p>Information about the Q search bar embedding experience.</p>"
9603+
},
95909604
"RegisteredUserQuickSightConsoleEmbeddingConfiguration":{
95919605
"type":"structure",
95929606
"members":{

0 commit comments

Comments
 (0)