{-# 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.ImportExport.CancelJob
-- Copyright   : (c) 2013-2021 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay <brendan.g.hay+amazonka@gmail.com>
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- This operation cancels a specified job. Only the job owner can cancel
-- it. The operation fails if the job has already started or is complete.
module Amazonka.ImportExport.CancelJob
  ( -- * Creating a Request
    CancelJob (..),
    newCancelJob,

    -- * Request Lenses
    cancelJob_aPIVersion,
    cancelJob_jobId,

    -- * Destructuring the Response
    CancelJobResponse (..),
    newCancelJobResponse,

    -- * Response Lenses
    cancelJobResponse_success,
    cancelJobResponse_httpStatus,
  )
where

import qualified Amazonka.Core as Core
import Amazonka.ImportExport.Types
import qualified Amazonka.Lens as Lens
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response

-- | Input structure for the CancelJob operation.
--
-- /See:/ 'newCancelJob' smart constructor.
data CancelJob = CancelJob'
  { CancelJob -> Maybe Text
aPIVersion :: Prelude.Maybe Prelude.Text,
    CancelJob -> Text
jobId :: Prelude.Text
  }
  deriving (CancelJob -> CancelJob -> Bool
(CancelJob -> CancelJob -> Bool)
-> (CancelJob -> CancelJob -> Bool) -> Eq CancelJob
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: CancelJob -> CancelJob -> Bool
$c/= :: CancelJob -> CancelJob -> Bool
== :: CancelJob -> CancelJob -> Bool
$c== :: CancelJob -> CancelJob -> Bool
Prelude.Eq, ReadPrec [CancelJob]
ReadPrec CancelJob
Int -> ReadS CancelJob
ReadS [CancelJob]
(Int -> ReadS CancelJob)
-> ReadS [CancelJob]
-> ReadPrec CancelJob
-> ReadPrec [CancelJob]
-> Read CancelJob
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [CancelJob]
$creadListPrec :: ReadPrec [CancelJob]
readPrec :: ReadPrec CancelJob
$creadPrec :: ReadPrec CancelJob
readList :: ReadS [CancelJob]
$creadList :: ReadS [CancelJob]
readsPrec :: Int -> ReadS CancelJob
$creadsPrec :: Int -> ReadS CancelJob
Prelude.Read, Int -> CancelJob -> ShowS
[CancelJob] -> ShowS
CancelJob -> String
(Int -> CancelJob -> ShowS)
-> (CancelJob -> String)
-> ([CancelJob] -> ShowS)
-> Show CancelJob
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [CancelJob] -> ShowS
$cshowList :: [CancelJob] -> ShowS
show :: CancelJob -> String
$cshow :: CancelJob -> String
showsPrec :: Int -> CancelJob -> ShowS
$cshowsPrec :: Int -> CancelJob -> ShowS
Prelude.Show, (forall x. CancelJob -> Rep CancelJob x)
-> (forall x. Rep CancelJob x -> CancelJob) -> Generic CancelJob
forall x. Rep CancelJob x -> CancelJob
forall x. CancelJob -> Rep CancelJob x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep CancelJob x -> CancelJob
$cfrom :: forall x. CancelJob -> Rep CancelJob x
Prelude.Generic)

-- |
-- Create a value of 'CancelJob' 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:
--
-- 'aPIVersion', 'cancelJob_aPIVersion' - Undocumented member.
--
-- 'jobId', 'cancelJob_jobId' - Undocumented member.
newCancelJob ::
  -- | 'jobId'
  Prelude.Text ->
  CancelJob
newCancelJob :: Text -> CancelJob
newCancelJob Text
pJobId_ =
  CancelJob' :: Maybe Text -> Text -> CancelJob
CancelJob'
    { $sel:aPIVersion:CancelJob' :: Maybe Text
aPIVersion = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:jobId:CancelJob' :: Text
jobId = Text
pJobId_
    }

-- | Undocumented member.
cancelJob_aPIVersion :: Lens.Lens' CancelJob (Prelude.Maybe Prelude.Text)
cancelJob_aPIVersion :: (Maybe Text -> f (Maybe Text)) -> CancelJob -> f CancelJob
cancelJob_aPIVersion = (CancelJob -> Maybe Text)
-> (CancelJob -> Maybe Text -> CancelJob)
-> Lens CancelJob CancelJob (Maybe Text) (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CancelJob' {Maybe Text
aPIVersion :: Maybe Text
$sel:aPIVersion:CancelJob' :: CancelJob -> Maybe Text
aPIVersion} -> Maybe Text
aPIVersion) (\s :: CancelJob
s@CancelJob' {} Maybe Text
a -> CancelJob
s {$sel:aPIVersion:CancelJob' :: Maybe Text
aPIVersion = Maybe Text
a} :: CancelJob)

-- | Undocumented member.
cancelJob_jobId :: Lens.Lens' CancelJob Prelude.Text
cancelJob_jobId :: (Text -> f Text) -> CancelJob -> f CancelJob
cancelJob_jobId = (CancelJob -> Text)
-> (CancelJob -> Text -> CancelJob)
-> Lens CancelJob CancelJob Text Text
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CancelJob' {Text
jobId :: Text
$sel:jobId:CancelJob' :: CancelJob -> Text
jobId} -> Text
jobId) (\s :: CancelJob
s@CancelJob' {} Text
a -> CancelJob
s {$sel:jobId:CancelJob' :: Text
jobId = Text
a} :: CancelJob)

instance Core.AWSRequest CancelJob where
  type AWSResponse CancelJob = CancelJobResponse
  request :: CancelJob -> Request CancelJob
request = Service -> CancelJob -> Request CancelJob
forall a. ToRequest a => Service -> a -> Request a
Request.postQuery Service
defaultService
  response :: Logger
-> Service
-> Proxy CancelJob
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse CancelJob)))
response =
    Text
-> (Int
    -> ResponseHeaders
    -> [Node]
    -> Either String (AWSResponse CancelJob))
-> Logger
-> Service
-> Proxy CancelJob
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse CancelJob)))
forall (m :: * -> *) a.
MonadResource m =>
Text
-> (Int
    -> ResponseHeaders -> [Node] -> Either String (AWSResponse a))
-> Logger
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveXMLWrapper
      Text
"CancelJobResult"
      ( \Int
s ResponseHeaders
h [Node]
x ->
          Maybe Bool -> Int -> CancelJobResponse
CancelJobResponse'
            (Maybe Bool -> Int -> CancelJobResponse)
-> Either String (Maybe Bool)
-> Either String (Int -> CancelJobResponse)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> ([Node]
x [Node] -> Text -> Either String (Maybe Bool)
forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Core..@? Text
"Success")
            Either String (Int -> CancelJobResponse)
-> Either String Int -> Either String CancelJobResponse
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Int -> Either String Int
forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (Int -> Int
forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
      )

instance Prelude.Hashable CancelJob

instance Prelude.NFData CancelJob

instance Core.ToHeaders CancelJob where
  toHeaders :: CancelJob -> ResponseHeaders
toHeaders = ResponseHeaders -> CancelJob -> ResponseHeaders
forall a b. a -> b -> a
Prelude.const ResponseHeaders
forall a. Monoid a => a
Prelude.mempty

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

instance Core.ToQuery CancelJob where
  toQuery :: CancelJob -> QueryString
toQuery CancelJob' {Maybe Text
Text
jobId :: Text
aPIVersion :: Maybe Text
$sel:jobId:CancelJob' :: CancelJob -> Text
$sel:aPIVersion:CancelJob' :: CancelJob -> Maybe Text
..} =
    [QueryString] -> QueryString
forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ QueryString
"Operation=CancelJob",
        ByteString
"Action" ByteString -> ByteString -> QueryString
forall a. ToQuery a => ByteString -> a -> QueryString
Core.=: (ByteString
"CancelJob" :: Prelude.ByteString),
        ByteString
"Version"
          ByteString -> ByteString -> QueryString
forall a. ToQuery a => ByteString -> a -> QueryString
Core.=: (ByteString
"2010-06-01" :: Prelude.ByteString),
        ByteString
"APIVersion" ByteString -> Maybe Text -> QueryString
forall a. ToQuery a => ByteString -> a -> QueryString
Core.=: Maybe Text
aPIVersion,
        ByteString
"JobId" ByteString -> Text -> QueryString
forall a. ToQuery a => ByteString -> a -> QueryString
Core.=: Text
jobId
      ]

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

-- |
-- Create a value of 'CancelJobResponse' 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:
--
-- 'success', 'cancelJobResponse_success' - Undocumented member.
--
-- 'httpStatus', 'cancelJobResponse_httpStatus' - The response's http status code.
newCancelJobResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  CancelJobResponse
newCancelJobResponse :: Int -> CancelJobResponse
newCancelJobResponse Int
pHttpStatus_ =
  CancelJobResponse' :: Maybe Bool -> Int -> CancelJobResponse
CancelJobResponse'
    { $sel:success:CancelJobResponse' :: Maybe Bool
success = Maybe Bool
forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:CancelJobResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | Undocumented member.
cancelJobResponse_success :: Lens.Lens' CancelJobResponse (Prelude.Maybe Prelude.Bool)
cancelJobResponse_success :: (Maybe Bool -> f (Maybe Bool))
-> CancelJobResponse -> f CancelJobResponse
cancelJobResponse_success = (CancelJobResponse -> Maybe Bool)
-> (CancelJobResponse -> Maybe Bool -> CancelJobResponse)
-> Lens
     CancelJobResponse CancelJobResponse (Maybe Bool) (Maybe Bool)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CancelJobResponse' {Maybe Bool
success :: Maybe Bool
$sel:success:CancelJobResponse' :: CancelJobResponse -> Maybe Bool
success} -> Maybe Bool
success) (\s :: CancelJobResponse
s@CancelJobResponse' {} Maybe Bool
a -> CancelJobResponse
s {$sel:success:CancelJobResponse' :: Maybe Bool
success = Maybe Bool
a} :: CancelJobResponse)

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

instance Prelude.NFData CancelJobResponse