{-# 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.DeleteService
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Deletes a specified service within a cluster. You can delete a service
-- if you have no running tasks in it and the desired task count is zero.
-- If the service is actively maintaining tasks, you can\'t delete it, and
-- you must update the service to a desired task count of zero. For more
-- information, see UpdateService.
--
-- When you delete a service, if there are still running tasks that require
-- cleanup, the service status moves from @ACTIVE@ to @DRAINING@, and the
-- service is no longer visible in the console or in the ListServices API
-- operation. After all tasks have transitioned to either @STOPPING@ or
-- @STOPPED@ status, the service status moves from @DRAINING@ to
-- @INACTIVE@. Services in the @DRAINING@ or @INACTIVE@ status can still be
-- viewed with the DescribeServices API operation. However, in the future,
-- @INACTIVE@ services may be cleaned up and purged from Amazon ECS record
-- keeping, and DescribeServices calls on those services return a
-- @ServiceNotFoundException@ error.
--
-- If you attempt to create a new service with the same name as an existing
-- service in either @ACTIVE@ or @DRAINING@ status, you receive an error.
module Amazonka.ECS.DeleteService
  ( -- * Creating a Request
    DeleteService (..),
    newDeleteService,

    -- * Request Lenses
    deleteService_cluster,
    deleteService_force,
    deleteService_service,

    -- * Destructuring the Response
    DeleteServiceResponse (..),
    newDeleteServiceResponse,

    -- * Response Lenses
    deleteServiceResponse_service,
    deleteServiceResponse_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:/ 'newDeleteService' smart constructor.
data DeleteService = DeleteService'
  { -- | The short name or full Amazon Resource Name (ARN) of the cluster that
    -- hosts the service to delete. If you do not specify a cluster, the
    -- default cluster is assumed.
    DeleteService -> Maybe Text
cluster :: Prelude.Maybe Prelude.Text,
    -- | If @true@, allows you to delete a service even if it wasn\'t scaled down
    -- to zero tasks. It\'s only necessary to use this if the service uses the
    -- @REPLICA@ scheduling strategy.
    DeleteService -> Maybe Bool
force :: Prelude.Maybe Prelude.Bool,
    -- | The name of the service to delete.
    DeleteService -> Text
service :: Prelude.Text
  }
  deriving (DeleteService -> DeleteService -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DeleteService -> DeleteService -> Bool
$c/= :: DeleteService -> DeleteService -> Bool
== :: DeleteService -> DeleteService -> Bool
$c== :: DeleteService -> DeleteService -> Bool
Prelude.Eq, ReadPrec [DeleteService]
ReadPrec DeleteService
Int -> ReadS DeleteService
ReadS [DeleteService]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DeleteService]
$creadListPrec :: ReadPrec [DeleteService]
readPrec :: ReadPrec DeleteService
$creadPrec :: ReadPrec DeleteService
readList :: ReadS [DeleteService]
$creadList :: ReadS [DeleteService]
readsPrec :: Int -> ReadS DeleteService
$creadsPrec :: Int -> ReadS DeleteService
Prelude.Read, Int -> DeleteService -> ShowS
[DeleteService] -> ShowS
DeleteService -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DeleteService] -> ShowS
$cshowList :: [DeleteService] -> ShowS
show :: DeleteService -> String
$cshow :: DeleteService -> String
showsPrec :: Int -> DeleteService -> ShowS
$cshowsPrec :: Int -> DeleteService -> ShowS
Prelude.Show, forall x. Rep DeleteService x -> DeleteService
forall x. DeleteService -> Rep DeleteService x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DeleteService x -> DeleteService
$cfrom :: forall x. DeleteService -> Rep DeleteService x
Prelude.Generic)

-- |
-- Create a value of 'DeleteService' 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', 'deleteService_cluster' - The short name or full Amazon Resource Name (ARN) of the cluster that
-- hosts the service to delete. If you do not specify a cluster, the
-- default cluster is assumed.
--
-- 'force', 'deleteService_force' - If @true@, allows you to delete a service even if it wasn\'t scaled down
-- to zero tasks. It\'s only necessary to use this if the service uses the
-- @REPLICA@ scheduling strategy.
--
-- 'service', 'deleteService_service' - The name of the service to delete.
newDeleteService ::
  -- | 'service'
  Prelude.Text ->
  DeleteService
newDeleteService :: Text -> DeleteService
newDeleteService Text
pService_ =
  DeleteService'
    { $sel:cluster:DeleteService' :: Maybe Text
cluster = forall a. Maybe a
Prelude.Nothing,
      $sel:force:DeleteService' :: Maybe Bool
force = forall a. Maybe a
Prelude.Nothing,
      $sel:service:DeleteService' :: Text
service = Text
pService_
    }

-- | The short name or full Amazon Resource Name (ARN) of the cluster that
-- hosts the service to delete. If you do not specify a cluster, the
-- default cluster is assumed.
deleteService_cluster :: Lens.Lens' DeleteService (Prelude.Maybe Prelude.Text)
deleteService_cluster :: Lens' DeleteService (Maybe Text)
deleteService_cluster = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DeleteService' {Maybe Text
cluster :: Maybe Text
$sel:cluster:DeleteService' :: DeleteService -> Maybe Text
cluster} -> Maybe Text
cluster) (\s :: DeleteService
s@DeleteService' {} Maybe Text
a -> DeleteService
s {$sel:cluster:DeleteService' :: Maybe Text
cluster = Maybe Text
a} :: DeleteService)

-- | If @true@, allows you to delete a service even if it wasn\'t scaled down
-- to zero tasks. It\'s only necessary to use this if the service uses the
-- @REPLICA@ scheduling strategy.
deleteService_force :: Lens.Lens' DeleteService (Prelude.Maybe Prelude.Bool)
deleteService_force :: Lens' DeleteService (Maybe Bool)
deleteService_force = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DeleteService' {Maybe Bool
force :: Maybe Bool
$sel:force:DeleteService' :: DeleteService -> Maybe Bool
force} -> Maybe Bool
force) (\s :: DeleteService
s@DeleteService' {} Maybe Bool
a -> DeleteService
s {$sel:force:DeleteService' :: Maybe Bool
force = Maybe Bool
a} :: DeleteService)

-- | The name of the service to delete.
deleteService_service :: Lens.Lens' DeleteService Prelude.Text
deleteService_service :: Lens' DeleteService Text
deleteService_service = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DeleteService' {Text
service :: Text
$sel:service:DeleteService' :: DeleteService -> Text
service} -> Text
service) (\s :: DeleteService
s@DeleteService' {} Text
a -> DeleteService
s {$sel:service:DeleteService' :: Text
service = Text
a} :: DeleteService)

instance Core.AWSRequest DeleteService where
  type
    AWSResponse DeleteService =
      DeleteServiceResponse
  request :: (Service -> Service) -> DeleteService -> Request DeleteService
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 DeleteService
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse DeleteService)))
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 ContainerService -> Int -> DeleteServiceResponse
DeleteServiceResponse'
            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
"service")
            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 DeleteService where
  hashWithSalt :: Int -> DeleteService -> Int
hashWithSalt Int
_salt DeleteService' {Maybe Bool
Maybe Text
Text
service :: Text
force :: Maybe Bool
cluster :: Maybe Text
$sel:service:DeleteService' :: DeleteService -> Text
$sel:force:DeleteService' :: DeleteService -> Maybe Bool
$sel:cluster:DeleteService' :: DeleteService -> 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 Bool
force
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
service

instance Prelude.NFData DeleteService where
  rnf :: DeleteService -> ()
rnf DeleteService' {Maybe Bool
Maybe Text
Text
service :: Text
force :: Maybe Bool
cluster :: Maybe Text
$sel:service:DeleteService' :: DeleteService -> Text
$sel:force:DeleteService' :: DeleteService -> Maybe Bool
$sel:cluster:DeleteService' :: DeleteService -> 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 Bool
force
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
service

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

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

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

-- | /See:/ 'newDeleteServiceResponse' smart constructor.
data DeleteServiceResponse = DeleteServiceResponse'
  { -- | The full description of the deleted service.
    DeleteServiceResponse -> Maybe ContainerService
service :: Prelude.Maybe ContainerService,
    -- | The response's http status code.
    DeleteServiceResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (DeleteServiceResponse -> DeleteServiceResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DeleteServiceResponse -> DeleteServiceResponse -> Bool
$c/= :: DeleteServiceResponse -> DeleteServiceResponse -> Bool
== :: DeleteServiceResponse -> DeleteServiceResponse -> Bool
$c== :: DeleteServiceResponse -> DeleteServiceResponse -> Bool
Prelude.Eq, ReadPrec [DeleteServiceResponse]
ReadPrec DeleteServiceResponse
Int -> ReadS DeleteServiceResponse
ReadS [DeleteServiceResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DeleteServiceResponse]
$creadListPrec :: ReadPrec [DeleteServiceResponse]
readPrec :: ReadPrec DeleteServiceResponse
$creadPrec :: ReadPrec DeleteServiceResponse
readList :: ReadS [DeleteServiceResponse]
$creadList :: ReadS [DeleteServiceResponse]
readsPrec :: Int -> ReadS DeleteServiceResponse
$creadsPrec :: Int -> ReadS DeleteServiceResponse
Prelude.Read, Int -> DeleteServiceResponse -> ShowS
[DeleteServiceResponse] -> ShowS
DeleteServiceResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DeleteServiceResponse] -> ShowS
$cshowList :: [DeleteServiceResponse] -> ShowS
show :: DeleteServiceResponse -> String
$cshow :: DeleteServiceResponse -> String
showsPrec :: Int -> DeleteServiceResponse -> ShowS
$cshowsPrec :: Int -> DeleteServiceResponse -> ShowS
Prelude.Show, forall x. Rep DeleteServiceResponse x -> DeleteServiceResponse
forall x. DeleteServiceResponse -> Rep DeleteServiceResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DeleteServiceResponse x -> DeleteServiceResponse
$cfrom :: forall x. DeleteServiceResponse -> Rep DeleteServiceResponse x
Prelude.Generic)

-- |
-- Create a value of 'DeleteServiceResponse' 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:
--
-- 'service', 'deleteServiceResponse_service' - The full description of the deleted service.
--
-- 'httpStatus', 'deleteServiceResponse_httpStatus' - The response's http status code.
newDeleteServiceResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  DeleteServiceResponse
newDeleteServiceResponse :: Int -> DeleteServiceResponse
newDeleteServiceResponse Int
pHttpStatus_ =
  DeleteServiceResponse'
    { $sel:service:DeleteServiceResponse' :: Maybe ContainerService
service = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:DeleteServiceResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | The full description of the deleted service.
deleteServiceResponse_service :: Lens.Lens' DeleteServiceResponse (Prelude.Maybe ContainerService)
deleteServiceResponse_service :: Lens' DeleteServiceResponse (Maybe ContainerService)
deleteServiceResponse_service = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DeleteServiceResponse' {Maybe ContainerService
service :: Maybe ContainerService
$sel:service:DeleteServiceResponse' :: DeleteServiceResponse -> Maybe ContainerService
service} -> Maybe ContainerService
service) (\s :: DeleteServiceResponse
s@DeleteServiceResponse' {} Maybe ContainerService
a -> DeleteServiceResponse
s {$sel:service:DeleteServiceResponse' :: Maybe ContainerService
service = Maybe ContainerService
a} :: DeleteServiceResponse)

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

instance Prelude.NFData DeleteServiceResponse where
  rnf :: DeleteServiceResponse -> ()
rnf DeleteServiceResponse' {Int
Maybe ContainerService
httpStatus :: Int
service :: Maybe ContainerService
$sel:httpStatus:DeleteServiceResponse' :: DeleteServiceResponse -> Int
$sel:service:DeleteServiceResponse' :: DeleteServiceResponse -> Maybe ContainerService
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe ContainerService
service
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus