{-# 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.TerminateInstances
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Shuts down the specified instances. This operation is idempotent; if you
-- terminate an instance more than once, each call succeeds.
--
-- If you specify multiple instances and the request fails (for example,
-- because of a single incorrect instance ID), none of the instances are
-- terminated.
--
-- If you terminate multiple instances across multiple Availability Zones,
-- and one or more of the specified instances are enabled for termination
-- protection, the request fails with the following results:
--
-- -   The specified instances that are in the same Availability Zone as
--     the protected instance are not terminated.
--
-- -   The specified instances that are in different Availability Zones,
--     where no other specified instances are protected, are successfully
--     terminated.
--
-- For example, say you have the following instances:
--
-- -   Instance A: @us-east-1a@; Not protected
--
-- -   Instance B: @us-east-1a@; Not protected
--
-- -   Instance C: @us-east-1b@; Protected
--
-- -   Instance D: @us-east-1b@; not protected
--
-- If you attempt to terminate all of these instances in the same request,
-- the request reports failure with the following results:
--
-- -   Instance A and Instance B are successfully terminated because none
--     of the specified instances in @us-east-1a@ are enabled for
--     termination protection.
--
-- -   Instance C and Instance D fail to terminate because at least one of
--     the specified instances in @us-east-1b@ (Instance C) is enabled for
--     termination protection.
--
-- Terminated instances remain visible after termination (for approximately
-- one hour).
--
-- By default, Amazon EC2 deletes all EBS volumes that were attached when
-- the instance launched. Volumes attached after instance launch continue
-- running.
--
-- You can stop, start, and terminate EBS-backed instances. You can only
-- terminate instance store-backed instances. What happens to an instance
-- differs if you stop it or terminate it. For example, when you stop an
-- instance, the root device and any other devices attached to the instance
-- persist. When you terminate an instance, any attached EBS volumes with
-- the @DeleteOnTermination@ block device mapping parameter set to @true@
-- are automatically deleted. For more information about the differences
-- between stopping and terminating instances, see
-- <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html Instance lifecycle>
-- in the /Amazon EC2 User Guide/.
--
-- For more information about troubleshooting, see
-- <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstancesShuttingDown.html Troubleshooting terminating your instance>
-- in the /Amazon EC2 User Guide/.
module Amazonka.EC2.TerminateInstances
  ( -- * Creating a Request
    TerminateInstances (..),
    newTerminateInstances,

    -- * Request Lenses
    terminateInstances_dryRun,
    terminateInstances_instanceIds,

    -- * Destructuring the Response
    TerminateInstancesResponse (..),
    newTerminateInstancesResponse,

    -- * Response Lenses
    terminateInstancesResponse_terminatingInstances,
    terminateInstancesResponse_httpStatus,
  )
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:/ 'newTerminateInstances' smart constructor.
data TerminateInstances = TerminateInstances'
  { -- | 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@.
    TerminateInstances -> Maybe Bool
dryRun :: Prelude.Maybe Prelude.Bool,
    -- | The IDs of the instances.
    --
    -- Constraints: Up to 1000 instance IDs. We recommend breaking up this
    -- request into smaller batches.
    TerminateInstances -> [Text]
instanceIds :: [Prelude.Text]
  }
  deriving (TerminateInstances -> TerminateInstances -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: TerminateInstances -> TerminateInstances -> Bool
$c/= :: TerminateInstances -> TerminateInstances -> Bool
== :: TerminateInstances -> TerminateInstances -> Bool
$c== :: TerminateInstances -> TerminateInstances -> Bool
Prelude.Eq, ReadPrec [TerminateInstances]
ReadPrec TerminateInstances
Int -> ReadS TerminateInstances
ReadS [TerminateInstances]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [TerminateInstances]
$creadListPrec :: ReadPrec [TerminateInstances]
readPrec :: ReadPrec TerminateInstances
$creadPrec :: ReadPrec TerminateInstances
readList :: ReadS [TerminateInstances]
$creadList :: ReadS [TerminateInstances]
readsPrec :: Int -> ReadS TerminateInstances
$creadsPrec :: Int -> ReadS TerminateInstances
Prelude.Read, Int -> TerminateInstances -> ShowS
[TerminateInstances] -> ShowS
TerminateInstances -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [TerminateInstances] -> ShowS
$cshowList :: [TerminateInstances] -> ShowS
show :: TerminateInstances -> String
$cshow :: TerminateInstances -> String
showsPrec :: Int -> TerminateInstances -> ShowS
$cshowsPrec :: Int -> TerminateInstances -> ShowS
Prelude.Show, forall x. Rep TerminateInstances x -> TerminateInstances
forall x. TerminateInstances -> Rep TerminateInstances x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep TerminateInstances x -> TerminateInstances
$cfrom :: forall x. TerminateInstances -> Rep TerminateInstances x
Prelude.Generic)

-- |
-- Create a value of 'TerminateInstances' 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', 'terminateInstances_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@.
--
-- 'instanceIds', 'terminateInstances_instanceIds' - The IDs of the instances.
--
-- Constraints: Up to 1000 instance IDs. We recommend breaking up this
-- request into smaller batches.
newTerminateInstances ::
  TerminateInstances
newTerminateInstances :: TerminateInstances
newTerminateInstances =
  TerminateInstances'
    { $sel:dryRun:TerminateInstances' :: Maybe Bool
dryRun = forall a. Maybe a
Prelude.Nothing,
      $sel:instanceIds:TerminateInstances' :: [Text]
instanceIds = forall a. Monoid a => a
Prelude.mempty
    }

-- | 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@.
terminateInstances_dryRun :: Lens.Lens' TerminateInstances (Prelude.Maybe Prelude.Bool)
terminateInstances_dryRun :: Lens' TerminateInstances (Maybe Bool)
terminateInstances_dryRun = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TerminateInstances' {Maybe Bool
dryRun :: Maybe Bool
$sel:dryRun:TerminateInstances' :: TerminateInstances -> Maybe Bool
dryRun} -> Maybe Bool
dryRun) (\s :: TerminateInstances
s@TerminateInstances' {} Maybe Bool
a -> TerminateInstances
s {$sel:dryRun:TerminateInstances' :: Maybe Bool
dryRun = Maybe Bool
a} :: TerminateInstances)

-- | The IDs of the instances.
--
-- Constraints: Up to 1000 instance IDs. We recommend breaking up this
-- request into smaller batches.
terminateInstances_instanceIds :: Lens.Lens' TerminateInstances [Prelude.Text]
terminateInstances_instanceIds :: Lens' TerminateInstances [Text]
terminateInstances_instanceIds = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TerminateInstances' {[Text]
instanceIds :: [Text]
$sel:instanceIds:TerminateInstances' :: TerminateInstances -> [Text]
instanceIds} -> [Text]
instanceIds) (\s :: TerminateInstances
s@TerminateInstances' {} [Text]
a -> TerminateInstances
s {$sel:instanceIds:TerminateInstances' :: [Text]
instanceIds = [Text]
a} :: TerminateInstances) 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 TerminateInstances where
  type
    AWSResponse TerminateInstances =
      TerminateInstancesResponse
  request :: (Service -> Service)
-> TerminateInstances -> Request TerminateInstances
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 TerminateInstances
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse TerminateInstances)))
response =
    forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> [Node] -> Either String (AWSResponse a))
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveXML
      ( \Int
s ResponseHeaders
h [Node]
x ->
          Maybe [InstanceStateChange] -> Int -> TerminateInstancesResponse
TerminateInstancesResponse'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> ( [Node]
x
                            forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"instancesSet"
                            forall (f :: * -> *) a. Functor f => f (Maybe a) -> a -> f a
Core..!@ forall a. Monoid a => a
Prelude.mempty
                            forall (m :: * -> *) a b. Monad m => m a -> (a -> m b) -> m b
Prelude.>>= forall (f :: * -> *) a b.
Applicative f =>
([a] -> f b) -> [a] -> f (Maybe b)
Core.may (forall a. FromXML a => Text -> [Node] -> Either String [a]
Data.parseXMLList Text
"item")
                        )
            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 TerminateInstances where
  hashWithSalt :: Int -> TerminateInstances -> Int
hashWithSalt Int
_salt TerminateInstances' {[Text]
Maybe Bool
instanceIds :: [Text]
dryRun :: Maybe Bool
$sel:instanceIds:TerminateInstances' :: TerminateInstances -> [Text]
$sel:dryRun:TerminateInstances' :: TerminateInstances -> 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` [Text]
instanceIds

instance Prelude.NFData TerminateInstances where
  rnf :: TerminateInstances -> ()
rnf TerminateInstances' {[Text]
Maybe Bool
instanceIds :: [Text]
dryRun :: Maybe Bool
$sel:instanceIds:TerminateInstances' :: TerminateInstances -> [Text]
$sel:dryRun:TerminateInstances' :: TerminateInstances -> 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 [Text]
instanceIds

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

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

instance Data.ToQuery TerminateInstances where
  toQuery :: TerminateInstances -> QueryString
toQuery TerminateInstances' {[Text]
Maybe Bool
instanceIds :: [Text]
dryRun :: Maybe Bool
$sel:instanceIds:TerminateInstances' :: TerminateInstances -> [Text]
$sel:dryRun:TerminateInstances' :: TerminateInstances -> Maybe Bool
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ ByteString
"Action"
          forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: (ByteString
"TerminateInstances" :: 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,
        forall a.
(IsList a, ToQuery (Item a)) =>
ByteString -> a -> QueryString
Data.toQueryList ByteString
"InstanceId" [Text]
instanceIds
      ]

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

-- |
-- Create a value of 'TerminateInstancesResponse' 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:
--
-- 'terminatingInstances', 'terminateInstancesResponse_terminatingInstances' - Information about the terminated instances.
--
-- 'httpStatus', 'terminateInstancesResponse_httpStatus' - The response's http status code.
newTerminateInstancesResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  TerminateInstancesResponse
newTerminateInstancesResponse :: Int -> TerminateInstancesResponse
newTerminateInstancesResponse Int
pHttpStatus_ =
  TerminateInstancesResponse'
    { $sel:terminatingInstances:TerminateInstancesResponse' :: Maybe [InstanceStateChange]
terminatingInstances =
        forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:TerminateInstancesResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | Information about the terminated instances.
terminateInstancesResponse_terminatingInstances :: Lens.Lens' TerminateInstancesResponse (Prelude.Maybe [InstanceStateChange])
terminateInstancesResponse_terminatingInstances :: Lens' TerminateInstancesResponse (Maybe [InstanceStateChange])
terminateInstancesResponse_terminatingInstances = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TerminateInstancesResponse' {Maybe [InstanceStateChange]
terminatingInstances :: Maybe [InstanceStateChange]
$sel:terminatingInstances:TerminateInstancesResponse' :: TerminateInstancesResponse -> Maybe [InstanceStateChange]
terminatingInstances} -> Maybe [InstanceStateChange]
terminatingInstances) (\s :: TerminateInstancesResponse
s@TerminateInstancesResponse' {} Maybe [InstanceStateChange]
a -> TerminateInstancesResponse
s {$sel:terminatingInstances:TerminateInstancesResponse' :: Maybe [InstanceStateChange]
terminatingInstances = Maybe [InstanceStateChange]
a} :: TerminateInstancesResponse) 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.
terminateInstancesResponse_httpStatus :: Lens.Lens' TerminateInstancesResponse Prelude.Int
terminateInstancesResponse_httpStatus :: Lens' TerminateInstancesResponse Int
terminateInstancesResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TerminateInstancesResponse' {Int
httpStatus :: Int
$sel:httpStatus:TerminateInstancesResponse' :: TerminateInstancesResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: TerminateInstancesResponse
s@TerminateInstancesResponse' {} Int
a -> TerminateInstancesResponse
s {$sel:httpStatus:TerminateInstancesResponse' :: Int
httpStatus = Int
a} :: TerminateInstancesResponse)

instance Prelude.NFData TerminateInstancesResponse where
  rnf :: TerminateInstancesResponse -> ()
rnf TerminateInstancesResponse' {Int
Maybe [InstanceStateChange]
httpStatus :: Int
terminatingInstances :: Maybe [InstanceStateChange]
$sel:httpStatus:TerminateInstancesResponse' :: TerminateInstancesResponse -> Int
$sel:terminatingInstances:TerminateInstancesResponse' :: TerminateInstancesResponse -> Maybe [InstanceStateChange]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [InstanceStateChange]
terminatingInstances
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus