{-# 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.EC2.CancelConversionTask
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Cancels an active conversion task. The task can be the import of an
-- instance or volume. The action removes all artifacts of the conversion,
-- including a partially uploaded volume or instance. If the conversion is
-- complete or is in the process of transferring the final disk image, the
-- command fails and returns an exception.
--
-- For more information, see
-- <https://docs.aws.amazon.com/AWSEC2/latest/CommandLineReference/ec2-cli-vmimport-export.html Importing a Virtual Machine Using the Amazon EC2 CLI>.
module Amazonka.EC2.CancelConversionTask
  ( -- * Creating a Request
    CancelConversionTask (..),
    newCancelConversionTask,

    -- * Request Lenses
    cancelConversionTask_dryRun,
    cancelConversionTask_reasonMessage,
    cancelConversionTask_conversionTaskId,

    -- * Destructuring the Response
    CancelConversionTaskResponse (..),
    newCancelConversionTaskResponse,
  )
where

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

-- | /See:/ 'newCancelConversionTask' smart constructor.
data CancelConversionTask = CancelConversionTask'
  { -- | Checks whether you have the required permissions for the action, without
    -- actually making the request, and provides an error response. If you have
    -- the required permissions, the error response is @DryRunOperation@.
    -- Otherwise, it is @UnauthorizedOperation@.
    CancelConversionTask -> Maybe Bool
dryRun :: Prelude.Maybe Prelude.Bool,
    -- | The reason for canceling the conversion task.
    CancelConversionTask -> Maybe Text
reasonMessage :: Prelude.Maybe Prelude.Text,
    -- | The ID of the conversion task.
    CancelConversionTask -> Text
conversionTaskId :: Prelude.Text
  }
  deriving (CancelConversionTask -> CancelConversionTask -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: CancelConversionTask -> CancelConversionTask -> Bool
$c/= :: CancelConversionTask -> CancelConversionTask -> Bool
== :: CancelConversionTask -> CancelConversionTask -> Bool
$c== :: CancelConversionTask -> CancelConversionTask -> Bool
Prelude.Eq, ReadPrec [CancelConversionTask]
ReadPrec CancelConversionTask
Int -> ReadS CancelConversionTask
ReadS [CancelConversionTask]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [CancelConversionTask]
$creadListPrec :: ReadPrec [CancelConversionTask]
readPrec :: ReadPrec CancelConversionTask
$creadPrec :: ReadPrec CancelConversionTask
readList :: ReadS [CancelConversionTask]
$creadList :: ReadS [CancelConversionTask]
readsPrec :: Int -> ReadS CancelConversionTask
$creadsPrec :: Int -> ReadS CancelConversionTask
Prelude.Read, Int -> CancelConversionTask -> ShowS
[CancelConversionTask] -> ShowS
CancelConversionTask -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [CancelConversionTask] -> ShowS
$cshowList :: [CancelConversionTask] -> ShowS
show :: CancelConversionTask -> String
$cshow :: CancelConversionTask -> String
showsPrec :: Int -> CancelConversionTask -> ShowS
$cshowsPrec :: Int -> CancelConversionTask -> ShowS
Prelude.Show, forall x. Rep CancelConversionTask x -> CancelConversionTask
forall x. CancelConversionTask -> Rep CancelConversionTask x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep CancelConversionTask x -> CancelConversionTask
$cfrom :: forall x. CancelConversionTask -> Rep CancelConversionTask x
Prelude.Generic)

-- |
-- Create a value of 'CancelConversionTask' 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:
--
-- 'dryRun', 'cancelConversionTask_dryRun' - Checks whether you have the required permissions for the action, without
-- actually making the request, and provides an error response. If you have
-- the required permissions, the error response is @DryRunOperation@.
-- Otherwise, it is @UnauthorizedOperation@.
--
-- 'reasonMessage', 'cancelConversionTask_reasonMessage' - The reason for canceling the conversion task.
--
-- 'conversionTaskId', 'cancelConversionTask_conversionTaskId' - The ID of the conversion task.
newCancelConversionTask ::
  -- | 'conversionTaskId'
  Prelude.Text ->
  CancelConversionTask
newCancelConversionTask :: Text -> CancelConversionTask
newCancelConversionTask Text
pConversionTaskId_ =
  CancelConversionTask'
    { $sel:dryRun:CancelConversionTask' :: Maybe Bool
dryRun = forall a. Maybe a
Prelude.Nothing,
      $sel:reasonMessage:CancelConversionTask' :: Maybe Text
reasonMessage = forall a. Maybe a
Prelude.Nothing,
      $sel:conversionTaskId:CancelConversionTask' :: Text
conversionTaskId = Text
pConversionTaskId_
    }

-- | Checks whether you have the required permissions for the action, without
-- actually making the request, and provides an error response. If you have
-- the required permissions, the error response is @DryRunOperation@.
-- Otherwise, it is @UnauthorizedOperation@.
cancelConversionTask_dryRun :: Lens.Lens' CancelConversionTask (Prelude.Maybe Prelude.Bool)
cancelConversionTask_dryRun :: Lens' CancelConversionTask (Maybe Bool)
cancelConversionTask_dryRun = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CancelConversionTask' {Maybe Bool
dryRun :: Maybe Bool
$sel:dryRun:CancelConversionTask' :: CancelConversionTask -> Maybe Bool
dryRun} -> Maybe Bool
dryRun) (\s :: CancelConversionTask
s@CancelConversionTask' {} Maybe Bool
a -> CancelConversionTask
s {$sel:dryRun:CancelConversionTask' :: Maybe Bool
dryRun = Maybe Bool
a} :: CancelConversionTask)

-- | The reason for canceling the conversion task.
cancelConversionTask_reasonMessage :: Lens.Lens' CancelConversionTask (Prelude.Maybe Prelude.Text)
cancelConversionTask_reasonMessage :: Lens' CancelConversionTask (Maybe Text)
cancelConversionTask_reasonMessage = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CancelConversionTask' {Maybe Text
reasonMessage :: Maybe Text
$sel:reasonMessage:CancelConversionTask' :: CancelConversionTask -> Maybe Text
reasonMessage} -> Maybe Text
reasonMessage) (\s :: CancelConversionTask
s@CancelConversionTask' {} Maybe Text
a -> CancelConversionTask
s {$sel:reasonMessage:CancelConversionTask' :: Maybe Text
reasonMessage = Maybe Text
a} :: CancelConversionTask)

-- | The ID of the conversion task.
cancelConversionTask_conversionTaskId :: Lens.Lens' CancelConversionTask Prelude.Text
cancelConversionTask_conversionTaskId :: Lens' CancelConversionTask Text
cancelConversionTask_conversionTaskId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CancelConversionTask' {Text
conversionTaskId :: Text
$sel:conversionTaskId:CancelConversionTask' :: CancelConversionTask -> Text
conversionTaskId} -> Text
conversionTaskId) (\s :: CancelConversionTask
s@CancelConversionTask' {} Text
a -> CancelConversionTask
s {$sel:conversionTaskId:CancelConversionTask' :: Text
conversionTaskId = Text
a} :: CancelConversionTask)

instance Core.AWSRequest CancelConversionTask where
  type
    AWSResponse CancelConversionTask =
      CancelConversionTaskResponse
  request :: (Service -> Service)
-> CancelConversionTask -> Request CancelConversionTask
request Service -> Service
overrides =
    forall a. ToRequest a => Service -> a -> Request a
Request.postQuery (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy CancelConversionTask
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse CancelConversionTask)))
response =
    forall (m :: * -> *) a.
MonadResource m =>
AWSResponse a
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveNull CancelConversionTaskResponse
CancelConversionTaskResponse'

instance Prelude.Hashable CancelConversionTask where
  hashWithSalt :: Int -> CancelConversionTask -> Int
hashWithSalt Int
_salt CancelConversionTask' {Maybe Bool
Maybe Text
Text
conversionTaskId :: Text
reasonMessage :: Maybe Text
dryRun :: Maybe Bool
$sel:conversionTaskId:CancelConversionTask' :: CancelConversionTask -> Text
$sel:reasonMessage:CancelConversionTask' :: CancelConversionTask -> Maybe Text
$sel:dryRun:CancelConversionTask' :: CancelConversionTask -> Maybe Bool
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
dryRun
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
reasonMessage
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
conversionTaskId

instance Prelude.NFData CancelConversionTask where
  rnf :: CancelConversionTask -> ()
rnf CancelConversionTask' {Maybe Bool
Maybe Text
Text
conversionTaskId :: Text
reasonMessage :: Maybe Text
dryRun :: Maybe Bool
$sel:conversionTaskId:CancelConversionTask' :: CancelConversionTask -> Text
$sel:reasonMessage:CancelConversionTask' :: CancelConversionTask -> Maybe Text
$sel:dryRun:CancelConversionTask' :: CancelConversionTask -> Maybe Bool
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Bool
dryRun
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
reasonMessage
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
conversionTaskId

instance Data.ToHeaders CancelConversionTask where
  toHeaders :: CancelConversionTask -> [Header]
toHeaders = forall a b. a -> b -> a
Prelude.const forall a. Monoid a => a
Prelude.mempty

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

instance Data.ToQuery CancelConversionTask where
  toQuery :: CancelConversionTask -> QueryString
toQuery CancelConversionTask' {Maybe Bool
Maybe Text
Text
conversionTaskId :: Text
reasonMessage :: Maybe Text
dryRun :: Maybe Bool
$sel:conversionTaskId:CancelConversionTask' :: CancelConversionTask -> Text
$sel:reasonMessage:CancelConversionTask' :: CancelConversionTask -> Maybe Text
$sel:dryRun:CancelConversionTask' :: CancelConversionTask -> Maybe Bool
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ ByteString
"Action"
          forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: (ByteString
"CancelConversionTask" :: Prelude.ByteString),
        ByteString
"Version"
          forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: (ByteString
"2016-11-15" :: Prelude.ByteString),
        ByteString
"DryRun" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Bool
dryRun,
        ByteString
"ReasonMessage" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Text
reasonMessage,
        ByteString
"ConversionTaskId" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Text
conversionTaskId
      ]

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

-- |
-- Create a value of 'CancelConversionTaskResponse' 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.
newCancelConversionTaskResponse ::
  CancelConversionTaskResponse
newCancelConversionTaskResponse :: CancelConversionTaskResponse
newCancelConversionTaskResponse =
  CancelConversionTaskResponse
CancelConversionTaskResponse'

instance Prelude.NFData CancelConversionTaskResponse where
  rnf :: CancelConversionTaskResponse -> ()
rnf CancelConversionTaskResponse
_ = ()