{-# 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.DataPipeline.DeactivatePipeline
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Deactivates the specified running pipeline. The pipeline is set to the
-- @DEACTIVATING@ state until the deactivation process completes.
--
-- To resume a deactivated pipeline, use ActivatePipeline. By default, the
-- pipeline resumes from the last completed execution. Optionally, you can
-- specify the date and time to resume the pipeline.
module Amazonka.DataPipeline.DeactivatePipeline
  ( -- * Creating a Request
    DeactivatePipeline (..),
    newDeactivatePipeline,

    -- * Request Lenses
    deactivatePipeline_cancelActive,
    deactivatePipeline_pipelineId,

    -- * Destructuring the Response
    DeactivatePipelineResponse (..),
    newDeactivatePipelineResponse,

    -- * Response Lenses
    deactivatePipelineResponse_httpStatus,
  )
where

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

-- | Contains the parameters for DeactivatePipeline.
--
-- /See:/ 'newDeactivatePipeline' smart constructor.
data DeactivatePipeline = DeactivatePipeline'
  { -- | Indicates whether to cancel any running objects. The default is true,
    -- which sets the state of any running objects to @CANCELED@. If this value
    -- is false, the pipeline is deactivated after all running objects finish.
    DeactivatePipeline -> Maybe Bool
cancelActive :: Prelude.Maybe Prelude.Bool,
    -- | The ID of the pipeline.
    DeactivatePipeline -> Text
pipelineId :: Prelude.Text
  }
  deriving (DeactivatePipeline -> DeactivatePipeline -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DeactivatePipeline -> DeactivatePipeline -> Bool
$c/= :: DeactivatePipeline -> DeactivatePipeline -> Bool
== :: DeactivatePipeline -> DeactivatePipeline -> Bool
$c== :: DeactivatePipeline -> DeactivatePipeline -> Bool
Prelude.Eq, ReadPrec [DeactivatePipeline]
ReadPrec DeactivatePipeline
Int -> ReadS DeactivatePipeline
ReadS [DeactivatePipeline]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DeactivatePipeline]
$creadListPrec :: ReadPrec [DeactivatePipeline]
readPrec :: ReadPrec DeactivatePipeline
$creadPrec :: ReadPrec DeactivatePipeline
readList :: ReadS [DeactivatePipeline]
$creadList :: ReadS [DeactivatePipeline]
readsPrec :: Int -> ReadS DeactivatePipeline
$creadsPrec :: Int -> ReadS DeactivatePipeline
Prelude.Read, Int -> DeactivatePipeline -> ShowS
[DeactivatePipeline] -> ShowS
DeactivatePipeline -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DeactivatePipeline] -> ShowS
$cshowList :: [DeactivatePipeline] -> ShowS
show :: DeactivatePipeline -> String
$cshow :: DeactivatePipeline -> String
showsPrec :: Int -> DeactivatePipeline -> ShowS
$cshowsPrec :: Int -> DeactivatePipeline -> ShowS
Prelude.Show, forall x. Rep DeactivatePipeline x -> DeactivatePipeline
forall x. DeactivatePipeline -> Rep DeactivatePipeline x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DeactivatePipeline x -> DeactivatePipeline
$cfrom :: forall x. DeactivatePipeline -> Rep DeactivatePipeline x
Prelude.Generic)

-- |
-- Create a value of 'DeactivatePipeline' 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:
--
-- 'cancelActive', 'deactivatePipeline_cancelActive' - Indicates whether to cancel any running objects. The default is true,
-- which sets the state of any running objects to @CANCELED@. If this value
-- is false, the pipeline is deactivated after all running objects finish.
--
-- 'pipelineId', 'deactivatePipeline_pipelineId' - The ID of the pipeline.
newDeactivatePipeline ::
  -- | 'pipelineId'
  Prelude.Text ->
  DeactivatePipeline
newDeactivatePipeline :: Text -> DeactivatePipeline
newDeactivatePipeline Text
pPipelineId_ =
  DeactivatePipeline'
    { $sel:cancelActive:DeactivatePipeline' :: Maybe Bool
cancelActive = forall a. Maybe a
Prelude.Nothing,
      $sel:pipelineId:DeactivatePipeline' :: Text
pipelineId = Text
pPipelineId_
    }

-- | Indicates whether to cancel any running objects. The default is true,
-- which sets the state of any running objects to @CANCELED@. If this value
-- is false, the pipeline is deactivated after all running objects finish.
deactivatePipeline_cancelActive :: Lens.Lens' DeactivatePipeline (Prelude.Maybe Prelude.Bool)
deactivatePipeline_cancelActive :: Lens' DeactivatePipeline (Maybe Bool)
deactivatePipeline_cancelActive = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DeactivatePipeline' {Maybe Bool
cancelActive :: Maybe Bool
$sel:cancelActive:DeactivatePipeline' :: DeactivatePipeline -> Maybe Bool
cancelActive} -> Maybe Bool
cancelActive) (\s :: DeactivatePipeline
s@DeactivatePipeline' {} Maybe Bool
a -> DeactivatePipeline
s {$sel:cancelActive:DeactivatePipeline' :: Maybe Bool
cancelActive = Maybe Bool
a} :: DeactivatePipeline)

-- | The ID of the pipeline.
deactivatePipeline_pipelineId :: Lens.Lens' DeactivatePipeline Prelude.Text
deactivatePipeline_pipelineId :: Lens' DeactivatePipeline Text
deactivatePipeline_pipelineId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DeactivatePipeline' {Text
pipelineId :: Text
$sel:pipelineId:DeactivatePipeline' :: DeactivatePipeline -> Text
pipelineId} -> Text
pipelineId) (\s :: DeactivatePipeline
s@DeactivatePipeline' {} Text
a -> DeactivatePipeline
s {$sel:pipelineId:DeactivatePipeline' :: Text
pipelineId = Text
a} :: DeactivatePipeline)

instance Core.AWSRequest DeactivatePipeline where
  type
    AWSResponse DeactivatePipeline =
      DeactivatePipelineResponse
  request :: (Service -> Service)
-> DeactivatePipeline -> Request DeactivatePipeline
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 DeactivatePipeline
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse DeactivatePipeline)))
response =
    forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> () -> Either String (AWSResponse a))
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveEmpty
      ( \Int
s ResponseHeaders
h ()
x ->
          Int -> DeactivatePipelineResponse
DeactivatePipelineResponse'
            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))
      )

instance Prelude.Hashable DeactivatePipeline where
  hashWithSalt :: Int -> DeactivatePipeline -> Int
hashWithSalt Int
_salt DeactivatePipeline' {Maybe Bool
Text
pipelineId :: Text
cancelActive :: Maybe Bool
$sel:pipelineId:DeactivatePipeline' :: DeactivatePipeline -> Text
$sel:cancelActive:DeactivatePipeline' :: DeactivatePipeline -> Maybe Bool
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
cancelActive
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
pipelineId

instance Prelude.NFData DeactivatePipeline where
  rnf :: DeactivatePipeline -> ()
rnf DeactivatePipeline' {Maybe Bool
Text
pipelineId :: Text
cancelActive :: Maybe Bool
$sel:pipelineId:DeactivatePipeline' :: DeactivatePipeline -> Text
$sel:cancelActive:DeactivatePipeline' :: DeactivatePipeline -> Maybe Bool
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Bool
cancelActive
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
pipelineId

instance Data.ToHeaders DeactivatePipeline where
  toHeaders :: DeactivatePipeline -> 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
"DataPipeline.DeactivatePipeline" ::
                          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 DeactivatePipeline where
  toJSON :: DeactivatePipeline -> Value
toJSON DeactivatePipeline' {Maybe Bool
Text
pipelineId :: Text
cancelActive :: Maybe Bool
$sel:pipelineId:DeactivatePipeline' :: DeactivatePipeline -> Text
$sel:cancelActive:DeactivatePipeline' :: DeactivatePipeline -> Maybe Bool
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"cancelActive" 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
cancelActive,
            forall a. a -> Maybe a
Prelude.Just (Key
"pipelineId" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
pipelineId)
          ]
      )

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

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

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

-- |
-- Create a value of 'DeactivatePipelineResponse' 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', 'deactivatePipelineResponse_httpStatus' - The response's http status code.
newDeactivatePipelineResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  DeactivatePipelineResponse
newDeactivatePipelineResponse :: Int -> DeactivatePipelineResponse
newDeactivatePipelineResponse Int
pHttpStatus_ =
  DeactivatePipelineResponse'
    { $sel:httpStatus:DeactivatePipelineResponse' :: Int
httpStatus =
        Int
pHttpStatus_
    }

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

instance Prelude.NFData DeactivatePipelineResponse where
  rnf :: DeactivatePipelineResponse -> ()
rnf DeactivatePipelineResponse' {Int
httpStatus :: Int
$sel:httpStatus:DeactivatePipelineResponse' :: DeactivatePipelineResponse -> Int
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus