{-# 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.DescribeDashboardDefinition
-- 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 detailed description of the definition of a dashboard.
--
-- If you do not need to know details about the content of a dashboard, for
-- instance if you are trying to check the status of a recently created or
-- updated dashboard, use the
-- <https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeDashboard.html DescribeDashboard>
-- instead.
module Amazonka.QuickSight.DescribeDashboardDefinition
  ( -- * Creating a Request
    DescribeDashboardDefinition (..),
    newDescribeDashboardDefinition,

    -- * Request Lenses
    describeDashboardDefinition_aliasName,
    describeDashboardDefinition_versionNumber,
    describeDashboardDefinition_awsAccountId,
    describeDashboardDefinition_dashboardId,

    -- * Destructuring the Response
    DescribeDashboardDefinitionResponse (..),
    newDescribeDashboardDefinitionResponse,

    -- * Response Lenses
    describeDashboardDefinitionResponse_dashboardId,
    describeDashboardDefinitionResponse_definition,
    describeDashboardDefinitionResponse_errors,
    describeDashboardDefinitionResponse_name,
    describeDashboardDefinitionResponse_requestId,
    describeDashboardDefinitionResponse_resourceStatus,
    describeDashboardDefinitionResponse_themeArn,
    describeDashboardDefinitionResponse_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:/ 'newDescribeDashboardDefinition' smart constructor.
data DescribeDashboardDefinition = DescribeDashboardDefinition'
  { -- | The alias name.
    DescribeDashboardDefinition -> 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.
    DescribeDashboardDefinition -> Maybe Natural
versionNumber :: Prelude.Maybe Prelude.Natural,
    -- | The ID of the Amazon Web Services account that contains the dashboard
    -- that you\'re describing.
    DescribeDashboardDefinition -> Text
awsAccountId :: Prelude.Text,
    -- | The ID for the dashboard.
    DescribeDashboardDefinition -> Text
dashboardId :: Prelude.Text
  }
  deriving (DescribeDashboardDefinition -> DescribeDashboardDefinition -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeDashboardDefinition -> DescribeDashboardDefinition -> Bool
$c/= :: DescribeDashboardDefinition -> DescribeDashboardDefinition -> Bool
== :: DescribeDashboardDefinition -> DescribeDashboardDefinition -> Bool
$c== :: DescribeDashboardDefinition -> DescribeDashboardDefinition -> Bool
Prelude.Eq, ReadPrec [DescribeDashboardDefinition]
ReadPrec DescribeDashboardDefinition
Int -> ReadS DescribeDashboardDefinition
ReadS [DescribeDashboardDefinition]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeDashboardDefinition]
$creadListPrec :: ReadPrec [DescribeDashboardDefinition]
readPrec :: ReadPrec DescribeDashboardDefinition
$creadPrec :: ReadPrec DescribeDashboardDefinition
readList :: ReadS [DescribeDashboardDefinition]
$creadList :: ReadS [DescribeDashboardDefinition]
readsPrec :: Int -> ReadS DescribeDashboardDefinition
$creadsPrec :: Int -> ReadS DescribeDashboardDefinition
Prelude.Read, Int -> DescribeDashboardDefinition -> ShowS
[DescribeDashboardDefinition] -> ShowS
DescribeDashboardDefinition -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeDashboardDefinition] -> ShowS
$cshowList :: [DescribeDashboardDefinition] -> ShowS
show :: DescribeDashboardDefinition -> String
$cshow :: DescribeDashboardDefinition -> String
showsPrec :: Int -> DescribeDashboardDefinition -> ShowS
$cshowsPrec :: Int -> DescribeDashboardDefinition -> ShowS
Prelude.Show, forall x.
Rep DescribeDashboardDefinition x -> DescribeDashboardDefinition
forall x.
DescribeDashboardDefinition -> Rep DescribeDashboardDefinition x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep DescribeDashboardDefinition x -> DescribeDashboardDefinition
$cfrom :: forall x.
DescribeDashboardDefinition -> Rep DescribeDashboardDefinition x
Prelude.Generic)

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

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

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

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

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

