{-# 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.DescribeServices
-- 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 the specified services running in your cluster.
module Amazonka.ECS.DescribeServices
  ( -- * Creating a Request
    DescribeServices (..),
    newDescribeServices,

    -- * Request Lenses
    describeServices_cluster,
    describeServices_include,
    describeServices_services,

    -- * Destructuring the Response
    DescribeServicesResponse (..),
    newDescribeServicesResponse,

    -- * Response Lenses
    describeServicesResponse_failures,
    describeServicesResponse_services,
    describeServicesResponse_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:/ 'newDescribeServices' smart constructor.
data DescribeServices = DescribeServices'
  { -- | The short name or full Amazon Resource Name (ARN)the cluster that hosts
    -- the service to describe. If you do not specify a cluster, the default
    -- cluster is assumed. This parameter is required if the service or
    -- services you are describing were launched in any cluster other than the
    -- default cluster.
    DescribeServices -> Maybe Text
cluster :: Prelude.Maybe Prelude.Text,
    -- | Determines whether you want to see the resource tags for the service. If
    -- @TAGS@ is specified, the tags are included in the response. If this
    -- field is omitted, tags aren\'t included in the response.
    DescribeServices -> Maybe [ServiceField]
include :: Prelude.Maybe [ServiceField],
    -- | A list of services to describe. You may specify up to 10 services to
    -- describe in a single operation.
    DescribeServices -> [Text]
services :: [Prelude.Text]
  }
  deriving (DescribeServices -> DescribeServices -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeServices -> DescribeServices -> Bool
$c/= :: DescribeServices -> DescribeServices -> Bool
== :: DescribeServices -> DescribeServices -> Bool
$c== :: DescribeServices -> DescribeServices -> Bool
Prelude.Eq, ReadPrec [DescribeServices]
ReadPrec DescribeServices
Int -> ReadS DescribeServices
ReadS [DescribeServices]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeServices]
$creadListPrec :: ReadPrec [DescribeServices]
readPrec :: ReadPrec DescribeServices
$creadPrec :: ReadPrec DescribeServices
readList :: ReadS [DescribeServices]
$creadList :: ReadS [DescribeServices]
readsPrec :: Int -> ReadS DescribeServices
$creadsPrec :: Int -> ReadS DescribeServices
Prelude.Read, Int -> DescribeServices -> ShowS
[DescribeServices] -> ShowS
DescribeServices -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeServices] -> ShowS
$cshowList :: [DescribeServices] -> ShowS
show :: DescribeServices -> String
$cshow :: DescribeServices -> String
showsPrec :: Int -> DescribeServices -> ShowS
$cshowsPrec :: Int -> DescribeServices -> ShowS
Prelude.Show, forall x. Rep DescribeServices x -> DescribeServices
forall x. DescribeServices -> Rep DescribeServices x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DescribeServices x -> DescribeServices
$cfrom :: forall x. DescribeServices -> Rep DescribeServices x
Prelude.Generic)

-- |
-- Create a value of 'DescribeServices' 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', 'describeServices_cluster' - The short name or full Amazon Resource Name (ARN)the cluster that hosts
-- the service to describe. If you do not specify a cluster, the default
-- cluster is assumed. This parameter is required if the service or
-- services you are describing were launched in any cluster other than the
-- default cluster.
--
-- 'include', 'describeServices_include' - Determines whether you want to see the resource tags for the service. If
-- @TAGS@ is specified, the tags are included in the response. If this
-- field is omitted, tags aren\'t included in the response.
--
-- 'services', 'describeServices_services' - A list of services to describe. You may specify up to 10 services to
-- describe in a single operation.
newDescribeServices ::
  DescribeServices
newDescribeServices :: DescribeServices
newDescribeServices =
  DescribeServices'
    { $sel:cluster:DescribeServices' :: Maybe Text
cluster = forall a. Maybe a
Prelude.Nothing,
      $sel:include:DescribeServices' :: Maybe [ServiceField]
include = forall a. Maybe a
Prelude.Nothing,
      $sel:services:DescribeServices' :: [Text]
services = forall a. Monoid a => a
Prelude.mempty
    }

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

-- | Determines whether you want to see the resource tags for the service. If
-- @TAGS@ is specified, the tags are included in the response. If this
-- field is omitted, tags aren\'t included in the response.
describeServices_include :: Lens.Lens' DescribeServices (Prelude.Maybe [ServiceField])
describeServices_include :: Lens' DescribeServices (Maybe [ServiceField])
describeServices_include = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeServices' {Maybe [ServiceField]
include :: Maybe [ServiceField]
$sel:include:DescribeServices' :: DescribeServices -> Maybe [ServiceField]
include} -> Maybe [ServiceField]
include) (\s :: DescribeServices
s@DescribeServices' {} Maybe [ServiceField]
a -> DescribeServices
s {$sel:include:DescribeServices' :: Maybe [ServiceField]
include = Maybe [ServiceField]
a} :: DescribeServices) 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 services to describe. You may specify up to 10 services to
-- describe in a single operation.
describeServices_services :: Lens.Lens' DescribeServices [Prelude.Text]
describeServices_services :: Lens' DescribeServices [Text]
describeServices_services = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeServices' {[Text]
services :: [Text]
$sel:services:DescribeServices' :: DescribeServices -> [Text]
services} -> [Text]
services) (\s :: DescribeServices
s@DescribeServices' {} [Text]
a -> DescribeServices
s {$sel:services:DescribeServices' :: [Text]
services = [Text]
a} :: DescribeServices) 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 DescribeServices where
  type
    AWSResponse DescribeServices =
      DescribeServicesResponse
  request :: (Service -> Service)
-> DescribeServices -> Request DescribeServices
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 DescribeServices
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse DescribeServices)))
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 [ContainerService] -> Int -> DescribeServicesResponse
DescribeServicesResponse'
            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
"services" 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 DescribeServices where
  hashWithSalt :: Int -> DescribeServices -> Int
hashWithSalt Int
_salt DescribeServices' {[Text]
Maybe [ServiceField]
Maybe Text
services :: [Text]
include :: Maybe [ServiceField]
cluster :: Maybe Text
$sel:services:DescribeServices' :: DescribeServices -> [Text]
$sel:include:DescribeServices' :: DescribeServices -> Maybe [ServiceField]
$sel:cluster:DescribeServices' :: DescribeServices -> 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 [ServiceField]
include
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` [Text]
services

instance Prelude.NFData DescribeServices where
  rnf :: DescribeServices -> ()
rnf DescribeServices' {[Text]
Maybe [ServiceField]
Maybe Text
services :: [Text]
include :: Maybe [ServiceField]
cluster :: Maybe Text
$sel:services:DescribeServices' :: DescribeServices -> [Text]
$sel:include:DescribeServices' :: DescribeServices -> Maybe [ServiceField]
$sel:cluster:DescribeServices' :: DescribeServices -> 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 [ServiceField]
include
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf [Text]
services

instance Data.ToHeaders DescribeServices where
  toHeaders :: DescribeServices -> 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.DescribeServices" ::
                          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 DescribeServices where
  toJSON :: DescribeServices -> Value
toJSON DescribeServices' {[Text]
Maybe [ServiceField]
Maybe Text
services :: [Text]
include :: Maybe [ServiceField]
cluster :: Maybe Text
$sel:services:DescribeServices' :: DescribeServices -> [Text]
$sel:include:DescribeServices' :: DescribeServices -> Maybe [ServiceField]
$sel:cluster:DescribeServices' :: DescribeServices -> 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 [ServiceField]
include,
            forall a. a -> Maybe a
Prelude.Just (Key
"services" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= [Text]
services)
          ]
      )

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

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

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

-- |
-- Create a value of 'DescribeServicesResponse' 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', 'describeServicesResponse_failures' - Any failures associated with the call.
--
-- 'services', 'describeServicesResponse_services' - The list of services described.
--
-- 'httpStatus', 'describeServicesResponse_httpStatus' - The response's http status code.
newDescribeServicesResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  DescribeServicesResponse
newDescribeServicesResponse :: Int -> DescribeServicesResponse
newDescribeServicesResponse Int
pHttpStatus_ =
  DescribeServicesResponse'
    { $sel:failures:DescribeServicesResponse' :: Maybe [Failure]
failures =
        forall a. Maybe a
Prelude.Nothing,
      $sel:services:DescribeServicesResponse' :: Maybe [ContainerService]
services = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:DescribeServicesResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | Any failures associated with the call.
describeServicesResponse_failures :: Lens.Lens' DescribeServicesResponse (Prelude.Maybe [Failure])
describeServicesResponse_failures :: Lens' DescribeServicesResponse (Maybe [Failure])
describeServicesResponse_failures = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeServicesResponse' {Maybe [Failure]
failures :: Maybe [Failure]
$sel:failures:DescribeServicesResponse' :: DescribeServicesResponse -> Maybe [Failure]
failures} -> Maybe [Failure]
failures) (\s :: DescribeServicesResponse
s@DescribeServicesResponse' {} Maybe [Failure]
a -> DescribeServicesResponse
s {$sel:failures:DescribeServicesResponse' :: Maybe [Failure]
failures = Maybe [Failure]
a} :: DescribeServicesResponse) 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 services described.
describeServicesResponse_services :: Lens.Lens' DescribeServicesResponse (Prelude.Maybe [ContainerService])
describeServicesResponse_services :: Lens' DescribeServicesResponse (Maybe [ContainerService])
describeServicesResponse_services = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeServicesResponse' {Maybe [ContainerService]
services :: Maybe [ContainerService]
$sel:services:DescribeServicesResponse' :: DescribeServicesResponse -> Maybe [ContainerService]
services} -> Maybe [ContainerService]
services) (\s :: DescribeServicesResponse
s@DescribeServicesResponse' {} Maybe [ContainerService]
a -> DescribeServicesResponse
s {$sel:services:DescribeServicesResponse' :: Maybe [ContainerService]
services = Maybe [ContainerService]
a} :: DescribeServicesResponse) 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.
describeServicesResponse_httpStatus :: Lens.Lens' DescribeServicesResponse Prelude.Int
describeServicesResponse_httpStatus :: Lens' DescribeServicesResponse Int
describeServicesResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeServicesResponse' {Int
httpStatus :: Int
$sel:httpStatus:DescribeServicesResponse' :: DescribeServicesResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: DescribeServicesResponse
s@DescribeServicesResponse' {} Int
a -> DescribeServicesResponse
s {$sel:httpStatus:DescribeServicesResponse' :: Int
httpStatus = Int
a} :: DescribeServicesResponse)

instance Prelude.NFData DescribeServicesResponse where
  rnf :: DescribeServicesResponse -> ()
rnf DescribeServicesResponse' {Int
Maybe [Failure]
Maybe [ContainerService]
httpStatus :: Int
services :: Maybe [ContainerService]
failures :: Maybe [Failure]
$sel:httpStatus:DescribeServicesResponse' :: DescribeServicesResponse -> Int
$sel:services:DescribeServicesResponse' :: DescribeServicesResponse -> Maybe [ContainerService]
$sel:failures:DescribeServicesResponse' :: DescribeServicesResponse -> 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 [ContainerService]
services
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus