{-# 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.StepFunctions.DescribeActivity
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Describes an activity.
--
-- This operation is eventually consistent. The results are best effort and
-- may not reflect very recent updates and changes.
module Amazonka.StepFunctions.DescribeActivity
  ( -- * Creating a Request
    DescribeActivity (..),
    newDescribeActivity,

    -- * Request Lenses
    describeActivity_activityArn,

    -- * Destructuring the Response
    DescribeActivityResponse (..),
    newDescribeActivityResponse,

    -- * Response Lenses
    describeActivityResponse_httpStatus,
    describeActivityResponse_activityArn,
    describeActivityResponse_name,
    describeActivityResponse_creationDate,
  )
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.StepFunctions.Types

-- | /See:/ 'newDescribeActivity' smart constructor.
data DescribeActivity = DescribeActivity'
  { -- | The Amazon Resource Name (ARN) of the activity to describe.
    DescribeActivity -> Text
activityArn :: Prelude.Text
  }
  deriving (DescribeActivity -> DescribeActivity -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeActivity -> DescribeActivity -> Bool
$c/= :: DescribeActivity -> DescribeActivity -> Bool
== :: DescribeActivity -> DescribeActivity -> Bool
$c== :: DescribeActivity -> DescribeActivity -> Bool
Prelude.Eq, ReadPrec [DescribeActivity]
ReadPrec DescribeActivity
Int -> ReadS DescribeActivity
ReadS [DescribeActivity]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeActivity]
$creadListPrec :: ReadPrec [DescribeActivity]
readPrec :: ReadPrec DescribeActivity
$creadPrec :: ReadPrec DescribeActivity
readList :: ReadS [DescribeActivity]
$creadList :: ReadS [DescribeActivity]
readsPrec :: Int -> ReadS DescribeActivity
$creadsPrec :: Int -> ReadS DescribeActivity
Prelude.Read, Int -> DescribeActivity -> ShowS
[DescribeActivity] -> ShowS
DescribeActivity -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeActivity] -> ShowS
$cshowList :: [DescribeActivity] -> ShowS
show :: DescribeActivity -> String
$cshow :: DescribeActivity -> String
showsPrec :: Int -> DescribeActivity -> ShowS
$cshowsPrec :: Int -> DescribeActivity -> ShowS
Prelude.Show, forall x. Rep DescribeActivity x -> DescribeActivity
forall x. DescribeActivity -> Rep DescribeActivity x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DescribeActivity x -> DescribeActivity
$cfrom :: forall x. DescribeActivity -> Rep DescribeActivity x
Prelude.Generic)

-- |
-- Create a value of 'DescribeActivity' 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:
--
-- 'activityArn', 'describeActivity_activityArn' - The Amazon Resource Name (ARN) of the activity to describe.
newDescribeActivity ::
  -- | 'activityArn'
  Prelude.Text ->
  DescribeActivity
newDescribeActivity :: Text -> DescribeActivity
newDescribeActivity Text
pActivityArn_ =
  DescribeActivity' {$sel:activityArn:DescribeActivity' :: Text
activityArn = Text
pActivityArn_}

-- | The Amazon Resource Name (ARN) of the activity to describe.
describeActivity_activityArn :: Lens.Lens' DescribeActivity Prelude.Text
describeActivity_activityArn :: Lens' DescribeActivity Text
describeActivity_activityArn = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeActivity' {Text
activityArn :: Text
$sel:activityArn:DescribeActivity' :: DescribeActivity -> Text
activityArn} -> Text
activityArn) (\s :: DescribeActivity
s@DescribeActivity' {} Text
a -> DescribeActivity
s {$sel:activityArn:DescribeActivity' :: Text
activityArn = Text
a} :: DescribeActivity)

instance Core.AWSRequest DescribeActivity where
  type
    AWSResponse DescribeActivity =
      DescribeActivityResponse
  request :: (Service -> Service)
-> DescribeActivity -> Request DescribeActivity
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 DescribeActivity
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse DescribeActivity)))
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 ->
          Int -> Text -> Text -> POSIX -> DescribeActivityResponse
DescribeActivityResponse'
            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))
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Either String a
Data..:> Key
"activityArn")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Either String 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 a
Data..:> Key
"creationDate")
      )

instance Prelude.Hashable DescribeActivity where
  hashWithSalt :: Int -> DescribeActivity -> Int
hashWithSalt Int
_salt DescribeActivity' {Text
activityArn :: Text
$sel:activityArn:DescribeActivity' :: DescribeActivity -> Text
..} =
    Int
_salt forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
activityArn

instance Prelude.NFData DescribeActivity where
  rnf :: DescribeActivity -> ()
rnf DescribeActivity' {Text
activityArn :: Text
$sel:activityArn:DescribeActivity' :: DescribeActivity -> Text
..} = forall a. NFData a => a -> ()
Prelude.rnf Text
activityArn

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

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

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

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

-- | /See:/ 'newDescribeActivityResponse' smart constructor.
data DescribeActivityResponse = DescribeActivityResponse'
  { -- | The response's http status code.
    DescribeActivityResponse -> Int
httpStatus :: Prelude.Int,
    -- | The Amazon Resource Name (ARN) that identifies the activity.
    DescribeActivityResponse -> Text
activityArn :: Prelude.Text,
    -- | The name of the activity.
    --
    -- A name must /not/ contain:
    --
    -- -   white space
    --
    -- -   brackets @\< > { } [ ]@
    --
    -- -   wildcard characters @? *@
    --
    -- -   special characters @\" # % \\ ^ | ~ \` $ & , ; : \/@
    --
    -- -   control characters (@U+0000-001F@, @U+007F-009F@)
    --
    -- To enable logging with CloudWatch Logs, the name should only contain
    -- 0-9, A-Z, a-z, - and _.
    DescribeActivityResponse -> Text
name :: Prelude.Text,
    -- | The date the activity is created.
    DescribeActivityResponse -> POSIX
creationDate :: Data.POSIX
  }
  deriving (DescribeActivityResponse -> DescribeActivityResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeActivityResponse -> DescribeActivityResponse -> Bool
$c/= :: DescribeActivityResponse -> DescribeActivityResponse -> Bool
== :: DescribeActivityResponse -> DescribeActivityResponse -> Bool
$c== :: DescribeActivityResponse -> DescribeActivityResponse -> Bool
Prelude.Eq, ReadPrec [DescribeActivityResponse]
ReadPrec DescribeActivityResponse
Int -> ReadS DescribeActivityResponse
ReadS [DescribeActivityResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeActivityResponse]
$creadListPrec :: ReadPrec [DescribeActivityResponse]
readPrec :: ReadPrec DescribeActivityResponse
$creadPrec :: ReadPrec DescribeActivityResponse
readList :: ReadS [DescribeActivityResponse]
$creadList :: ReadS [DescribeActivityResponse]
readsPrec :: Int -> ReadS DescribeActivityResponse
$creadsPrec :: Int -> ReadS DescribeActivityResponse
Prelude.Read, Int -> DescribeActivityResponse -> ShowS
[DescribeActivityResponse] -> ShowS
DescribeActivityResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeActivityResponse] -> ShowS
$cshowList :: [DescribeActivityResponse] -> ShowS
show :: DescribeActivityResponse -> String
$cshow :: DescribeActivityResponse -> String
showsPrec :: Int -> DescribeActivityResponse -> ShowS
$cshowsPrec :: Int -> DescribeActivityResponse -> ShowS
Prelude.Show, forall x.
Rep DescribeActivityResponse x -> DescribeActivityResponse
forall x.
DescribeActivityResponse -> Rep DescribeActivityResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep DescribeActivityResponse x -> DescribeActivityResponse
$cfrom :: forall x.
DescribeActivityResponse -> Rep DescribeActivityResponse x
Prelude.Generic)

-- |
-- Create a value of 'DescribeActivityResponse' 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', 'describeActivityResponse_httpStatus' - The response's http status code.
--
-- 'activityArn', 'describeActivityResponse_activityArn' - The Amazon Resource Name (ARN) that identifies the activity.
--
-- 'name', 'describeActivityResponse_name' - The name of the activity.
--
-- A name must /not/ contain:
--
-- -   white space
--
-- -   brackets @\< > { } [ ]@
--
-- -   wildcard characters @? *@
--
-- -   special characters @\" # % \\ ^ | ~ \` $ & , ; : \/@
--
-- -   control characters (@U+0000-001F@, @U+007F-009F@)
--
-- To enable logging with CloudWatch Logs, the name should only contain
-- 0-9, A-Z, a-z, - and _.
--
-- 'creationDate', 'describeActivityResponse_creationDate' - The date the activity is created.
newDescribeActivityResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  -- | 'activityArn'
  Prelude.Text ->
  -- | 'name'
  Prelude.Text ->
  -- | 'creationDate'
  Prelude.UTCTime ->
  DescribeActivityResponse
newDescribeActivityResponse :: Int -> Text -> Text -> UTCTime -> DescribeActivityResponse
newDescribeActivityResponse
  Int
pHttpStatus_
  Text
pActivityArn_
  Text
pName_
  UTCTime
pCreationDate_ =
    DescribeActivityResponse'
      { $sel:httpStatus:DescribeActivityResponse' :: Int
httpStatus =
          Int
pHttpStatus_,
        $sel:activityArn:DescribeActivityResponse' :: Text
activityArn = Text
pActivityArn_,
        $sel:name:DescribeActivityResponse' :: Text
name = Text
pName_,
        $sel:creationDate:DescribeActivityResponse' :: POSIX
creationDate = forall (a :: Format). Iso' (Time a) UTCTime
Data._Time forall t b. AReview t b -> b -> t
Lens.# UTCTime
pCreationDate_
      }

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

-- | The Amazon Resource Name (ARN) that identifies the activity.
describeActivityResponse_activityArn :: Lens.Lens' DescribeActivityResponse Prelude.Text
describeActivityResponse_activityArn :: Lens' DescribeActivityResponse Text
describeActivityResponse_activityArn = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeActivityResponse' {Text
activityArn :: Text
$sel:activityArn:DescribeActivityResponse' :: DescribeActivityResponse -> Text
activityArn} -> Text
activityArn) (\s :: DescribeActivityResponse
s@DescribeActivityResponse' {} Text
a -> DescribeActivityResponse
s {$sel:activityArn:DescribeActivityResponse' :: Text
activityArn = Text
a} :: DescribeActivityResponse)

-- | The name of the activity.
--
-- A name must /not/ contain:
--
-- -   white space
--
-- -   brackets @\< > { } [ ]@
--
-- -   wildcard characters @? *@
--
-- -   special characters @\" # % \\ ^ | ~ \` $ & , ; : \/@
--
-- -   control characters (@U+0000-001F@, @U+007F-009F@)
--
-- To enable logging with CloudWatch Logs, the name should only contain
-- 0-9, A-Z, a-z, - and _.
describeActivityResponse_name :: Lens.Lens' DescribeActivityResponse Prelude.Text
describeActivityResponse_name :: Lens' DescribeActivityResponse Text
describeActivityResponse_name = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeActivityResponse' {Text
name :: Text
$sel:name:DescribeActivityResponse' :: DescribeActivityResponse -> Text
name} -> Text
name) (\s :: DescribeActivityResponse
s@DescribeActivityResponse' {} Text
a -> DescribeActivityResponse
s {$sel:name:DescribeActivityResponse' :: Text
name = Text
a} :: DescribeActivityResponse)

-- | The date the activity is created.
describeActivityResponse_creationDate :: Lens.Lens' DescribeActivityResponse Prelude.UTCTime
describeActivityResponse_creationDate :: Lens' DescribeActivityResponse UTCTime
describeActivityResponse_creationDate = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeActivityResponse' {POSIX
creationDate :: POSIX
$sel:creationDate:DescribeActivityResponse' :: DescribeActivityResponse -> POSIX
creationDate} -> POSIX
creationDate) (\s :: DescribeActivityResponse
s@DescribeActivityResponse' {} POSIX
a -> DescribeActivityResponse
s {$sel:creationDate:DescribeActivityResponse' :: POSIX
creationDate = POSIX
a} :: DescribeActivityResponse) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (a :: Format). Iso' (Time a) UTCTime
Data._Time

instance Prelude.NFData DescribeActivityResponse where
  rnf :: DescribeActivityResponse -> ()
rnf DescribeActivityResponse' {Int
Text
POSIX
creationDate :: POSIX
name :: Text
activityArn :: Text
httpStatus :: Int
$sel:creationDate:DescribeActivityResponse' :: DescribeActivityResponse -> POSIX
$sel:name:DescribeActivityResponse' :: DescribeActivityResponse -> Text
$sel:activityArn:DescribeActivityResponse' :: DescribeActivityResponse -> Text
$sel:httpStatus:DescribeActivityResponse' :: DescribeActivityResponse -> Int
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
activityArn
      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 POSIX
creationDate