{-# 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.ListExperiments
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Lists your experiments.
module Amazonka.FIS.ListExperiments
  ( -- * Creating a Request
    ListExperiments (..),
    newListExperiments,

    -- * Request Lenses
    listExperiments_maxResults,
    listExperiments_nextToken,

    -- * Destructuring the Response
    ListExperimentsResponse (..),
    newListExperimentsResponse,

    -- * Response Lenses
    listExperimentsResponse_experiments,
    listExperimentsResponse_nextToken,
    listExperimentsResponse_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:/ 'newListExperiments' smart constructor.
data ListExperiments = ListExperiments'
  { -- | The maximum number of results to return with a single call. To retrieve
    -- the remaining results, make another call with the returned @nextToken@
    -- value.
    ListExperiments -> Maybe Natural
maxResults :: Prelude.Maybe Prelude.Natural,
    -- | The token for the next page of results.
    ListExperiments -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text
  }
  deriving (ListExperiments -> ListExperiments -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListExperiments -> ListExperiments -> Bool
$c/= :: ListExperiments -> ListExperiments -> Bool
== :: ListExperiments -> ListExperiments -> Bool
$c== :: ListExperiments -> ListExperiments -> Bool
Prelude.Eq, ReadPrec [ListExperiments]
ReadPrec ListExperiments
Int -> ReadS ListExperiments
ReadS [ListExperiments]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListExperiments]
$creadListPrec :: ReadPrec [ListExperiments]
readPrec :: ReadPrec ListExperiments
$creadPrec :: ReadPrec ListExperiments
readList :: ReadS [ListExperiments]
$creadList :: ReadS [ListExperiments]
readsPrec :: Int -> ReadS ListExperiments
$creadsPrec :: Int -> ReadS ListExperiments
Prelude.Read, Int -> ListExperiments -> ShowS
[ListExperiments] -> ShowS
ListExperiments -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListExperiments] -> ShowS
$cshowList :: [ListExperiments] -> ShowS
show :: ListExperiments -> String
$cshow :: ListExperiments -> String
showsPrec :: Int -> ListExperiments -> ShowS
$cshowsPrec :: Int -> ListExperiments -> ShowS
Prelude.Show, forall x. Rep ListExperiments x -> ListExperiments
forall x. ListExperiments -> Rep ListExperiments x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListExperiments x -> ListExperiments
$cfrom :: forall x. ListExperiments -> Rep ListExperiments x
Prelude.Generic)

-- |
-- Create a value of 'ListExperiments' 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:
--
-- 'maxResults', 'listExperiments_maxResults' - The maximum number of results to return with a single call. To retrieve
-- the remaining results, make another call with the returned @nextToken@
-- value.
--
-- 'nextToken', 'listExperiments_nextToken' - The token for the next page of results.
newListExperiments ::
  ListExperiments
newListExperiments :: ListExperiments
newListExperiments =
  ListExperiments'
    { $sel:maxResults:ListExperiments' :: Maybe Natural
maxResults = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:ListExperiments' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing
    }

-- | The maximum number of results to return with a single call. To retrieve
-- the remaining results, make another call with the returned @nextToken@
-- value.
listExperiments_maxResults :: Lens.Lens' ListExperiments (Prelude.Maybe Prelude.Natural)
listExperiments_maxResults :: Lens' ListExperiments (Maybe Natural)
listExperiments_maxResults = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListExperiments' {Maybe Natural
maxResults :: Maybe Natural
$sel:maxResults:ListExperiments' :: ListExperiments -> Maybe Natural
maxResults} -> Maybe Natural
maxResults) (\s :: ListExperiments
s@ListExperiments' {} Maybe Natural
a -> ListExperiments
s {$sel:maxResults:ListExperiments' :: Maybe Natural
maxResults = Maybe Natural
a} :: ListExperiments)

-- | The token for the next page of results.
listExperiments_nextToken :: Lens.Lens' ListExperiments (Prelude.Maybe Prelude.Text)
listExperiments_nextToken :: Lens' ListExperiments (Maybe Text)
listExperiments_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListExperiments' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListExperiments' :: ListExperiments -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListExperiments
s@ListExperiments' {} Maybe Text
a -> ListExperiments
s {$sel:nextToken:ListExperiments' :: Maybe Text
nextToken = Maybe Text
a} :: ListExperiments)

instance Core.AWSRequest ListExperiments where
  type
    AWSResponse ListExperiments =
      ListExperimentsResponse
  request :: (Service -> Service) -> ListExperiments -> Request ListExperiments
request Service -> Service
overrides =
    forall a. ToRequest a => Service -> a -> Request a
Request.get (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy ListExperiments
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse ListExperiments)))
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 [ExperimentSummary]
-> Maybe Text -> Int -> ListExperimentsResponse
ListExperimentsResponse'
            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
"experiments" forall (f :: * -> *) a. Functor f => f (Maybe a) -> a -> f a
Core..!@ forall a. Monoid a => a
Prelude.mempty)
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"nextToken")
            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 ListExperiments where
  hashWithSalt :: Int -> ListExperiments -> Int
hashWithSalt Int
_salt ListExperiments' {Maybe Natural
Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:nextToken:ListExperiments' :: ListExperiments -> Maybe Text
$sel:maxResults:ListExperiments' :: ListExperiments -> Maybe Natural
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Natural
maxResults
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
nextToken

instance Prelude.NFData ListExperiments where
  rnf :: ListExperiments -> ()
rnf ListExperiments' {Maybe Natural
Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:nextToken:ListExperiments' :: ListExperiments -> Maybe Text
$sel:maxResults:ListExperiments' :: ListExperiments -> Maybe Natural
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Natural
maxResults
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
nextToken

instance Data.ToHeaders ListExperiments where
  toHeaders :: ListExperiments -> 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.ToPath ListExperiments where
  toPath :: ListExperiments -> ByteString
toPath = forall a b. a -> b -> a
Prelude.const ByteString
"/experiments"

instance Data.ToQuery ListExperiments where
  toQuery :: ListExperiments -> QueryString
toQuery ListExperiments' {Maybe Natural
Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:nextToken:ListExperiments' :: ListExperiments -> Maybe Text
$sel:maxResults:ListExperiments' :: ListExperiments -> Maybe Natural
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ ByteString
"maxResults" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Natural
maxResults,
        ByteString
"nextToken" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Text
nextToken
      ]

-- | /See:/ 'newListExperimentsResponse' smart constructor.
data ListExperimentsResponse = ListExperimentsResponse'
  { -- | The experiments.
    ListExperimentsResponse -> Maybe [ExperimentSummary]
experiments :: Prelude.Maybe [ExperimentSummary],
    -- | The token to use to retrieve the next page of results. This value is
    -- @null@ when there are no more results to return.
    ListExperimentsResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The response's http status code.
    ListExperimentsResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (ListExperimentsResponse -> ListExperimentsResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListExperimentsResponse -> ListExperimentsResponse -> Bool
$c/= :: ListExperimentsResponse -> ListExperimentsResponse -> Bool
== :: ListExperimentsResponse -> ListExperimentsResponse -> Bool
$c== :: ListExperimentsResponse -> ListExperimentsResponse -> Bool
Prelude.Eq, ReadPrec [ListExperimentsResponse]
ReadPrec ListExperimentsResponse
Int -> ReadS ListExperimentsResponse
ReadS [ListExperimentsResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListExperimentsResponse]
$creadListPrec :: ReadPrec [ListExperimentsResponse]
readPrec :: ReadPrec ListExperimentsResponse
$creadPrec :: ReadPrec ListExperimentsResponse
readList :: ReadS [ListExperimentsResponse]
$creadList :: ReadS [ListExperimentsResponse]
readsPrec :: Int -> ReadS ListExperimentsResponse
$creadsPrec :: Int -> ReadS ListExperimentsResponse
Prelude.Read, Int -> ListExperimentsResponse -> ShowS
[ListExperimentsResponse] -> ShowS
ListExperimentsResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListExperimentsResponse] -> ShowS
$cshowList :: [ListExperimentsResponse] -> ShowS
show :: ListExperimentsResponse -> String
$cshow :: ListExperimentsResponse -> String
showsPrec :: Int -> ListExperimentsResponse -> ShowS
$cshowsPrec :: Int -> ListExperimentsResponse -> ShowS
Prelude.Show, forall x. Rep ListExperimentsResponse x -> ListExperimentsResponse
forall x. ListExperimentsResponse -> Rep ListExperimentsResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListExperimentsResponse x -> ListExperimentsResponse
$cfrom :: forall x. ListExperimentsResponse -> Rep ListExperimentsResponse x
Prelude.Generic)

-- |
-- Create a value of 'ListExperimentsResponse' 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:
--
-- 'experiments', 'listExperimentsResponse_experiments' - The experiments.
--
-- 'nextToken', 'listExperimentsResponse_nextToken' - The token to use to retrieve the next page of results. This value is
-- @null@ when there are no more results to return.
--
-- 'httpStatus', 'listExperimentsResponse_httpStatus' - The response's http status code.
newListExperimentsResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  ListExperimentsResponse
newListExperimentsResponse :: Int -> ListExperimentsResponse
newListExperimentsResponse Int
pHttpStatus_ =
  ListExperimentsResponse'
    { $sel:experiments:ListExperimentsResponse' :: Maybe [ExperimentSummary]
experiments =
        forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:ListExperimentsResponse' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:ListExperimentsResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | The experiments.
listExperimentsResponse_experiments :: Lens.Lens' ListExperimentsResponse (Prelude.Maybe [ExperimentSummary])
listExperimentsResponse_experiments :: Lens' ListExperimentsResponse (Maybe [ExperimentSummary])
listExperimentsResponse_experiments = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListExperimentsResponse' {Maybe [ExperimentSummary]
experiments :: Maybe [ExperimentSummary]
$sel:experiments:ListExperimentsResponse' :: ListExperimentsResponse -> Maybe [ExperimentSummary]
experiments} -> Maybe [ExperimentSummary]
experiments) (\s :: ListExperimentsResponse
s@ListExperimentsResponse' {} Maybe [ExperimentSummary]
a -> ListExperimentsResponse
s {$sel:experiments:ListExperimentsResponse' :: Maybe [ExperimentSummary]
experiments = Maybe [ExperimentSummary]
a} :: ListExperimentsResponse) 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 token to use to retrieve the next page of results. This value is
-- @null@ when there are no more results to return.
listExperimentsResponse_nextToken :: Lens.Lens' ListExperimentsResponse (Prelude.Maybe Prelude.Text)
listExperimentsResponse_nextToken :: Lens' ListExperimentsResponse (Maybe Text)
listExperimentsResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListExperimentsResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListExperimentsResponse' :: ListExperimentsResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListExperimentsResponse
s@ListExperimentsResponse' {} Maybe Text
a -> ListExperimentsResponse
s {$sel:nextToken:ListExperimentsResponse' :: Maybe Text
nextToken = Maybe Text
a} :: ListExperimentsResponse)

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

instance Prelude.NFData ListExperimentsResponse where
  rnf :: ListExperimentsResponse -> ()
rnf ListExperimentsResponse' {Int
Maybe [ExperimentSummary]
Maybe Text
httpStatus :: Int
nextToken :: Maybe Text
experiments :: Maybe [ExperimentSummary]
$sel:httpStatus:ListExperimentsResponse' :: ListExperimentsResponse -> Int
$sel:nextToken:ListExperimentsResponse' :: ListExperimentsResponse -> Maybe Text
$sel:experiments:ListExperimentsResponse' :: ListExperimentsResponse -> Maybe [ExperimentSummary]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [ExperimentSummary]
experiments
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
nextToken
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus