Amazonka.QuickSight.Types.AnonymousUserQSearchBarEmbeddingConfiguration

Documentation

data AnonymousUserQSearchBarEmbeddingConfiguration

The settings that you want to use with the Q search bar.

See: newAnonymousUserQSearchBarEmbeddingConfiguration smart constructor.

Constructors

AnonymousUserQSearchBarEmbeddingConfiguration'

Fields

• initialTopicId :: Text

  The QuickSight Q topic ID of the topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders the Q search bar with this topic pre-selected.

  The Amazon Resource Name (ARN) of this Q topic must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

Instances

ToJSON AnonymousUserQSearchBarEmbeddingConfiguration

Defined in Amazonka.QuickSight.Types.AnonymousUserQSearchBarEmbeddingConfiguration

Methods

toJSON :: AnonymousUserQSearchBarEmbeddingConfiguration -> Value

toEncoding :: AnonymousUserQSearchBarEmbeddingConfiguration -> Encoding

toJSONList :: [AnonymousUserQSearchBarEmbeddingConfiguration] -> Value

toEncodingList :: [AnonymousUserQSearchBarEmbeddingConfiguration] -> Encoding

Generic AnonymousUserQSearchBarEmbeddingConfiguration

Defined in Amazonka.QuickSight.Types.AnonymousUserQSearchBarEmbeddingConfiguration

Associated Types

type Rep AnonymousUserQSearchBarEmbeddingConfiguration :: Type -> Type

Methods

from :: AnonymousUserQSearchBarEmbeddingConfiguration -> Rep AnonymousUserQSearchBarEmbeddingConfiguration x

to :: Rep AnonymousUserQSearchBarEmbeddingConfiguration x -> AnonymousUserQSearchBarEmbeddingConfiguration

Read AnonymousUserQSearchBarEmbeddingConfiguration

Defined in Amazonka.QuickSight.Types.AnonymousUserQSearchBarEmbeddingConfiguration

Methods

readsPrec :: Int -> ReadS AnonymousUserQSearchBarEmbeddingConfiguration

readList :: ReadS [AnonymousUserQSearchBarEmbeddingConfiguration]

readPrec :: ReadPrec AnonymousUserQSearchBarEmbeddingConfiguration

readListPrec :: ReadPrec [AnonymousUserQSearchBarEmbeddingConfiguration]

Show AnonymousUserQSearchBarEmbeddingConfiguration

Defined in Amazonka.QuickSight.Types.AnonymousUserQSearchBarEmbeddingConfiguration

Methods

showsPrec :: Int -> AnonymousUserQSearchBarEmbeddingConfiguration -> ShowS

show :: AnonymousUserQSearchBarEmbeddingConfiguration -> String

showList :: [AnonymousUserQSearchBarEmbeddingConfiguration] -> ShowS

NFData AnonymousUserQSearchBarEmbeddingConfiguration

Defined in Amazonka.QuickSight.Types.AnonymousUserQSearchBarEmbeddingConfiguration

Methods

rnf :: AnonymousUserQSearchBarEmbeddingConfiguration -> ()

Eq AnonymousUserQSearchBarEmbeddingConfiguration

Defined in Amazonka.QuickSight.Types.AnonymousUserQSearchBarEmbeddingConfiguration

Methods

(==) :: AnonymousUserQSearchBarEmbeddingConfiguration -> AnonymousUserQSearchBarEmbeddingConfiguration -> Bool

(/=) :: AnonymousUserQSearchBarEmbeddingConfiguration -> AnonymousUserQSearchBarEmbeddingConfiguration -> Bool

Hashable AnonymousUserQSearchBarEmbeddingConfiguration

Defined in Amazonka.QuickSight.Types.AnonymousUserQSearchBarEmbeddingConfiguration

Methods

hashWithSalt :: Int -> AnonymousUserQSearchBarEmbeddingConfiguration -> Int

hash :: AnonymousUserQSearchBarEmbeddingConfiguration -> Int

type Rep AnonymousUserQSearchBarEmbeddingConfiguration

Defined in Amazonka.QuickSight.Types.AnonymousUserQSearchBarEmbeddingConfiguration

type Rep AnonymousUserQSearchBarEmbeddingConfiguration = D1 ('MetaData "AnonymousUserQSearchBarEmbeddingConfiguration" "Amazonka.QuickSight.Types.AnonymousUserQSearchBarEmbeddingConfiguration" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "AnonymousUserQSearchBarEmbeddingConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "initialTopicId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newAnonymousUserQSearchBarEmbeddingConfiguration

Arguments

:: Text

$sel:initialTopicId:AnonymousUserQSearchBarEmbeddingConfiguration'

-> AnonymousUserQSearchBarEmbeddingConfiguration

Create a value of AnonymousUserQSearchBarEmbeddingConfiguration 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:AnonymousUserQSearchBarEmbeddingConfiguration', anonymousUserQSearchBarEmbeddingConfiguration_initialTopicId - The QuickSight Q topic ID of the topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders the Q search bar with this topic pre-selected.

The Amazon Resource Name (ARN) of this Q topic must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

anonymousUserQSearchBarEmbeddingConfiguration_initialTopicId :: Lens' AnonymousUserQSearchBarEmbeddingConfiguration Text

The QuickSight Q topic ID of the topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders the Q search bar with this topic pre-selected.

The Amazon Resource Name (ARN) of this Q topic must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.