{-# 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.SWF.DeprecateActivityType
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Deprecates the specified /activity type/. After an activity type has
-- been deprecated, you cannot create new tasks of that activity type.
-- Tasks of this type that were scheduled before the type was deprecated
-- continue to run.
--
-- This operation is eventually consistent. The results are best effort and
-- may not exactly reflect recent updates and changes.
--
-- __Access Control__
--
-- You can use IAM policies to control this action\'s access to Amazon SWF
-- resources as follows:
--
-- -   Use a @Resource@ element with the domain name to limit the action to
--     only specified domains.
--
-- -   Use an @Action@ element to allow or deny permission to call this
--     action.
--
-- -   Constrain the following parameters by using a @Condition@ element
--     with the appropriate keys.
--
--     -   @activityType.name@: String constraint. The key is
--         @swf:activityType.name@.
--
--     -   @activityType.version@: String constraint. The key is
--         @swf:activityType.version@.
--
-- If the caller doesn\'t have sufficient permissions to invoke the action,
-- or the parameter values fall outside the specified constraints, the
-- action fails. The associated event attribute\'s @cause@ parameter is set
-- to @OPERATION_NOT_PERMITTED@. For details and example IAM policies, see
-- <https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html Using IAM to Manage Access to Amazon SWF Workflows>
-- in the /Amazon SWF Developer Guide/.
module Amazonka.SWF.DeprecateActivityType
  ( -- * Creating a Request
    DeprecateActivityType (..),
    newDeprecateActivityType,

    -- * Request Lenses
    deprecateActivityType_domain,
    deprecateActivityType_activityType,

    -- * Destructuring the Response
    DeprecateActivityTypeResponse (..),
    newDeprecateActivityTypeResponse,
  )
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.SWF.Types

-- | /See:/ 'newDeprecateActivityType' smart constructor.
data DeprecateActivityType = DeprecateActivityType'
  { -- | The name of the domain in which the activity type is registered.
    DeprecateActivityType -> Text
domain :: Prelude.Text,
    -- | The activity type to deprecate.
    DeprecateActivityType -> ActivityType
activityType :: ActivityType
  }
  deriving (DeprecateActivityType -> DeprecateActivityType -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DeprecateActivityType -> DeprecateActivityType -> Bool
$c/= :: DeprecateActivityType -> DeprecateActivityType -> Bool
== :: DeprecateActivityType -> DeprecateActivityType -> Bool
$c== :: DeprecateActivityType -> DeprecateActivityType -> Bool
Prelude.Eq, ReadPrec [DeprecateActivityType]
ReadPrec DeprecateActivityType
Int -> ReadS DeprecateActivityType
ReadS [DeprecateActivityType]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DeprecateActivityType]
$creadListPrec :: ReadPrec [DeprecateActivityType]
readPrec :: ReadPrec DeprecateActivityType
$creadPrec :: ReadPrec DeprecateActivityType
readList :: ReadS [DeprecateActivityType]
$creadList :: ReadS [DeprecateActivityType]
readsPrec :: Int -> ReadS DeprecateActivityType
$creadsPrec :: Int -> ReadS DeprecateActivityType
Prelude.Read, Int -> DeprecateActivityType -> ShowS
[DeprecateActivityType] -> ShowS
DeprecateActivityType -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DeprecateActivityType] -> ShowS
$cshowList :: [DeprecateActivityType] -> ShowS
show :: DeprecateActivityType -> String
$cshow :: DeprecateActivityType -> String
showsPrec :: Int -> DeprecateActivityType -> ShowS
$cshowsPrec :: Int -> DeprecateActivityType -> ShowS
Prelude.Show, forall x. Rep DeprecateActivityType x -> DeprecateActivityType
forall x. DeprecateActivityType -> Rep DeprecateActivityType x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DeprecateActivityType x -> DeprecateActivityType
$cfrom :: forall x. DeprecateActivityType -> Rep DeprecateActivityType x
Prelude.Generic)

-- |
-- Create a value of 'DeprecateActivityType' 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:
--
-- 'domain', 'deprecateActivityType_domain' - The name of the domain in which the activity type is registered.
--
-- 'activityType', 'deprecateActivityType_activityType' - The activity type to deprecate.
newDeprecateActivityType ::
  -- | 'domain'
  Prelude.Text ->
  -- | 'activityType'
  ActivityType ->
  DeprecateActivityType
newDeprecateActivityType :: Text -> ActivityType -> DeprecateActivityType
newDeprecateActivityType Text
pDomain_ ActivityType
pActivityType_ =
  DeprecateActivityType'
    { $sel:domain:DeprecateActivityType' :: Text
domain = Text
pDomain_,
      $sel:activityType:DeprecateActivityType' :: ActivityType
activityType = ActivityType
pActivityType_
    }

-- | The name of the domain in which the activity type is registered.
deprecateActivityType_domain :: Lens.Lens' DeprecateActivityType Prelude.Text
deprecateActivityType_domain :: Lens' DeprecateActivityType Text
deprecateActivityType_domain = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DeprecateActivityType' {Text
domain :: Text
$sel:domain:DeprecateActivityType' :: DeprecateActivityType -> Text
domain} -> Text
domain) (\s :: DeprecateActivityType
s@DeprecateActivityType' {} Text
a -> DeprecateActivityType
s {$sel:domain:DeprecateActivityType' :: Text
domain = Text
a} :: DeprecateActivityType)

-- | The activity type to deprecate.
deprecateActivityType_activityType :: Lens.Lens' DeprecateActivityType ActivityType
deprecateActivityType_activityType :: Lens' DeprecateActivityType ActivityType
deprecateActivityType_activityType = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DeprecateActivityType' {ActivityType
activityType :: ActivityType
$sel:activityType:DeprecateActivityType' :: DeprecateActivityType -> ActivityType
activityType} -> ActivityType
activityType) (\s :: DeprecateActivityType
s@DeprecateActivityType' {} ActivityType
a -> DeprecateActivityType
s {$sel:activityType:DeprecateActivityType' :: ActivityType
activityType = ActivityType
a} :: DeprecateActivityType)

instance Core.AWSRequest DeprecateActivityType where
  type
    AWSResponse DeprecateActivityType =
      DeprecateActivityTypeResponse
  request :: (Service -> Service)
-> DeprecateActivityType -> Request DeprecateActivityType
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 DeprecateActivityType
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse DeprecateActivityType)))
response =
    forall (m :: * -> *) a.
MonadResource m =>
AWSResponse a
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveNull DeprecateActivityTypeResponse
DeprecateActivityTypeResponse'

instance Prelude.Hashable DeprecateActivityType where
  hashWithSalt :: Int -> DeprecateActivityType -> Int
hashWithSalt Int
_salt DeprecateActivityType' {Text
ActivityType
activityType :: ActivityType
domain :: Text
$sel:activityType:DeprecateActivityType' :: DeprecateActivityType -> ActivityType
$sel:domain:DeprecateActivityType' :: DeprecateActivityType -> Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
domain
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` ActivityType
activityType

instance Prelude.NFData DeprecateActivityType where
  rnf :: DeprecateActivityType -> ()
rnf DeprecateActivityType' {Text
ActivityType
activityType :: ActivityType
domain :: Text
$sel:activityType:DeprecateActivityType' :: DeprecateActivityType -> ActivityType
$sel:domain:DeprecateActivityType' :: DeprecateActivityType -> Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Text
domain
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf ActivityType
activityType

instance Data.ToHeaders DeprecateActivityType where
  toHeaders :: DeprecateActivityType -> [Header]
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 -> [Header]
Data.=# ( ByteString
"SimpleWorkflowService.DeprecateActivityType" ::
                          Prelude.ByteString
                      ),
            HeaderName
"Content-Type"
              forall a. ToHeader a => HeaderName -> a -> [Header]
Data.=# ( ByteString
"application/x-amz-json-1.0" ::
                          Prelude.ByteString
                      )
          ]
      )

instance Data.ToJSON DeprecateActivityType where
  toJSON :: DeprecateActivityType -> Value
toJSON DeprecateActivityType' {Text
ActivityType
activityType :: ActivityType
domain :: Text
$sel:activityType:DeprecateActivityType' :: DeprecateActivityType -> ActivityType
$sel:domain:DeprecateActivityType' :: DeprecateActivityType -> Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ forall a. a -> Maybe a
Prelude.Just (Key
"domain" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
domain),
            forall a. a -> Maybe a
Prelude.Just (Key
"activityType" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= ActivityType
activityType)
          ]
      )

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

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

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

-- |
-- Create a value of 'DeprecateActivityTypeResponse' 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.
newDeprecateActivityTypeResponse ::
  DeprecateActivityTypeResponse
newDeprecateActivityTypeResponse :: DeprecateActivityTypeResponse
newDeprecateActivityTypeResponse =
  DeprecateActivityTypeResponse
DeprecateActivityTypeResponse'

instance Prelude.NFData DeprecateActivityTypeResponse where
  rnf :: DeprecateActivityTypeResponse -> ()
rnf DeprecateActivityTypeResponse
_ = ()