Amazon QuickSight Update: Added a new optional property DashboardVisual under ExperienceConfiguration parameter of GenerateEmbedUrlForAnonymousUser and GenerateEmbedUrlForRegisteredUser API operations. This supports embedding of specific visuals in QuickSight dashboards.

AWS · AWS · commit be6ad36f9d7c · 2022-08-24T18:10:58.000Z
diff --git a/.changes/next-release/feature-AmazonQuickSight-98a15a8.json b/.changes/next-release/feature-AmazonQuickSight-98a15a8.json
@@ -0,0 +1,6 @@
+{
+    "type": "feature",
+    "category": "Amazon QuickSight",
+    "contributor": "",
+    "description": "Added a new optional property DashboardVisual under ExperienceConfiguration parameter of GenerateEmbedUrlForAnonymousUser and GenerateEmbedUrlForRegisteredUser API operations. This supports embedding of specific visuals in QuickSight dashboards."
+}
diff --git a/services/quicksight/src/main/resources/codegen-resources/service-2.json b/services/quicksight/src/main/resources/codegen-resources/service-2.json
@@ -1186,7 +1186,7 @@
         {"shape":"UnsupportedPricingPlanException"},
         {"shape":"InternalFailureException"}
       ],
-      "documentation":"<p>Generates an embed URL that you can use to embed an Amazon QuickSight dashboard in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions.</p> <p>The following rules apply to the generated URL:</p> <ul> <li> <p>It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.</p> </li> <li> <p>The URL validity period should not be confused with the actual session lifetime that can be customized using the <code> <a href=\"https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GenerateEmbedUrlForAnonymousUser.html#QS-GenerateEmbedUrlForAnonymousUser-request-SessionLifetimeInMinutes\">SessionLifetimeInMinutes</a> </code> parameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours.</p> </li> <li> <p>You are charged only when the URL is used or there is interaction with Amazon QuickSight.</p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html\">Embedded Analytics</a> in the <i>Amazon QuickSight User Guide</i>.</p> <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>"
+      "documentation":"<p>Generates an embed URL that you can use to embed an Amazon QuickSight dashboard or visual in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions.</p> <p>The following rules apply to the generated URL:</p> <ul> <li> <p>It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.</p> </li> <li> <p>The URL validity period should not be confused with the actual session lifetime that can be customized using the <code> <a href=\"https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GenerateEmbedUrlForAnonymousUser.html#QS-GenerateEmbedUrlForAnonymousUser-request-SessionLifetimeInMinutes\">SessionLifetimeInMinutes</a> </code> parameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours.</p> </li> <li> <p>You are charged only when the URL is used or there is interaction with Amazon QuickSight.</p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html\">Embedded Analytics</a> in the <i>Amazon QuickSight User Guide</i>.</p> <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>"
     },
     "GenerateEmbedUrlForRegisteredUser":{
       "name":"GenerateEmbedUrlForRegisteredUser",
@@ -2591,12 +2591,27 @@
       },
       "documentation":"<p>Information about the dashboard that you want to embed.</p>"
     },
+    "AnonymousUserDashboardVisualEmbeddingConfiguration":{
+      "type":"structure",
+      "required":["InitialDashboardVisualId"],
+      "members":{
+        "InitialDashboardVisualId":{
+          "shape":"DashboardVisualId",
+          "documentation":"<p>The visual ID for the visual that you want the user to see. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this visual.</p> <p>The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the <code>AuthorizedResourceArns</code> parameter. Otherwise, the request will fail with <code>InvalidParameterValueException</code>.</p>"
+        }
+      },
+      "documentation":"<p>The experience that you are embedding. You can use this object to generate a url that embeds a visual into your application.</p>"
+    },
     "AnonymousUserEmbeddingExperienceConfiguration":{
       "type":"structure",
       "members":{
         "Dashboard":{
           "shape":"AnonymousUserDashboardEmbeddingConfiguration",
           "documentation":"<p>The type of embedding experience. In this case, Amazon QuickSight dashboards.</p>"
+        },
+        "DashboardVisual":{
+          "shape":"AnonymousUserDashboardVisualEmbeddingConfiguration",
+          "documentation":"<p>The type of embedding experience. In this case, Amazon QuickSight visuals.</p>"
         }
       },
       "documentation":"<p>The type of experience you want to embed. For anonymous users, you can embed Amazon QuickSight dashboards.</p>"
@@ -4525,6 +4540,29 @@
       "member":{"shape":"DashboardVersionSummary"},
       "max":100
     },
+    "DashboardVisualId":{
+      "type":"structure",
+      "required":[
+        "DashboardId",
+        "SheetId",
+        "VisualId"
+      ],
+      "members":{
+        "DashboardId":{
+          "shape":"RestrictiveResourceId",
+          "documentation":"<p>The ID of the dashboard that has the visual that you want to embed. The <code>DashboardId</code> can be found in the <code>IDs for developers</code> section of the <code>Embed visual</code> pane of the visual's on-visual menu of the Amazon QuickSight console. You can also get the <code>DashboardId</code> with a <code>ListDashboards</code> API operation.</p>"
+        },
+        "SheetId":{
+          "shape":"RestrictiveResourceId",
+          "documentation":"<p>The ID of the sheet that the has visual that you want to embed. The <code>SheetId</code> can be found in the <code>IDs for developers</code> section of the <code>Embed visual</code> pane of the visual's on-visual menu of the Amazon QuickSight console.</p>"
+        },
+        "VisualId":{
+          "shape":"RestrictiveResourceId",
+          "documentation":"<p>The ID of the visual that you want to embed. The <code>VisualID</code> can be found in the <code>IDs for developers</code> section of the <code>Embed visual</code> pane of the visual's on-visual menu of the Amazon QuickSight console.</p>"
+        }
+      },
+      "documentation":"<p>A structure that contains the following elements:</p> <ul> <li> <p>The <code>DashboardId</code> of the dashboard that has the visual that you want to embed.</p> </li> <li> <p>The <code>SheetId</code> of the sheet that has the visual that you want to embed.</p> </li> <li> <p>The <code>VisualId</code> of the visual that you want to embed.</p> </li> </ul> <p>The <code>DashboardId</code>, <code>SheetId</code>, and <code>VisualId</code> can be found in the <code>IDs for developers</code> section of the <code>Embed visual</code> pane of the visual's on-visual menu of the Amazon QuickSight console. You can also get the <code>DashboardId</code> with a <code>ListDashboards</code> API operation.</p>"
+    },
     "DataColorPalette":{
       "type":"structure",
       "members":{
@@ -7403,7 +7441,7 @@
         },
         "ExperienceConfiguration":{
           "shape":"RegisteredUserEmbeddingExperienceConfiguration",
-          "documentation":"<p>The experience you are embedding. For registered users, you can embed Amazon QuickSight dashboards or the entire Amazon QuickSight console.</p>"
+          "documentation":"<p>The experience you are embedding. For registered users, you can embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search bar, or the entire Amazon QuickSight console.</p>"
         },
         "AllowedDomains":{
           "shape":"StringList",
@@ -7421,7 +7459,7 @@
       "members":{
         "EmbedUrl":{
           "shape":"EmbeddingUrl",
-          "documentation":"<p>The embed URL for the Amazon QuickSight dashboard or console.</p>"
+          "documentation":"<p>The embed URL for the Amazon QuickSight dashboard, visual, Q search bar, or console.</p>"
         },
         "Status":{
           "shape":"StatusCode",
@@ -9980,6 +10018,17 @@
       },
       "documentation":"<p>Information about the dashboard you want to embed.</p>"
     },
+    "RegisteredUserDashboardVisualEmbeddingConfiguration":{
+      "type":"structure",
+      "required":["InitialDashboardVisualId"],
+      "members":{
+        "InitialDashboardVisualId":{
+          "shape":"DashboardVisualId",
+          "documentation":"<p>The visual ID for the visual that you want the user to embed. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this visual.</p> <p>The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the <code>AuthorizedResourceArns</code> parameter. Otherwise, the request will fail with <code>InvalidParameterValueException</code>.</p>"
+        }
+      },
+      "documentation":"<p>The experience that you are embedding. You can use this object to generate a url that embeds a visual into your application.</p>"
+    },
     "RegisteredUserEmbeddingExperienceConfiguration":{
       "type":"structure",
       "members":{
@@ -9994,6 +10043,10 @@
         "QSearchBar":{
           "shape":"RegisteredUserQSearchBarEmbeddingConfiguration",
           "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> in the <i>Amazon QuickSight User Guide</i>.</p>"
+        },
+        "DashboardVisual":{
+          "shape":"RegisteredUserDashboardVisualEmbeddingConfiguration",
+          "documentation":"<p>The type of embedding experience. In this case, Amazon QuickSight visuals.</p>"
         }
       },
       "documentation":"<p>The type of experience you want to embed. For registered users, you can embed Amazon QuickSight dashboards 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 configuration.</p> </note>"