instance Core.AWSRequest DescribeDashboardDefinition where
  type
    AWSResponse DescribeDashboardDefinition =
      DescribeDashboardDefinitionResponse
  request :: (Service -> Service)
-> DescribeDashboardDefinition
-> Request DescribeDashboardDefinition
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 DescribeDashboardDefinition
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse DescribeDashboardDefinition)))
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 Text
-> Maybe DashboardVersionDefinition
-> Maybe (NonEmpty DashboardError)
-> Maybe Text
-> Maybe Text
-> Maybe ResourceStatus
-> Maybe Text
-> Int
-> DescribeDashboardDefinitionResponse
DescribeDashboardDefinitionResponse'
            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
"DashboardId")
            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
"Definition")
            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
"Errors")
            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
"Name")
            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.<*> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"ResourceStatus")
            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
"ThemeArn")
            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 DescribeDashboardDefinition where
  hashWithSalt :: Int -> DescribeDashboardDefinition -> Int
hashWithSalt Int
_salt DescribeDashboardDefinition' {Maybe Natural
Maybe Text
Text
dashboardId :: Text
awsAccountId :: Text
versionNumber :: Maybe Natural
aliasName :: Maybe Text
$sel:dashboardId:DescribeDashboardDefinition' :: DescribeDashboardDefinition -> Text
$sel:awsAccountId:DescribeDashboardDefinition' :: DescribeDashboardDefinition -> Text
$sel:versionNumber:DescribeDashboardDefinition' :: DescribeDashboardDefinition -> Maybe Natural
$sel:aliasName:DescribeDashboardDefinition' :: DescribeDashboardDefinition -> 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 DescribeDashboardDefinition where
  rnf :: DescribeDashboardDefinition -> ()
rnf DescribeDashboardDefinition' {Maybe Natural
Maybe Text
Text
dashboardId :: Text
awsAccountId :: Text
versionNumber :: Maybe Natural
aliasName :: Maybe Text
$sel:dashboardId:DescribeDashboardDefinition' :: DescribeDashboardDefinition -> Text
$sel:awsAccountId:DescribeDashboardDefinition' :: DescribeDashboardDefinition -> Text
$sel:versionNumber:DescribeDashboardDefinition' :: DescribeDashboardDefinition -> Maybe Natural
$sel:aliasName:DescribeDashboardDefinition' :: DescribeDashboardDefinition -> 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 DescribeDashboardDefinition where
  toHeaders :: DescribeDashboardDefinition -> 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 DescribeDashboardDefinition where
  toPath :: DescribeDashboardDefinition -> ByteString
toPath DescribeDashboardDefinition' {Maybe Natural
Maybe Text
Text
dashboardId :: Text
awsAccountId :: Text
versionNumber :: Maybe Natural
aliasName :: Maybe Text
$sel:dashboardId:DescribeDashboardDefinition' :: DescribeDashboardDefinition -> Text
$sel:awsAccountId:DescribeDashboardDefinition' :: DescribeDashboardDefinition -> Text
$sel:versionNumber:DescribeDashboardDefinition' :: DescribeDashboardDefinition -> Maybe Natural
$sel:aliasName:DescribeDashboardDefinition' :: DescribeDashboardDefinition -> 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,
        ByteString
"/definition"
      ]

instance Data.ToQuery DescribeDashboardDefinition where
  toQuery :: DescribeDashboardDefinition -> QueryString
toQuery DescribeDashboardDefinition' {Maybe Natural
Maybe Text
Text
dashboardId :: Text
awsAccountId :: Text
versionNumber :: Maybe Natural
aliasName :: Maybe Text
$sel:dashboardId:DescribeDashboardDefinition' :: DescribeDashboardDefinition -> Text
$sel:awsAccountId:DescribeDashboardDefinition' :: DescribeDashboardDefinition -> Text
$sel:versionNumber:DescribeDashboardDefinition' :: DescribeDashboardDefinition -> Maybe Natural
$sel:aliasName:DescribeDashboardDefinition' :: DescribeDashboardDefinition -> 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:/ 'newDescribeDashboardDefinitionResponse' smart constructor.
data DescribeDashboardDefinitionResponse = DescribeDashboardDefinitionResponse'
  { -- | The ID of the dashboard described.
    DescribeDashboardDefinitionResponse -> Maybe Text
dashboardId :: Prelude.Maybe Prelude.Text,
    -- | The definition of a dashboard.
    --
    -- A definition is the data model of all features in a Dashboard, Template,
    -- or Analysis.
    DescribeDashboardDefinitionResponse
-> Maybe DashboardVersionDefinition
definition :: Prelude.Maybe DashboardVersionDefinition,
    -- | Errors associated with this dashboard version.
    DescribeDashboardDefinitionResponse
-> Maybe (NonEmpty DashboardError)
errors :: Prelude.Maybe (Prelude.NonEmpty DashboardError),
    -- | The display name of the dashboard.
    DescribeDashboardDefinitionResponse -> Maybe Text
name :: Prelude.Maybe Prelude.Text,
    -- | The Amazon Web Services request ID for this operation.
    DescribeDashboardDefinitionResponse -> Maybe Text
requestId :: Prelude.Maybe Prelude.Text,
    -- | Status associated with the dashboard version.
    --
    -- -   @CREATION_IN_PROGRESS@
    --
    -- -   @CREATION_SUCCESSFUL@
    --
    -- -   @CREATION_FAILED@
    --
    -- -   @UPDATE_IN_PROGRESS@
    --
    -- -   @UPDATE_SUCCESSFUL@
    --
    -- -   @UPDATE_FAILED@
    --
    -- -   @DELETED@
    DescribeDashboardDefinitionResponse -> Maybe ResourceStatus
resourceStatus :: Prelude.Maybe ResourceStatus,
    -- | The ARN of the theme of the dashboard.
    DescribeDashboardDefinitionResponse -> Maybe Text
themeArn :: Prelude.Maybe Prelude.Text,
    -- | The HTTP status of the request.
    DescribeDashboardDefinitionResponse -> Int
status :: Prelude.Int
  }
  deriving (DescribeDashboardDefinitionResponse
-> DescribeDashboardDefinitionResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeDashboardDefinitionResponse
-> DescribeDashboardDefinitionResponse -> Bool
$c/= :: DescribeDashboardDefinitionResponse
-> DescribeDashboardDefinitionResponse -> Bool
== :: DescribeDashboardDefinitionResponse
-> DescribeDashboardDefinitionResponse -> Bool
$c== :: DescribeDashboardDefinitionResponse
-> DescribeDashboardDefinitionResponse -> Bool
Prelude.Eq, Int -> DescribeDashboardDefinitionResponse -> ShowS
[DescribeDashboardDefinitionResponse] -> ShowS
DescribeDashboardDefinitionResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeDashboardDefinitionResponse] -> ShowS
$cshowList :: [DescribeDashboardDefinitionResponse] -> ShowS
show :: DescribeDashboardDefinitionResponse -> String
$cshow :: DescribeDashboardDefinitionResponse -> String
showsPrec :: Int -> DescribeDashboardDefinitionResponse -> ShowS
$cshowsPrec :: Int -> DescribeDashboardDefinitionResponse -> ShowS
Prelude.Show, forall x.
Rep DescribeDashboardDefinitionResponse x
-> DescribeDashboardDefinitionResponse
forall x.
DescribeDashboardDefinitionResponse
-> Rep DescribeDashboardDefinitionResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep DescribeDashboardDefinitionResponse x
-> DescribeDashboardDefinitionResponse
$cfrom :: forall x.
DescribeDashboardDefinitionResponse
-> Rep DescribeDashboardDefinitionResponse x
Prelude.Generic)

-- |
-- Create a value of 'DescribeDashboardDefinitionResponse' 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:
--
-- 'dashboardId', 'describeDashboardDefinitionResponse_dashboardId' - The ID of the dashboard described.
--
-- 'definition', 'describeDashboardDefinitionResponse_definition' - The definition of a dashboard.
--
-- A definition is the data model of all features in a Dashboard, Template,
-- or Analysis.
--
-- 'errors', 'describeDashboardDefinitionResponse_errors' - Errors associated with this dashboard version.
--
-- 'name', 'describeDashboardDefinitionResponse_name' - The display name of the dashboard.
--
-- 'requestId', 'describeDashboardDefinitionResponse_requestId' - The Amazon Web Services request ID for this operation.
--
-- 'resourceStatus', 'describeDashboardDefinitionResponse_resourceStatus' - Status associated with the dashboard version.
--
-- -   @CREATION_IN_PROGRESS@
--
-- -   @CREATION_SUCCESSFUL@
--
-- -   @CREATION_FAILED@
--
-- -   @UPDATE_IN_PROGRESS@
--
-- -   @UPDATE_SUCCESSFUL@
--
-- -   @UPDATE_FAILED@
--
-- -   @DELETED@
--
-- 'themeArn', 'describeDashboardDefinitionResponse_themeArn' - The ARN of the theme of the dashboard.
--
-- 'status', 'describeDashboardDefinitionResponse_status' - The HTTP status of the request.
newDescribeDashboardDefinitionResponse ::
  -- | 'status'
  Prelude.Int ->
  DescribeDashboardDefinitionResponse
newDescribeDashboardDefinitionResponse :: Int -> DescribeDashboardDefinitionResponse
newDescribeDashboardDefinitionResponse Int
pStatus_ =
  DescribeDashboardDefinitionResponse'
    { $sel:dashboardId:DescribeDashboardDefinitionResponse' :: Maybe Text
dashboardId =
        forall a. Maybe a
Prelude.Nothing,
      $sel:definition:DescribeDashboardDefinitionResponse' :: Maybe DashboardVersionDefinition
definition = forall a. Maybe a
Prelude.Nothing,
      $sel:errors:DescribeDashboardDefinitionResponse' :: Maybe (NonEmpty DashboardError)
errors = forall a. Maybe a
Prelude.Nothing,
      $sel:name:DescribeDashboardDefinitionResponse' :: Maybe Text
name = forall a. Maybe a
Prelude.Nothing,
      $sel:requestId:DescribeDashboardDefinitionResponse' :: Maybe Text
requestId = forall a. Maybe a
Prelude.Nothing,
      $sel:resourceStatus:DescribeDashboardDefinitionResponse' :: Maybe ResourceStatus
resourceStatus = forall a. Maybe a
Prelude.Nothing,
      $sel:themeArn:DescribeDashboardDefinitionResponse' :: Maybe Text
themeArn = forall a. Maybe a
Prelude.Nothing,
      $sel:status:DescribeDashboardDefinitionResponse' :: Int
status = Int
pStatus_
    }

-- | The ID of the dashboard described.
describeDashboardDefinitionResponse_dashboardId :: Lens.Lens' DescribeDashboardDefinitionResponse (Prelude.Maybe Prelude.Text)
describeDashboardDefinitionResponse_dashboardId :: Lens' DescribeDashboardDefinitionResponse (Maybe Text)
describeDashboardDefinitionResponse_dashboardId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeDashboardDefinitionResponse' {Maybe Text
dashboardId :: Maybe Text
$sel:dashboardId:DescribeDashboardDefinitionResponse' :: DescribeDashboardDefinitionResponse -> Maybe Text
dashboardId} -> Maybe Text
dashboardId) (\s :: DescribeDashboardDefinitionResponse
s@DescribeDashboardDefinitionResponse' {} Maybe Text
a -> DescribeDashboardDefinitionResponse
s {$sel:dashboardId:DescribeDashboardDefinitionResponse' :: Maybe Text
dashboardId = Maybe Text
a} :: DescribeDashboardDefinitionResponse)

-- | The definition of a dashboard.
--
-- A definition is the data model of all features in a Dashboard, Template,
-- or Analysis.
describeDashboardDefinitionResponse_definition :: Lens.Lens' DescribeDashboardDefinitionResponse (Prelude.Maybe DashboardVersionDefinition)
describeDashboardDefinitionResponse_definition :: Lens'
  DescribeDashboardDefinitionResponse
  (Maybe DashboardVersionDefinition)
describeDashboardDefinitionResponse_definition = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeDashboardDefinitionResponse' {Maybe DashboardVersionDefinition
definition :: Maybe DashboardVersionDefinition
$sel:definition:DescribeDashboardDefinitionResponse' :: DescribeDashboardDefinitionResponse
-> Maybe DashboardVersionDefinition
definition} -> Maybe DashboardVersionDefinition
definition) (\s :: DescribeDashboardDefinitionResponse
s@DescribeDashboardDefinitionResponse' {} Maybe DashboardVersionDefinition
a -> DescribeDashboardDefinitionResponse
s {$sel:definition:DescribeDashboardDefinitionResponse' :: Maybe DashboardVersionDefinition
definition = Maybe DashboardVersionDefinition
a} :: DescribeDashboardDefinitionResponse)

-- | Errors associated with this dashboard version.
describeDashboardDefinitionResponse_errors :: Lens.Lens' DescribeDashboardDefinitionResponse (Prelude.Maybe (Prelude.NonEmpty DashboardError))
describeDashboardDefinitionResponse_errors :: Lens'
  DescribeDashboardDefinitionResponse
  (Maybe (NonEmpty DashboardError))
describeDashboardDefinitionResponse_errors = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeDashboardDefinitionResponse' {Maybe (NonEmpty DashboardError)
errors :: Maybe (NonEmpty DashboardError)
$sel:errors:DescribeDashboardDefinitionResponse' :: DescribeDashboardDefinitionResponse
-> Maybe (NonEmpty DashboardError)
errors} -> Maybe (NonEmpty DashboardError)
errors) (\s :: DescribeDashboardDefinitionResponse
s@DescribeDashboardDefinitionResponse' {} Maybe (NonEmpty DashboardError)
a -> DescribeDashboardDefinitionResponse
s {$sel:errors:DescribeDashboardDefinitionResponse' :: Maybe (NonEmpty DashboardError)
errors = Maybe (NonEmpty DashboardError)
a} :: DescribeDashboardDefinitionResponse) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The display name of the dashboard.
describeDashboardDefinitionResponse_name :: Lens.Lens' DescribeDashboardDefinitionResponse (Prelude.Maybe Prelude.Text)
describeDashboardDefinitionResponse_name :: Lens' DescribeDashboardDefinitionResponse (Maybe Text)
describeDashboardDefinitionResponse_name = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeDashboardDefinitionResponse' {Maybe Text
name :: Maybe Text
$sel:name:DescribeDashboardDefinitionResponse' :: DescribeDashboardDefinitionResponse -> Maybe Text
name} -> Maybe Text
name) (\s :: DescribeDashboardDefinitionResponse
s@DescribeDashboardDefinitionResponse' {} Maybe Text
a -> DescribeDashboardDefinitionResponse
s {$sel:name:DescribeDashboardDefinitionResponse' :: Maybe Text
name = Maybe Text
a} :: DescribeDashboardDefinitionResponse)

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

-- | Status associated with the dashboard version.
--
-- -   @CREATION_IN_PROGRESS@
--
-- -   @CREATION_SUCCESSFUL@
--
-- -   @CREATION_FAILED@
--
-- -   @UPDATE_IN_PROGRESS@
--
-- -   @UPDATE_SUCCESSFUL@
--
-- -   @UPDATE_FAILED@
--
-- -   @DELETED@
describeDashboardDefinitionResponse_resourceStatus :: Lens.Lens' DescribeDashboardDefinitionResponse (Prelude.Maybe ResourceStatus)
describeDashboardDefinitionResponse_resourceStatus :: Lens' DescribeDashboardDefinitionResponse (Maybe ResourceStatus)
describeDashboardDefinitionResponse_resourceStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeDashboardDefinitionResponse' {Maybe ResourceStatus
resourceStatus :: Maybe ResourceStatus
$sel:resourceStatus:DescribeDashboardDefinitionResponse' :: DescribeDashboardDefinitionResponse -> Maybe ResourceStatus
resourceStatus} -> Maybe ResourceStatus
resourceStatus) (\s :: DescribeDashboardDefinitionResponse
s@DescribeDashboardDefinitionResponse' {} Maybe ResourceStatus
a -> DescribeDashboardDefinitionResponse
s {$sel:resourceStatus:DescribeDashboardDefinitionResponse' :: Maybe ResourceStatus
resourceStatus = Maybe ResourceStatus
a} :: DescribeDashboardDefinitionResponse)

-- | The ARN of the theme of the dashboard.
describeDashboardDefinitionResponse_themeArn :: Lens.Lens' DescribeDashboardDefinitionResponse (Prelude.Maybe Prelude.Text)
describeDashboardDefinitionResponse_themeArn :: Lens' DescribeDashboardDefinitionResponse (Maybe Text)
describeDashboardDefinitionResponse_themeArn = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeDashboardDefinitionResponse' {Maybe Text
themeArn :: Maybe Text
$sel:themeArn:DescribeDashboardDefinitionResponse' :: DescribeDashboardDefinitionResponse -> Maybe Text
themeArn} -> Maybe Text
themeArn) (\s :: DescribeDashboardDefinitionResponse
s@DescribeDashboardDefinitionResponse' {} Maybe Text
a -> DescribeDashboardDefinitionResponse
s {$sel:themeArn:DescribeDashboardDefinitionResponse' :: Maybe Text
themeArn = Maybe Text
a} :: DescribeDashboardDefinitionResponse)

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

instance
  Prelude.NFData
    DescribeDashboardDefinitionResponse
  where
  rnf :: DescribeDashboardDefinitionResponse -> ()
rnf DescribeDashboardDefinitionResponse' {Int
Maybe (NonEmpty DashboardError)
Maybe Text
Maybe ResourceStatus
Maybe DashboardVersionDefinition
status :: Int
themeArn :: Maybe Text
resourceStatus :: Maybe ResourceStatus
requestId :: Maybe Text
name :: Maybe Text
errors :: Maybe (NonEmpty DashboardError)
definition :: Maybe DashboardVersionDefinition
dashboardId :: Maybe Text
$sel:status:DescribeDashboardDefinitionResponse' :: DescribeDashboardDefinitionResponse -> Int
$sel:themeArn:DescribeDashboardDefinitionResponse' :: DescribeDashboardDefinitionResponse -> Maybe Text
$sel:resourceStatus:DescribeDashboardDefinitionResponse' :: DescribeDashboardDefinitionResponse -> Maybe ResourceStatus
$sel:requestId:DescribeDashboardDefinitionResponse' :: DescribeDashboardDefinitionResponse -> Maybe Text
$sel:name:DescribeDashboardDefinitionResponse' :: DescribeDashboardDefinitionResponse -> Maybe Text
$sel:errors:DescribeDashboardDefinitionResponse' :: DescribeDashboardDefinitionResponse
-> Maybe (NonEmpty DashboardError)
$sel:definition:DescribeDashboardDefinitionResponse' :: DescribeDashboardDefinitionResponse
-> Maybe DashboardVersionDefinition
$sel:dashboardId:DescribeDashboardDefinitionResponse' :: DescribeDashboardDefinitionResponse -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
dashboardId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe DashboardVersionDefinition
definition
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe (NonEmpty DashboardError)
errors
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
name
      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 Maybe ResourceStatus
resourceStatus
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
themeArn
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
status