{-# 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.WorkMail.PutRetentionPolicy
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Puts a retention policy to the specified organization.
module Amazonka.WorkMail.PutRetentionPolicy
  ( -- * Creating a Request
    PutRetentionPolicy (..),
    newPutRetentionPolicy,

    -- * Request Lenses
    putRetentionPolicy_description,
    putRetentionPolicy_id,
    putRetentionPolicy_organizationId,
    putRetentionPolicy_name,
    putRetentionPolicy_folderConfigurations,

    -- * Destructuring the Response
    PutRetentionPolicyResponse (..),
    newPutRetentionPolicyResponse,

    -- * Response Lenses
    putRetentionPolicyResponse_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.WorkMail.Types

-- | /See:/ 'newPutRetentionPolicy' smart constructor.
data PutRetentionPolicy = PutRetentionPolicy'
  { -- | The retention policy description.
    PutRetentionPolicy -> Maybe (Sensitive Text)
description :: Prelude.Maybe (Data.Sensitive Prelude.Text),
    -- | The retention policy ID.
    PutRetentionPolicy -> Maybe Text
id :: Prelude.Maybe Prelude.Text,
    -- | The organization ID.
    PutRetentionPolicy -> Text
organizationId :: Prelude.Text,
    -- | The retention policy name.
    PutRetentionPolicy -> Text
name :: Prelude.Text,
    -- | The retention policy folder configurations.
    PutRetentionPolicy -> [FolderConfiguration]
folderConfigurations :: [FolderConfiguration]
  }
  deriving (PutRetentionPolicy -> PutRetentionPolicy -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: PutRetentionPolicy -> PutRetentionPolicy -> Bool
$c/= :: PutRetentionPolicy -> PutRetentionPolicy -> Bool
== :: PutRetentionPolicy -> PutRetentionPolicy -> Bool
$c== :: PutRetentionPolicy -> PutRetentionPolicy -> Bool
Prelude.Eq, Int -> PutRetentionPolicy -> ShowS
[PutRetentionPolicy] -> ShowS
PutRetentionPolicy -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [PutRetentionPolicy] -> ShowS
$cshowList :: [PutRetentionPolicy] -> ShowS
show :: PutRetentionPolicy -> String
$cshow :: PutRetentionPolicy -> String
showsPrec :: Int -> PutRetentionPolicy -> ShowS
$cshowsPrec :: Int -> PutRetentionPolicy -> ShowS
Prelude.Show, forall x. Rep PutRetentionPolicy x -> PutRetentionPolicy
forall x. PutRetentionPolicy -> Rep PutRetentionPolicy x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep PutRetentionPolicy x -> PutRetentionPolicy
$cfrom :: forall x. PutRetentionPolicy -> Rep PutRetentionPolicy x
Prelude.Generic)

-- |
-- Create a value of 'PutRetentionPolicy' 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:
--
-- 'description', 'putRetentionPolicy_description' - The retention policy description.
--
-- 'id', 'putRetentionPolicy_id' - The retention policy ID.
--
-- 'organizationId', 'putRetentionPolicy_organizationId' - The organization ID.
--
-- 'name', 'putRetentionPolicy_name' - The retention policy name.
--
-- 'folderConfigurations', 'putRetentionPolicy_folderConfigurations' - The retention policy folder configurations.
newPutRetentionPolicy ::
  -- | 'organizationId'
  Prelude.Text ->
  -- | 'name'
  Prelude.Text ->
  PutRetentionPolicy
newPutRetentionPolicy :: Text -> Text -> PutRetentionPolicy
newPutRetentionPolicy Text
pOrganizationId_ Text
pName_ =
  PutRetentionPolicy'
    { $sel:description:PutRetentionPolicy' :: Maybe (Sensitive Text)
description = forall a. Maybe a
Prelude.Nothing,
      $sel:id:PutRetentionPolicy' :: Maybe Text
id = forall a. Maybe a
Prelude.Nothing,
      $sel:organizationId:PutRetentionPolicy' :: Text
organizationId = Text
pOrganizationId_,
      $sel:name:PutRetentionPolicy' :: Text
name = Text
pName_,
      $sel:folderConfigurations:PutRetentionPolicy' :: [FolderConfiguration]
folderConfigurations = forall a. Monoid a => a
Prelude.mempty
    }

-- | The retention policy description.
putRetentionPolicy_description :: Lens.Lens' PutRetentionPolicy (Prelude.Maybe Prelude.Text)
putRetentionPolicy_description :: Lens' PutRetentionPolicy (Maybe Text)
putRetentionPolicy_description = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PutRetentionPolicy' {Maybe (Sensitive Text)
description :: Maybe (Sensitive Text)
$sel:description:PutRetentionPolicy' :: PutRetentionPolicy -> Maybe (Sensitive Text)
description} -> Maybe (Sensitive Text)
description) (\s :: PutRetentionPolicy
s@PutRetentionPolicy' {} Maybe (Sensitive Text)
a -> PutRetentionPolicy
s {$sel:description:PutRetentionPolicy' :: Maybe (Sensitive Text)
description = Maybe (Sensitive Text)
a} :: PutRetentionPolicy) 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 a. Iso' (Sensitive a) a
Data._Sensitive

-- | The retention policy ID.
putRetentionPolicy_id :: Lens.Lens' PutRetentionPolicy (Prelude.Maybe Prelude.Text)
putRetentionPolicy_id :: Lens' PutRetentionPolicy (Maybe Text)
putRetentionPolicy_id = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PutRetentionPolicy' {Maybe Text
id :: Maybe Text
$sel:id:PutRetentionPolicy' :: PutRetentionPolicy -> Maybe Text
id} -> Maybe Text
id) (\s :: PutRetentionPolicy
s@PutRetentionPolicy' {} Maybe Text
a -> PutRetentionPolicy
s {$sel:id:PutRetentionPolicy' :: Maybe Text
id = Maybe Text
a} :: PutRetentionPolicy)

-- | The organization ID.
putRetentionPolicy_organizationId :: Lens.Lens' PutRetentionPolicy Prelude.Text
putRetentionPolicy_organizationId :: Lens' PutRetentionPolicy Text
putRetentionPolicy_organizationId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PutRetentionPolicy' {Text
organizationId :: Text
$sel:organizationId:PutRetentionPolicy' :: PutRetentionPolicy -> Text
organizationId} -> Text
organizationId) (\s :: PutRetentionPolicy
s@PutRetentionPolicy' {} Text
a -> PutRetentionPolicy
s {$sel:organizationId:PutRetentionPolicy' :: Text
organizationId = Text
a} :: PutRetentionPolicy)

-- | The retention policy name.
putRetentionPolicy_name :: Lens.Lens' PutRetentionPolicy Prelude.Text
putRetentionPolicy_name :: Lens' PutRetentionPolicy Text
putRetentionPolicy_name = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PutRetentionPolicy' {Text
name :: Text
$sel:name:PutRetentionPolicy' :: PutRetentionPolicy -> Text
name} -> Text
name) (\s :: PutRetentionPolicy
s@PutRetentionPolicy' {} Text
a -> PutRetentionPolicy
s {$sel:name:PutRetentionPolicy' :: Text
name = Text
a} :: PutRetentionPolicy)

-- | The retention policy folder configurations.
putRetentionPolicy_folderConfigurations :: Lens.Lens' PutRetentionPolicy [FolderConfiguration]
putRetentionPolicy_folderConfigurations :: Lens' PutRetentionPolicy [FolderConfiguration]
putRetentionPolicy_folderConfigurations = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PutRetentionPolicy' {[FolderConfiguration]
folderConfigurations :: [FolderConfiguration]
$sel:folderConfigurations:PutRetentionPolicy' :: PutRetentionPolicy -> [FolderConfiguration]
folderConfigurations} -> [FolderConfiguration]
folderConfigurations) (\s :: PutRetentionPolicy
s@PutRetentionPolicy' {} [FolderConfiguration]
a -> PutRetentionPolicy
s {$sel:folderConfigurations:PutRetentionPolicy' :: [FolderConfiguration]
folderConfigurations = [FolderConfiguration]
a} :: PutRetentionPolicy) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

instance Core.AWSRequest PutRetentionPolicy where
  type
    AWSResponse PutRetentionPolicy =
      PutRetentionPolicyResponse
  request :: (Service -> Service)
-> PutRetentionPolicy -> Request PutRetentionPolicy
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 PutRetentionPolicy
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse PutRetentionPolicy)))
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 -> PutRetentionPolicyResponse
PutRetentionPolicyResponse'
            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 PutRetentionPolicy where
  hashWithSalt :: Int -> PutRetentionPolicy -> Int
hashWithSalt Int
_salt PutRetentionPolicy' {[FolderConfiguration]
Maybe Text
Maybe (Sensitive Text)
Text
folderConfigurations :: [FolderConfiguration]
name :: Text
organizationId :: Text
id :: Maybe Text
description :: Maybe (Sensitive Text)
$sel:folderConfigurations:PutRetentionPolicy' :: PutRetentionPolicy -> [FolderConfiguration]
$sel:name:PutRetentionPolicy' :: PutRetentionPolicy -> Text
$sel:organizationId:PutRetentionPolicy' :: PutRetentionPolicy -> Text
$sel:id:PutRetentionPolicy' :: PutRetentionPolicy -> Maybe Text
$sel:description:PutRetentionPolicy' :: PutRetentionPolicy -> Maybe (Sensitive Text)
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (Sensitive Text)
description
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
id
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
organizationId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
name
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` [FolderConfiguration]
folderConfigurations

instance Prelude.NFData PutRetentionPolicy where
  rnf :: PutRetentionPolicy -> ()
rnf PutRetentionPolicy' {[FolderConfiguration]
Maybe Text
Maybe (Sensitive Text)
Text
folderConfigurations :: [FolderConfiguration]
name :: Text
organizationId :: Text
id :: Maybe Text
description :: Maybe (Sensitive Text)
$sel:folderConfigurations:PutRetentionPolicy' :: PutRetentionPolicy -> [FolderConfiguration]
$sel:name:PutRetentionPolicy' :: PutRetentionPolicy -> Text
$sel:organizationId:PutRetentionPolicy' :: PutRetentionPolicy -> Text
$sel:id:PutRetentionPolicy' :: PutRetentionPolicy -> Maybe Text
$sel:description:PutRetentionPolicy' :: PutRetentionPolicy -> Maybe (Sensitive Text)
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe (Sensitive Text)
description
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
id
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
organizationId
      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 [FolderConfiguration]
folderConfigurations

instance Data.ToHeaders PutRetentionPolicy where
  toHeaders :: PutRetentionPolicy -> 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
"WorkMailService.PutRetentionPolicy" ::
                          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 PutRetentionPolicy where
  toJSON :: PutRetentionPolicy -> Value
toJSON PutRetentionPolicy' {[FolderConfiguration]
Maybe Text
Maybe (Sensitive Text)
Text
folderConfigurations :: [FolderConfiguration]
name :: Text
organizationId :: Text
id :: Maybe Text
description :: Maybe (Sensitive Text)
$sel:folderConfigurations:PutRetentionPolicy' :: PutRetentionPolicy -> [FolderConfiguration]
$sel:name:PutRetentionPolicy' :: PutRetentionPolicy -> Text
$sel:organizationId:PutRetentionPolicy' :: PutRetentionPolicy -> Text
$sel:id:PutRetentionPolicy' :: PutRetentionPolicy -> Maybe Text
$sel:description:PutRetentionPolicy' :: PutRetentionPolicy -> Maybe (Sensitive Text)
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"Description" 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 (Sensitive Text)
description,
            (Key
"Id" 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
id,
            forall a. a -> Maybe a
Prelude.Just
              (Key
"OrganizationId" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
organizationId),
            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
"FolderConfigurations"
                  forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= [FolderConfiguration]
folderConfigurations
              )
          ]
      )

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

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

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

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

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

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