{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
{-# 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.DescribeDashboard
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Provides a summary for a dashboard.
module Amazonka.QuickSight.DescribeDashboard
  ( -- * Creating a Request
    DescribeDashboard (..),
    newDescribeDashboard,

    -- * Request Lenses
    describeDashboard_aliasName,
    describeDashboard_versionNumber,
    describeDashboard_awsAccountId,
    describeDashboard_dashboardId,

    -- * Destructuring the Response
    DescribeDashboardResponse (..),
    newDescribeDashboardResponse,

    -- * Response Lenses
    describeDashboardResponse_dashboard,
    describeDashboardResponse_requestId,
    describeDashboardResponse_status,
  )
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
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response

-- | /See:/ 'newDescribeDashboard' smart constructor.
data DescribeDashboard = DescribeDashboard'
  { -- | The alias name.
    DescribeDashboard -> Maybe Text
aliasName :: Prelude.Maybe Prelude.Text,
    -- | The version number for the dashboard. If a version number isn\'t passed,
    -- the latest published dashboard version is described.
    DescribeDashboard -> Maybe Natural
versionNumber :: Prelude.Maybe Prelude.Natural,
    -- | The ID of the Amazon Web Services account that contains the dashboard
    -- that you\'re describing.
    DescribeDashboard -> Text
awsAccountId :: Prelude.Text,
    -- | The ID for the dashboard.
    DescribeDashboard -> Text
dashboardId :: Prelude.Text
  }
  deriving (DescribeDashboard -> DescribeDashboard -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeDashboard -> DescribeDashboard -> Bool
$c/= :: DescribeDashboard -> DescribeDashboard -> Bool
== :: DescribeDashboard -> DescribeDashboard -> Bool
$c== :: DescribeDashboard -> DescribeDashboard -> Bool
Prelude.Eq, ReadPrec [DescribeDashboard]
ReadPrec DescribeDashboard
Int -> ReadS DescribeDashboard
ReadS [DescribeDashboard]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeDashboard]
$creadListPrec :: ReadPrec [DescribeDashboard]
readPrec :: ReadPrec DescribeDashboard
$creadPrec :: ReadPrec DescribeDashboard
readList :: ReadS [DescribeDashboard]
$creadList :: ReadS [DescribeDashboard]
readsPrec :: Int -> ReadS DescribeDashboard
$creadsPrec :: Int -> ReadS DescribeDashboard
Prelude.Read, Int -> DescribeDashboard -> ShowS
[DescribeDashboard] -> ShowS
DescribeDashboard -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeDashboard] -> ShowS
$cshowList :: [DescribeDashboard] -> ShowS
show :: DescribeDashboard -> String
$cshow :: DescribeDashboard -> String
showsPrec :: Int -> DescribeDashboard -> ShowS
$cshowsPrec :: Int -> DescribeDashboard -> ShowS
Prelude.Show, forall x. Rep DescribeDashboard x -> DescribeDashboard
forall x. DescribeDashboard -> Rep DescribeDashboard x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DescribeDashboard x -> DescribeDashboard
$cfrom :: forall x. DescribeDashboard -> Rep DescribeDashboard x
Prelude.Generic)

-- |
-- Create a value of 'DescribeDashboard' 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:
--
-- 'aliasName', 'describeDashboard_aliasName' - The alias name.
--
-- 'versionNumber', 'describeDashboard_versionNumber' - The version number for the dashboard. If a version number isn\'t passed,
-- the latest published dashboard version is described.
--
-- 'awsAccountId', 'describeDashboard_awsAccountId' - The ID of the Amazon Web Services account that contains the dashboard
-- that you\'re describing.
--
-- 'dashboardId', 'describeDashboard_dashboardId' - The ID for the dashboard.
newDescribeDashboard ::
  -- | 'awsAccountId'
  Prelude.Text ->
  -- | 'dashboardId'
  Prelude.Text ->
  DescribeDashboard
newDescribeDashboard :: Text -> Text -> DescribeDashboard
newDescribeDashboard Text
pAwsAccountId_ Text
pDashboardId_ =
  DescribeDashboard'
    { $sel:aliasName:DescribeDashboard' :: Maybe Text
aliasName = forall a. Maybe a
Prelude.Nothing,
      $sel:versionNumber:DescribeDashboard' :: Maybe Natural
versionNumber = forall a. Maybe a
Prelude.Nothing,
      $sel:awsAccountId:DescribeDashboard' :: Text
awsAccountId = Text
pAwsAccountId_,
      $sel:dashboardId:DescribeDashboard' :: Text
dashboardId = Text
pDashboardId_
    }

-- | The alias name.
describeDashboard_aliasName :: Lens.Lens' DescribeDashboard (Prelude.Maybe Prelude.Text)
describeDashboard_aliasName :: Lens' DescribeDashboard (Maybe Text)
describeDashboard_aliasName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeDashboard' {Maybe Text
aliasName :: Maybe Text
$sel:aliasName:DescribeDashboard' :: DescribeDashboard -> Maybe Text
aliasName} -> Maybe Text
aliasName) (\s :: DescribeDashboard
s@DescribeDashboard' {} Maybe Text
a -> DescribeDashboard
s {$sel:aliasName:DescribeDashboard' :: Maybe Text
aliasName = Maybe Text
a} :: DescribeDashboard)

-- | The version number for the dashboard. If a version number isn\'t passed,
-- the latest published dashboard version is described.
describeDashboard_versionNumber :: Lens.Lens' DescribeDashboard (Prelude.Maybe Prelude.Natural)
describeDashboard_versionNumber :: Lens' DescribeDashboard (Maybe Natural)
describeDashboard_versionNumber = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeDashboard' {Maybe Natural
versionNumber :: Maybe Natural
$sel:versionNumber:DescribeDashboard' :: DescribeDashboard -> Maybe Natural
versionNumber} -> Maybe Natural
versionNumber) (\s :: DescribeDashboard
s@DescribeDashboard' {} Maybe Natural
a -> DescribeDashboard
s {$sel:versionNumber:DescribeDashboard' :: Maybe Natural
versionNumber = Maybe Natural
a} :: DescribeDashboard)

-- | The ID of the Amazon Web Services account that contains the dashboard
-- that you\'re describing.
describeDashboard_awsAccountId :: Lens.Lens' DescribeDashboard Prelude.Text
describeDashboard_awsAccountId :: Lens' DescribeDashboard Text
describeDashboard_awsAccountId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeDashboard' {Text
awsAccountId :: Text
$sel:awsAccountId:DescribeDashboard' :: DescribeDashboard -> Text
awsAccountId} -> Text
awsAccountId) (\s :: DescribeDashboard
s@DescribeDashboard' {} Text
a -> DescribeDashboard
s {$sel:awsAccountId:DescribeDashboard' :: Text
awsAccountId = Text
a} :: DescribeDashboard)

-- | The ID for the dashboard.
describeDashboard_dashboardId :: Lens.Lens' DescribeDashboard Prelude.Text
describeDashboard_dashboardId :: Lens' DescribeDashboard Text
describeDashboard_dashboardId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeDashboard' {Text
dashboardId :: Text
$sel:dashboardId:DescribeDashboard' :: DescribeDashboard -> Text
dashboardId} -> Text
dashboardId) (\s :: DescribeDashboard
s@DescribeDashboard' {} Text
a -> DescribeDashboard
s {$sel:dashboardId:DescribeDashboard' :: Text
dashboardId = Text
a} :: DescribeDashboard)

instance Core.AWSRequest DescribeDashboard where
  type
    AWSResponse DescribeDashboard =
      DescribeDashboardResponse
  request :: (Service -> Service)
-> DescribeDashboard -> Request DescribeDashboard
request Service -> Service
overrides =
    forall a. ToRequest a => Service -> a -> Request a
Request.get (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy DescribeDashboard
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse DescribeDashboard)))
response =
    forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> Object -> Either String (AWSResponse a))
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveJSON
      ( \Int
s ResponseHeaders
h Object
x ->
          Maybe Dashboard -> Maybe Text -> Int -> DescribeDashboardResponse
DescribeDashboardResponse'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"Dashboard")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"RequestId")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
      )

instance Prelude.Hashable DescribeDashboard where
  hashWithSalt :: Int -> DescribeDashboard -> Int
hashWithSalt Int
_salt DescribeDashboard' {Maybe Natural
Maybe Text
Text
dashboardId :: Text
awsAccountId :: Text
versionNumber :: Maybe Natural
aliasName :: Maybe Text
$sel:dashboardId:DescribeDashboard' :: DescribeDashboard -> Text
$sel:awsAccountId:DescribeDashboard' :: DescribeDashboard -> Text
$sel:versionNumber:DescribeDashboard' :: DescribeDashboard -> Maybe Natural
$sel:aliasName:DescribeDashboard' :: DescribeDashboard -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
aliasName
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Natural
versionNumber
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
awsAccountId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
dashboardId

instance Prelude.NFData DescribeDashboard where
  rnf :: DescribeDashboard -> ()
rnf DescribeDashboard' {Maybe Natural
Maybe Text
Text
dashboardId :: Text
awsAccountId :: Text
versionNumber :: Maybe Natural
aliasName :: Maybe Text
$sel:dashboardId:DescribeDashboard' :: DescribeDashboard -> Text
$sel:awsAccountId:DescribeDashboard' :: DescribeDashboard -> Text
$sel:versionNumber:DescribeDashboard' :: DescribeDashboard -> Maybe Natural
$sel:aliasName:DescribeDashboard' :: DescribeDashboard -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
aliasName
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Natural
versionNumber
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
awsAccountId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
dashboardId

instance Data.ToHeaders DescribeDashboard where
  toHeaders :: DescribeDashboard -> ResponseHeaders
toHeaders =
    forall a b. a -> b -> a
Prelude.const
      ( forall a. Monoid a => [a] -> a
Prelude.mconcat
          [ HeaderName
"Content-Type"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# ( ByteString
"application/x-amz-json-1.0" ::
                          Prelude.ByteString
                      )
          ]
      )

instance Data.ToPath DescribeDashboard where
  toPath :: DescribeDashboard -> ByteString
toPath DescribeDashboard' {Maybe Natural
Maybe Text
Text
dashboardId :: Text
awsAccountId :: Text
versionNumber :: Maybe Natural
aliasName :: Maybe Text
$sel:dashboardId:DescribeDashboard' :: DescribeDashboard -> Text
$sel:awsAccountId:DescribeDashboard' :: DescribeDashboard -> Text
$sel:versionNumber:DescribeDashboard' :: DescribeDashboard -> Maybe Natural
$sel:aliasName:DescribeDashboard' :: DescribeDashboard -> Maybe Text
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ ByteString
"/accounts/",
        forall a. ToByteString a => a -> ByteString
Data.toBS Text
awsAccountId,
        ByteString
"/dashboards/",
        forall a. ToByteString a => a -> ByteString
Data.toBS Text
dashboardId
      ]

instance Data.ToQuery DescribeDashboard where
  toQuery :: DescribeDashboard -> QueryString
toQuery DescribeDashboard' {Maybe Natural
Maybe Text
Text
dashboardId :: Text
awsAccountId :: Text
versionNumber :: Maybe Natural
aliasName :: Maybe Text
$sel:dashboardId:DescribeDashboard' :: DescribeDashboard -> Text
$sel:awsAccountId:DescribeDashboard' :: DescribeDashboard -> Text
$sel:versionNumber:DescribeDashboard' :: DescribeDashboard -> Maybe Natural
$sel:aliasName:DescribeDashboard' :: DescribeDashboard -> Maybe Text
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ ByteString
"alias-name" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Text
aliasName,
        ByteString
"version-number" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Natural
versionNumber
      ]

-- | /See:/ 'newDescribeDashboardResponse' smart constructor.
data DescribeDashboardResponse = DescribeDashboardResponse'
  { -- | Information about the dashboard.
    DescribeDashboardResponse -> Maybe Dashboard
dashboard :: Prelude.Maybe Dashboard,
    -- | The Amazon Web Services request ID for this operation.
    DescribeDashboardResponse -> Maybe Text
requestId :: Prelude.Maybe Prelude.Text,
    -- | The HTTP status of this request.
    DescribeDashboardResponse -> Int
status :: Prelude.Int
  }
  deriving (DescribeDashboardResponse -> DescribeDashboardResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeDashboardResponse -> DescribeDashboardResponse -> Bool
$c/= :: DescribeDashboardResponse -> DescribeDashboardResponse -> Bool
== :: DescribeDashboardResponse -> DescribeDashboardResponse -> Bool
$c== :: DescribeDashboardResponse -> DescribeDashboardResponse -> Bool
Prelude.Eq, ReadPrec [DescribeDashboardResponse]
ReadPrec DescribeDashboardResponse
Int -> ReadS DescribeDashboardResponse
ReadS [DescribeDashboardResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeDashboardResponse]
$creadListPrec :: ReadPrec [DescribeDashboardResponse]
readPrec :: ReadPrec DescribeDashboardResponse
$creadPrec :: ReadPrec DescribeDashboardResponse
readList :: ReadS [DescribeDashboardResponse]
$creadList :: ReadS [DescribeDashboardResponse]
readsPrec :: Int -> ReadS DescribeDashboardResponse
$creadsPrec :: Int -> ReadS DescribeDashboardResponse
Prelude.Read, Int -> DescribeDashboardResponse -> ShowS
[DescribeDashboardResponse] -> ShowS
DescribeDashboardResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeDashboardResponse] -> ShowS
$cshowList :: [DescribeDashboardResponse] -> ShowS
show :: DescribeDashboardResponse -> String
$cshow :: DescribeDashboardResponse -> String
showsPrec :: Int -> DescribeDashboardResponse -> ShowS
$cshowsPrec :: Int -> DescribeDashboardResponse -> ShowS
Prelude.Show, forall x.
Rep DescribeDashboardResponse x -> DescribeDashboardResponse
forall x.
DescribeDashboardResponse -> Rep DescribeDashboardResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep DescribeDashboardResponse x -> DescribeDashboardResponse
$cfrom :: forall x.
DescribeDashboardResponse -> Rep DescribeDashboardResponse x
Prelude.Generic)

-- |
-- Create a value of 'DescribeDashboardResponse' 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:
--
-- 'dashboard', 'describeDashboardResponse_dashboard' - Information about the dashboard.
--
-- 'requestId', 'describeDashboardResponse_requestId' - The Amazon Web Services request ID for this operation.
--
-- 'status', 'describeDashboardResponse_status' - The HTTP status of this request.
newDescribeDashboardResponse ::
  -- | 'status'
  Prelude.Int ->
  DescribeDashboardResponse
newDescribeDashboardResponse :: Int -> DescribeDashboardResponse
newDescribeDashboardResponse Int
pStatus_ =
  DescribeDashboardResponse'
    { $sel:dashboard:DescribeDashboardResponse' :: Maybe Dashboard
dashboard =
        forall a. Maybe a
Prelude.Nothing,
      $sel:requestId:DescribeDashboardResponse' :: Maybe Text
requestId = forall a. Maybe a
Prelude.Nothing,
      $sel:status:DescribeDashboardResponse' :: Int
status = Int
pStatus_
    }

-- | Information about the dashboard.
describeDashboardResponse_dashboard :: Lens.Lens' DescribeDashboardResponse (Prelude.Maybe Dashboard)
describeDashboardResponse_dashboard :: Lens' DescribeDashboardResponse (Maybe Dashboard)
describeDashboardResponse_dashboard = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeDashboardResponse' {Maybe Dashboard
dashboard :: Maybe Dashboard
$sel:dashboard:DescribeDashboardResponse' :: DescribeDashboardResponse -> Maybe Dashboard
dashboard} -> Maybe Dashboard
dashboard) (\s :: DescribeDashboardResponse
s@DescribeDashboardResponse' {} Maybe Dashboard
a -> DescribeDashboardResponse
s {$sel:dashboard:DescribeDashboardResponse' :: Maybe Dashboard
dashboard = Maybe Dashboard
a} :: DescribeDashboardResponse)

-- | The Amazon Web Services request ID for this operation.
describeDashboardResponse_requestId :: Lens.Lens' DescribeDashboardResponse (Prelude.Maybe Prelude.Text)
describeDashboardResponse_requestId :: Lens' DescribeDashboardResponse (Maybe Text)
describeDashboardResponse_requestId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeDashboardResponse' {Maybe Text
requestId :: Maybe Text
$sel:requestId:DescribeDashboardResponse' :: DescribeDashboardResponse -> Maybe Text
requestId} -> Maybe Text
requestId) (\s :: DescribeDashboardResponse
s@DescribeDashboardResponse' {} Maybe Text
a -> DescribeDashboardResponse
s {$sel:requestId:DescribeDashboardResponse' :: Maybe Text
requestId = Maybe Text
a} :: DescribeDashboardResponse)

-- | The HTTP status of this request.
describeDashboardResponse_status :: Lens.Lens' DescribeDashboardResponse Prelude.Int
describeDashboardResponse_status :: Lens' DescribeDashboardResponse Int
describeDashboardResponse_status = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeDashboardResponse' {Int
status :: Int
$sel:status:DescribeDashboardResponse' :: DescribeDashboardResponse -> Int
status} -> Int
status) (\s :: DescribeDashboardResponse
s@DescribeDashboardResponse' {} Int
a -> DescribeDashboardResponse
s {$sel:status:DescribeDashboardResponse' :: Int
status = Int
a} :: DescribeDashboardResponse)

instance Prelude.NFData DescribeDashboardResponse where
  rnf :: DescribeDashboardResponse -> ()
rnf DescribeDashboardResponse' {Int
Maybe Text
Maybe Dashboard
status :: Int
requestId :: Maybe Text
dashboard :: Maybe Dashboard
$sel:status:DescribeDashboardResponse' :: DescribeDashboardResponse -> Int
$sel:requestId:DescribeDashboardResponse' :: DescribeDashboardResponse -> Maybe Text
$sel:dashboard:DescribeDashboardResponse' :: DescribeDashboardResponse -> Maybe Dashboard
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Dashboard
dashboard
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
requestId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
status