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

    -- * Request Lenses
    describeTemplateDefinition_aliasName,
    describeTemplateDefinition_versionNumber,
    describeTemplateDefinition_awsAccountId,
    describeTemplateDefinition_templateId,

    -- * Destructuring the Response
    DescribeTemplateDefinitionResponse (..),
    newDescribeTemplateDefinitionResponse,

    -- * Response Lenses
    describeTemplateDefinitionResponse_definition,
    describeTemplateDefinitionResponse_errors,
    describeTemplateDefinitionResponse_name,
    describeTemplateDefinitionResponse_requestId,
    describeTemplateDefinitionResponse_resourceStatus,
    describeTemplateDefinitionResponse_templateId,
    describeTemplateDefinitionResponse_themeArn,
    describeTemplateDefinitionResponse_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:/ 'newDescribeTemplateDefinition' smart constructor.
data DescribeTemplateDefinition = DescribeTemplateDefinition'
  { -- | The alias of the template that you want to describe. If you name a
    -- specific alias, you describe the version that the alias points to. You
    -- can specify the latest version of the template by providing the keyword
    -- @$LATEST@ in the @AliasName@ parameter. The keyword @$PUBLISHED@
    -- doesn\'t apply to templates.
    DescribeTemplateDefinition -> Maybe Text
aliasName :: Prelude.Maybe Prelude.Text,
    -- | The version number of the template.
    DescribeTemplateDefinition -> Maybe Natural
versionNumber :: Prelude.Maybe Prelude.Natural,
    -- | The ID of the Amazon Web Services account that contains the template.
    -- You must be using the Amazon Web Services account that the template is
    -- in.
    DescribeTemplateDefinition -> Text
awsAccountId :: Prelude.Text,
    -- | The ID of the template that you\'re describing.
    DescribeTemplateDefinition -> Text
templateId :: Prelude.Text
  }
  deriving (DescribeTemplateDefinition -> DescribeTemplateDefinition -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeTemplateDefinition -> DescribeTemplateDefinition -> Bool
$c/= :: DescribeTemplateDefinition -> DescribeTemplateDefinition -> Bool
== :: DescribeTemplateDefinition -> DescribeTemplateDefinition -> Bool
$c== :: DescribeTemplateDefinition -> DescribeTemplateDefinition -> Bool
Prelude.Eq, ReadPrec [DescribeTemplateDefinition]
ReadPrec DescribeTemplateDefinition
Int -> ReadS DescribeTemplateDefinition
ReadS [DescribeTemplateDefinition]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeTemplateDefinition]
$creadListPrec :: ReadPrec [DescribeTemplateDefinition]
readPrec :: ReadPrec DescribeTemplateDefinition
$creadPrec :: ReadPrec DescribeTemplateDefinition
readList :: ReadS [DescribeTemplateDefinition]
$creadList :: ReadS [DescribeTemplateDefinition]
readsPrec :: Int -> ReadS DescribeTemplateDefinition
$creadsPrec :: Int -> ReadS DescribeTemplateDefinition
Prelude.Read, Int -> DescribeTemplateDefinition -> ShowS
[DescribeTemplateDefinition] -> ShowS
DescribeTemplateDefinition -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeTemplateDefinition] -> ShowS
$cshowList :: [DescribeTemplateDefinition] -> ShowS
show :: DescribeTemplateDefinition -> String
$cshow :: DescribeTemplateDefinition -> String
showsPrec :: Int -> DescribeTemplateDefinition -> ShowS
$cshowsPrec :: Int -> DescribeTemplateDefinition -> ShowS
Prelude.Show, forall x.
Rep DescribeTemplateDefinition x -> DescribeTemplateDefinition
forall x.
DescribeTemplateDefinition -> Rep DescribeTemplateDefinition x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep DescribeTemplateDefinition x -> DescribeTemplateDefinition
$cfrom :: forall x.
DescribeTemplateDefinition -> Rep DescribeTemplateDefinition x
Prelude.Generic)

-- |
-- Create a value of 'DescribeTemplateDefinition' 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', 'describeTemplateDefinition_aliasName' - The alias of the template that you want to describe. If you name a
-- specific alias, you describe the version that the alias points to. You
-- can specify the latest version of the template by providing the keyword
-- @$LATEST@ in the @AliasName@ parameter. The keyword @$PUBLISHED@
-- doesn\'t apply to templates.
--
-- 'versionNumber', 'describeTemplateDefinition_versionNumber' - The version number of the template.
--
-- 'awsAccountId', 'describeTemplateDefinition_awsAccountId' - The ID of the Amazon Web Services account that contains the template.
-- You must be using the Amazon Web Services account that the template is
-- in.
--
-- 'templateId', 'describeTemplateDefinition_templateId' - The ID of the template that you\'re describing.
newDescribeTemplateDefinition ::
  -- | 'awsAccountId'
  Prelude.Text ->
  -- | 'templateId'
  Prelude.Text ->
  DescribeTemplateDefinition
newDescribeTemplateDefinition :: Text -> Text -> DescribeTemplateDefinition
newDescribeTemplateDefinition
  Text
pAwsAccountId_
  Text
pTemplateId_ =
    DescribeTemplateDefinition'
      { $sel:aliasName:DescribeTemplateDefinition' :: Maybe Text
aliasName =
          forall a. Maybe a
Prelude.Nothing,
        $sel:versionNumber:DescribeTemplateDefinition' :: Maybe Natural
versionNumber = forall a. Maybe a
Prelude.Nothing,
        $sel:awsAccountId:DescribeTemplateDefinition' :: Text
awsAccountId = Text
pAwsAccountId_,
        $sel:templateId:DescribeTemplateDefinition' :: Text
templateId = Text
pTemplateId_
      }

-- | The alias of the template that you want to describe. If you name a
-- specific alias, you describe the version that the alias points to. You
-- can specify the latest version of the template by providing the keyword
-- @$LATEST@ in the @AliasName@ parameter. The keyword @$PUBLISHED@
-- doesn\'t apply to templates.
describeTemplateDefinition_aliasName :: Lens.Lens' DescribeTemplateDefinition (Prelude.Maybe Prelude.Text)
describeTemplateDefinition_aliasName :: Lens' DescribeTemplateDefinition (Maybe Text)
describeTemplateDefinition_aliasName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeTemplateDefinition' {Maybe Text
aliasName :: Maybe Text
$sel:aliasName:DescribeTemplateDefinition' :: DescribeTemplateDefinition -> Maybe Text
aliasName} -> Maybe Text
aliasName) (\s :: DescribeTemplateDefinition
s@DescribeTemplateDefinition' {} Maybe Text
a -> DescribeTemplateDefinition
s {$sel:aliasName:DescribeTemplateDefinition' :: Maybe Text
aliasName = Maybe Text
a} :: DescribeTemplateDefinition)

-- | The version number of the template.
describeTemplateDefinition_versionNumber :: Lens.Lens' DescribeTemplateDefinition (Prelude.Maybe Prelude.Natural)
describeTemplateDefinition_versionNumber :: Lens' DescribeTemplateDefinition (Maybe Natural)
describeTemplateDefinition_versionNumber = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeTemplateDefinition' {Maybe Natural
versionNumber :: Maybe Natural
$sel:versionNumber:DescribeTemplateDefinition' :: DescribeTemplateDefinition -> Maybe Natural
versionNumber} -> Maybe Natural
versionNumber) (\s :: DescribeTemplateDefinition
s@DescribeTemplateDefinition' {} Maybe Natural
a -> DescribeTemplateDefinition
s {$sel:versionNumber:DescribeTemplateDefinition' :: Maybe Natural
versionNumber = Maybe Natural
a} :: DescribeTemplateDefinition)

-- | The ID of the Amazon Web Services account that contains the template.
-- You must be using the Amazon Web Services account that the template is
-- in.
describeTemplateDefinition_awsAccountId :: Lens.Lens' DescribeTemplateDefinition Prelude.Text
describeTemplateDefinition_awsAccountId :: Lens' DescribeTemplateDefinition Text
describeTemplateDefinition_awsAccountId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeTemplateDefinition' {Text
awsAccountId :: Text
$sel:awsAccountId:DescribeTemplateDefinition' :: DescribeTemplateDefinition -> Text
awsAccountId} -> Text
awsAccountId) (\s :: DescribeTemplateDefinition
s@DescribeTemplateDefinition' {} Text
a -> DescribeTemplateDefinition
s {$sel:awsAccountId:DescribeTemplateDefinition' :: Text
awsAccountId = Text
a} :: DescribeTemplateDefinition)

-- | The ID of the template that you\'re describing.
describeTemplateDefinition_templateId :: Lens.Lens' DescribeTemplateDefinition Prelude.Text
describeTemplateDefinition_templateId :: Lens' DescribeTemplateDefinition Text
describeTemplateDefinition_templateId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeTemplateDefinition' {Text
templateId :: Text
$sel:templateId:DescribeTemplateDefinition' :: DescribeTemplateDefinition -> Text
templateId} -> Text
templateId) (\s :: DescribeTemplateDefinition
s@DescribeTemplateDefinition' {} Text
a -> DescribeTemplateDefinition
s {$sel:templateId:DescribeTemplateDefinition' :: Text
templateId = Text
a} :: DescribeTemplateDefinition)

instance Core.AWSRequest DescribeTemplateDefinition where
  type
    AWSResponse DescribeTemplateDefinition =
      DescribeTemplateDefinitionResponse
  request :: (Service -> Service)
-> DescribeTemplateDefinition -> Request DescribeTemplateDefinition
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 DescribeTemplateDefinition
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse DescribeTemplateDefinition)))
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 TemplateVersionDefinition
-> Maybe (NonEmpty TemplateError)
-> Maybe Text
-> Maybe Text
-> Maybe ResourceStatus
-> Maybe Text
-> Maybe Text
-> Int
-> DescribeTemplateDefinitionResponse
DescribeTemplateDefinitionResponse'
            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
"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
"TemplateId")
            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 DescribeTemplateDefinition where
  hashWithSalt :: Int -> DescribeTemplateDefinition -> Int
hashWithSalt Int
_salt DescribeTemplateDefinition' {Maybe Natural
Maybe Text
Text
templateId :: Text
awsAccountId :: Text
versionNumber :: Maybe Natural
aliasName :: Maybe Text
$sel:templateId:DescribeTemplateDefinition' :: DescribeTemplateDefinition -> Text
$sel:awsAccountId:DescribeTemplateDefinition' :: DescribeTemplateDefinition -> Text
$sel:versionNumber:DescribeTemplateDefinition' :: DescribeTemplateDefinition -> Maybe Natural
$sel:aliasName:DescribeTemplateDefinition' :: DescribeTemplateDefinition -> 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
templateId

instance Prelude.NFData DescribeTemplateDefinition where
  rnf :: DescribeTemplateDefinition -> ()
rnf DescribeTemplateDefinition' {Maybe Natural
Maybe Text
Text
templateId :: Text
awsAccountId :: Text
versionNumber :: Maybe Natural
aliasName :: Maybe Text
$sel:templateId:DescribeTemplateDefinition' :: DescribeTemplateDefinition -> Text
$sel:awsAccountId:DescribeTemplateDefinition' :: DescribeTemplateDefinition -> Text
$sel:versionNumber:DescribeTemplateDefinition' :: DescribeTemplateDefinition -> Maybe Natural
$sel:aliasName:DescribeTemplateDefinition' :: DescribeTemplateDefinition -> 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
templateId

instance Data.ToHeaders DescribeTemplateDefinition where
  toHeaders :: DescribeTemplateDefinition -> 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 DescribeTemplateDefinition where
  toPath :: DescribeTemplateDefinition -> ByteString
toPath DescribeTemplateDefinition' {Maybe Natural
Maybe Text
Text
templateId :: Text
awsAccountId :: Text
versionNumber :: Maybe Natural
aliasName :: Maybe Text
$sel:templateId:DescribeTemplateDefinition' :: DescribeTemplateDefinition -> Text
$sel:awsAccountId:DescribeTemplateDefinition' :: DescribeTemplateDefinition -> Text
$sel:versionNumber:DescribeTemplateDefinition' :: DescribeTemplateDefinition -> Maybe Natural
$sel:aliasName:DescribeTemplateDefinition' :: DescribeTemplateDefinition -> Maybe Text
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ ByteString
"/accounts/",
        forall a. ToByteString a => a -> ByteString
Data.toBS Text
awsAccountId,
        ByteString
"/templates/",
        forall a. ToByteString a => a -> ByteString
Data.toBS Text
templateId,
        ByteString
"/definition"
      ]

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

-- |
-- Create a value of 'DescribeTemplateDefinitionResponse' 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:
--
-- 'definition', 'describeTemplateDefinitionResponse_definition' - The definition of the template.
--
-- A definition is the data model of all features in a Dashboard, Template,
-- or Analysis.
--
-- 'errors', 'describeTemplateDefinitionResponse_errors' - Errors associated with the template version.
--
-- 'name', 'describeTemplateDefinitionResponse_name' - The descriptive name of the template.
--
-- 'requestId', 'describeTemplateDefinitionResponse_requestId' - The Amazon Web Services request ID for this operation.
--
-- 'resourceStatus', 'describeTemplateDefinitionResponse_resourceStatus' - Status associated with the template.
--
-- -   @CREATION_IN_PROGRESS@
--
-- -   @CREATION_SUCCESSFUL@
--
-- -   @CREATION_FAILED@
--
-- -   @UPDATE_IN_PROGRESS@
--
-- -   @UPDATE_SUCCESSFUL@
--
-- -   @UPDATE_FAILED@
--
-- -   @DELETED@
--
-- 'templateId', 'describeTemplateDefinitionResponse_templateId' - The ID of the template described.
--
-- 'themeArn', 'describeTemplateDefinitionResponse_themeArn' - The ARN of the theme of the template.
--
-- 'status', 'describeTemplateDefinitionResponse_status' - The HTTP status of the request.
newDescribeTemplateDefinitionResponse ::
  -- | 'status'
  Prelude.Int ->
  DescribeTemplateDefinitionResponse
newDescribeTemplateDefinitionResponse :: Int -> DescribeTemplateDefinitionResponse
newDescribeTemplateDefinitionResponse Int
pStatus_ =
  DescribeTemplateDefinitionResponse'
    { $sel:definition:DescribeTemplateDefinitionResponse' :: Maybe TemplateVersionDefinition
definition =
        forall a. Maybe a
Prelude.Nothing,
      $sel:errors:DescribeTemplateDefinitionResponse' :: Maybe (NonEmpty TemplateError)
errors = forall a. Maybe a
Prelude.Nothing,
      $sel:name:DescribeTemplateDefinitionResponse' :: Maybe Text
name = forall a. Maybe a
Prelude.Nothing,
      $sel:requestId:DescribeTemplateDefinitionResponse' :: Maybe Text
requestId = forall a. Maybe a
Prelude.Nothing,
      $sel:resourceStatus:DescribeTemplateDefinitionResponse' :: Maybe ResourceStatus
resourceStatus = forall a. Maybe a
Prelude.Nothing,
      $sel:templateId:DescribeTemplateDefinitionResponse' :: Maybe Text
templateId = forall a. Maybe a
Prelude.Nothing,
      $sel:themeArn:DescribeTemplateDefinitionResponse' :: Maybe Text
themeArn = forall a. Maybe a
Prelude.Nothing,
      $sel:status:DescribeTemplateDefinitionResponse' :: Int
status = Int
pStatus_
    }

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

-- | Errors associated with the template version.
describeTemplateDefinitionResponse_errors :: Lens.Lens' DescribeTemplateDefinitionResponse (Prelude.Maybe (Prelude.NonEmpty TemplateError))
describeTemplateDefinitionResponse_errors :: Lens'
  DescribeTemplateDefinitionResponse (Maybe (NonEmpty TemplateError))
describeTemplateDefinitionResponse_errors = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeTemplateDefinitionResponse' {Maybe (NonEmpty TemplateError)
errors :: Maybe (NonEmpty TemplateError)
$sel:errors:DescribeTemplateDefinitionResponse' :: DescribeTemplateDefinitionResponse
-> Maybe (NonEmpty TemplateError)
errors} -> Maybe (NonEmpty TemplateError)
errors) (\s :: DescribeTemplateDefinitionResponse
s@DescribeTemplateDefinitionResponse' {} Maybe (NonEmpty TemplateError)
a -> DescribeTemplateDefinitionResponse
s {$sel:errors:DescribeTemplateDefinitionResponse' :: Maybe (NonEmpty TemplateError)
errors = Maybe (NonEmpty TemplateError)
a} :: DescribeTemplateDefinitionResponse) 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 descriptive name of the template.
describeTemplateDefinitionResponse_name :: Lens.Lens' DescribeTemplateDefinitionResponse (Prelude.Maybe Prelude.Text)
describeTemplateDefinitionResponse_name :: Lens' DescribeTemplateDefinitionResponse (Maybe Text)
describeTemplateDefinitionResponse_name = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeTemplateDefinitionResponse' {Maybe Text
name :: Maybe Text
$sel:name:DescribeTemplateDefinitionResponse' :: DescribeTemplateDefinitionResponse -> Maybe Text
name} -> Maybe Text
name) (\s :: DescribeTemplateDefinitionResponse
s@DescribeTemplateDefinitionResponse' {} Maybe Text
a -> DescribeTemplateDefinitionResponse
s {$sel:name:DescribeTemplateDefinitionResponse' :: Maybe Text
name = Maybe Text
a} :: DescribeTemplateDefinitionResponse)

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

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

-- | The ID of the template described.
describeTemplateDefinitionResponse_templateId :: Lens.Lens' DescribeTemplateDefinitionResponse (Prelude.Maybe Prelude.Text)
describeTemplateDefinitionResponse_templateId :: Lens' DescribeTemplateDefinitionResponse (Maybe Text)
describeTemplateDefinitionResponse_templateId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeTemplateDefinitionResponse' {Maybe Text
templateId :: Maybe Text
$sel:templateId:DescribeTemplateDefinitionResponse' :: DescribeTemplateDefinitionResponse -> Maybe Text
templateId} -> Maybe Text
templateId) (\s :: DescribeTemplateDefinitionResponse
s@DescribeTemplateDefinitionResponse' {} Maybe Text
a -> DescribeTemplateDefinitionResponse
s {$sel:templateId:DescribeTemplateDefinitionResponse' :: Maybe Text
templateId = Maybe Text
a} :: DescribeTemplateDefinitionResponse)

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

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

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