{-# 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.SageMakerFeatureStoreRuntime.DeleteRecord
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Deletes a @Record@ from a @FeatureGroup@. When the @DeleteRecord@ API is
-- called a new record will be added to the @OfflineStore@ and the @Record@
-- will be removed from the @OnlineStore@. This record will have a value of
-- @True@ in the @is_deleted@ column.
module Amazonka.SageMakerFeatureStoreRuntime.DeleteRecord
  ( -- * Creating a Request
    DeleteRecord (..),
    newDeleteRecord,

    -- * Request Lenses
    deleteRecord_targetStores,
    deleteRecord_featureGroupName,
    deleteRecord_recordIdentifierValueAsString,
    deleteRecord_eventTime,

    -- * Destructuring the Response
    DeleteRecordResponse (..),
    newDeleteRecordResponse,
  )
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.SageMakerFeatureStoreRuntime.Types

-- | /See:/ 'newDeleteRecord' smart constructor.
data DeleteRecord = DeleteRecord'
  { -- | A list of stores from which you\'re deleting the record. By default,
    -- Feature Store deletes the record from all of the stores that you\'re
    -- using for the @FeatureGroup@.
    DeleteRecord -> Maybe (NonEmpty TargetStore)
targetStores :: Prelude.Maybe (Prelude.NonEmpty TargetStore),
    -- | The name of the feature group to delete the record from.
    DeleteRecord -> Text
featureGroupName :: Prelude.Text,
    -- | The value for the @RecordIdentifier@ that uniquely identifies the
    -- record, in string format.
    DeleteRecord -> Text
recordIdentifierValueAsString :: Prelude.Text,
    -- | Timestamp indicating when the deletion event occurred. @EventTime@ can
    -- be used to query data at a certain point in time.
    DeleteRecord -> Text
eventTime :: Prelude.Text
  }
  deriving (DeleteRecord -> DeleteRecord -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DeleteRecord -> DeleteRecord -> Bool
$c/= :: DeleteRecord -> DeleteRecord -> Bool
== :: DeleteRecord -> DeleteRecord -> Bool
$c== :: DeleteRecord -> DeleteRecord -> Bool
Prelude.Eq, ReadPrec [DeleteRecord]
ReadPrec DeleteRecord
Int -> ReadS DeleteRecord
ReadS [DeleteRecord]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DeleteRecord]
$creadListPrec :: ReadPrec [DeleteRecord]
readPrec :: ReadPrec DeleteRecord
$creadPrec :: ReadPrec DeleteRecord
readList :: ReadS [DeleteRecord]
$creadList :: ReadS [DeleteRecord]
readsPrec :: Int -> ReadS DeleteRecord
$creadsPrec :: Int -> ReadS DeleteRecord
Prelude.Read, Int -> DeleteRecord -> ShowS
[DeleteRecord] -> ShowS
DeleteRecord -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DeleteRecord] -> ShowS
$cshowList :: [DeleteRecord] -> ShowS
show :: DeleteRecord -> String
$cshow :: DeleteRecord -> String
showsPrec :: Int -> DeleteRecord -> ShowS
$cshowsPrec :: Int -> DeleteRecord -> ShowS
Prelude.Show, forall x. Rep DeleteRecord x -> DeleteRecord
forall x. DeleteRecord -> Rep DeleteRecord x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DeleteRecord x -> DeleteRecord
$cfrom :: forall x. DeleteRecord -> Rep DeleteRecord x
Prelude.Generic)

-- |
-- Create a value of 'DeleteRecord' 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:
--
-- 'targetStores', 'deleteRecord_targetStores' - A list of stores from which you\'re deleting the record. By default,
-- Feature Store deletes the record from all of the stores that you\'re
-- using for the @FeatureGroup@.
--
-- 'featureGroupName', 'deleteRecord_featureGroupName' - The name of the feature group to delete the record from.
--
-- 'recordIdentifierValueAsString', 'deleteRecord_recordIdentifierValueAsString' - The value for the @RecordIdentifier@ that uniquely identifies the
-- record, in string format.
--
-- 'eventTime', 'deleteRecord_eventTime' - Timestamp indicating when the deletion event occurred. @EventTime@ can
-- be used to query data at a certain point in time.
newDeleteRecord ::
  -- | 'featureGroupName'
  Prelude.Text ->
  -- | 'recordIdentifierValueAsString'
  Prelude.Text ->
  -- | 'eventTime'
  Prelude.Text ->
  DeleteRecord
newDeleteRecord :: Text -> Text -> Text -> DeleteRecord
newDeleteRecord
  Text
pFeatureGroupName_
  Text
pRecordIdentifierValueAsString_
  Text
pEventTime_ =
    DeleteRecord'
      { $sel:targetStores:DeleteRecord' :: Maybe (NonEmpty TargetStore)
targetStores = forall a. Maybe a
Prelude.Nothing,
        $sel:featureGroupName:DeleteRecord' :: Text
featureGroupName = Text
pFeatureGroupName_,
        $sel:recordIdentifierValueAsString:DeleteRecord' :: Text
recordIdentifierValueAsString =
          Text
pRecordIdentifierValueAsString_,
        $sel:eventTime:DeleteRecord' :: Text
eventTime = Text
pEventTime_
      }

-- | A list of stores from which you\'re deleting the record. By default,
-- Feature Store deletes the record from all of the stores that you\'re
-- using for the @FeatureGroup@.
deleteRecord_targetStores :: Lens.Lens' DeleteRecord (Prelude.Maybe (Prelude.NonEmpty TargetStore))
deleteRecord_targetStores :: Lens' DeleteRecord (Maybe (NonEmpty TargetStore))
deleteRecord_targetStores = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DeleteRecord' {Maybe (NonEmpty TargetStore)
targetStores :: Maybe (NonEmpty TargetStore)
$sel:targetStores:DeleteRecord' :: DeleteRecord -> Maybe (NonEmpty TargetStore)
targetStores} -> Maybe (NonEmpty TargetStore)
targetStores) (\s :: DeleteRecord
s@DeleteRecord' {} Maybe (NonEmpty TargetStore)
a -> DeleteRecord
s {$sel:targetStores:DeleteRecord' :: Maybe (NonEmpty TargetStore)
targetStores = Maybe (NonEmpty TargetStore)
a} :: DeleteRecord) 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 name of the feature group to delete the record from.
deleteRecord_featureGroupName :: Lens.Lens' DeleteRecord Prelude.Text
deleteRecord_featureGroupName :: Lens' DeleteRecord Text
deleteRecord_featureGroupName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DeleteRecord' {Text
featureGroupName :: Text
$sel:featureGroupName:DeleteRecord' :: DeleteRecord -> Text
featureGroupName} -> Text
featureGroupName) (\s :: DeleteRecord
s@DeleteRecord' {} Text
a -> DeleteRecord
s {$sel:featureGroupName:DeleteRecord' :: Text
featureGroupName = Text
a} :: DeleteRecord)

-- | The value for the @RecordIdentifier@ that uniquely identifies the
-- record, in string format.
deleteRecord_recordIdentifierValueAsString :: Lens.Lens' DeleteRecord Prelude.Text
deleteRecord_recordIdentifierValueAsString :: Lens' DeleteRecord Text
deleteRecord_recordIdentifierValueAsString = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DeleteRecord' {Text
recordIdentifierValueAsString :: Text
$sel:recordIdentifierValueAsString:DeleteRecord' :: DeleteRecord -> Text
recordIdentifierValueAsString} -> Text
recordIdentifierValueAsString) (\s :: DeleteRecord
s@DeleteRecord' {} Text
a -> DeleteRecord
s {$sel:recordIdentifierValueAsString:DeleteRecord' :: Text
recordIdentifierValueAsString = Text
a} :: DeleteRecord)

-- | Timestamp indicating when the deletion event occurred. @EventTime@ can
-- be used to query data at a certain point in time.
deleteRecord_eventTime :: Lens.Lens' DeleteRecord Prelude.Text
deleteRecord_eventTime :: Lens' DeleteRecord Text
deleteRecord_eventTime = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DeleteRecord' {Text
eventTime :: Text
$sel:eventTime:DeleteRecord' :: DeleteRecord -> Text
eventTime} -> Text
eventTime) (\s :: DeleteRecord
s@DeleteRecord' {} Text
a -> DeleteRecord
s {$sel:eventTime:DeleteRecord' :: Text
eventTime = Text
a} :: DeleteRecord)

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

instance Prelude.Hashable DeleteRecord where
  hashWithSalt :: Int -> DeleteRecord -> Int
hashWithSalt Int
_salt DeleteRecord' {Maybe (NonEmpty TargetStore)
Text
eventTime :: Text
recordIdentifierValueAsString :: Text
featureGroupName :: Text
targetStores :: Maybe (NonEmpty TargetStore)
$sel:eventTime:DeleteRecord' :: DeleteRecord -> Text
$sel:recordIdentifierValueAsString:DeleteRecord' :: DeleteRecord -> Text
$sel:featureGroupName:DeleteRecord' :: DeleteRecord -> Text
$sel:targetStores:DeleteRecord' :: DeleteRecord -> Maybe (NonEmpty TargetStore)
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (NonEmpty TargetStore)
targetStores
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
featureGroupName
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
recordIdentifierValueAsString
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
eventTime

instance Prelude.NFData DeleteRecord where
  rnf :: DeleteRecord -> ()
rnf DeleteRecord' {Maybe (NonEmpty TargetStore)
Text
eventTime :: Text
recordIdentifierValueAsString :: Text
featureGroupName :: Text
targetStores :: Maybe (NonEmpty TargetStore)
$sel:eventTime:DeleteRecord' :: DeleteRecord -> Text
$sel:recordIdentifierValueAsString:DeleteRecord' :: DeleteRecord -> Text
$sel:featureGroupName:DeleteRecord' :: DeleteRecord -> Text
$sel:targetStores:DeleteRecord' :: DeleteRecord -> Maybe (NonEmpty TargetStore)
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe (NonEmpty TargetStore)
targetStores
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
featureGroupName
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
recordIdentifierValueAsString
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
eventTime

instance Data.ToHeaders DeleteRecord where
  toHeaders :: DeleteRecord -> [Header]
toHeaders =
    forall a b. a -> b -> a
Prelude.const
      ( forall a. Monoid a => [a] -> a
Prelude.mconcat
          [ HeaderName
"Content-Type"
              forall a. ToHeader a => HeaderName -> a -> [Header]
Data.=# ( ByteString
"application/x-amz-json-1.1" ::
                          Prelude.ByteString
                      )
          ]
      )

instance Data.ToPath DeleteRecord where
  toPath :: DeleteRecord -> ByteString
toPath DeleteRecord' {Maybe (NonEmpty TargetStore)
Text
eventTime :: Text
recordIdentifierValueAsString :: Text
featureGroupName :: Text
targetStores :: Maybe (NonEmpty TargetStore)
$sel:eventTime:DeleteRecord' :: DeleteRecord -> Text
$sel:recordIdentifierValueAsString:DeleteRecord' :: DeleteRecord -> Text
$sel:featureGroupName:DeleteRecord' :: DeleteRecord -> Text
$sel:targetStores:DeleteRecord' :: DeleteRecord -> Maybe (NonEmpty TargetStore)
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ByteString
"/FeatureGroup/", forall a. ToByteString a => a -> ByteString
Data.toBS Text
featureGroupName]

instance Data.ToQuery DeleteRecord where
  toQuery :: DeleteRecord -> QueryString
toQuery DeleteRecord' {Maybe (NonEmpty TargetStore)
Text
eventTime :: Text
recordIdentifierValueAsString :: Text
featureGroupName :: Text
targetStores :: Maybe (NonEmpty TargetStore)
$sel:eventTime:DeleteRecord' :: DeleteRecord -> Text
$sel:recordIdentifierValueAsString:DeleteRecord' :: DeleteRecord -> Text
$sel:featureGroupName:DeleteRecord' :: DeleteRecord -> Text
$sel:targetStores:DeleteRecord' :: DeleteRecord -> Maybe (NonEmpty TargetStore)
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ ByteString
"TargetStores"
          forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: forall a. ToQuery a => a -> QueryString
Data.toQuery
            (forall a.
(IsList a, ToQuery (Item a)) =>
ByteString -> a -> QueryString
Data.toQueryList ByteString
"member" forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe (NonEmpty TargetStore)
targetStores),
        ByteString
"RecordIdentifierValueAsString"
          forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Text
recordIdentifierValueAsString,
        ByteString
"EventTime" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Text
eventTime
      ]

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

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

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