Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.QuickSight.Types.RegisteredUserQSearchBarEmbeddingConfiguration

Description

Synopsis

data RegisteredUserQSearchBarEmbeddingConfiguration = RegisteredUserQSearchBarEmbeddingConfiguration' {
- initialTopicId :: Maybe Text
}
newRegisteredUserQSearchBarEmbeddingConfiguration :: RegisteredUserQSearchBarEmbeddingConfiguration
registeredUserQSearchBarEmbeddingConfiguration_initialTopicId :: Lens' RegisteredUserQSearchBarEmbeddingConfiguration (Maybe Text)

Documentation

data RegisteredUserQSearchBarEmbeddingConfiguration Source #

Information about the Q search bar embedding experience.

See: newRegisteredUserQSearchBarEmbeddingConfiguration smart constructor.

Constructors

RegisteredUserQSearchBarEmbeddingConfiguration'

Fields

initialTopicId :: Maybe Text
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.

Instances

Instances details

Eq RegisteredUserQSearchBarEmbeddingConfiguration Source #
Instance details Defined in Amazonka.QuickSight.Types.RegisteredUserQSearchBarEmbeddingConfiguration Methods (==) :: RegisteredUserQSearchBarEmbeddingConfiguration -> RegisteredUserQSearchBarEmbeddingConfiguration -> Bool # (/=) :: RegisteredUserQSearchBarEmbeddingConfiguration -> RegisteredUserQSearchBarEmbeddingConfiguration -> Bool #
Read RegisteredUserQSearchBarEmbeddingConfiguration Source #
Instance details Defined in Amazonka.QuickSight.Types.RegisteredUserQSearchBarEmbeddingConfiguration Methods readsPrec :: Int -> ReadS RegisteredUserQSearchBarEmbeddingConfiguration # readList :: ReadS [RegisteredUserQSearchBarEmbeddingConfiguration] # readPrec :: ReadPrec RegisteredUserQSearchBarEmbeddingConfiguration # readListPrec :: ReadPrec [RegisteredUserQSearchBarEmbeddingConfiguration] #
Show RegisteredUserQSearchBarEmbeddingConfiguration Source #
Instance details Defined in Amazonka.QuickSight.Types.RegisteredUserQSearchBarEmbeddingConfiguration Methods showsPrec :: Int -> RegisteredUserQSearchBarEmbeddingConfiguration -> ShowS # show :: RegisteredUserQSearchBarEmbeddingConfiguration -> String # showList :: [RegisteredUserQSearchBarEmbeddingConfiguration] -> ShowS #
Generic RegisteredUserQSearchBarEmbeddingConfiguration Source #
Instance details Defined in Amazonka.QuickSight.Types.RegisteredUserQSearchBarEmbeddingConfiguration Associated Types type Rep RegisteredUserQSearchBarEmbeddingConfiguration :: Type -> Type # Methods from :: RegisteredUserQSearchBarEmbeddingConfiguration -> Rep RegisteredUserQSearchBarEmbeddingConfiguration x # to :: Rep RegisteredUserQSearchBarEmbeddingConfiguration x -> RegisteredUserQSearchBarEmbeddingConfiguration #
NFData RegisteredUserQSearchBarEmbeddingConfiguration Source #
Instance details Defined in Amazonka.QuickSight.Types.RegisteredUserQSearchBarEmbeddingConfiguration Methods rnf :: RegisteredUserQSearchBarEmbeddingConfiguration -> () #
Hashable RegisteredUserQSearchBarEmbeddingConfiguration Source #
Instance details Defined in Amazonka.QuickSight.Types.RegisteredUserQSearchBarEmbeddingConfiguration Methods hashWithSalt :: Int -> RegisteredUserQSearchBarEmbeddingConfiguration -> Int # hash :: RegisteredUserQSearchBarEmbeddingConfiguration -> Int #
ToJSON RegisteredUserQSearchBarEmbeddingConfiguration Source #
Instance details Defined in Amazonka.QuickSight.Types.RegisteredUserQSearchBarEmbeddingConfiguration Methods toJSON :: RegisteredUserQSearchBarEmbeddingConfiguration -> Value # toEncoding :: RegisteredUserQSearchBarEmbeddingConfiguration -> Encoding # toJSONList :: [RegisteredUserQSearchBarEmbeddingConfiguration] -> Value # toEncodingList :: [RegisteredUserQSearchBarEmbeddingConfiguration] -> Encoding #
type Rep RegisteredUserQSearchBarEmbeddingConfiguration Source #
Instance details Defined in Amazonka.QuickSight.Types.RegisteredUserQSearchBarEmbeddingConfiguration type Rep RegisteredUserQSearchBarEmbeddingConfiguration = D1 ('MetaData "RegisteredUserQSearchBarEmbeddingConfiguration" "Amazonka.QuickSight.Types.RegisteredUserQSearchBarEmbeddingConfiguration" "libZSservicesZSamazonka-quicksightZSamazonka-quicksight" 'False) (C1 ('MetaCons "RegisteredUserQSearchBarEmbeddingConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "initialTopicId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newRegisteredUserQSearchBarEmbeddingConfiguration :: RegisteredUserQSearchBarEmbeddingConfiguration Source #

Create a value of RegisteredUserQSearchBarEmbeddingConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:initialTopicId:RegisteredUserQSearchBarEmbeddingConfiguration', registeredUserQSearchBarEmbeddingConfiguration_initialTopicId - 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.

registeredUserQSearchBarEmbeddingConfiguration_initialTopicId :: Lens' RegisteredUserQSearchBarEmbeddingConfiguration (Maybe Text) Source #

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.