Class: Aws::QuickSight::Types::RegisteredUserQSearchBarEmbeddingConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb

Overview

Note:

When making an API call, you may pass RegisteredUserQSearchBarEmbeddingConfiguration data as a hash:

{
  initial_topic_id: "RestrictiveResourceId",
}

Information about the Q search bar embedding experience.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#initial_topic_idString

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.

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.

Returns:

  • (String)


10513
10514
10515
10516
10517
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 10513

class RegisteredUserQSearchBarEmbeddingConfiguration < Struct.new(
  :initial_topic_id)
  SENSITIVE = []
  include Aws::Structure
end