{-# 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.FIS.StartExperiment
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Starts running an experiment from the specified experiment template.
module Amazonka.FIS.StartExperiment
  ( -- * Creating a Request
    StartExperiment (..),
    newStartExperiment,

    -- * Request Lenses
    startExperiment_tags,
    startExperiment_clientToken,
    startExperiment_experimentTemplateId,

    -- * Destructuring the Response
    StartExperimentResponse (..),
    newStartExperimentResponse,

    -- * Response Lenses
    startExperimentResponse_experiment,
    startExperimentResponse_httpStatus,
  )
where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.FIS.Types
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response

-- | /See:/ 'newStartExperiment' smart constructor.
data StartExperiment = StartExperiment'
  { -- | The tags to apply to the experiment.
    StartExperiment -> Maybe (HashMap Text Text)
tags :: Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text),
    -- | Unique, case-sensitive identifier that you provide to ensure the
    -- idempotency of the request.
    StartExperiment -> Text
clientToken :: Prelude.Text,
    -- | The ID of the experiment template.
    StartExperiment -> Text
experimentTemplateId :: Prelude.Text
  }
  deriving (StartExperiment -> StartExperiment -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: StartExperiment -> StartExperiment -> Bool
$c/= :: StartExperiment -> StartExperiment -> Bool
== :: StartExperiment -> StartExperiment -> Bool
$c== :: StartExperiment -> StartExperiment -> Bool
Prelude.Eq, ReadPrec [StartExperiment]
ReadPrec StartExperiment
Int -> ReadS StartExperiment
ReadS [StartExperiment]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [StartExperiment]
$creadListPrec :: ReadPrec [StartExperiment]
readPrec :: ReadPrec StartExperiment
$creadPrec :: ReadPrec StartExperiment
readList :: ReadS [StartExperiment]
$creadList :: ReadS [StartExperiment]
readsPrec :: Int -> ReadS StartExperiment
$creadsPrec :: Int -> ReadS StartExperiment
Prelude.Read, Int -> StartExperiment -> ShowS
[StartExperiment] -> ShowS
StartExperiment -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [StartExperiment] -> ShowS
$cshowList :: [StartExperiment] -> ShowS
show :: StartExperiment -> String
$cshow :: StartExperiment -> String
showsPrec :: Int -> StartExperiment -> ShowS
$cshowsPrec :: Int -> StartExperiment -> ShowS
Prelude.Show, forall x. Rep StartExperiment x -> StartExperiment
forall x. StartExperiment -> Rep StartExperiment x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep StartExperiment x -> StartExperiment
$cfrom :: forall x. StartExperiment -> Rep StartExperiment x
Prelude.Generic)

-- |
-- Create a value of 'StartExperiment' 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:
--
-- 'tags', 'startExperiment_tags' - The tags to apply to the experiment.
--
-- 'clientToken', 'startExperiment_clientToken' - Unique, case-sensitive identifier that you provide to ensure the
-- idempotency of the request.
--
-- 'experimentTemplateId', 'startExperiment_experimentTemplateId' - The ID of the experiment template.
newStartExperiment ::
  -- | 'clientToken'
  Prelude.Text ->
  -- | 'experimentTemplateId'
  Prelude.Text ->
  StartExperiment
newStartExperiment :: Text -> Text -> StartExperiment
newStartExperiment
  Text
pClientToken_
  Text
pExperimentTemplateId_ =
    StartExperiment'
      { $sel:tags:StartExperiment' :: Maybe (HashMap Text Text)
tags = forall a. Maybe a
Prelude.Nothing,
        $sel:clientToken:StartExperiment' :: Text
clientToken = Text
pClientToken_,
        $sel:experimentTemplateId:StartExperiment' :: Text
experimentTemplateId = Text
pExperimentTemplateId_
      }

-- | The tags to apply to the experiment.
startExperiment_tags :: Lens.Lens' StartExperiment (Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text))
startExperiment_tags :: Lens' StartExperiment (Maybe (HashMap Text Text))
startExperiment_tags = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\StartExperiment' {Maybe (HashMap Text Text)
tags :: Maybe (HashMap Text Text)
$sel:tags:StartExperiment' :: StartExperiment -> Maybe (HashMap Text Text)
tags} -> Maybe (HashMap Text Text)
tags) (\s :: StartExperiment
s@StartExperiment' {} Maybe (HashMap Text Text)
a -> StartExperiment
s {$sel:tags:StartExperiment' :: Maybe (HashMap Text Text)
tags = Maybe (HashMap Text Text)
a} :: StartExperiment) 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

-- | Unique, case-sensitive identifier that you provide to ensure the
-- idempotency of the request.
startExperiment_clientToken :: Lens.Lens' StartExperiment Prelude.Text
startExperiment_clientToken :: Lens' StartExperiment Text
startExperiment_clientToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\StartExperiment' {Text
clientToken :: Text
$sel:clientToken:StartExperiment' :: StartExperiment -> Text
clientToken} -> Text
clientToken) (\s :: StartExperiment
s@StartExperiment' {} Text
a -> StartExperiment
s {$sel:clientToken:StartExperiment' :: Text
clientToken = Text
a} :: StartExperiment)

-- | The ID of the experiment template.
startExperiment_experimentTemplateId :: Lens.Lens' StartExperiment Prelude.Text
startExperiment_experimentTemplateId :: Lens' StartExperiment Text
startExperiment_experimentTemplateId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\StartExperiment' {Text
experimentTemplateId :: Text
$sel:experimentTemplateId:StartExperiment' :: StartExperiment -> Text
experimentTemplateId} -> Text
experimentTemplateId) (\s :: StartExperiment
s@StartExperiment' {} Text
a -> StartExperiment
s {$sel:experimentTemplateId:StartExperiment' :: Text
experimentTemplateId = Text
a} :: StartExperiment)

instance Core.AWSRequest StartExperiment where
  type
    AWSResponse StartExperiment =
      StartExperimentResponse
  request :: (Service -> Service) -> StartExperiment -> Request StartExperiment
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 StartExperiment
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse StartExperiment)))
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 Experiment -> Int -> StartExperimentResponse
StartExperimentResponse'
            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
"experiment")
            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 StartExperiment where
  hashWithSalt :: Int -> StartExperiment -> Int
hashWithSalt Int
_salt StartExperiment' {Maybe (HashMap Text Text)
Text
experimentTemplateId :: Text
clientToken :: Text
tags :: Maybe (HashMap Text Text)
$sel:experimentTemplateId:StartExperiment' :: StartExperiment -> Text
$sel:clientToken:StartExperiment' :: StartExperiment -> Text
$sel:tags:StartExperiment' :: StartExperiment -> Maybe (HashMap Text Text)
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (HashMap Text Text)
tags
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
clientToken
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
experimentTemplateId

instance Prelude.NFData StartExperiment where
  rnf :: StartExperiment -> ()
rnf StartExperiment' {Maybe (HashMap Text Text)
Text
experimentTemplateId :: Text
clientToken :: Text
tags :: Maybe (HashMap Text Text)
$sel:experimentTemplateId:StartExperiment' :: StartExperiment -> Text
$sel:clientToken:StartExperiment' :: StartExperiment -> Text
$sel:tags:StartExperiment' :: StartExperiment -> Maybe (HashMap Text Text)
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe (HashMap Text Text)
tags
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
clientToken
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
experimentTemplateId

instance Data.ToHeaders StartExperiment where
  toHeaders :: StartExperiment -> ResponseHeaders
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 -> ResponseHeaders
Data.=# ( ByteString
"application/x-amz-json-1.1" ::
                          Prelude.ByteString
                      )
          ]
      )

instance Data.ToJSON StartExperiment where
  toJSON :: StartExperiment -> Value
toJSON StartExperiment' {Maybe (HashMap Text Text)
Text
experimentTemplateId :: Text
clientToken :: Text
tags :: Maybe (HashMap Text Text)
$sel:experimentTemplateId:StartExperiment' :: StartExperiment -> Text
$sel:clientToken:StartExperiment' :: StartExperiment -> Text
$sel:tags:StartExperiment' :: StartExperiment -> Maybe (HashMap Text Text)
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"tags" 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 (HashMap Text Text)
tags,
            forall a. a -> Maybe a
Prelude.Just (Key
"clientToken" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
clientToken),
            forall a. a -> Maybe a
Prelude.Just
              ( Key
"experimentTemplateId"
                  forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
experimentTemplateId
              )
          ]
      )

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

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

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

-- |
-- Create a value of 'StartExperimentResponse' 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:
--
-- 'experiment', 'startExperimentResponse_experiment' - Information about the experiment.
--
-- 'httpStatus', 'startExperimentResponse_httpStatus' - The response's http status code.
newStartExperimentResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  StartExperimentResponse
newStartExperimentResponse :: Int -> StartExperimentResponse
newStartExperimentResponse Int
pHttpStatus_ =
  StartExperimentResponse'
    { $sel:experiment:StartExperimentResponse' :: Maybe Experiment
experiment =
        forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:StartExperimentResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | Information about the experiment.
startExperimentResponse_experiment :: Lens.Lens' StartExperimentResponse (Prelude.Maybe Experiment)
startExperimentResponse_experiment :: Lens' StartExperimentResponse (Maybe Experiment)
startExperimentResponse_experiment = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\StartExperimentResponse' {Maybe Experiment
experiment :: Maybe Experiment
$sel:experiment:StartExperimentResponse' :: StartExperimentResponse -> Maybe Experiment
experiment} -> Maybe Experiment
experiment) (\s :: StartExperimentResponse
s@StartExperimentResponse' {} Maybe Experiment
a -> StartExperimentResponse
s {$sel:experiment:StartExperimentResponse' :: Maybe Experiment
experiment = Maybe Experiment
a} :: StartExperimentResponse)

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

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