{-# 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.ECS.DescribeTasks
-- 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 a specified task or tasks.
--
-- Currently, stopped tasks appear in the returned results for at least one
-- hour.
module Amazonka.ECS.DescribeTasks
  ( -- * Creating a Request
    DescribeTasks (..),
    newDescribeTasks,

    -- * Request Lenses
    describeTasks_cluster,
    describeTasks_include,
    describeTasks_tasks,

    -- * Destructuring the Response
    DescribeTasksResponse (..),
    newDescribeTasksResponse,

    -- * Response Lenses
    describeTasksResponse_failures,
    describeTasksResponse_tasks,
    describeTasksResponse_httpStatus,
  )
where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.ECS.Types
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response

-- | /See:/ 'newDescribeTasks' smart constructor.
data DescribeTasks = DescribeTasks'
  { -- | The short name or full Amazon Resource Name (ARN) of the cluster that
    -- hosts the task or tasks to describe. If you do not specify a cluster,
    -- the default cluster is assumed. This parameter is required if the task
    -- or tasks you are describing were launched in any cluster other than the
    -- default cluster.
    DescribeTasks -> Maybe Text
cluster :: Prelude.Maybe Prelude.Text,
    -- | Specifies whether you want to see the resource tags for the task. If
    -- @TAGS@ is specified, the tags are included in the response. If this
    -- field is omitted, tags aren\'t included in the response.
    DescribeTasks -> Maybe [TaskField]
include :: Prelude.Maybe [TaskField],
    -- | A list of up to 100 task IDs or full ARN entries.
    DescribeTasks -> [Text]
tasks :: [Prelude.Text]
  }
  deriving (DescribeTasks -> DescribeTasks -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeTasks -> DescribeTasks -> Bool
$c/= :: DescribeTasks -> DescribeTasks -> Bool
== :: DescribeTasks -> DescribeTasks -> Bool
$c== :: DescribeTasks -> DescribeTasks -> Bool
Prelude.Eq, ReadPrec [DescribeTasks]
ReadPrec DescribeTasks
Int -> ReadS DescribeTasks
ReadS [DescribeTasks]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeTasks]
$creadListPrec :: ReadPrec [DescribeTasks]
readPrec :: ReadPrec DescribeTasks
$creadPrec :: ReadPrec DescribeTasks
readList :: ReadS [DescribeTasks]
$creadList :: ReadS [DescribeTasks]
readsPrec :: Int -> ReadS DescribeTasks
$creadsPrec :: Int -> ReadS DescribeTasks
Prelude.Read, Int -> DescribeTasks -> ShowS
[DescribeTasks] -> ShowS
DescribeTasks -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeTasks] -> ShowS
$cshowList :: [DescribeTasks] -> ShowS
show :: DescribeTasks -> String
$cshow :: DescribeTasks -> String
showsPrec :: Int -> DescribeTasks -> ShowS
$cshowsPrec :: Int -> DescribeTasks -> ShowS
Prelude.Show, forall x. Rep DescribeTasks x -> DescribeTasks
forall x. DescribeTasks -> Rep DescribeTasks x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DescribeTasks x -> DescribeTasks
$cfrom :: forall x. DescribeTasks -> Rep DescribeTasks x
Prelude.Generic)

-- |
-- Create a value of 'DescribeTasks' 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:
--
-- 'cluster', 'describeTasks_cluster' - The short name or full Amazon Resource Name (ARN) of the cluster that
-- hosts the task or tasks to describe. If you do not specify a cluster,
-- the default cluster is assumed. This parameter is required if the task
-- or tasks you are describing were launched in any cluster other than the
-- default cluster.
--
-- 'include', 'describeTasks_include' - Specifies whether you want to see the resource tags for the task. If
-- @TAGS@ is specified, the tags are included in the response. If this
-- field is omitted, tags aren\'t included in the response.
--
-- 'tasks', 'describeTasks_tasks' - A list of up to 100 task IDs or full ARN entries.
newDescribeTasks ::
  DescribeTasks
newDescribeTasks :: DescribeTasks
newDescribeTasks =
  DescribeTasks'
    { $sel:cluster:DescribeTasks' :: Maybe Text
cluster = forall a. Maybe a
Prelude.Nothing,
      $sel:include:DescribeTasks' :: Maybe [TaskField]
include = forall a. Maybe a
Prelude.Nothing,
      $sel:tasks:DescribeTasks' :: [Text]
tasks = forall a. Monoid a => a
Prelude.mempty
    }

-- | The short name or full Amazon Resource Name (ARN) of the cluster that
-- hosts the task or tasks to describe. If you do not specify a cluster,
-- the default cluster is assumed. This parameter is required if the task
-- or tasks you are describing were launched in any cluster other than the
-- default cluster.
describeTasks_cluster :: Lens.Lens' DescribeTasks (Prelude.Maybe Prelude.Text)
describeTasks_cluster :: Lens' DescribeTasks (Maybe Text)
describeTasks_cluster = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeTasks' {Maybe Text
cluster :: Maybe Text
$sel:cluster:DescribeTasks' :: DescribeTasks -> Maybe Text
cluster} -> Maybe Text
cluster) (\s :: DescribeTasks
s@DescribeTasks' {} Maybe Text
a -> DescribeTasks
s {$sel:cluster:DescribeTasks' :: Maybe Text
cluster = Maybe Text
a} :: DescribeTasks)

-- | Specifies whether you want to see the resource tags for the task. If
-- @TAGS@ is specified, the tags are included in the response. If this
-- field is omitted, tags aren\'t included in the response.
describeTasks_include :: Lens.Lens' DescribeTasks (Prelude.Maybe [TaskField])
describeTasks_include :: Lens' DescribeTasks (Maybe [TaskField])
describeTasks_include = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeTasks' {Maybe [TaskField]
include :: Maybe [TaskField]
$sel:include:DescribeTasks' :: DescribeTasks -> Maybe [TaskField]
include} -> Maybe [TaskField]
include) (\s :: DescribeTasks
s@DescribeTasks' {} Maybe [TaskField]
a -> DescribeTasks
s {$sel:include:DescribeTasks' :: Maybe [TaskField]
include = Maybe [TaskField]
a} :: DescribeTasks) 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 s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | A list of up to 100 task IDs or full ARN entries.
describeTasks_tasks :: Lens.Lens' DescribeTasks [Prelude.Text]
describeTasks_tasks :: Lens' DescribeTasks [Text]
describeTasks_tasks = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeTasks' {[Text]
tasks :: [Text]
$sel:tasks:DescribeTasks' :: DescribeTasks -> [Text]
tasks} -> [Text]
tasks) (\s :: DescribeTasks
s@DescribeTasks' {} [Text]
a -> DescribeTasks
s {$sel:tasks:DescribeTasks' :: [Text]
tasks = [Text]
a} :: DescribeTasks) 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 DescribeTasks where
  type
    AWSResponse DescribeTasks =
      DescribeTasksResponse
  request :: (Service -> Service) -> DescribeTasks -> Request DescribeTasks
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 DescribeTasks
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse DescribeTasks)))
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 ->
          Maybe [Failure] -> Maybe [Task] -> Int -> DescribeTasksResponse
DescribeTasksResponse'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"failures" forall (f :: * -> *) a. Functor f => f (Maybe a) -> a -> f a
Core..!@ forall a. Monoid a => a
Prelude.mempty)
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"tasks" forall (f :: * -> *) a. Functor f => f (Maybe a) -> a -> f a
Core..!@ forall a. Monoid a => a
Prelude.mempty)
            forall (f :: * -> *) a b. Applicative f => 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 DescribeTasks where
  hashWithSalt :: Int -> DescribeTasks -> Int
hashWithSalt Int
_salt DescribeTasks' {[Text]
Maybe [TaskField]
Maybe Text
tasks :: [Text]
include :: Maybe [TaskField]
cluster :: Maybe Text
$sel:tasks:DescribeTasks' :: DescribeTasks -> [Text]
$sel:include:DescribeTasks' :: DescribeTasks -> Maybe [TaskField]
$sel:cluster:DescribeTasks' :: DescribeTasks -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
cluster
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [TaskField]
include
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` [Text]
tasks

instance Prelude.NFData DescribeTasks where
  rnf :: DescribeTasks -> ()
rnf DescribeTasks' {[Text]
Maybe [TaskField]
Maybe Text
tasks :: [Text]
include :: Maybe [TaskField]
cluster :: Maybe Text
$sel:tasks:DescribeTasks' :: DescribeTasks -> [Text]
$sel:include:DescribeTasks' :: DescribeTasks -> Maybe [TaskField]
$sel:cluster:DescribeTasks' :: DescribeTasks -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
cluster
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [TaskField]
include
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf [Text]
tasks

instance Data.ToHeaders DescribeTasks where
  toHeaders :: DescribeTasks -> 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
"AmazonEC2ContainerServiceV20141113.DescribeTasks" ::
                          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 DescribeTasks where
  toJSON :: DescribeTasks -> Value
toJSON DescribeTasks' {[Text]
Maybe [TaskField]
Maybe Text
tasks :: [Text]
include :: Maybe [TaskField]
cluster :: Maybe Text
$sel:tasks:DescribeTasks' :: DescribeTasks -> [Text]
$sel:include:DescribeTasks' :: DescribeTasks -> Maybe [TaskField]
$sel:cluster:DescribeTasks' :: DescribeTasks -> Maybe Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"cluster" 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
cluster,
            (Key
"include" 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 [TaskField]
include,
            forall a. a -> Maybe a
Prelude.Just (Key
"tasks" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= [Text]
tasks)
          ]
      )

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

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

-- | /See:/ 'newDescribeTasksResponse' smart constructor.
data DescribeTasksResponse = DescribeTasksResponse'
  { -- | Any failures associated with the call.
    DescribeTasksResponse -> Maybe [Failure]
failures :: Prelude.Maybe [Failure],
    -- | The list of tasks.
    DescribeTasksResponse -> Maybe [Task]
tasks :: Prelude.Maybe [Task],
    -- | The response's http status code.
    DescribeTasksResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (DescribeTasksResponse -> DescribeTasksResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeTasksResponse -> DescribeTasksResponse -> Bool
$c/= :: DescribeTasksResponse -> DescribeTasksResponse -> Bool
== :: DescribeTasksResponse -> DescribeTasksResponse -> Bool
$c== :: DescribeTasksResponse -> DescribeTasksResponse -> Bool
Prelude.Eq, ReadPrec [DescribeTasksResponse]
ReadPrec DescribeTasksResponse
Int -> ReadS DescribeTasksResponse
ReadS [DescribeTasksResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeTasksResponse]
$creadListPrec :: ReadPrec [DescribeTasksResponse]
readPrec :: ReadPrec DescribeTasksResponse
$creadPrec :: ReadPrec DescribeTasksResponse
readList :: ReadS [DescribeTasksResponse]
$creadList :: ReadS [DescribeTasksResponse]
readsPrec :: Int -> ReadS DescribeTasksResponse
$creadsPrec :: Int -> ReadS DescribeTasksResponse
Prelude.Read, Int -> DescribeTasksResponse -> ShowS
[DescribeTasksResponse] -> ShowS
DescribeTasksResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeTasksResponse] -> ShowS
$cshowList :: [DescribeTasksResponse] -> ShowS
show :: DescribeTasksResponse -> String
$cshow :: DescribeTasksResponse -> String
showsPrec :: Int -> DescribeTasksResponse -> ShowS
$cshowsPrec :: Int -> DescribeTasksResponse -> ShowS
Prelude.Show, forall x. Rep DescribeTasksResponse x -> DescribeTasksResponse
forall x. DescribeTasksResponse -> Rep DescribeTasksResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DescribeTasksResponse x -> DescribeTasksResponse
$cfrom :: forall x. DescribeTasksResponse -> Rep DescribeTasksResponse x
Prelude.Generic)

-- |
-- Create a value of 'DescribeTasksResponse' 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:
--
-- 'failures', 'describeTasksResponse_failures' - Any failures associated with the call.
--
-- 'tasks', 'describeTasksResponse_tasks' - The list of tasks.
--
-- 'httpStatus', 'describeTasksResponse_httpStatus' - The response's http status code.
newDescribeTasksResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  DescribeTasksResponse
newDescribeTasksResponse :: Int -> DescribeTasksResponse
newDescribeTasksResponse Int
pHttpStatus_ =
  DescribeTasksResponse'
    { $sel:failures:DescribeTasksResponse' :: Maybe [Failure]
failures = forall a. Maybe a
Prelude.Nothing,
      $sel:tasks:DescribeTasksResponse' :: Maybe [Task]
tasks = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:DescribeTasksResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | Any failures associated with the call.
describeTasksResponse_failures :: Lens.Lens' DescribeTasksResponse (Prelude.Maybe [Failure])
describeTasksResponse_failures :: Lens' DescribeTasksResponse (Maybe [Failure])
describeTasksResponse_failures = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeTasksResponse' {Maybe [Failure]
failures :: Maybe [Failure]
$sel:failures:DescribeTasksResponse' :: DescribeTasksResponse -> Maybe [Failure]
failures} -> Maybe [Failure]
failures) (\s :: DescribeTasksResponse
s@DescribeTasksResponse' {} Maybe [Failure]
a -> DescribeTasksResponse
s {$sel:failures:DescribeTasksResponse' :: Maybe [Failure]
failures = Maybe [Failure]
a} :: DescribeTasksResponse) 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 s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The list of tasks.
describeTasksResponse_tasks :: Lens.Lens' DescribeTasksResponse (Prelude.Maybe [Task])
describeTasksResponse_tasks :: Lens' DescribeTasksResponse (Maybe [Task])
describeTasksResponse_tasks = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeTasksResponse' {Maybe [Task]
tasks :: Maybe [Task]
$sel:tasks:DescribeTasksResponse' :: DescribeTasksResponse -> Maybe [Task]
tasks} -> Maybe [Task]
tasks) (\s :: DescribeTasksResponse
s@DescribeTasksResponse' {} Maybe [Task]
a -> DescribeTasksResponse
s {$sel:tasks:DescribeTasksResponse' :: Maybe [Task]
tasks = Maybe [Task]
a} :: DescribeTasksResponse) 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 s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

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

instance Prelude.NFData DescribeTasksResponse where
  rnf :: DescribeTasksResponse -> ()
rnf DescribeTasksResponse' {Int
Maybe [Failure]
Maybe [Task]
httpStatus :: Int
tasks :: Maybe [Task]
failures :: Maybe [Failure]
$sel:httpStatus:DescribeTasksResponse' :: DescribeTasksResponse -> Int
$sel:tasks:DescribeTasksResponse' :: DescribeTasksResponse -> Maybe [Task]
$sel:failures:DescribeTasksResponse' :: DescribeTasksResponse -> Maybe [Failure]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [Failure]
failures
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [Task]
tasks
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus