{-# 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.IoTDeviceAdvisor.ListSuiteDefinitions
-- 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 the Device Advisor test suites you have created.
--
-- Requires permission to access the
-- <https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions ListSuiteDefinitions>
-- action.
module Amazonka.IoTDeviceAdvisor.ListSuiteDefinitions
  ( -- * Creating a Request
    ListSuiteDefinitions (..),
    newListSuiteDefinitions,

    -- * Request Lenses
    listSuiteDefinitions_maxResults,
    listSuiteDefinitions_nextToken,

    -- * Destructuring the Response
    ListSuiteDefinitionsResponse (..),
    newListSuiteDefinitionsResponse,

    -- * Response Lenses
    listSuiteDefinitionsResponse_nextToken,
    listSuiteDefinitionsResponse_suiteDefinitionInformationList,
    listSuiteDefinitionsResponse_httpStatus,
  )
where

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

-- | /See:/ 'newListSuiteDefinitions' smart constructor.
data ListSuiteDefinitions = ListSuiteDefinitions'
  { -- | The maximum number of results to return at once.
    ListSuiteDefinitions -> Maybe Natural
maxResults :: Prelude.Maybe Prelude.Natural,
    -- | A token used to get the next set of results.
    ListSuiteDefinitions -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text
  }
  deriving (ListSuiteDefinitions -> ListSuiteDefinitions -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListSuiteDefinitions -> ListSuiteDefinitions -> Bool
$c/= :: ListSuiteDefinitions -> ListSuiteDefinitions -> Bool
== :: ListSuiteDefinitions -> ListSuiteDefinitions -> Bool
$c== :: ListSuiteDefinitions -> ListSuiteDefinitions -> Bool
Prelude.Eq, ReadPrec [ListSuiteDefinitions]
ReadPrec ListSuiteDefinitions
Int -> ReadS ListSuiteDefinitions
ReadS [ListSuiteDefinitions]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListSuiteDefinitions]
$creadListPrec :: ReadPrec [ListSuiteDefinitions]
readPrec :: ReadPrec ListSuiteDefinitions
$creadPrec :: ReadPrec ListSuiteDefinitions
readList :: ReadS [ListSuiteDefinitions]
$creadList :: ReadS [ListSuiteDefinitions]
readsPrec :: Int -> ReadS ListSuiteDefinitions
$creadsPrec :: Int -> ReadS ListSuiteDefinitions
Prelude.Read, Int -> ListSuiteDefinitions -> ShowS
[ListSuiteDefinitions] -> ShowS
ListSuiteDefinitions -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListSuiteDefinitions] -> ShowS
$cshowList :: [ListSuiteDefinitions] -> ShowS
show :: ListSuiteDefinitions -> String
$cshow :: ListSuiteDefinitions -> String
showsPrec :: Int -> ListSuiteDefinitions -> ShowS
$cshowsPrec :: Int -> ListSuiteDefinitions -> ShowS
Prelude.Show, forall x. Rep ListSuiteDefinitions x -> ListSuiteDefinitions
forall x. ListSuiteDefinitions -> Rep ListSuiteDefinitions x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListSuiteDefinitions x -> ListSuiteDefinitions
$cfrom :: forall x. ListSuiteDefinitions -> Rep ListSuiteDefinitions x
Prelude.Generic)

-- |
-- Create a value of 'ListSuiteDefinitions' 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', 'listSuiteDefinitions_maxResults' - The maximum number of results to return at once.
--
-- 'nextToken', 'listSuiteDefinitions_nextToken' - A token used to get the next set of results.
newListSuiteDefinitions ::
  ListSuiteDefinitions
newListSuiteDefinitions :: ListSuiteDefinitions
newListSuiteDefinitions =
  ListSuiteDefinitions'
    { $sel:maxResults:ListSuiteDefinitions' :: Maybe Natural
maxResults = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:ListSuiteDefinitions' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing
    }

-- | The maximum number of results to return at once.
listSuiteDefinitions_maxResults :: Lens.Lens' ListSuiteDefinitions (Prelude.Maybe Prelude.Natural)
listSuiteDefinitions_maxResults :: Lens' ListSuiteDefinitions (Maybe Natural)
listSuiteDefinitions_maxResults = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListSuiteDefinitions' {Maybe Natural
maxResults :: Maybe Natural
$sel:maxResults:ListSuiteDefinitions' :: ListSuiteDefinitions -> Maybe Natural
maxResults} -> Maybe Natural
maxResults) (\s :: ListSuiteDefinitions
s@ListSuiteDefinitions' {} Maybe Natural
a -> ListSuiteDefinitions
s {$sel:maxResults:ListSuiteDefinitions' :: Maybe Natural
maxResults = Maybe Natural
a} :: ListSuiteDefinitions)

-- | A token used to get the next set of results.
listSuiteDefinitions_nextToken :: Lens.Lens' ListSuiteDefinitions (Prelude.Maybe Prelude.Text)
listSuiteDefinitions_nextToken :: Lens' ListSuiteDefinitions (Maybe Text)
listSuiteDefinitions_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListSuiteDefinitions' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListSuiteDefinitions' :: ListSuiteDefinitions -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListSuiteDefinitions
s@ListSuiteDefinitions' {} Maybe Text
a -> ListSuiteDefinitions
s {$sel:nextToken:ListSuiteDefinitions' :: Maybe Text
nextToken = Maybe Text
a} :: ListSuiteDefinitions)

instance Core.AWSRequest ListSuiteDefinitions where
  type
    AWSResponse ListSuiteDefinitions =
      ListSuiteDefinitionsResponse
  request :: (Service -> Service)
-> ListSuiteDefinitions -> Request ListSuiteDefinitions
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 ListSuiteDefinitions
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse ListSuiteDefinitions)))
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
-> Maybe [SuiteDefinitionInformation]
-> Int
-> ListSuiteDefinitionsResponse
ListSuiteDefinitionsResponse'
            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
"nextToken")
            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
"suiteDefinitionInformationList"
                            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.<*> (forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
      )

instance Prelude.Hashable ListSuiteDefinitions where
  hashWithSalt :: Int -> ListSuiteDefinitions -> Int
hashWithSalt Int
_salt ListSuiteDefinitions' {Maybe Natural
Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:nextToken:ListSuiteDefinitions' :: ListSuiteDefinitions -> Maybe Text
$sel:maxResults:ListSuiteDefinitions' :: ListSuiteDefinitions -> 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 ListSuiteDefinitions where
  rnf :: ListSuiteDefinitions -> ()
rnf ListSuiteDefinitions' {Maybe Natural
Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:nextToken:ListSuiteDefinitions' :: ListSuiteDefinitions -> Maybe Text
$sel:maxResults:ListSuiteDefinitions' :: ListSuiteDefinitions -> 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 ListSuiteDefinitions where
  toHeaders :: ListSuiteDefinitions -> 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 ListSuiteDefinitions where
  toPath :: ListSuiteDefinitions -> ByteString
toPath = forall a b. a -> b -> a
Prelude.const ByteString
"/suiteDefinitions"

instance Data.ToQuery ListSuiteDefinitions where
  toQuery :: ListSuiteDefinitions -> QueryString
toQuery ListSuiteDefinitions' {Maybe Natural
Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:nextToken:ListSuiteDefinitions' :: ListSuiteDefinitions -> Maybe Text
$sel:maxResults:ListSuiteDefinitions' :: ListSuiteDefinitions -> 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:/ 'newListSuiteDefinitionsResponse' smart constructor.
data ListSuiteDefinitionsResponse = ListSuiteDefinitionsResponse'
  { -- | A token used to get the next set of results.
    ListSuiteDefinitionsResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | An array of objects that provide summaries of information about the
    -- suite definitions in the list.
    ListSuiteDefinitionsResponse -> Maybe [SuiteDefinitionInformation]
suiteDefinitionInformationList :: Prelude.Maybe [SuiteDefinitionInformation],
    -- | The response's http status code.
    ListSuiteDefinitionsResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (ListSuiteDefinitionsResponse
-> ListSuiteDefinitionsResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListSuiteDefinitionsResponse
-> ListSuiteDefinitionsResponse -> Bool
$c/= :: ListSuiteDefinitionsResponse
-> ListSuiteDefinitionsResponse -> Bool
== :: ListSuiteDefinitionsResponse
-> ListSuiteDefinitionsResponse -> Bool
$c== :: ListSuiteDefinitionsResponse
-> ListSuiteDefinitionsResponse -> Bool
Prelude.Eq, ReadPrec [ListSuiteDefinitionsResponse]
ReadPrec ListSuiteDefinitionsResponse
Int -> ReadS ListSuiteDefinitionsResponse
ReadS [ListSuiteDefinitionsResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListSuiteDefinitionsResponse]
$creadListPrec :: ReadPrec [ListSuiteDefinitionsResponse]
readPrec :: ReadPrec ListSuiteDefinitionsResponse
$creadPrec :: ReadPrec ListSuiteDefinitionsResponse
readList :: ReadS [ListSuiteDefinitionsResponse]
$creadList :: ReadS [ListSuiteDefinitionsResponse]
readsPrec :: Int -> ReadS ListSuiteDefinitionsResponse
$creadsPrec :: Int -> ReadS ListSuiteDefinitionsResponse
Prelude.Read, Int -> ListSuiteDefinitionsResponse -> ShowS
[ListSuiteDefinitionsResponse] -> ShowS
ListSuiteDefinitionsResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListSuiteDefinitionsResponse] -> ShowS
$cshowList :: [ListSuiteDefinitionsResponse] -> ShowS
show :: ListSuiteDefinitionsResponse -> String
$cshow :: ListSuiteDefinitionsResponse -> String
showsPrec :: Int -> ListSuiteDefinitionsResponse -> ShowS
$cshowsPrec :: Int -> ListSuiteDefinitionsResponse -> ShowS
Prelude.Show, forall x.
Rep ListSuiteDefinitionsResponse x -> ListSuiteDefinitionsResponse
forall x.
ListSuiteDefinitionsResponse -> Rep ListSuiteDefinitionsResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep ListSuiteDefinitionsResponse x -> ListSuiteDefinitionsResponse
$cfrom :: forall x.
ListSuiteDefinitionsResponse -> Rep ListSuiteDefinitionsResponse x
Prelude.Generic)

-- |
-- Create a value of 'ListSuiteDefinitionsResponse' 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:
--
-- 'nextToken', 'listSuiteDefinitionsResponse_nextToken' - A token used to get the next set of results.
--
-- 'suiteDefinitionInformationList', 'listSuiteDefinitionsResponse_suiteDefinitionInformationList' - An array of objects that provide summaries of information about the
-- suite definitions in the list.
--
-- 'httpStatus', 'listSuiteDefinitionsResponse_httpStatus' - The response's http status code.
newListSuiteDefinitionsResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  ListSuiteDefinitionsResponse
newListSuiteDefinitionsResponse :: Int -> ListSuiteDefinitionsResponse
newListSuiteDefinitionsResponse Int
pHttpStatus_ =
  ListSuiteDefinitionsResponse'
    { $sel:nextToken:ListSuiteDefinitionsResponse' :: Maybe Text
nextToken =
        forall a. Maybe a
Prelude.Nothing,
      $sel:suiteDefinitionInformationList:ListSuiteDefinitionsResponse' :: Maybe [SuiteDefinitionInformation]
suiteDefinitionInformationList =
        forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:ListSuiteDefinitionsResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | A token used to get the next set of results.
listSuiteDefinitionsResponse_nextToken :: Lens.Lens' ListSuiteDefinitionsResponse (Prelude.Maybe Prelude.Text)
listSuiteDefinitionsResponse_nextToken :: Lens' ListSuiteDefinitionsResponse (Maybe Text)
listSuiteDefinitionsResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListSuiteDefinitionsResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListSuiteDefinitionsResponse' :: ListSuiteDefinitionsResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListSuiteDefinitionsResponse
s@ListSuiteDefinitionsResponse' {} Maybe Text
a -> ListSuiteDefinitionsResponse
s {$sel:nextToken:ListSuiteDefinitionsResponse' :: Maybe Text
nextToken = Maybe Text
a} :: ListSuiteDefinitionsResponse)

-- | An array of objects that provide summaries of information about the
-- suite definitions in the list.
listSuiteDefinitionsResponse_suiteDefinitionInformationList :: Lens.Lens' ListSuiteDefinitionsResponse (Prelude.Maybe [SuiteDefinitionInformation])
listSuiteDefinitionsResponse_suiteDefinitionInformationList :: Lens'
  ListSuiteDefinitionsResponse (Maybe [SuiteDefinitionInformation])
listSuiteDefinitionsResponse_suiteDefinitionInformationList = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListSuiteDefinitionsResponse' {Maybe [SuiteDefinitionInformation]
suiteDefinitionInformationList :: Maybe [SuiteDefinitionInformation]
$sel:suiteDefinitionInformationList:ListSuiteDefinitionsResponse' :: ListSuiteDefinitionsResponse -> Maybe [SuiteDefinitionInformation]
suiteDefinitionInformationList} -> Maybe [SuiteDefinitionInformation]
suiteDefinitionInformationList) (\s :: ListSuiteDefinitionsResponse
s@ListSuiteDefinitionsResponse' {} Maybe [SuiteDefinitionInformation]
a -> ListSuiteDefinitionsResponse
s {$sel:suiteDefinitionInformationList:ListSuiteDefinitionsResponse' :: Maybe [SuiteDefinitionInformation]
suiteDefinitionInformationList = Maybe [SuiteDefinitionInformation]
a} :: ListSuiteDefinitionsResponse) 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 response's http status code.
listSuiteDefinitionsResponse_httpStatus :: Lens.Lens' ListSuiteDefinitionsResponse Prelude.Int
listSuiteDefinitionsResponse_httpStatus :: Lens' ListSuiteDefinitionsResponse Int
listSuiteDefinitionsResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListSuiteDefinitionsResponse' {Int
httpStatus :: Int
$sel:httpStatus:ListSuiteDefinitionsResponse' :: ListSuiteDefinitionsResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: ListSuiteDefinitionsResponse
s@ListSuiteDefinitionsResponse' {} Int
a -> ListSuiteDefinitionsResponse
s {$sel:httpStatus:ListSuiteDefinitionsResponse' :: Int
httpStatus = Int
a} :: ListSuiteDefinitionsResponse)

instance Prelude.NFData ListSuiteDefinitionsResponse where
  rnf :: ListSuiteDefinitionsResponse -> ()
rnf ListSuiteDefinitionsResponse' {Int
Maybe [SuiteDefinitionInformation]
Maybe Text
httpStatus :: Int
suiteDefinitionInformationList :: Maybe [SuiteDefinitionInformation]
nextToken :: Maybe Text
$sel:httpStatus:ListSuiteDefinitionsResponse' :: ListSuiteDefinitionsResponse -> Int
$sel:suiteDefinitionInformationList:ListSuiteDefinitionsResponse' :: ListSuiteDefinitionsResponse -> Maybe [SuiteDefinitionInformation]
$sel:nextToken:ListSuiteDefinitionsResponse' :: ListSuiteDefinitionsResponse -> Maybe Text
..} =
    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 Maybe [SuiteDefinitionInformation]
suiteDefinitionInformationList
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus