{-# 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.SSM.UpdateDocumentMetadata
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Updates information related to approval reviews for a specific version
-- of a change template in Change Manager.
module Amazonka.SSM.UpdateDocumentMetadata
  ( -- * Creating a Request
    UpdateDocumentMetadata (..),
    newUpdateDocumentMetadata,

    -- * Request Lenses
    updateDocumentMetadata_documentVersion,
    updateDocumentMetadata_name,
    updateDocumentMetadata_documentReviews,

    -- * Destructuring the Response
    UpdateDocumentMetadataResponse (..),
    newUpdateDocumentMetadataResponse,

    -- * Response Lenses
    updateDocumentMetadataResponse_httpStatus,
  )
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 qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response
import Amazonka.SSM.Types

-- | /See:/ 'newUpdateDocumentMetadata' smart constructor.
data UpdateDocumentMetadata = UpdateDocumentMetadata'
  { -- | The version of a change template in which to update approval metadata.
    UpdateDocumentMetadata -> Maybe Text
documentVersion :: Prelude.Maybe Prelude.Text,
    -- | The name of the change template for which a version\'s metadata is to be
    -- updated.
    UpdateDocumentMetadata -> Text
name :: Prelude.Text,
    -- | The change template review details to update.
    UpdateDocumentMetadata -> DocumentReviews
documentReviews :: DocumentReviews
  }
  deriving (UpdateDocumentMetadata -> UpdateDocumentMetadata -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: UpdateDocumentMetadata -> UpdateDocumentMetadata -> Bool
$c/= :: UpdateDocumentMetadata -> UpdateDocumentMetadata -> Bool
== :: UpdateDocumentMetadata -> UpdateDocumentMetadata -> Bool
$c== :: UpdateDocumentMetadata -> UpdateDocumentMetadata -> Bool
Prelude.Eq, ReadPrec [UpdateDocumentMetadata]
ReadPrec UpdateDocumentMetadata
Int -> ReadS UpdateDocumentMetadata
ReadS [UpdateDocumentMetadata]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [UpdateDocumentMetadata]
$creadListPrec :: ReadPrec [UpdateDocumentMetadata]
readPrec :: ReadPrec UpdateDocumentMetadata
$creadPrec :: ReadPrec UpdateDocumentMetadata
readList :: ReadS [UpdateDocumentMetadata]
$creadList :: ReadS [UpdateDocumentMetadata]
readsPrec :: Int -> ReadS UpdateDocumentMetadata
$creadsPrec :: Int -> ReadS UpdateDocumentMetadata
Prelude.Read, Int -> UpdateDocumentMetadata -> ShowS
[UpdateDocumentMetadata] -> ShowS
UpdateDocumentMetadata -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [UpdateDocumentMetadata] -> ShowS
$cshowList :: [UpdateDocumentMetadata] -> ShowS
show :: UpdateDocumentMetadata -> String
$cshow :: UpdateDocumentMetadata -> String
showsPrec :: Int -> UpdateDocumentMetadata -> ShowS
$cshowsPrec :: Int -> UpdateDocumentMetadata -> ShowS
Prelude.Show, forall x. Rep UpdateDocumentMetadata x -> UpdateDocumentMetadata
forall x. UpdateDocumentMetadata -> Rep UpdateDocumentMetadata x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep UpdateDocumentMetadata x -> UpdateDocumentMetadata
$cfrom :: forall x. UpdateDocumentMetadata -> Rep UpdateDocumentMetadata x
Prelude.Generic)

-- |
-- Create a value of 'UpdateDocumentMetadata' 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:
--
-- 'documentVersion', 'updateDocumentMetadata_documentVersion' - The version of a change template in which to update approval metadata.
--
-- 'name', 'updateDocumentMetadata_name' - The name of the change template for which a version\'s metadata is to be
-- updated.
--
-- 'documentReviews', 'updateDocumentMetadata_documentReviews' - The change template review details to update.
newUpdateDocumentMetadata ::
  -- | 'name'
  Prelude.Text ->
  -- | 'documentReviews'
  DocumentReviews ->
  UpdateDocumentMetadata
newUpdateDocumentMetadata :: Text -> DocumentReviews -> UpdateDocumentMetadata
newUpdateDocumentMetadata Text
pName_ DocumentReviews
pDocumentReviews_ =
  UpdateDocumentMetadata'
    { $sel:documentVersion:UpdateDocumentMetadata' :: Maybe Text
documentVersion =
        forall a. Maybe a
Prelude.Nothing,
      $sel:name:UpdateDocumentMetadata' :: Text
name = Text
pName_,
      $sel:documentReviews:UpdateDocumentMetadata' :: DocumentReviews
documentReviews = DocumentReviews
pDocumentReviews_
    }

-- | The version of a change template in which to update approval metadata.
updateDocumentMetadata_documentVersion :: Lens.Lens' UpdateDocumentMetadata (Prelude.Maybe Prelude.Text)
updateDocumentMetadata_documentVersion :: Lens' UpdateDocumentMetadata (Maybe Text)
updateDocumentMetadata_documentVersion = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\UpdateDocumentMetadata' {Maybe Text
documentVersion :: Maybe Text
$sel:documentVersion:UpdateDocumentMetadata' :: UpdateDocumentMetadata -> Maybe Text
documentVersion} -> Maybe Text
documentVersion) (\s :: UpdateDocumentMetadata
s@UpdateDocumentMetadata' {} Maybe Text
a -> UpdateDocumentMetadata
s {$sel:documentVersion:UpdateDocumentMetadata' :: Maybe Text
documentVersion = Maybe Text
a} :: UpdateDocumentMetadata)

-- | The name of the change template for which a version\'s metadata is to be
-- updated.
updateDocumentMetadata_name :: Lens.Lens' UpdateDocumentMetadata Prelude.Text
updateDocumentMetadata_name :: Lens' UpdateDocumentMetadata Text
updateDocumentMetadata_name = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\UpdateDocumentMetadata' {Text
name :: Text
$sel:name:UpdateDocumentMetadata' :: UpdateDocumentMetadata -> Text
name} -> Text
name) (\s :: UpdateDocumentMetadata
s@UpdateDocumentMetadata' {} Text
a -> UpdateDocumentMetadata
s {$sel:name:UpdateDocumentMetadata' :: Text
name = Text
a} :: UpdateDocumentMetadata)

-- | The change template review details to update.
updateDocumentMetadata_documentReviews :: Lens.Lens' UpdateDocumentMetadata DocumentReviews
updateDocumentMetadata_documentReviews :: Lens' UpdateDocumentMetadata DocumentReviews
updateDocumentMetadata_documentReviews = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\UpdateDocumentMetadata' {DocumentReviews
documentReviews :: DocumentReviews
$sel:documentReviews:UpdateDocumentMetadata' :: UpdateDocumentMetadata -> DocumentReviews
documentReviews} -> DocumentReviews
documentReviews) (\s :: UpdateDocumentMetadata
s@UpdateDocumentMetadata' {} DocumentReviews
a -> UpdateDocumentMetadata
s {$sel:documentReviews:UpdateDocumentMetadata' :: DocumentReviews
documentReviews = DocumentReviews
a} :: UpdateDocumentMetadata)

instance Core.AWSRequest UpdateDocumentMetadata where
  type
    AWSResponse UpdateDocumentMetadata =
      UpdateDocumentMetadataResponse
  request :: (Service -> Service)
-> UpdateDocumentMetadata -> Request UpdateDocumentMetadata
request Service -> Service
overrides =
    forall a. (ToRequest a, ToJSON a) => Service -> a -> Request a
Request.postJSON (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy UpdateDocumentMetadata
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse UpdateDocumentMetadata)))
response =
    forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> () -> Either String (AWSResponse a))
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveEmpty
      ( \Int
s ResponseHeaders
h ()
x ->
          Int -> UpdateDocumentMetadataResponse
UpdateDocumentMetadataResponse'
            forall (f :: * -> *) a b. Functor 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 UpdateDocumentMetadata where
  hashWithSalt :: Int -> UpdateDocumentMetadata -> Int
hashWithSalt Int
_salt UpdateDocumentMetadata' {Maybe Text
Text
DocumentReviews
documentReviews :: DocumentReviews
name :: Text
documentVersion :: Maybe Text
$sel:documentReviews:UpdateDocumentMetadata' :: UpdateDocumentMetadata -> DocumentReviews
$sel:name:UpdateDocumentMetadata' :: UpdateDocumentMetadata -> Text
$sel:documentVersion:UpdateDocumentMetadata' :: UpdateDocumentMetadata -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
documentVersion
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
name
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` DocumentReviews
documentReviews

instance Prelude.NFData UpdateDocumentMetadata where
  rnf :: UpdateDocumentMetadata -> ()
rnf UpdateDocumentMetadata' {Maybe Text
Text
DocumentReviews
documentReviews :: DocumentReviews
name :: Text
documentVersion :: Maybe Text
$sel:documentReviews:UpdateDocumentMetadata' :: UpdateDocumentMetadata -> DocumentReviews
$sel:name:UpdateDocumentMetadata' :: UpdateDocumentMetadata -> Text
$sel:documentVersion:UpdateDocumentMetadata' :: UpdateDocumentMetadata -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
documentVersion
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
name
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf DocumentReviews
documentReviews

instance Data.ToHeaders UpdateDocumentMetadata where
  toHeaders :: UpdateDocumentMetadata -> ResponseHeaders
toHeaders =
    forall a b. a -> b -> a
Prelude.const
      ( forall a. Monoid a => [a] -> a
Prelude.mconcat
          [ HeaderName
"X-Amz-Target"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# ( ByteString
"AmazonSSM.UpdateDocumentMetadata" ::
                          Prelude.ByteString
                      ),
            HeaderName
"Content-Type"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# ( ByteString
"application/x-amz-json-1.1" ::
                          Prelude.ByteString
                      )
          ]
      )

instance Data.ToJSON UpdateDocumentMetadata where
  toJSON :: UpdateDocumentMetadata -> Value
toJSON UpdateDocumentMetadata' {Maybe Text
Text
DocumentReviews
documentReviews :: DocumentReviews
name :: Text
documentVersion :: Maybe Text
$sel:documentReviews:UpdateDocumentMetadata' :: UpdateDocumentMetadata -> DocumentReviews
$sel:name:UpdateDocumentMetadata' :: UpdateDocumentMetadata -> Text
$sel:documentVersion:UpdateDocumentMetadata' :: UpdateDocumentMetadata -> Maybe Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"DocumentVersion" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
documentVersion,
            forall a. a -> Maybe a
Prelude.Just (Key
"Name" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
name),
            forall a. a -> Maybe a
Prelude.Just
              (Key
"DocumentReviews" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= DocumentReviews
documentReviews)
          ]
      )

instance Data.ToPath UpdateDocumentMetadata where
  toPath :: UpdateDocumentMetadata -> ByteString
toPath = forall a b. a -> b -> a
Prelude.const ByteString
"/"

instance Data.ToQuery UpdateDocumentMetadata where
  toQuery :: UpdateDocumentMetadata -> QueryString
toQuery = forall a b. a -> b -> a
Prelude.const forall a. Monoid a => a
Prelude.mempty

-- | /See:/ 'newUpdateDocumentMetadataResponse' smart constructor.
data UpdateDocumentMetadataResponse = UpdateDocumentMetadataResponse'
  { -- | The response's http status code.
    UpdateDocumentMetadataResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (UpdateDocumentMetadataResponse
-> UpdateDocumentMetadataResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: UpdateDocumentMetadataResponse
-> UpdateDocumentMetadataResponse -> Bool
$c/= :: UpdateDocumentMetadataResponse
-> UpdateDocumentMetadataResponse -> Bool
== :: UpdateDocumentMetadataResponse
-> UpdateDocumentMetadataResponse -> Bool
$c== :: UpdateDocumentMetadataResponse
-> UpdateDocumentMetadataResponse -> Bool
Prelude.Eq, ReadPrec [UpdateDocumentMetadataResponse]
ReadPrec UpdateDocumentMetadataResponse
Int -> ReadS UpdateDocumentMetadataResponse
ReadS [UpdateDocumentMetadataResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [UpdateDocumentMetadataResponse]
$creadListPrec :: ReadPrec [UpdateDocumentMetadataResponse]
readPrec :: ReadPrec UpdateDocumentMetadataResponse
$creadPrec :: ReadPrec UpdateDocumentMetadataResponse
readList :: ReadS [UpdateDocumentMetadataResponse]
$creadList :: ReadS [UpdateDocumentMetadataResponse]
readsPrec :: Int -> ReadS UpdateDocumentMetadataResponse
$creadsPrec :: Int -> ReadS UpdateDocumentMetadataResponse
Prelude.Read, Int -> UpdateDocumentMetadataResponse -> ShowS
[UpdateDocumentMetadataResponse] -> ShowS
UpdateDocumentMetadataResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [UpdateDocumentMetadataResponse] -> ShowS
$cshowList :: [UpdateDocumentMetadataResponse] -> ShowS
show :: UpdateDocumentMetadataResponse -> String
$cshow :: UpdateDocumentMetadataResponse -> String
showsPrec :: Int -> UpdateDocumentMetadataResponse -> ShowS
$cshowsPrec :: Int -> UpdateDocumentMetadataResponse -> ShowS
Prelude.Show, forall x.
Rep UpdateDocumentMetadataResponse x
-> UpdateDocumentMetadataResponse
forall x.
UpdateDocumentMetadataResponse
-> Rep UpdateDocumentMetadataResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep UpdateDocumentMetadataResponse x
-> UpdateDocumentMetadataResponse
$cfrom :: forall x.
UpdateDocumentMetadataResponse
-> Rep UpdateDocumentMetadataResponse x
Prelude.Generic)

-- |
-- Create a value of 'UpdateDocumentMetadataResponse' 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:
--
-- 'httpStatus', 'updateDocumentMetadataResponse_httpStatus' - The response's http status code.
newUpdateDocumentMetadataResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  UpdateDocumentMetadataResponse
newUpdateDocumentMetadataResponse :: Int -> UpdateDocumentMetadataResponse
newUpdateDocumentMetadataResponse Int
pHttpStatus_ =
  UpdateDocumentMetadataResponse'
    { $sel:httpStatus:UpdateDocumentMetadataResponse' :: Int
httpStatus =
        Int
pHttpStatus_
    }

-- | The response's http status code.
updateDocumentMetadataResponse_httpStatus :: Lens.Lens' UpdateDocumentMetadataResponse Prelude.Int
updateDocumentMetadataResponse_httpStatus :: Lens' UpdateDocumentMetadataResponse Int
updateDocumentMetadataResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\UpdateDocumentMetadataResponse' {Int
httpStatus :: Int
$sel:httpStatus:UpdateDocumentMetadataResponse' :: UpdateDocumentMetadataResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: UpdateDocumentMetadataResponse
s@UpdateDocumentMetadataResponse' {} Int
a -> UpdateDocumentMetadataResponse
s {$sel:httpStatus:UpdateDocumentMetadataResponse' :: Int
httpStatus = Int
a} :: UpdateDocumentMetadataResponse)

instance
  Prelude.NFData
    UpdateDocumentMetadataResponse
  where
  rnf :: UpdateDocumentMetadataResponse -> ()
rnf UpdateDocumentMetadataResponse' {Int
httpStatus :: Int
$sel:httpStatus:UpdateDocumentMetadataResponse' :: UpdateDocumentMetadataResponse -> Int
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus