{-# 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.CountPendingActivityTasks
-- Copyright   : (c) 2013-2021 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay <brendan.g.hay+amazonka@gmail.com>
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Returns the estimated number of activity tasks in the specified task
-- list. The count returned is an approximation and isn\'t guaranteed to be
-- exact. If you specify a task list that no activity task was ever
-- scheduled in then @0@ is returned.
--
-- __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 @taskList.name@ parameter by using a @Condition@
--     element with the @swf:taskList.name@ key to allow the action to
--     access only certain task lists.
--
-- 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.CountPendingActivityTasks
  ( -- * Creating a Request
    CountPendingActivityTasks (..),
    newCountPendingActivityTasks,

    -- * Request Lenses
    countPendingActivityTasks_domain,
    countPendingActivityTasks_taskList,

    -- * Destructuring the Response
    PendingTaskCount (..),
    newPendingTaskCount,

    -- * Response Lenses
    pendingTaskCount_truncated,
    pendingTaskCount_count,
  )
where

import qualified Amazonka.Core as Core
import qualified Amazonka.Lens as Lens
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response
import Amazonka.SWF.Types

-- | /See:/ 'newCountPendingActivityTasks' smart constructor.
data CountPendingActivityTasks = CountPendingActivityTasks'
  { -- | The name of the domain that contains the task list.
    CountPendingActivityTasks -> Text
domain :: Prelude.Text,
    -- | The name of the task list.
    CountPendingActivityTasks -> TaskList
taskList :: TaskList
  }
  deriving (CountPendingActivityTasks -> CountPendingActivityTasks -> Bool
(CountPendingActivityTasks -> CountPendingActivityTasks -> Bool)
-> (CountPendingActivityTasks -> CountPendingActivityTasks -> Bool)
-> Eq CountPendingActivityTasks
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: CountPendingActivityTasks -> CountPendingActivityTasks -> Bool
$c/= :: CountPendingActivityTasks -> CountPendingActivityTasks -> Bool
== :: CountPendingActivityTasks -> CountPendingActivityTasks -> Bool
$c== :: CountPendingActivityTasks -> CountPendingActivityTasks -> Bool
Prelude.Eq, ReadPrec [CountPendingActivityTasks]
ReadPrec CountPendingActivityTasks
Int -> ReadS CountPendingActivityTasks
ReadS [CountPendingActivityTasks]
(Int -> ReadS CountPendingActivityTasks)
-> ReadS [CountPendingActivityTasks]
-> ReadPrec CountPendingActivityTasks
-> ReadPrec [CountPendingActivityTasks]
-> Read CountPendingActivityTasks
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [CountPendingActivityTasks]
$creadListPrec :: ReadPrec [CountPendingActivityTasks]
readPrec :: ReadPrec CountPendingActivityTasks
$creadPrec :: ReadPrec CountPendingActivityTasks
readList :: ReadS [CountPendingActivityTasks]
$creadList :: ReadS [CountPendingActivityTasks]
readsPrec :: Int -> ReadS CountPendingActivityTasks
$creadsPrec :: Int -> ReadS CountPendingActivityTasks
Prelude.Read, Int -> CountPendingActivityTasks -> ShowS
[CountPendingActivityTasks] -> ShowS
CountPendingActivityTasks -> String
(Int -> CountPendingActivityTasks -> ShowS)
-> (CountPendingActivityTasks -> String)
-> ([CountPendingActivityTasks] -> ShowS)
-> Show CountPendingActivityTasks
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [CountPendingActivityTasks] -> ShowS
$cshowList :: [CountPendingActivityTasks] -> ShowS
show :: CountPendingActivityTasks -> String
$cshow :: CountPendingActivityTasks -> String
showsPrec :: Int -> CountPendingActivityTasks -> ShowS
$cshowsPrec :: Int -> CountPendingActivityTasks -> ShowS
Prelude.Show, (forall x.
 CountPendingActivityTasks -> Rep CountPendingActivityTasks x)
-> (forall x.
    Rep CountPendingActivityTasks x -> CountPendingActivityTasks)
-> Generic CountPendingActivityTasks
forall x.
Rep CountPendingActivityTasks x -> CountPendingActivityTasks
forall x.
CountPendingActivityTasks -> Rep CountPendingActivityTasks x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep CountPendingActivityTasks x -> CountPendingActivityTasks
$cfrom :: forall x.
CountPendingActivityTasks -> Rep CountPendingActivityTasks x
Prelude.Generic)

-- |
-- Create a value of 'CountPendingActivityTasks' 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', 'countPendingActivityTasks_domain' - The name of the domain that contains the task list.
--
-- 'taskList', 'countPendingActivityTasks_taskList' - The name of the task list.
newCountPendingActivityTasks ::
  -- | 'domain'
  Prelude.Text ->
  -- | 'taskList'
  TaskList ->
  CountPendingActivityTasks
newCountPendingActivityTasks :: Text -> TaskList -> CountPendingActivityTasks
newCountPendingActivityTasks Text
pDomain_ TaskList
pTaskList_ =
  CountPendingActivityTasks' :: Text -> TaskList -> CountPendingActivityTasks
CountPendingActivityTasks'
    { $sel:domain:CountPendingActivityTasks' :: Text
domain = Text
pDomain_,
      $sel:taskList:CountPendingActivityTasks' :: TaskList
taskList = TaskList
pTaskList_
    }

-- | The name of the domain that contains the task list.
countPendingActivityTasks_domain :: Lens.Lens' CountPendingActivityTasks Prelude.Text
countPendingActivityTasks_domain :: (Text -> f Text)
-> CountPendingActivityTasks -> f CountPendingActivityTasks
countPendingActivityTasks_domain = (CountPendingActivityTasks -> Text)
-> (CountPendingActivityTasks -> Text -> CountPendingActivityTasks)
-> Lens
     CountPendingActivityTasks CountPendingActivityTasks Text Text
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CountPendingActivityTasks' {Text
domain :: Text
$sel:domain:CountPendingActivityTasks' :: CountPendingActivityTasks -> Text
domain} -> Text
domain) (\s :: CountPendingActivityTasks
s@CountPendingActivityTasks' {} Text
a -> CountPendingActivityTasks
s {$sel:domain:CountPendingActivityTasks' :: Text
domain = Text
a} :: CountPendingActivityTasks)

-- | The name of the task list.
countPendingActivityTasks_taskList :: Lens.Lens' CountPendingActivityTasks TaskList
countPendingActivityTasks_taskList :: (TaskList -> f TaskList)
-> CountPendingActivityTasks -> f CountPendingActivityTasks
countPendingActivityTasks_taskList = (CountPendingActivityTasks -> TaskList)
-> (CountPendingActivityTasks
    -> TaskList -> CountPendingActivityTasks)
-> Lens
     CountPendingActivityTasks
     CountPendingActivityTasks
     TaskList
     TaskList
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CountPendingActivityTasks' {TaskList
taskList :: TaskList
$sel:taskList:CountPendingActivityTasks' :: CountPendingActivityTasks -> TaskList
taskList} -> TaskList
taskList) (\s :: CountPendingActivityTasks
s@CountPendingActivityTasks' {} TaskList
a -> CountPendingActivityTasks
s {$sel:taskList:CountPendingActivityTasks' :: TaskList
taskList = TaskList
a} :: CountPendingActivityTasks)

instance Core.AWSRequest CountPendingActivityTasks where
  type
    AWSResponse CountPendingActivityTasks =
      PendingTaskCount
  request :: CountPendingActivityTasks -> Request CountPendingActivityTasks
request = Service
-> CountPendingActivityTasks -> Request CountPendingActivityTasks
forall a. (ToRequest a, ToJSON a) => Service -> a -> Request a
Request.postJSON Service
defaultService
  response :: Logger
-> Service
-> Proxy CountPendingActivityTasks
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse CountPendingActivityTasks)))
response =
    (Int
 -> ResponseHeaders
 -> Object
 -> Either String (AWSResponse CountPendingActivityTasks))
-> Logger
-> Service
-> Proxy CountPendingActivityTasks
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse CountPendingActivityTasks)))
forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> Object -> Either String (AWSResponse a))
-> Logger
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveJSON
      (\Int
s ResponseHeaders
h Object
x -> Object -> Either String PendingTaskCount
forall a. FromJSON a => Object -> Either String a
Core.eitherParseJSON Object
x)

instance Prelude.Hashable CountPendingActivityTasks

instance Prelude.NFData CountPendingActivityTasks

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

instance Core.ToJSON CountPendingActivityTasks where
  toJSON :: CountPendingActivityTasks -> Value
toJSON CountPendingActivityTasks' {Text
TaskList
taskList :: TaskList
domain :: Text
$sel:taskList:CountPendingActivityTasks' :: CountPendingActivityTasks -> TaskList
$sel:domain:CountPendingActivityTasks' :: CountPendingActivityTasks -> Text
..} =
    [Pair] -> Value
Core.object
      ( [Maybe Pair] -> [Pair]
forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just (Text
"domain" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= Text
domain),
            Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just (Text
"taskList" Text -> TaskList -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= TaskList
taskList)
          ]
      )

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

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