{-# 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.IoTSiteWise.ListDashboards
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Retrieves a paginated list of dashboards for an IoT SiteWise Monitor
-- project.
--
-- This operation returns paginated results.
module Amazonka.IoTSiteWise.ListDashboards
  ( -- * Creating a Request
    ListDashboards (..),
    newListDashboards,

    -- * Request Lenses
    listDashboards_maxResults,
    listDashboards_nextToken,
    listDashboards_projectId,

    -- * Destructuring the Response
    ListDashboardsResponse (..),
    newListDashboardsResponse,

    -- * Response Lenses
    listDashboardsResponse_nextToken,
    listDashboardsResponse_httpStatus,
    listDashboardsResponse_dashboardSummaries,
  )
where

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

-- | /See:/ 'newListDashboards' smart constructor.
data ListDashboards = ListDashboards'
  { -- | The maximum number of results to return for each paginated request.
    --
    -- Default: 50
    ListDashboards -> Maybe Natural
maxResults :: Prelude.Maybe Prelude.Natural,
    -- | The token to be used for the next set of paginated results.
    ListDashboards -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The ID of the project.
    ListDashboards -> Text
projectId :: Prelude.Text
  }
  deriving (ListDashboards -> ListDashboards -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListDashboards -> ListDashboards -> Bool
$c/= :: ListDashboards -> ListDashboards -> Bool
== :: ListDashboards -> ListDashboards -> Bool
$c== :: ListDashboards -> ListDashboards -> Bool
Prelude.Eq, ReadPrec [ListDashboards]
ReadPrec ListDashboards
Int -> ReadS ListDashboards
ReadS [ListDashboards]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListDashboards]
$creadListPrec :: ReadPrec [ListDashboards]
readPrec :: ReadPrec ListDashboards
$creadPrec :: ReadPrec ListDashboards
readList :: ReadS [ListDashboards]
$creadList :: ReadS [ListDashboards]
readsPrec :: Int -> ReadS ListDashboards
$creadsPrec :: Int -> ReadS ListDashboards
Prelude.Read, Int -> ListDashboards -> ShowS
[ListDashboards] -> ShowS
ListDashboards -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListDashboards] -> ShowS
$cshowList :: [ListDashboards] -> ShowS
show :: ListDashboards -> String
$cshow :: ListDashboards -> String
showsPrec :: Int -> ListDashboards -> ShowS
$cshowsPrec :: Int -> ListDashboards -> ShowS
Prelude.Show, forall x. Rep ListDashboards x -> ListDashboards
forall x. ListDashboards -> Rep ListDashboards x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListDashboards x -> ListDashboards
$cfrom :: forall x. ListDashboards -> Rep ListDashboards x
Prelude.Generic)

-- |
-- Create a value of 'ListDashboards' 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', 'listDashboards_maxResults' - The maximum number of results to return for each paginated request.
--
-- Default: 50
--
-- 'nextToken', 'listDashboards_nextToken' - The token to be used for the next set of paginated results.
--
-- 'projectId', 'listDashboards_projectId' - The ID of the project.
newListDashboards ::
  -- | 'projectId'
  Prelude.Text ->
  ListDashboards
newListDashboards :: Text -> ListDashboards
newListDashboards Text
pProjectId_ =
  ListDashboards'
    { $sel:maxResults:ListDashboards' :: Maybe Natural
maxResults = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:ListDashboards' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:projectId:ListDashboards' :: Text
projectId = Text
pProjectId_
    }

-- | The maximum number of results to return for each paginated request.
--
-- Default: 50
listDashboards_maxResults :: Lens.Lens' ListDashboards (Prelude.Maybe Prelude.Natural)
listDashboards_maxResults :: Lens' ListDashboards (Maybe Natural)
listDashboards_maxResults = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListDashboards' {Maybe Natural
maxResults :: Maybe Natural
$sel:maxResults:ListDashboards' :: ListDashboards -> Maybe Natural
maxResults} -> Maybe Natural
maxResults) (\s :: ListDashboards
s@ListDashboards' {} Maybe Natural
a -> ListDashboards
s {$sel:maxResults:ListDashboards' :: Maybe Natural
maxResults = Maybe Natural
a} :: ListDashboards)

-- | The token to be used for the next set of paginated results.
listDashboards_nextToken :: Lens.Lens' ListDashboards (Prelude.Maybe Prelude.Text)
listDashboards_nextToken :: Lens' ListDashboards (Maybe Text)
listDashboards_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListDashboards' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListDashboards' :: ListDashboards -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListDashboards
s@ListDashboards' {} Maybe Text
a -> ListDashboards
s {$sel:nextToken:ListDashboards' :: Maybe Text
nextToken = Maybe Text
a} :: ListDashboards)

-- | The ID of the project.
listDashboards_projectId :: Lens.Lens' ListDashboards Prelude.Text
listDashboards_projectId :: Lens' ListDashboards Text
listDashboards_projectId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListDashboards' {Text
projectId :: Text
$sel:projectId:ListDashboards' :: ListDashboards -> Text
projectId} -> Text
projectId) (\s :: ListDashboards
s@ListDashboards' {} Text
a -> ListDashboards
s {$sel:projectId:ListDashboards' :: Text
projectId = Text
a} :: ListDashboards)

instance Core.AWSPager ListDashboards where
  page :: ListDashboards
-> AWSResponse ListDashboards -> Maybe ListDashboards
page ListDashboards
rq AWSResponse ListDashboards
rs
    | forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse ListDashboards
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' ListDashboardsResponse (Maybe Text)
listDashboardsResponse_nextToken
            forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall a b. Prism (Maybe a) (Maybe b) a b
Lens._Just
        ) =
        forall a. Maybe a
Prelude.Nothing
    | forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse ListDashboards
rs
            forall s a. s -> Getting a s a -> a
Lens.^. Lens' ListDashboardsResponse [DashboardSummary]
listDashboardsResponse_dashboardSummaries
        ) =
        forall a. Maybe a
Prelude.Nothing
    | Bool
Prelude.otherwise =
        forall a. a -> Maybe a
Prelude.Just
          forall a b. (a -> b) -> a -> b
Prelude.$ ListDashboards
rq
          forall a b. a -> (a -> b) -> b
Prelude.& Lens' ListDashboards (Maybe Text)
listDashboards_nextToken
          forall s t a b. ASetter s t a b -> b -> s -> t
Lens..~ AWSResponse ListDashboards
rs
          forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' ListDashboardsResponse (Maybe Text)
listDashboardsResponse_nextToken
          forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall a b. Prism (Maybe a) (Maybe b) a b
Lens._Just

instance Core.AWSRequest ListDashboards where
  type
    AWSResponse ListDashboards =
      ListDashboardsResponse
  request :: (Service -> Service) -> ListDashboards -> Request ListDashboards
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 ListDashboards
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse ListDashboards)))
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 -> [DashboardSummary] -> ListDashboardsResponse
ListDashboardsResponse'
            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.<*> (forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
            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
"dashboardSummaries"
                            forall (f :: * -> *) a. Functor f => f (Maybe a) -> a -> f a
Core..!@ forall a. Monoid a => a
Prelude.mempty
                        )
      )

instance Prelude.Hashable ListDashboards where
  hashWithSalt :: Int -> ListDashboards -> Int
hashWithSalt Int
_salt ListDashboards' {Maybe Natural
Maybe Text
Text
projectId :: Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:projectId:ListDashboards' :: ListDashboards -> Text
$sel:nextToken:ListDashboards' :: ListDashboards -> Maybe Text
$sel:maxResults:ListDashboards' :: ListDashboards -> 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
projectId

instance Prelude.NFData ListDashboards where
  rnf :: ListDashboards -> ()
rnf ListDashboards' {Maybe Natural
Maybe Text
Text
projectId :: Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:projectId:ListDashboards' :: ListDashboards -> Text
$sel:nextToken:ListDashboards' :: ListDashboards -> Maybe Text
$sel:maxResults:ListDashboards' :: ListDashboards -> 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
projectId

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

instance Data.ToQuery ListDashboards where
  toQuery :: ListDashboards -> QueryString
toQuery ListDashboards' {Maybe Natural
Maybe Text
Text
projectId :: Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:projectId:ListDashboards' :: ListDashboards -> Text
$sel:nextToken:ListDashboards' :: ListDashboards -> Maybe Text
$sel:maxResults:ListDashboards' :: ListDashboards -> 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,
        ByteString
"projectId" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Text
projectId
      ]

-- | /See:/ 'newListDashboardsResponse' smart constructor.
data ListDashboardsResponse = ListDashboardsResponse'
  { -- | The token for the next set of results, or null if there are no
    -- additional results.
    ListDashboardsResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The response's http status code.
    ListDashboardsResponse -> Int
httpStatus :: Prelude.Int,
    -- | A list that summarizes each dashboard in the project.
    ListDashboardsResponse -> [DashboardSummary]
dashboardSummaries :: [DashboardSummary]
  }
  deriving (ListDashboardsResponse -> ListDashboardsResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListDashboardsResponse -> ListDashboardsResponse -> Bool
$c/= :: ListDashboardsResponse -> ListDashboardsResponse -> Bool
== :: ListDashboardsResponse -> ListDashboardsResponse -> Bool
$c== :: ListDashboardsResponse -> ListDashboardsResponse -> Bool
Prelude.Eq, ReadPrec [ListDashboardsResponse]
ReadPrec ListDashboardsResponse
Int -> ReadS ListDashboardsResponse
ReadS [ListDashboardsResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListDashboardsResponse]
$creadListPrec :: ReadPrec [ListDashboardsResponse]
readPrec :: ReadPrec ListDashboardsResponse
$creadPrec :: ReadPrec ListDashboardsResponse
readList :: ReadS [ListDashboardsResponse]
$creadList :: ReadS [ListDashboardsResponse]
readsPrec :: Int -> ReadS ListDashboardsResponse
$creadsPrec :: Int -> ReadS ListDashboardsResponse
Prelude.Read, Int -> ListDashboardsResponse -> ShowS
[ListDashboardsResponse] -> ShowS
ListDashboardsResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListDashboardsResponse] -> ShowS
$cshowList :: [ListDashboardsResponse] -> ShowS
show :: ListDashboardsResponse -> String
$cshow :: ListDashboardsResponse -> String
showsPrec :: Int -> ListDashboardsResponse -> ShowS
$cshowsPrec :: Int -> ListDashboardsResponse -> ShowS
Prelude.Show, forall x. Rep ListDashboardsResponse x -> ListDashboardsResponse
forall x. ListDashboardsResponse -> Rep ListDashboardsResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListDashboardsResponse x -> ListDashboardsResponse
$cfrom :: forall x. ListDashboardsResponse -> Rep ListDashboardsResponse x
Prelude.Generic)

-- |
-- Create a value of 'ListDashboardsResponse' 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', 'listDashboardsResponse_nextToken' - The token for the next set of results, or null if there are no
-- additional results.
--
-- 'httpStatus', 'listDashboardsResponse_httpStatus' - The response's http status code.
--
-- 'dashboardSummaries', 'listDashboardsResponse_dashboardSummaries' - A list that summarizes each dashboard in the project.
newListDashboardsResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  ListDashboardsResponse
newListDashboardsResponse :: Int -> ListDashboardsResponse
newListDashboardsResponse Int
pHttpStatus_ =
  ListDashboardsResponse'
    { $sel:nextToken:ListDashboardsResponse' :: Maybe Text
nextToken =
        forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:ListDashboardsResponse' :: Int
httpStatus = Int
pHttpStatus_,
      $sel:dashboardSummaries:ListDashboardsResponse' :: [DashboardSummary]
dashboardSummaries = forall a. Monoid a => a
Prelude.mempty
    }

-- | The token for the next set of results, or null if there are no
-- additional results.
listDashboardsResponse_nextToken :: Lens.Lens' ListDashboardsResponse (Prelude.Maybe Prelude.Text)
listDashboardsResponse_nextToken :: Lens' ListDashboardsResponse (Maybe Text)
listDashboardsResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListDashboardsResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListDashboardsResponse' :: ListDashboardsResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListDashboardsResponse
s@ListDashboardsResponse' {} Maybe Text
a -> ListDashboardsResponse
s {$sel:nextToken:ListDashboardsResponse' :: Maybe Text
nextToken = Maybe Text
a} :: ListDashboardsResponse)

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

-- | A list that summarizes each dashboard in the project.
listDashboardsResponse_dashboardSummaries :: Lens.Lens' ListDashboardsResponse [DashboardSummary]
listDashboardsResponse_dashboardSummaries :: Lens' ListDashboardsResponse [DashboardSummary]
listDashboardsResponse_dashboardSummaries = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListDashboardsResponse' {[DashboardSummary]
dashboardSummaries :: [DashboardSummary]
$sel:dashboardSummaries:ListDashboardsResponse' :: ListDashboardsResponse -> [DashboardSummary]
dashboardSummaries} -> [DashboardSummary]
dashboardSummaries) (\s :: ListDashboardsResponse
s@ListDashboardsResponse' {} [DashboardSummary]
a -> ListDashboardsResponse
s {$sel:dashboardSummaries:ListDashboardsResponse' :: [DashboardSummary]
dashboardSummaries = [DashboardSummary]
a} :: ListDashboardsResponse) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

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