{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.QuickSight.Types.RegisteredUserDashboardVisualEmbeddingConfiguration
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.QuickSight.Types.RegisteredUserDashboardVisualEmbeddingConfiguration where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude
import Amazonka.QuickSight.Types.DashboardVisualId

-- | The experience that you are embedding. You can use this object to
-- generate a url that embeds a visual into your application.
--
-- /See:/ 'newRegisteredUserDashboardVisualEmbeddingConfiguration' smart constructor.
data RegisteredUserDashboardVisualEmbeddingConfiguration = RegisteredUserDashboardVisualEmbeddingConfiguration'
  { -- | 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@.
    RegisteredUserDashboardVisualEmbeddingConfiguration
-> DashboardVisualId
initialDashboardVisualId :: DashboardVisualId
  }
  deriving (RegisteredUserDashboardVisualEmbeddingConfiguration
-> RegisteredUserDashboardVisualEmbeddingConfiguration -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: RegisteredUserDashboardVisualEmbeddingConfiguration
-> RegisteredUserDashboardVisualEmbeddingConfiguration -> Bool
$c/= :: RegisteredUserDashboardVisualEmbeddingConfiguration
-> RegisteredUserDashboardVisualEmbeddingConfiguration -> Bool
== :: RegisteredUserDashboardVisualEmbeddingConfiguration
-> RegisteredUserDashboardVisualEmbeddingConfiguration -> Bool
$c== :: RegisteredUserDashboardVisualEmbeddingConfiguration
-> RegisteredUserDashboardVisualEmbeddingConfiguration -> Bool
Prelude.Eq, ReadPrec [RegisteredUserDashboardVisualEmbeddingConfiguration]
ReadPrec RegisteredUserDashboardVisualEmbeddingConfiguration
Int -> ReadS RegisteredUserDashboardVisualEmbeddingConfiguration
ReadS [RegisteredUserDashboardVisualEmbeddingConfiguration]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [RegisteredUserDashboardVisualEmbeddingConfiguration]
$creadListPrec :: ReadPrec [RegisteredUserDashboardVisualEmbeddingConfiguration]
readPrec :: ReadPrec RegisteredUserDashboardVisualEmbeddingConfiguration
$creadPrec :: ReadPrec RegisteredUserDashboardVisualEmbeddingConfiguration
readList :: ReadS [RegisteredUserDashboardVisualEmbeddingConfiguration]
$creadList :: ReadS [RegisteredUserDashboardVisualEmbeddingConfiguration]
readsPrec :: Int -> ReadS RegisteredUserDashboardVisualEmbeddingConfiguration
$creadsPrec :: Int -> ReadS RegisteredUserDashboardVisualEmbeddingConfiguration
Prelude.Read, Int -> RegisteredUserDashboardVisualEmbeddingConfiguration -> ShowS
[RegisteredUserDashboardVisualEmbeddingConfiguration] -> ShowS
RegisteredUserDashboardVisualEmbeddingConfiguration -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [RegisteredUserDashboardVisualEmbeddingConfiguration] -> ShowS
$cshowList :: [RegisteredUserDashboardVisualEmbeddingConfiguration] -> ShowS
show :: RegisteredUserDashboardVisualEmbeddingConfiguration -> String
$cshow :: RegisteredUserDashboardVisualEmbeddingConfiguration -> String
showsPrec :: Int -> RegisteredUserDashboardVisualEmbeddingConfiguration -> ShowS
$cshowsPrec :: Int -> RegisteredUserDashboardVisualEmbeddingConfiguration -> ShowS
Prelude.Show, forall x.
Rep RegisteredUserDashboardVisualEmbeddingConfiguration x
-> RegisteredUserDashboardVisualEmbeddingConfiguration
forall x.
RegisteredUserDashboardVisualEmbeddingConfiguration
-> Rep RegisteredUserDashboardVisualEmbeddingConfiguration x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep RegisteredUserDashboardVisualEmbeddingConfiguration x
-> RegisteredUserDashboardVisualEmbeddingConfiguration
$cfrom :: forall x.
RegisteredUserDashboardVisualEmbeddingConfiguration
-> Rep RegisteredUserDashboardVisualEmbeddingConfiguration x
Prelude.Generic)

-- |
-- Create a value of 'RegisteredUserDashboardVisualEmbeddingConfiguration' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'initialDashboardVisualId', 'registeredUserDashboardVisualEmbeddingConfiguration_initialDashboardVisualId' - 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@.
newRegisteredUserDashboardVisualEmbeddingConfiguration ::
  -- | 'initialDashboardVisualId'
  DashboardVisualId ->
  RegisteredUserDashboardVisualEmbeddingConfiguration
newRegisteredUserDashboardVisualEmbeddingConfiguration :: DashboardVisualId
-> RegisteredUserDashboardVisualEmbeddingConfiguration
newRegisteredUserDashboardVisualEmbeddingConfiguration
  DashboardVisualId
pInitialDashboardVisualId_ =
    RegisteredUserDashboardVisualEmbeddingConfiguration'
      { $sel:initialDashboardVisualId:RegisteredUserDashboardVisualEmbeddingConfiguration' :: DashboardVisualId
initialDashboardVisualId =
          DashboardVisualId
pInitialDashboardVisualId_
      }

-- | 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@.
registeredUserDashboardVisualEmbeddingConfiguration_initialDashboardVisualId :: Lens.Lens' RegisteredUserDashboardVisualEmbeddingConfiguration DashboardVisualId
registeredUserDashboardVisualEmbeddingConfiguration_initialDashboardVisualId :: Lens'
  RegisteredUserDashboardVisualEmbeddingConfiguration
  DashboardVisualId
registeredUserDashboardVisualEmbeddingConfiguration_initialDashboardVisualId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\RegisteredUserDashboardVisualEmbeddingConfiguration' {DashboardVisualId
initialDashboardVisualId :: DashboardVisualId
$sel:initialDashboardVisualId:RegisteredUserDashboardVisualEmbeddingConfiguration' :: RegisteredUserDashboardVisualEmbeddingConfiguration
-> DashboardVisualId
initialDashboardVisualId} -> DashboardVisualId
initialDashboardVisualId) (\s :: RegisteredUserDashboardVisualEmbeddingConfiguration
s@RegisteredUserDashboardVisualEmbeddingConfiguration' {} DashboardVisualId
a -> RegisteredUserDashboardVisualEmbeddingConfiguration
s {$sel:initialDashboardVisualId:RegisteredUserDashboardVisualEmbeddingConfiguration' :: DashboardVisualId
initialDashboardVisualId = DashboardVisualId
a} :: RegisteredUserDashboardVisualEmbeddingConfiguration)

instance
  Prelude.Hashable
    RegisteredUserDashboardVisualEmbeddingConfiguration
  where
  hashWithSalt :: Int -> RegisteredUserDashboardVisualEmbeddingConfiguration -> Int
hashWithSalt
    Int
_salt
    RegisteredUserDashboardVisualEmbeddingConfiguration' {DashboardVisualId
initialDashboardVisualId :: DashboardVisualId
$sel:initialDashboardVisualId:RegisteredUserDashboardVisualEmbeddingConfiguration' :: RegisteredUserDashboardVisualEmbeddingConfiguration
-> DashboardVisualId
..} =
      Int
_salt
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` DashboardVisualId
initialDashboardVisualId

instance
  Prelude.NFData
    RegisteredUserDashboardVisualEmbeddingConfiguration
  where
  rnf :: RegisteredUserDashboardVisualEmbeddingConfiguration -> ()
rnf
    RegisteredUserDashboardVisualEmbeddingConfiguration' {DashboardVisualId
initialDashboardVisualId :: DashboardVisualId
$sel:initialDashboardVisualId:RegisteredUserDashboardVisualEmbeddingConfiguration' :: RegisteredUserDashboardVisualEmbeddingConfiguration
-> DashboardVisualId
..} =
      forall a. NFData a => a -> ()
Prelude.rnf DashboardVisualId
initialDashboardVisualId

instance
  Data.ToJSON
    RegisteredUserDashboardVisualEmbeddingConfiguration
  where
  toJSON :: RegisteredUserDashboardVisualEmbeddingConfiguration -> Value
toJSON
    RegisteredUserDashboardVisualEmbeddingConfiguration' {DashboardVisualId
initialDashboardVisualId :: DashboardVisualId
$sel:initialDashboardVisualId:RegisteredUserDashboardVisualEmbeddingConfiguration' :: RegisteredUserDashboardVisualEmbeddingConfiguration
-> DashboardVisualId
..} =
      [Pair] -> Value
Data.object
        ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
            [ forall a. a -> Maybe a
Prelude.Just
                ( Key
"InitialDashboardVisualId"
                    forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= DashboardVisualId
initialDashboardVisualId
                )
            ]
        )