amazonka-shield-2.0: gen/Amazonka/Shield/DescribeAttack.hs
{-# 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.Shield.DescribeAttack
-- Copyright : (c) 2013-2023 Brendan Hay
-- License : Mozilla Public License, v. 2.0.
-- Maintainer : Brendan Hay
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Describes the details of a DDoS attack.
module Amazonka.Shield.DescribeAttack
( -- * Creating a Request
DescribeAttack (..),
newDescribeAttack,
-- * Request Lenses
describeAttack_attackId,
-- * Destructuring the Response
DescribeAttackResponse (..),
newDescribeAttackResponse,
-- * Response Lenses
describeAttackResponse_attack,
describeAttackResponse_httpStatus,
)
where
import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response
import Amazonka.Shield.Types
-- | /See:/ 'newDescribeAttack' smart constructor.
data DescribeAttack = DescribeAttack'
{ -- | The unique identifier (ID) for the attack.
attackId :: Prelude.Text
}
deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)
-- |
-- Create a value of 'DescribeAttack' 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:
--
-- 'attackId', 'describeAttack_attackId' - The unique identifier (ID) for the attack.
newDescribeAttack ::
-- | 'attackId'
Prelude.Text ->
DescribeAttack
newDescribeAttack pAttackId_ =
DescribeAttack' {attackId = pAttackId_}
-- | The unique identifier (ID) for the attack.
describeAttack_attackId :: Lens.Lens' DescribeAttack Prelude.Text
describeAttack_attackId = Lens.lens (\DescribeAttack' {attackId} -> attackId) (\s@DescribeAttack' {} a -> s {attackId = a} :: DescribeAttack)
instance Core.AWSRequest DescribeAttack where
type
AWSResponse DescribeAttack =
DescribeAttackResponse
request overrides =
Request.postJSON (overrides defaultService)
response =
Response.receiveJSON
( \s h x ->
DescribeAttackResponse'
Prelude.<$> (x Data..?> "Attack")
Prelude.<*> (Prelude.pure (Prelude.fromEnum s))
)
instance Prelude.Hashable DescribeAttack where
hashWithSalt _salt DescribeAttack' {..} =
_salt `Prelude.hashWithSalt` attackId
instance Prelude.NFData DescribeAttack where
rnf DescribeAttack' {..} = Prelude.rnf attackId
instance Data.ToHeaders DescribeAttack where
toHeaders =
Prelude.const
( Prelude.mconcat
[ "X-Amz-Target"
Data.=# ( "AWSShield_20160616.DescribeAttack" ::
Prelude.ByteString
),
"Content-Type"
Data.=# ( "application/x-amz-json-1.1" ::
Prelude.ByteString
)
]
)
instance Data.ToJSON DescribeAttack where
toJSON DescribeAttack' {..} =
Data.object
( Prelude.catMaybes
[Prelude.Just ("AttackId" Data..= attackId)]
)
instance Data.ToPath DescribeAttack where
toPath = Prelude.const "/"
instance Data.ToQuery DescribeAttack where
toQuery = Prelude.const Prelude.mempty
-- | /See:/ 'newDescribeAttackResponse' smart constructor.
data DescribeAttackResponse = DescribeAttackResponse'
{ -- | The attack that you requested.
attack :: Prelude.Maybe AttackDetail,
-- | The response's http status code.
httpStatus :: Prelude.Int
}
deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)
-- |
-- Create a value of 'DescribeAttackResponse' 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:
--
-- 'attack', 'describeAttackResponse_attack' - The attack that you requested.
--
-- 'httpStatus', 'describeAttackResponse_httpStatus' - The response's http status code.
newDescribeAttackResponse ::
-- | 'httpStatus'
Prelude.Int ->
DescribeAttackResponse
newDescribeAttackResponse pHttpStatus_ =
DescribeAttackResponse'
{ attack = Prelude.Nothing,
httpStatus = pHttpStatus_
}
-- | The attack that you requested.
describeAttackResponse_attack :: Lens.Lens' DescribeAttackResponse (Prelude.Maybe AttackDetail)
describeAttackResponse_attack = Lens.lens (\DescribeAttackResponse' {attack} -> attack) (\s@DescribeAttackResponse' {} a -> s {attack = a} :: DescribeAttackResponse)
-- | The response's http status code.
describeAttackResponse_httpStatus :: Lens.Lens' DescribeAttackResponse Prelude.Int
describeAttackResponse_httpStatus = Lens.lens (\DescribeAttackResponse' {httpStatus} -> httpStatus) (\s@DescribeAttackResponse' {} a -> s {httpStatus = a} :: DescribeAttackResponse)
instance Prelude.NFData DescribeAttackResponse where
rnf DescribeAttackResponse' {..} =
Prelude.rnf attack
`Prelude.seq` Prelude.rnf httpStatus