{-# 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.IotTwinMaker.ListScenes
-- 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 all scenes in a workspace.
module Amazonka.IotTwinMaker.ListScenes
  ( -- * Creating a Request
    ListScenes (..),
    newListScenes,

    -- * Request Lenses
    listScenes_maxResults,
    listScenes_nextToken,
    listScenes_workspaceId,

    -- * Destructuring the Response
    ListScenesResponse (..),
    newListScenesResponse,

    -- * Response Lenses
    listScenesResponse_nextToken,
    listScenesResponse_sceneSummaries,
    listScenesResponse_httpStatus,
  )
where

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

-- | /See:/ 'newListScenes' smart constructor.
data ListScenes = ListScenes'
  { -- | Specifies the maximum number of results to display.
    ListScenes -> Maybe Natural
maxResults :: Prelude.Maybe Prelude.Natural,
    -- | The string that specifies the next page of results.
    ListScenes -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The ID of the workspace that contains the scenes.
    ListScenes -> Text
workspaceId :: Prelude.Text
  }
  deriving (ListScenes -> ListScenes -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListScenes -> ListScenes -> Bool
$c/= :: ListScenes -> ListScenes -> Bool
== :: ListScenes -> ListScenes -> Bool
$c== :: ListScenes -> ListScenes -> Bool
Prelude.Eq, ReadPrec [ListScenes]
ReadPrec ListScenes
Int -> ReadS ListScenes
ReadS [ListScenes]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListScenes]
$creadListPrec :: ReadPrec [ListScenes]
readPrec :: ReadPrec ListScenes
$creadPrec :: ReadPrec ListScenes
readList :: ReadS [ListScenes]
$creadList :: ReadS [ListScenes]
readsPrec :: Int -> ReadS ListScenes
$creadsPrec :: Int -> ReadS ListScenes
Prelude.Read, Int -> ListScenes -> ShowS
[ListScenes] -> ShowS
ListScenes -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListScenes] -> ShowS
$cshowList :: [ListScenes] -> ShowS
show :: ListScenes -> String
$cshow :: ListScenes -> String
showsPrec :: Int -> ListScenes -> ShowS
$cshowsPrec :: Int -> ListScenes -> ShowS
Prelude.Show, forall x. Rep ListScenes x -> ListScenes
forall x. ListScenes -> Rep ListScenes x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListScenes x -> ListScenes
$cfrom :: forall x. ListScenes -> Rep ListScenes x
Prelude.Generic)

-- |
-- Create a value of 'ListScenes' 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', 'listScenes_maxResults' - Specifies the maximum number of results to display.
--
-- 'nextToken', 'listScenes_nextToken' - The string that specifies the next page of results.
--
-- 'workspaceId', 'listScenes_workspaceId' - The ID of the workspace that contains the scenes.
newListScenes ::
  -- | 'workspaceId'
  Prelude.Text ->
  ListScenes
newListScenes :: Text -> ListScenes
newListScenes Text
pWorkspaceId_ =
  ListScenes'
    { $sel:maxResults:ListScenes' :: Maybe Natural
maxResults = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:ListScenes' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:workspaceId:ListScenes' :: Text
workspaceId = Text
pWorkspaceId_
    }

-- | Specifies the maximum number of results to display.
listScenes_maxResults :: Lens.Lens' ListScenes (Prelude.Maybe Prelude.Natural)
listScenes_maxResults :: Lens' ListScenes (Maybe Natural)
listScenes_maxResults = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListScenes' {Maybe Natural
maxResults :: Maybe Natural
$sel:maxResults:ListScenes' :: ListScenes -> Maybe Natural
maxResults} -> Maybe Natural
maxResults) (\s :: ListScenes
s@ListScenes' {} Maybe Natural
a -> ListScenes
s {$sel:maxResults:ListScenes' :: Maybe Natural
maxResults = Maybe Natural
a} :: ListScenes)

-- | The string that specifies the next page of results.
listScenes_nextToken :: Lens.Lens' ListScenes (Prelude.Maybe Prelude.Text)
listScenes_nextToken :: Lens' ListScenes (Maybe Text)
listScenes_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListScenes' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListScenes' :: ListScenes -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListScenes
s@ListScenes' {} Maybe Text
a -> ListScenes
s {$sel:nextToken:ListScenes' :: Maybe Text
nextToken = Maybe Text
a} :: ListScenes)

-- | The ID of the workspace that contains the scenes.
listScenes_workspaceId :: Lens.Lens' ListScenes Prelude.Text
listScenes_workspaceId :: Lens' ListScenes Text
listScenes_workspaceId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListScenes' {Text
workspaceId :: Text
$sel:workspaceId:ListScenes' :: ListScenes -> Text
workspaceId} -> Text
workspaceId) (\s :: ListScenes
s@ListScenes' {} Text
a -> ListScenes
s {$sel:workspaceId:ListScenes' :: Text
workspaceId = Text
a} :: ListScenes)

instance Core.AWSRequest ListScenes where
  type AWSResponse ListScenes = ListScenesResponse
  request :: (Service -> Service) -> ListScenes -> Request ListScenes
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 ListScenes
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse ListScenes)))
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 [SceneSummary] -> Int -> ListScenesResponse
ListScenesResponse'
            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
"sceneSummaries" 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 ListScenes where
  hashWithSalt :: Int -> ListScenes -> Int
hashWithSalt Int
_salt ListScenes' {Maybe Natural
Maybe Text
Text
workspaceId :: Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:workspaceId:ListScenes' :: ListScenes -> Text
$sel:nextToken:ListScenes' :: ListScenes -> Maybe Text
$sel:maxResults:ListScenes' :: ListScenes -> 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
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
workspaceId

instance Prelude.NFData ListScenes where
  rnf :: ListScenes -> ()
rnf ListScenes' {Maybe Natural
Maybe Text
Text
workspaceId :: Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:workspaceId:ListScenes' :: ListScenes -> Text
$sel:nextToken:ListScenes' :: ListScenes -> Maybe Text
$sel:maxResults:ListScenes' :: ListScenes -> 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
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
workspaceId

instance Data.ToHeaders ListScenes where
  toHeaders :: ListScenes -> 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 ListScenes where
  toJSON :: ListScenes -> Value
toJSON ListScenes' {Maybe Natural
Maybe Text
Text
workspaceId :: Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:workspaceId:ListScenes' :: ListScenes -> Text
$sel:nextToken:ListScenes' :: ListScenes -> Maybe Text
$sel:maxResults:ListScenes' :: ListScenes -> Maybe Natural
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"maxResults" 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 Natural
maxResults,
            (Key
"nextToken" 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 Text
nextToken
          ]
      )

instance Data.ToPath ListScenes where
  toPath :: ListScenes -> ByteString
toPath ListScenes' {Maybe Natural
Maybe Text
Text
workspaceId :: Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:workspaceId:ListScenes' :: ListScenes -> Text
$sel:nextToken:ListScenes' :: ListScenes -> Maybe Text
$sel:maxResults:ListScenes' :: ListScenes -> Maybe Natural
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ ByteString
"/workspaces/",
        forall a. ToByteString a => a -> ByteString
Data.toBS Text
workspaceId,
        ByteString
"/scenes-list"
      ]

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

-- | /See:/ 'newListScenesResponse' smart constructor.
data ListScenesResponse = ListScenesResponse'
  { -- | The string that specifies the next page of results.
    ListScenesResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | A list of objects that contain information about the scenes.
    ListScenesResponse -> Maybe [SceneSummary]
sceneSummaries :: Prelude.Maybe [SceneSummary],
    -- | The response's http status code.
    ListScenesResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (ListScenesResponse -> ListScenesResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListScenesResponse -> ListScenesResponse -> Bool
$c/= :: ListScenesResponse -> ListScenesResponse -> Bool
== :: ListScenesResponse -> ListScenesResponse -> Bool
$c== :: ListScenesResponse -> ListScenesResponse -> Bool
Prelude.Eq, ReadPrec [ListScenesResponse]
ReadPrec ListScenesResponse
Int -> ReadS ListScenesResponse
ReadS [ListScenesResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListScenesResponse]
$creadListPrec :: ReadPrec [ListScenesResponse]
readPrec :: ReadPrec ListScenesResponse
$creadPrec :: ReadPrec ListScenesResponse
readList :: ReadS [ListScenesResponse]
$creadList :: ReadS [ListScenesResponse]
readsPrec :: Int -> ReadS ListScenesResponse
$creadsPrec :: Int -> ReadS ListScenesResponse
Prelude.Read, Int -> ListScenesResponse -> ShowS
[ListScenesResponse] -> ShowS
ListScenesResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListScenesResponse] -> ShowS
$cshowList :: [ListScenesResponse] -> ShowS
show :: ListScenesResponse -> String
$cshow :: ListScenesResponse -> String
showsPrec :: Int -> ListScenesResponse -> ShowS
$cshowsPrec :: Int -> ListScenesResponse -> ShowS
Prelude.Show, forall x. Rep ListScenesResponse x -> ListScenesResponse
forall x. ListScenesResponse -> Rep ListScenesResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListScenesResponse x -> ListScenesResponse
$cfrom :: forall x. ListScenesResponse -> Rep ListScenesResponse x
Prelude.Generic)

-- |
-- Create a value of 'ListScenesResponse' 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', 'listScenesResponse_nextToken' - The string that specifies the next page of results.
--
-- 'sceneSummaries', 'listScenesResponse_sceneSummaries' - A list of objects that contain information about the scenes.
--
-- 'httpStatus', 'listScenesResponse_httpStatus' - The response's http status code.
newListScenesResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  ListScenesResponse
newListScenesResponse :: Int -> ListScenesResponse
newListScenesResponse Int
pHttpStatus_ =
  ListScenesResponse'
    { $sel:nextToken:ListScenesResponse' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:sceneSummaries:ListScenesResponse' :: Maybe [SceneSummary]
sceneSummaries = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:ListScenesResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | The string that specifies the next page of results.
listScenesResponse_nextToken :: Lens.Lens' ListScenesResponse (Prelude.Maybe Prelude.Text)
listScenesResponse_nextToken :: Lens' ListScenesResponse (Maybe Text)
listScenesResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListScenesResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListScenesResponse' :: ListScenesResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListScenesResponse
s@ListScenesResponse' {} Maybe Text
a -> ListScenesResponse
s {$sel:nextToken:ListScenesResponse' :: Maybe Text
nextToken = Maybe Text
a} :: ListScenesResponse)

-- | A list of objects that contain information about the scenes.
listScenesResponse_sceneSummaries :: Lens.Lens' ListScenesResponse (Prelude.Maybe [SceneSummary])
listScenesResponse_sceneSummaries :: Lens' ListScenesResponse (Maybe [SceneSummary])
listScenesResponse_sceneSummaries = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListScenesResponse' {Maybe [SceneSummary]
sceneSummaries :: Maybe [SceneSummary]
$sel:sceneSummaries:ListScenesResponse' :: ListScenesResponse -> Maybe [SceneSummary]
sceneSummaries} -> Maybe [SceneSummary]
sceneSummaries) (\s :: ListScenesResponse
s@ListScenesResponse' {} Maybe [SceneSummary]
a -> ListScenesResponse
s {$sel:sceneSummaries:ListScenesResponse' :: Maybe [SceneSummary]
sceneSummaries = Maybe [SceneSummary]
a} :: ListScenesResponse) 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.
listScenesResponse_httpStatus :: Lens.Lens' ListScenesResponse Prelude.Int
listScenesResponse_httpStatus :: Lens' ListScenesResponse Int
listScenesResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListScenesResponse' {Int
httpStatus :: Int
$sel:httpStatus:ListScenesResponse' :: ListScenesResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: ListScenesResponse
s@ListScenesResponse' {} Int
a -> ListScenesResponse
s {$sel:httpStatus:ListScenesResponse' :: Int
httpStatus = Int
a} :: ListScenesResponse)

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