{-# 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.SageMaker.DeleteExperiment
-- 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 an SageMaker experiment. All trials associated with the
-- experiment must be deleted first. Use the ListTrials API to get a list
-- of the trials associated with the experiment.
module Amazonka.SageMaker.DeleteExperiment
  ( -- * Creating a Request
    DeleteExperiment (..),
    newDeleteExperiment,

    -- * Request Lenses
    deleteExperiment_experimentName,

    -- * Destructuring the Response
    DeleteExperimentResponse (..),
    newDeleteExperimentResponse,

    -- * Response Lenses
    deleteExperimentResponse_experimentArn,
    deleteExperimentResponse_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.SageMaker.Types

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

-- |
-- Create a value of 'DeleteExperiment' 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:
--
-- 'experimentName', 'deleteExperiment_experimentName' - The name of the experiment to delete.
newDeleteExperiment ::
  -- | 'experimentName'
  Prelude.Text ->
  DeleteExperiment
newDeleteExperiment :: Text -> DeleteExperiment
newDeleteExperiment Text
pExperimentName_ =
  DeleteExperiment'
    { $sel:experimentName:DeleteExperiment' :: Text
experimentName =
        Text
pExperimentName_
    }

-- | The name of the experiment to delete.
deleteExperiment_experimentName :: Lens.Lens' DeleteExperiment Prelude.Text
deleteExperiment_experimentName :: Lens' DeleteExperiment Text
deleteExperiment_experimentName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DeleteExperiment' {Text
experimentName :: Text
$sel:experimentName:DeleteExperiment' :: DeleteExperiment -> Text
experimentName} -> Text
experimentName) (\s :: DeleteExperiment
s@DeleteExperiment' {} Text
a -> DeleteExperiment
s {$sel:experimentName:DeleteExperiment' :: Text
experimentName = Text
a} :: DeleteExperiment)

instance Core.AWSRequest DeleteExperiment where
  type
    AWSResponse DeleteExperiment =
      DeleteExperimentResponse
  request :: (Service -> Service)
-> DeleteExperiment -> Request DeleteExperiment
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 DeleteExperiment
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse DeleteExperiment)))
response =
    forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> Object -> Either String (AWSResponse a))
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveJSON
      ( \Int
s ResponseHeaders
h Object
x ->
          Maybe Text -> Int -> DeleteExperimentResponse
DeleteExperimentResponse'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"ExperimentArn")
            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 DeleteExperiment where
  hashWithSalt :: Int -> DeleteExperiment -> Int
hashWithSalt Int
_salt DeleteExperiment' {Text
experimentName :: Text
$sel:experimentName:DeleteExperiment' :: DeleteExperiment -> Text
..} =
    Int
_salt forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
experimentName

instance Prelude.NFData DeleteExperiment where
  rnf :: DeleteExperiment -> ()
rnf DeleteExperiment' {Text
experimentName :: Text
$sel:experimentName:DeleteExperiment' :: DeleteExperiment -> Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Text
experimentName

instance Data.ToHeaders DeleteExperiment where
  toHeaders :: DeleteExperiment -> 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
"SageMaker.DeleteExperiment" :: 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 DeleteExperiment where
  toJSON :: DeleteExperiment -> Value
toJSON DeleteExperiment' {Text
experimentName :: Text
$sel:experimentName:DeleteExperiment' :: DeleteExperiment -> Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ forall a. a -> Maybe a
Prelude.Just
              (Key
"ExperimentName" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
experimentName)
          ]
      )

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

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

-- | /See:/ 'newDeleteExperimentResponse' smart constructor.
data DeleteExperimentResponse = DeleteExperimentResponse'
  { -- | The Amazon Resource Name (ARN) of the experiment that is being deleted.
    DeleteExperimentResponse -> Maybe Text
experimentArn :: Prelude.Maybe Prelude.Text,
    -- | The response's http status code.
    DeleteExperimentResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (DeleteExperimentResponse -> DeleteExperimentResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DeleteExperimentResponse -> DeleteExperimentResponse -> Bool
$c/= :: DeleteExperimentResponse -> DeleteExperimentResponse -> Bool
== :: DeleteExperimentResponse -> DeleteExperimentResponse -> Bool
$c== :: DeleteExperimentResponse -> DeleteExperimentResponse -> Bool
Prelude.Eq, ReadPrec [DeleteExperimentResponse]
ReadPrec DeleteExperimentResponse
Int -> ReadS DeleteExperimentResponse
ReadS [DeleteExperimentResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DeleteExperimentResponse]
$creadListPrec :: ReadPrec [DeleteExperimentResponse]
readPrec :: ReadPrec DeleteExperimentResponse
$creadPrec :: ReadPrec DeleteExperimentResponse
readList :: ReadS [DeleteExperimentResponse]
$creadList :: ReadS [DeleteExperimentResponse]
readsPrec :: Int -> ReadS DeleteExperimentResponse
$creadsPrec :: Int -> ReadS DeleteExperimentResponse
Prelude.Read, Int -> DeleteExperimentResponse -> ShowS
[DeleteExperimentResponse] -> ShowS
DeleteExperimentResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DeleteExperimentResponse] -> ShowS
$cshowList :: [DeleteExperimentResponse] -> ShowS
show :: DeleteExperimentResponse -> String
$cshow :: DeleteExperimentResponse -> String
showsPrec :: Int -> DeleteExperimentResponse -> ShowS
$cshowsPrec :: Int -> DeleteExperimentResponse -> ShowS
Prelude.Show, forall x.
Rep DeleteExperimentResponse x -> DeleteExperimentResponse
forall x.
DeleteExperimentResponse -> Rep DeleteExperimentResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep DeleteExperimentResponse x -> DeleteExperimentResponse
$cfrom :: forall x.
DeleteExperimentResponse -> Rep DeleteExperimentResponse x
Prelude.Generic)

-- |
-- Create a value of 'DeleteExperimentResponse' 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:
--
-- 'experimentArn', 'deleteExperimentResponse_experimentArn' - The Amazon Resource Name (ARN) of the experiment that is being deleted.
--
-- 'httpStatus', 'deleteExperimentResponse_httpStatus' - The response's http status code.
newDeleteExperimentResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  DeleteExperimentResponse
newDeleteExperimentResponse :: Int -> DeleteExperimentResponse
newDeleteExperimentResponse Int
pHttpStatus_ =
  DeleteExperimentResponse'
    { $sel:experimentArn:DeleteExperimentResponse' :: Maybe Text
experimentArn =
        forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:DeleteExperimentResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | The Amazon Resource Name (ARN) of the experiment that is being deleted.
deleteExperimentResponse_experimentArn :: Lens.Lens' DeleteExperimentResponse (Prelude.Maybe Prelude.Text)
deleteExperimentResponse_experimentArn :: Lens' DeleteExperimentResponse (Maybe Text)
deleteExperimentResponse_experimentArn = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DeleteExperimentResponse' {Maybe Text
experimentArn :: Maybe Text
$sel:experimentArn:DeleteExperimentResponse' :: DeleteExperimentResponse -> Maybe Text
experimentArn} -> Maybe Text
experimentArn) (\s :: DeleteExperimentResponse
s@DeleteExperimentResponse' {} Maybe Text
a -> DeleteExperimentResponse
s {$sel:experimentArn:DeleteExperimentResponse' :: Maybe Text
experimentArn = Maybe Text
a} :: DeleteExperimentResponse)

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

instance Prelude.NFData DeleteExperimentResponse where
  rnf :: DeleteExperimentResponse -> ()
rnf DeleteExperimentResponse' {Int
Maybe Text
httpStatus :: Int
experimentArn :: Maybe Text
$sel:httpStatus:DeleteExperimentResponse' :: DeleteExperimentResponse -> Int
$sel:experimentArn:DeleteExperimentResponse' :: DeleteExperimentResponse -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
experimentArn
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus