aws-sdk-quicksight 1.67.0 → 1.68.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eddf140897b8879b3cac3ca05a734a267f282a8da77327bc90220d63fbe10a4b
-  data.tar.gz: 1e3257fb0e95a6f43b14b214a444b4457f5fe03bea50d5cc6b1398a6ba0610fc
+  metadata.gz: c18f75c0c37e09764f89b24e843d8e2beb7904cd40e477b74ab5ef520231b728
+  data.tar.gz: d3494ab6767a744b54da61f05c89981d79bcfc32cb91151877df93a3d9382945
 SHA512:
-  metadata.gz: 4636b15384cbbcc9c0ea8e025a6f798c0b834d5c63e654add4f1148e8c983ff88b7cbe4fe060056c4ed432985ede4045b75504e67bb177e9f92ed82bde1cecb7
-  data.tar.gz: b187fe0782edcbeaab735c3c70dfa8bacb9d0b8999e3235377783c266522d4daa0ebb70ffc5f860b4e8021e9d5291abdf8eff114aaca6491cd9e3cf541c186c2
+  metadata.gz: 4e75a93fc45cde055ef80779bf895c0487d7809fa70d7eedb81ff33cd2fb71ab25ee4221920d0c92c53fbaca73c341618a82f5eef1b02f8456992be058a9910d
+  data.tar.gz: 65962f03fc0c2db13f6a58828a98fa04ade432202d6986cbf12a86ef27afcc7f9b87a21ce4ff47b6909e071cdf536fd779158625c4a77da069ed658e61519722

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.68.0 (2022-08-24)
+------------------
+
+* Feature - Added a new optional property DashboardVisual under ExperienceConfiguration parameter of GenerateEmbedUrlForAnonymousUser and GenerateEmbedUrlForRegisteredUser API operations. This supports embedding of specific visuals in QuickSight dashboards.
+
 1.67.0 (2022-08-08)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.67.0
+1.68.0

data/lib/aws-sdk-quicksight/client.rb

@@ -4652,9 +4652,9 @@ module Aws::QuickSight
     end
 
     # 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.
+    # 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.
     #
     # The following rules apply to the generated URL:
     #
@@ -4756,6 +4756,13 @@ module Aws::QuickSight
     #       dashboard: {
     #         initial_dashboard_id: "RestrictiveResourceId", # required
     #       },
+    #       dashboard_visual: {
+    #         initial_dashboard_visual_id: { # required
+    #           dashboard_id: "RestrictiveResourceId", # required
+    #           sheet_id: "RestrictiveResourceId", # required
+    #           visual_id: "RestrictiveResourceId", # required
+    #         },
+    #       },
     #     },
     #     allowed_domains: ["String"],
     #   })
@@ -4822,7 +4829,8 @@ module Aws::QuickSight
     #
     # @option params [required, Types::RegisteredUserEmbeddingExperienceConfiguration] :experience_configuration
     #   The experience you are embedding. For registered users, you can embed
-    #   Amazon QuickSight dashboards or the entire Amazon QuickSight console.
+    #   Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon
+    #   QuickSight Q search bar, or the entire Amazon QuickSight console.
     #
     # @option params [Array<String>] :allowed_domains
     #   The domains that you want to add to the allow list for access to the
@@ -4858,6 +4866,13 @@ module Aws::QuickSight
     #       q_search_bar: {
     #         initial_topic_id: "RestrictiveResourceId",
     #       },
+    #       dashboard_visual: {
+    #         initial_dashboard_visual_id: { # required
+    #           dashboard_id: "RestrictiveResourceId", # required
+    #           sheet_id: "RestrictiveResourceId", # required
+    #           visual_id: "RestrictiveResourceId", # required
+    #         },
+    #       },
     #     },
     #     allowed_domains: ["String"],
     #   })
@@ -9089,7 +9104,7 @@ module Aws::QuickSight
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-quicksight'
-      context[:gem_version] = '1.67.0'
+      context[:gem_version] = '1.68.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-quicksight/client_api.rb

@@ -38,6 +38,7 @@ module Aws::QuickSight
     AnalysisSummary = Shapes::StructureShape.new(name: 'AnalysisSummary')
     AnalysisSummaryList = Shapes::ListShape.new(name: 'AnalysisSummaryList')
     AnonymousUserDashboardEmbeddingConfiguration = Shapes::StructureShape.new(name: 'AnonymousUserDashboardEmbeddingConfiguration')
+    AnonymousUserDashboardVisualEmbeddingConfiguration = Shapes::StructureShape.new(name: 'AnonymousUserDashboardVisualEmbeddingConfiguration')
     AnonymousUserEmbeddingExperienceConfiguration = Shapes::StructureShape.new(name: 'AnonymousUserEmbeddingExperienceConfiguration')
     Arn = Shapes::StringShape.new(name: 'Arn')
     ArnList = Shapes::ListShape.new(name: 'ArnList')
@@ -141,6 +142,7 @@ module Aws::QuickSight
     DashboardVersion = Shapes::StructureShape.new(name: 'DashboardVersion')
     DashboardVersionSummary = Shapes::StructureShape.new(name: 'DashboardVersionSummary')
     DashboardVersionSummaryList = Shapes::ListShape.new(name: 'DashboardVersionSummaryList')
+    DashboardVisualId = Shapes::StructureShape.new(name: 'DashboardVisualId')
     DataColorPalette = Shapes::StructureShape.new(name: 'DataColorPalette')
     DataSet = Shapes::StructureShape.new(name: 'DataSet')
     DataSetArnsList = Shapes::ListShape.new(name: 'DataSetArnsList')
@@ -445,6 +447,7 @@ module Aws::QuickSight
     RegisterUserRequest = Shapes::StructureShape.new(name: 'RegisterUserRequest')
     RegisterUserResponse = Shapes::StructureShape.new(name: 'RegisterUserResponse')
     RegisteredUserDashboardEmbeddingConfiguration = Shapes::StructureShape.new(name: 'RegisteredUserDashboardEmbeddingConfiguration')
+    RegisteredUserDashboardVisualEmbeddingConfiguration = Shapes::StructureShape.new(name: 'RegisteredUserDashboardVisualEmbeddingConfiguration')
     RegisteredUserEmbeddingExperienceConfiguration = Shapes::StructureShape.new(name: 'RegisteredUserEmbeddingExperienceConfiguration')
     RegisteredUserQSearchBarEmbeddingConfiguration = Shapes::StructureShape.new(name: 'RegisteredUserQSearchBarEmbeddingConfiguration')
     RegisteredUserQuickSightConsoleEmbeddingConfiguration = Shapes::StructureShape.new(name: 'RegisteredUserQuickSightConsoleEmbeddingConfiguration')
@@ -713,7 +716,11 @@ module Aws::QuickSight
     AnonymousUserDashboardEmbeddingConfiguration.add_member(:initial_dashboard_id, Shapes::ShapeRef.new(shape: RestrictiveResourceId, required: true, location_name: "InitialDashboardId"))
     AnonymousUserDashboardEmbeddingConfiguration.struct_class = Types::AnonymousUserDashboardEmbeddingConfiguration
 
+    AnonymousUserDashboardVisualEmbeddingConfiguration.add_member(:initial_dashboard_visual_id, Shapes::ShapeRef.new(shape: DashboardVisualId, required: true, location_name: "InitialDashboardVisualId"))
+    AnonymousUserDashboardVisualEmbeddingConfiguration.struct_class = Types::AnonymousUserDashboardVisualEmbeddingConfiguration
+
     AnonymousUserEmbeddingExperienceConfiguration.add_member(:dashboard, Shapes::ShapeRef.new(shape: AnonymousUserDashboardEmbeddingConfiguration, location_name: "Dashboard"))
+    AnonymousUserEmbeddingExperienceConfiguration.add_member(:dashboard_visual, Shapes::ShapeRef.new(shape: AnonymousUserDashboardVisualEmbeddingConfiguration, location_name: "DashboardVisual"))
     AnonymousUserEmbeddingExperienceConfiguration.struct_class = Types::AnonymousUserEmbeddingExperienceConfiguration
 
     ArnList.member = Shapes::ShapeRef.new(shape: Arn)
@@ -1161,6 +1168,11 @@ module Aws::QuickSight
 
     DashboardVersionSummaryList.member = Shapes::ShapeRef.new(shape: DashboardVersionSummary)
 
+    DashboardVisualId.add_member(:dashboard_id, Shapes::ShapeRef.new(shape: RestrictiveResourceId, required: true, location_name: "DashboardId"))
+    DashboardVisualId.add_member(:sheet_id, Shapes::ShapeRef.new(shape: RestrictiveResourceId, required: true, location_name: "SheetId"))
+    DashboardVisualId.add_member(:visual_id, Shapes::ShapeRef.new(shape: RestrictiveResourceId, required: true, location_name: "VisualId"))
+    DashboardVisualId.struct_class = Types::DashboardVisualId
+
     DataColorPalette.add_member(:colors, Shapes::ShapeRef.new(shape: ColorList, location_name: "Colors"))
     DataColorPalette.add_member(:min_max_gradient, Shapes::ShapeRef.new(shape: ColorList, location_name: "MinMaxGradient"))
     DataColorPalette.add_member(:empty_fill_color, Shapes::ShapeRef.new(shape: HexColor, location_name: "EmptyFillColor"))
@@ -2361,9 +2373,13 @@ module Aws::QuickSight
     RegisteredUserDashboardEmbeddingConfiguration.add_member(:initial_dashboard_id, Shapes::ShapeRef.new(shape: RestrictiveResourceId, required: true, location_name: "InitialDashboardId"))
     RegisteredUserDashboardEmbeddingConfiguration.struct_class = Types::RegisteredUserDashboardEmbeddingConfiguration
 
+    RegisteredUserDashboardVisualEmbeddingConfiguration.add_member(:initial_dashboard_visual_id, Shapes::ShapeRef.new(shape: DashboardVisualId, required: true, location_name: "InitialDashboardVisualId"))
+    RegisteredUserDashboardVisualEmbeddingConfiguration.struct_class = Types::RegisteredUserDashboardVisualEmbeddingConfiguration
+
     RegisteredUserEmbeddingExperienceConfiguration.add_member(:dashboard, Shapes::ShapeRef.new(shape: RegisteredUserDashboardEmbeddingConfiguration, location_name: "Dashboard"))
     RegisteredUserEmbeddingExperienceConfiguration.add_member(:quick_sight_console, Shapes::ShapeRef.new(shape: RegisteredUserQuickSightConsoleEmbeddingConfiguration, location_name: "QuickSightConsole"))
     RegisteredUserEmbeddingExperienceConfiguration.add_member(:q_search_bar, Shapes::ShapeRef.new(shape: RegisteredUserQSearchBarEmbeddingConfiguration, location_name: "QSearchBar"))
+    RegisteredUserEmbeddingExperienceConfiguration.add_member(:dashboard_visual, Shapes::ShapeRef.new(shape: RegisteredUserDashboardVisualEmbeddingConfiguration, location_name: "DashboardVisual"))
     RegisteredUserEmbeddingExperienceConfiguration.struct_class = Types::RegisteredUserEmbeddingExperienceConfiguration
 
     RegisteredUserQSearchBarEmbeddingConfiguration.add_member(:initial_topic_id, Shapes::ShapeRef.new(shape: RestrictiveResourceId, location_name: "InitialTopicId"))

data/lib/aws-sdk-quicksight/types.rb

@@ -484,6 +484,39 @@ module Aws::QuickSight
       include Aws::Structure
     end
 
+    # The experience that you are embedding. You can use this object to
+    # generate a url that embeds a visual into your application.
+    #
+    # @note When making an API call, you may pass AnonymousUserDashboardVisualEmbeddingConfiguration
+    #   data as a hash:
+    #
+    #       {
+    #         initial_dashboard_visual_id: { # required
+    #           dashboard_id: "RestrictiveResourceId", # required
+    #           sheet_id: "RestrictiveResourceId", # required
+    #           visual_id: "RestrictiveResourceId", # required
+    #         },
+    #       }
+    #
+    # @!attribute [rw] initial_dashboard_visual_id
+    #   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.
+    #
+    #   The Amazon Resource Name (ARN) of the dashboard that the visual
+    #   belongs to must be included in the `AuthorizedResourceArns`
+    #   parameter. Otherwise, the request will fail with
+    #   `InvalidParameterValueException`.
+    #   @return [Types::DashboardVisualId]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AnonymousUserDashboardVisualEmbeddingConfiguration AWS API Documentation
+    #
+    class AnonymousUserDashboardVisualEmbeddingConfiguration < Struct.new(
+      :initial_dashboard_visual_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The type of experience you want to embed. For anonymous users, you can
     # embed Amazon QuickSight dashboards.
     #
@@ -494,6 +527,13 @@ module Aws::QuickSight
     #         dashboard: {
     #           initial_dashboard_id: "RestrictiveResourceId", # required
     #         },
+    #         dashboard_visual: {
+    #           initial_dashboard_visual_id: { # required
+    #             dashboard_id: "RestrictiveResourceId", # required
+    #             sheet_id: "RestrictiveResourceId", # required
+    #             visual_id: "RestrictiveResourceId", # required
+    #           },
+    #         },
     #       }
     #
     # @!attribute [rw] dashboard
@@ -501,10 +541,16 @@ module Aws::QuickSight
     #   dashboards.
     #   @return [Types::AnonymousUserDashboardEmbeddingConfiguration]
     #
+    # @!attribute [rw] dashboard_visual
+    #   The type of embedding experience. In this case, Amazon QuickSight
+    #   visuals.
+    #   @return [Types::AnonymousUserDashboardVisualEmbeddingConfiguration]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AnonymousUserEmbeddingExperienceConfiguration AWS API Documentation
     #
     class AnonymousUserEmbeddingExperienceConfiguration < Struct.new(
-      :dashboard)
+      :dashboard,
+      :dashboard_visual)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -3793,6 +3839,61 @@ module Aws::QuickSight
       include Aws::Structure
     end
 
+    # A structure that contains the following elements:
+    #
+    # * The `DashboardId` of the dashboard that has the visual that you want
+    #   to embed.
+    #
+    # * The `SheetId` of the sheet that has the visual that you want to
+    #   embed.
+    #
+    # * The `VisualId` of the visual that you want to embed.
+    #
+    # The `DashboardId`, `SheetId`, and `VisualId` can be found in the `IDs
+    # for developers` section of the `Embed visual` pane of the visual's
+    # on-visual menu of the Amazon QuickSight console. You can also get the
+    # `DashboardId` with a `ListDashboards` API operation.
+    #
+    # @note When making an API call, you may pass DashboardVisualId
+    #   data as a hash:
+    #
+    #       {
+    #         dashboard_id: "RestrictiveResourceId", # required
+    #         sheet_id: "RestrictiveResourceId", # required
+    #         visual_id: "RestrictiveResourceId", # required
+    #       }
+    #
+    # @!attribute [rw] dashboard_id
+    #   The ID of the dashboard that has the visual that you want to embed.
+    #   The `DashboardId` can be found in the `IDs for developers` section
+    #   of the `Embed visual` pane of the visual's on-visual menu of the
+    #   Amazon QuickSight console. You can also get the `DashboardId` with a
+    #   `ListDashboards` API operation.
+    #   @return [String]
+    #
+    # @!attribute [rw] sheet_id
+    #   The ID of the sheet that the has visual that you want to embed. The
+    #   `SheetId` can be found in the `IDs for developers` section of the
+    #   `Embed visual` pane of the visual's on-visual menu of the Amazon
+    #   QuickSight console.
+    #   @return [String]
+    #
+    # @!attribute [rw] visual_id
+    #   The ID of the visual that you want to embed. The `VisualID` can be
+    #   found in the `IDs for developers` section of the `Embed visual` pane
+    #   of the visual's on-visual menu of the Amazon QuickSight console.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DashboardVisualId AWS API Documentation
+    #
+    class DashboardVisualId < Struct.new(
+      :dashboard_id,
+      :sheet_id,
+      :visual_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The theme colors that are used for data colors in charts. The colors
     # description is a hexadecimal color code that consists of six
     # alphanumerical characters, prefixed with `#`, for example #37BFF5.
@@ -7394,6 +7495,13 @@ module Aws::QuickSight
     #           dashboard: {
     #             initial_dashboard_id: "RestrictiveResourceId", # required
     #           },
+    #           dashboard_visual: {
+    #             initial_dashboard_visual_id: { # required
+    #               dashboard_id: "RestrictiveResourceId", # required
+    #               sheet_id: "RestrictiveResourceId", # required
+    #               visual_id: "RestrictiveResourceId", # required
+    #             },
+    #           },
     #         },
     #         allowed_domains: ["String"],
     #       }
@@ -7508,6 +7616,13 @@ module Aws::QuickSight
     #           q_search_bar: {
     #             initial_topic_id: "RestrictiveResourceId",
     #           },
+    #           dashboard_visual: {
+    #             initial_dashboard_visual_id: { # required
+    #               dashboard_id: "RestrictiveResourceId", # required
+    #               sheet_id: "RestrictiveResourceId", # required
+    #               visual_id: "RestrictiveResourceId", # required
+    #             },
+    #           },
     #         },
     #         allowed_domains: ["String"],
     #       }
@@ -7528,7 +7643,8 @@ module Aws::QuickSight
     #
     # @!attribute [rw] experience_configuration
     #   The experience you are embedding. For registered users, you can
-    #   embed Amazon QuickSight dashboards or the entire Amazon QuickSight
+    #   embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the
+    #   Amazon QuickSight Q search bar, or the entire Amazon QuickSight
     #   console.
     #   @return [Types::RegisteredUserEmbeddingExperienceConfiguration]
     #
@@ -7558,7 +7674,8 @@ module Aws::QuickSight
     end
 
     # @!attribute [rw] embed_url
-    #   The embed URL for the Amazon QuickSight dashboard or console.
+    #   The embed URL for the Amazon QuickSight dashboard, visual, Q search
+    #   bar, or console.
     #   @return [String]
     #
     # @!attribute [rw] status
@@ -10751,6 +10868,39 @@ module Aws::QuickSight
       include Aws::Structure
     end
 
+    # The experience that you are embedding. You can use this object to
+    # generate a url that embeds a visual into your application.
+    #
+    # @note When making an API call, you may pass RegisteredUserDashboardVisualEmbeddingConfiguration
+    #   data as a hash:
+    #
+    #       {
+    #         initial_dashboard_visual_id: { # required
+    #           dashboard_id: "RestrictiveResourceId", # required
+    #           sheet_id: "RestrictiveResourceId", # required
+    #           visual_id: "RestrictiveResourceId", # required
+    #         },
+    #       }
+    #
+    # @!attribute [rw] initial_dashboard_visual_id
+    #   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.
+    #
+    #   The Amazon Resource Name (ARN) of the dashboard that the visual
+    #   belongs to must be included in the `AuthorizedResourceArns`
+    #   parameter. Otherwise, the request will fail with
+    #   `InvalidParameterValueException`.
+    #   @return [Types::DashboardVisualId]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RegisteredUserDashboardVisualEmbeddingConfiguration AWS API Documentation
+    #
+    class RegisteredUserDashboardVisualEmbeddingConfiguration < Struct.new(
+      :initial_dashboard_visual_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The type of experience you want to embed. For registered users, you
     # can embed Amazon QuickSight dashboards or the Amazon QuickSight
     # console.
@@ -10774,6 +10924,13 @@ module Aws::QuickSight
     #         q_search_bar: {
     #           initial_topic_id: "RestrictiveResourceId",
     #         },
+    #         dashboard_visual: {
+    #           initial_dashboard_visual_id: { # required
+    #             dashboard_id: "RestrictiveResourceId", # required
+    #             sheet_id: "RestrictiveResourceId", # required
+    #             visual_id: "RestrictiveResourceId", # required
+    #           },
+    #         },
     #       }
     #
     # @!attribute [rw] dashboard
@@ -10826,12 +10983,18 @@ module Aws::QuickSight
     #   [1]: https://docs.aws.amazon.com/quicksight/latest/user/embedding-overview.html
     #   @return [Types::RegisteredUserQSearchBarEmbeddingConfiguration]
     #
+    # @!attribute [rw] dashboard_visual
+    #   The type of embedding experience. In this case, Amazon QuickSight
+    #   visuals.
+    #   @return [Types::RegisteredUserDashboardVisualEmbeddingConfiguration]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RegisteredUserEmbeddingExperienceConfiguration AWS API Documentation
     #
     class RegisteredUserEmbeddingExperienceConfiguration < Struct.new(
       :dashboard,
       :quick_sight_console,
-      :q_search_bar)
+      :q_search_bar,
+      :dashboard_visual)
       SENSITIVE = []
       include Aws::Structure
     end

data/lib/aws-sdk-quicksight.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-quicksight/customizations'
 # @!group service
 module Aws::QuickSight
 
-  GEM_VERSION = '1.67.0'
+  GEM_VERSION = '1.68.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-quicksight
 version: !ruby/object:Gem::Version
-  version: 1.67.0
+  version: 1.68.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-08 00:00:00.000000000 Z
+date: 2022-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core