{-# 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.CloudWatch.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)
--
-- Returns a list of the dashboards for your account. If you include
-- @DashboardNamePrefix@, only those dashboards with names starting with
-- the prefix are listed. Otherwise, all dashboards in your account are
-- listed.
--
-- @ListDashboards@ returns up to 1000 results on one page. If there are
-- more than 1000 dashboards, you can call @ListDashboards@ again and
-- include the value you received for @NextToken@ in the first call, to
-- receive the next 1000 results.
--
-- This operation returns paginated results.
module Amazonka.CloudWatch.ListDashboards
  ( -- * Creating a Request
    ListDashboards (..),
    newListDashboards,

    -- * Request Lenses
    listDashboards_dashboardNamePrefix,
    listDashboards_nextToken,

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

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

import Amazonka.CloudWatch.Types
import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
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'
  { -- | If you specify this parameter, only the dashboards with names starting
    -- with the specified string are listed. The maximum length is 255, and
    -- valid characters are A-Z, a-z, 0-9, \".\", \"-\", and \"_\".
    ListDashboards -> Maybe Text
dashboardNamePrefix :: Prelude.Maybe Prelude.Text,
    -- | The token returned by a previous call to indicate that there is more
    -- data available.
    ListDashboards -> Maybe Text
nextToken :: Prelude.Maybe 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:
--
-- 'dashboardNamePrefix', 'listDashboards_dashboardNamePrefix' - If you specify this parameter, only the dashboards with names starting
-- with the specified string are listed. The maximum length is 255, and
-- valid characters are A-Z, a-z, 0-9, \".\", \"-\", and \"_\".
--
-- 'nextToken', 'listDashboards_nextToken' - The token returned by a previous call to indicate that there is more
-- data available.
newListDashboards ::
  ListDashboards
newListDashboards :: ListDashboards
newListDashboards =
  ListDashboards'
    { $sel:dashboardNamePrefix:ListDashboards' :: Maybe Text
dashboardNamePrefix =
        forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:ListDashboards' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing
    }

-- | If you specify this parameter, only the dashboards with names starting
-- with the specified string are listed. The maximum length is 255, and
-- valid characters are A-Z, a-z, 0-9, \".\", \"-\", and \"_\".
listDashboards_dashboardNamePrefix :: Lens.Lens' ListDashboards (Prelude.Maybe Prelude.Text)
listDashboards_dashboardNamePrefix :: Lens' ListDashboards (Maybe Text)
listDashboards_dashboardNamePrefix = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListDashboards' {Maybe Text
dashboardNamePrefix :: Maybe Text
$sel:dashboardNamePrefix:ListDashboards' :: ListDashboards -> Maybe Text
dashboardNamePrefix} -> Maybe Text
dashboardNamePrefix) (\s :: ListDashboards
s@ListDashboards' {} Maybe Text
a -> ListDashboards
s {$sel:dashboardNamePrefix:ListDashboards' :: Maybe Text
dashboardNamePrefix = Maybe Text
a} :: ListDashboards)

-- | The token returned by a previous call to indicate that there is more
-- data available.
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)

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 (First a) s a -> Maybe a
Lens.^? Lens' ListDashboardsResponse (Maybe [DashboardEntry])
listDashboardsResponse_dashboardEntries
            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
    | 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.postQuery (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 =>
Text
-> (Int
    -> ResponseHeaders -> [Node] -> Either String (AWSResponse a))
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveXMLWrapper
      Text
"ListDashboardsResult"
      ( \Int
s ResponseHeaders
h [Node]
x ->
          Maybe [DashboardEntry]
-> Maybe Text -> Int -> ListDashboardsResponse
ListDashboardsResponse'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> ( [Node]
x
                            forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"DashboardEntries"
                            forall (f :: * -> *) a. Functor f => f (Maybe a) -> a -> f a
Core..!@ forall a. Monoid a => a
Prelude.mempty
                            forall (m :: * -> *) a b. Monad m => m a -> (a -> m b) -> m b
Prelude.>>= forall (f :: * -> *) a b.
Applicative f =>
([a] -> f b) -> [a] -> f (Maybe b)
Core.may (forall a. FromXML a => Text -> [Node] -> Either String [a]
Data.parseXMLList Text
"member")
                        )
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"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 ListDashboards where
  hashWithSalt :: Int -> ListDashboards -> Int
hashWithSalt Int
_salt ListDashboards' {Maybe Text
nextToken :: Maybe Text
dashboardNamePrefix :: Maybe Text
$sel:nextToken:ListDashboards' :: ListDashboards -> Maybe Text
$sel:dashboardNamePrefix:ListDashboards' :: ListDashboards -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
dashboardNamePrefix
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
nextToken

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

instance Data.ToHeaders ListDashboards where
  toHeaders :: ListDashboards -> ResponseHeaders
toHeaders = forall a b. a -> b -> a
Prelude.const forall a. Monoid a => a
Prelude.mempty

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

instance Data.ToQuery ListDashboards where
  toQuery :: ListDashboards -> QueryString
toQuery ListDashboards' {Maybe Text
nextToken :: Maybe Text
dashboardNamePrefix :: Maybe Text
$sel:nextToken:ListDashboards' :: ListDashboards -> Maybe Text
$sel:dashboardNamePrefix:ListDashboards' :: ListDashboards -> Maybe Text
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ ByteString
"Action"
          forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: (ByteString
"ListDashboards" :: Prelude.ByteString),
        ByteString
"Version"
          forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: (ByteString
"2010-08-01" :: Prelude.ByteString),
        ByteString
"DashboardNamePrefix" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Text
dashboardNamePrefix,
        ByteString
"NextToken" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Text
nextToken
      ]

-- | /See:/ 'newListDashboardsResponse' smart constructor.
data ListDashboardsResponse = ListDashboardsResponse'
  { -- | The list of matching dashboards.
    ListDashboardsResponse -> Maybe [DashboardEntry]
dashboardEntries :: Prelude.Maybe [DashboardEntry],
    -- | The token that marks the start of the next batch of returned results.
    ListDashboardsResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The response's http status code.
    ListDashboardsResponse -> Int
httpStatus :: Prelude.Int
  }
  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:
--
-- 'dashboardEntries', 'listDashboardsResponse_dashboardEntries' - The list of matching dashboards.
--
-- 'nextToken', 'listDashboardsResponse_nextToken' - The token that marks the start of the next batch of returned results.
--
-- 'httpStatus', 'listDashboardsResponse_httpStatus' - The response's http status code.
newListDashboardsResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  ListDashboardsResponse
newListDashboardsResponse :: Int -> ListDashboardsResponse
newListDashboardsResponse Int
pHttpStatus_ =
  ListDashboardsResponse'
    { $sel:dashboardEntries:ListDashboardsResponse' :: Maybe [DashboardEntry]
dashboardEntries =
        forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:ListDashboardsResponse' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:ListDashboardsResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | The list of matching dashboards.
listDashboardsResponse_dashboardEntries :: Lens.Lens' ListDashboardsResponse (Prelude.Maybe [DashboardEntry])
listDashboardsResponse_dashboardEntries :: Lens' ListDashboardsResponse (Maybe [DashboardEntry])
listDashboardsResponse_dashboardEntries = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListDashboardsResponse' {Maybe [DashboardEntry]
dashboardEntries :: Maybe [DashboardEntry]
$sel:dashboardEntries:ListDashboardsResponse' :: ListDashboardsResponse -> Maybe [DashboardEntry]
dashboardEntries} -> Maybe [DashboardEntry]
dashboardEntries) (\s :: ListDashboardsResponse
s@ListDashboardsResponse' {} Maybe [DashboardEntry]
a -> ListDashboardsResponse
s {$sel:dashboardEntries:ListDashboardsResponse' :: Maybe [DashboardEntry]
dashboardEntries = Maybe [DashboardEntry]
a} :: ListDashboardsResponse) 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 that marks the start of the next batch of returned 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)

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