{-# 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.CognitoIdentityProvider.AdminUpdateDeviceStatus
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Updates the device status as an administrator.
--
-- Calling this action requires developer credentials.
module Amazonka.CognitoIdentityProvider.AdminUpdateDeviceStatus
  ( -- * Creating a Request
    AdminUpdateDeviceStatus (..),
    newAdminUpdateDeviceStatus,

    -- * Request Lenses
    adminUpdateDeviceStatus_deviceRememberedStatus,
    adminUpdateDeviceStatus_userPoolId,
    adminUpdateDeviceStatus_username,
    adminUpdateDeviceStatus_deviceKey,

    -- * Destructuring the Response
    AdminUpdateDeviceStatusResponse (..),
    newAdminUpdateDeviceStatusResponse,

    -- * Response Lenses
    adminUpdateDeviceStatusResponse_httpStatus,
  )
where

import Amazonka.CognitoIdentityProvider.Types
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

-- | The request to update the device status, as an administrator.
--
-- /See:/ 'newAdminUpdateDeviceStatus' smart constructor.
data AdminUpdateDeviceStatus = AdminUpdateDeviceStatus'
  { -- | The status indicating whether a device has been remembered or not.
    AdminUpdateDeviceStatus -> Maybe DeviceRememberedStatusType
deviceRememberedStatus :: Prelude.Maybe DeviceRememberedStatusType,
    -- | The user pool ID.
    AdminUpdateDeviceStatus -> Text
userPoolId :: Prelude.Text,
    -- | The user name.
    AdminUpdateDeviceStatus -> Sensitive Text
username :: Data.Sensitive Prelude.Text,
    -- | The device key.
    AdminUpdateDeviceStatus -> Text
deviceKey :: Prelude.Text
  }
  deriving (AdminUpdateDeviceStatus -> AdminUpdateDeviceStatus -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: AdminUpdateDeviceStatus -> AdminUpdateDeviceStatus -> Bool
$c/= :: AdminUpdateDeviceStatus -> AdminUpdateDeviceStatus -> Bool
== :: AdminUpdateDeviceStatus -> AdminUpdateDeviceStatus -> Bool
$c== :: AdminUpdateDeviceStatus -> AdminUpdateDeviceStatus -> Bool
Prelude.Eq, Int -> AdminUpdateDeviceStatus -> ShowS
[AdminUpdateDeviceStatus] -> ShowS
AdminUpdateDeviceStatus -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [AdminUpdateDeviceStatus] -> ShowS
$cshowList :: [AdminUpdateDeviceStatus] -> ShowS
show :: AdminUpdateDeviceStatus -> String
$cshow :: AdminUpdateDeviceStatus -> String
showsPrec :: Int -> AdminUpdateDeviceStatus -> ShowS
$cshowsPrec :: Int -> AdminUpdateDeviceStatus -> ShowS
Prelude.Show, forall x. Rep AdminUpdateDeviceStatus x -> AdminUpdateDeviceStatus
forall x. AdminUpdateDeviceStatus -> Rep AdminUpdateDeviceStatus x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep AdminUpdateDeviceStatus x -> AdminUpdateDeviceStatus
$cfrom :: forall x. AdminUpdateDeviceStatus -> Rep AdminUpdateDeviceStatus x
Prelude.Generic)

-- |
-- Create a value of 'AdminUpdateDeviceStatus' 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:
--
-- 'deviceRememberedStatus', 'adminUpdateDeviceStatus_deviceRememberedStatus' - The status indicating whether a device has been remembered or not.
--
-- 'userPoolId', 'adminUpdateDeviceStatus_userPoolId' - The user pool ID.
--
-- 'username', 'adminUpdateDeviceStatus_username' - The user name.
--
-- 'deviceKey', 'adminUpdateDeviceStatus_deviceKey' - The device key.
newAdminUpdateDeviceStatus ::
  -- | 'userPoolId'
  Prelude.Text ->
  -- | 'username'
  Prelude.Text ->
  -- | 'deviceKey'
  Prelude.Text ->
  AdminUpdateDeviceStatus
newAdminUpdateDeviceStatus :: Text -> Text -> Text -> AdminUpdateDeviceStatus
newAdminUpdateDeviceStatus
  Text
pUserPoolId_
  Text
pUsername_
  Text
pDeviceKey_ =
    AdminUpdateDeviceStatus'
      { $sel:deviceRememberedStatus:AdminUpdateDeviceStatus' :: Maybe DeviceRememberedStatusType
deviceRememberedStatus =
          forall a. Maybe a
Prelude.Nothing,
        $sel:userPoolId:AdminUpdateDeviceStatus' :: Text
userPoolId = Text
pUserPoolId_,
        $sel:username:AdminUpdateDeviceStatus' :: Sensitive Text
username = forall a. Iso' (Sensitive a) a
Data._Sensitive forall t b. AReview t b -> b -> t
Lens.# Text
pUsername_,
        $sel:deviceKey:AdminUpdateDeviceStatus' :: Text
deviceKey = Text
pDeviceKey_
      }

-- | The status indicating whether a device has been remembered or not.
adminUpdateDeviceStatus_deviceRememberedStatus :: Lens.Lens' AdminUpdateDeviceStatus (Prelude.Maybe DeviceRememberedStatusType)
adminUpdateDeviceStatus_deviceRememberedStatus :: Lens' AdminUpdateDeviceStatus (Maybe DeviceRememberedStatusType)
adminUpdateDeviceStatus_deviceRememberedStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AdminUpdateDeviceStatus' {Maybe DeviceRememberedStatusType
deviceRememberedStatus :: Maybe DeviceRememberedStatusType
$sel:deviceRememberedStatus:AdminUpdateDeviceStatus' :: AdminUpdateDeviceStatus -> Maybe DeviceRememberedStatusType
deviceRememberedStatus} -> Maybe DeviceRememberedStatusType
deviceRememberedStatus) (\s :: AdminUpdateDeviceStatus
s@AdminUpdateDeviceStatus' {} Maybe DeviceRememberedStatusType
a -> AdminUpdateDeviceStatus
s {$sel:deviceRememberedStatus:AdminUpdateDeviceStatus' :: Maybe DeviceRememberedStatusType
deviceRememberedStatus = Maybe DeviceRememberedStatusType
a} :: AdminUpdateDeviceStatus)

-- | The user pool ID.
adminUpdateDeviceStatus_userPoolId :: Lens.Lens' AdminUpdateDeviceStatus Prelude.Text
adminUpdateDeviceStatus_userPoolId :: Lens' AdminUpdateDeviceStatus Text
adminUpdateDeviceStatus_userPoolId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AdminUpdateDeviceStatus' {Text
userPoolId :: Text
$sel:userPoolId:AdminUpdateDeviceStatus' :: AdminUpdateDeviceStatus -> Text
userPoolId} -> Text
userPoolId) (\s :: AdminUpdateDeviceStatus
s@AdminUpdateDeviceStatus' {} Text
a -> AdminUpdateDeviceStatus
s {$sel:userPoolId:AdminUpdateDeviceStatus' :: Text
userPoolId = Text
a} :: AdminUpdateDeviceStatus)

-- | The user name.
adminUpdateDeviceStatus_username :: Lens.Lens' AdminUpdateDeviceStatus Prelude.Text
adminUpdateDeviceStatus_username :: Lens' AdminUpdateDeviceStatus Text
adminUpdateDeviceStatus_username = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AdminUpdateDeviceStatus' {Sensitive Text
username :: Sensitive Text
$sel:username:AdminUpdateDeviceStatus' :: AdminUpdateDeviceStatus -> Sensitive Text
username} -> Sensitive Text
username) (\s :: AdminUpdateDeviceStatus
s@AdminUpdateDeviceStatus' {} Sensitive Text
a -> AdminUpdateDeviceStatus
s {$sel:username:AdminUpdateDeviceStatus' :: Sensitive Text
username = Sensitive Text
a} :: AdminUpdateDeviceStatus) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall a. Iso' (Sensitive a) a
Data._Sensitive

-- | The device key.
adminUpdateDeviceStatus_deviceKey :: Lens.Lens' AdminUpdateDeviceStatus Prelude.Text
adminUpdateDeviceStatus_deviceKey :: Lens' AdminUpdateDeviceStatus Text
adminUpdateDeviceStatus_deviceKey = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AdminUpdateDeviceStatus' {Text
deviceKey :: Text
$sel:deviceKey:AdminUpdateDeviceStatus' :: AdminUpdateDeviceStatus -> Text
deviceKey} -> Text
deviceKey) (\s :: AdminUpdateDeviceStatus
s@AdminUpdateDeviceStatus' {} Text
a -> AdminUpdateDeviceStatus
s {$sel:deviceKey:AdminUpdateDeviceStatus' :: Text
deviceKey = Text
a} :: AdminUpdateDeviceStatus)

instance Core.AWSRequest AdminUpdateDeviceStatus where
  type
    AWSResponse AdminUpdateDeviceStatus =
      AdminUpdateDeviceStatusResponse
  request :: (Service -> Service)
-> AdminUpdateDeviceStatus -> Request AdminUpdateDeviceStatus
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 AdminUpdateDeviceStatus
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse AdminUpdateDeviceStatus)))
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 -> AdminUpdateDeviceStatusResponse
AdminUpdateDeviceStatusResponse'
            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 AdminUpdateDeviceStatus where
  hashWithSalt :: Int -> AdminUpdateDeviceStatus -> Int
hashWithSalt Int
_salt AdminUpdateDeviceStatus' {Maybe DeviceRememberedStatusType
Text
Sensitive Text
deviceKey :: Text
username :: Sensitive Text
userPoolId :: Text
deviceRememberedStatus :: Maybe DeviceRememberedStatusType
$sel:deviceKey:AdminUpdateDeviceStatus' :: AdminUpdateDeviceStatus -> Text
$sel:username:AdminUpdateDeviceStatus' :: AdminUpdateDeviceStatus -> Sensitive Text
$sel:userPoolId:AdminUpdateDeviceStatus' :: AdminUpdateDeviceStatus -> Text
$sel:deviceRememberedStatus:AdminUpdateDeviceStatus' :: AdminUpdateDeviceStatus -> Maybe DeviceRememberedStatusType
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe DeviceRememberedStatusType
deviceRememberedStatus
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
userPoolId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Sensitive Text
username
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
deviceKey

instance Prelude.NFData AdminUpdateDeviceStatus where
  rnf :: AdminUpdateDeviceStatus -> ()
rnf AdminUpdateDeviceStatus' {Maybe DeviceRememberedStatusType
Text
Sensitive Text
deviceKey :: Text
username :: Sensitive Text
userPoolId :: Text
deviceRememberedStatus :: Maybe DeviceRememberedStatusType
$sel:deviceKey:AdminUpdateDeviceStatus' :: AdminUpdateDeviceStatus -> Text
$sel:username:AdminUpdateDeviceStatus' :: AdminUpdateDeviceStatus -> Sensitive Text
$sel:userPoolId:AdminUpdateDeviceStatus' :: AdminUpdateDeviceStatus -> Text
$sel:deviceRememberedStatus:AdminUpdateDeviceStatus' :: AdminUpdateDeviceStatus -> Maybe DeviceRememberedStatusType
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe DeviceRememberedStatusType
deviceRememberedStatus
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
userPoolId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Sensitive Text
username
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
deviceKey

instance Data.ToHeaders AdminUpdateDeviceStatus where
  toHeaders :: AdminUpdateDeviceStatus -> 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
"AWSCognitoIdentityProviderService.AdminUpdateDeviceStatus" ::
                          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 AdminUpdateDeviceStatus where
  toJSON :: AdminUpdateDeviceStatus -> Value
toJSON AdminUpdateDeviceStatus' {Maybe DeviceRememberedStatusType
Text
Sensitive Text
deviceKey :: Text
username :: Sensitive Text
userPoolId :: Text
deviceRememberedStatus :: Maybe DeviceRememberedStatusType
$sel:deviceKey:AdminUpdateDeviceStatus' :: AdminUpdateDeviceStatus -> Text
$sel:username:AdminUpdateDeviceStatus' :: AdminUpdateDeviceStatus -> Sensitive Text
$sel:userPoolId:AdminUpdateDeviceStatus' :: AdminUpdateDeviceStatus -> Text
$sel:deviceRememberedStatus:AdminUpdateDeviceStatus' :: AdminUpdateDeviceStatus -> Maybe DeviceRememberedStatusType
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"DeviceRememberedStatus" 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 DeviceRememberedStatusType
deviceRememberedStatus,
            forall a. a -> Maybe a
Prelude.Just (Key
"UserPoolId" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
userPoolId),
            forall a. a -> Maybe a
Prelude.Just (Key
"Username" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Sensitive Text
username),
            forall a. a -> Maybe a
Prelude.Just (Key
"DeviceKey" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
deviceKey)
          ]
      )

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

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

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

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

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

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