{-# 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.IoT.ListDimensions
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- List the set of dimensions that are defined for your Amazon Web Services
-- accounts.
--
-- Requires permission to access the
-- <https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions ListDimensions>
-- action.
--
-- This operation returns paginated results.
module Amazonka.IoT.ListDimensions
  ( -- * Creating a Request
    ListDimensions (..),
    newListDimensions,

    -- * Request Lenses
    listDimensions_maxResults,
    listDimensions_nextToken,

    -- * Destructuring the Response
    ListDimensionsResponse (..),
    newListDimensionsResponse,

    -- * Response Lenses
    listDimensionsResponse_dimensionNames,
    listDimensionsResponse_nextToken,
    listDimensionsResponse_httpStatus,
  )
where

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

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

-- |
-- Create a value of 'ListDimensions' 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', 'listDimensions_maxResults' - The maximum number of results to retrieve at one time.
--
-- 'nextToken', 'listDimensions_nextToken' - The token for the next set of results.
newListDimensions ::
  ListDimensions
newListDimensions :: ListDimensions
newListDimensions =
  ListDimensions'
    { $sel:maxResults:ListDimensions' :: Maybe Natural
maxResults = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:ListDimensions' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing
    }

-- | The maximum number of results to retrieve at one time.
listDimensions_maxResults :: Lens.Lens' ListDimensions (Prelude.Maybe Prelude.Natural)
listDimensions_maxResults :: Lens' ListDimensions (Maybe Natural)
listDimensions_maxResults = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListDimensions' {Maybe Natural
maxResults :: Maybe Natural
$sel:maxResults:ListDimensions' :: ListDimensions -> Maybe Natural
maxResults} -> Maybe Natural
maxResults) (\s :: ListDimensions
s@ListDimensions' {} Maybe Natural
a -> ListDimensions
s {$sel:maxResults:ListDimensions' :: Maybe Natural
maxResults = Maybe Natural
a} :: ListDimensions)

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

instance Core.AWSPager ListDimensions where
  page :: ListDimensions
-> AWSResponse ListDimensions -> Maybe ListDimensions
page ListDimensions
rq AWSResponse ListDimensions
rs
    | forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse ListDimensions
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' ListDimensionsResponse (Maybe Text)
listDimensionsResponse_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 ListDimensions
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' ListDimensionsResponse (Maybe [Text])
listDimensionsResponse_dimensionNames
            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.$ ListDimensions
rq
          forall a b. a -> (a -> b) -> b
Prelude.& Lens' ListDimensions (Maybe Text)
listDimensions_nextToken
          forall s t a b. ASetter s t a b -> b -> s -> t
Lens..~ AWSResponse ListDimensions
rs
          forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' ListDimensionsResponse (Maybe Text)
listDimensionsResponse_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 ListDimensions where
  type
    AWSResponse ListDimensions =
      ListDimensionsResponse
  request :: (Service -> Service) -> ListDimensions -> Request ListDimensions
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 ListDimensions
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse ListDimensions)))
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 Text -> Int -> ListDimensionsResponse
ListDimensionsResponse'
            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
"dimensionNames" 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 ListDimensions where
  hashWithSalt :: Int -> ListDimensions -> Int
hashWithSalt Int
_salt ListDimensions' {Maybe Natural
Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:nextToken:ListDimensions' :: ListDimensions -> Maybe Text
$sel:maxResults:ListDimensions' :: ListDimensions -> 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 ListDimensions where
  rnf :: ListDimensions -> ()
rnf ListDimensions' {Maybe Natural
Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:nextToken:ListDimensions' :: ListDimensions -> Maybe Text
$sel:maxResults:ListDimensions' :: ListDimensions -> 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 ListDimensions where
  toHeaders :: ListDimensions -> ResponseHeaders
toHeaders = forall a b. a -> b -> a
Prelude.const forall a. Monoid a => a
Prelude.mempty

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

instance Data.ToQuery ListDimensions where
  toQuery :: ListDimensions -> QueryString
toQuery ListDimensions' {Maybe Natural
Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:nextToken:ListDimensions' :: ListDimensions -> Maybe Text
$sel:maxResults:ListDimensions' :: ListDimensions -> 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:/ 'newListDimensionsResponse' smart constructor.
data ListDimensionsResponse = ListDimensionsResponse'
  { -- | A list of the names of the defined dimensions. Use @DescribeDimension@
    -- to get details for a dimension.
    ListDimensionsResponse -> Maybe [Text]
dimensionNames :: Prelude.Maybe [Prelude.Text],
    -- | A token that can be used to retrieve the next set of results, or @null@
    -- if there are no additional results.
    ListDimensionsResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The response's http status code.
    ListDimensionsResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (ListDimensionsResponse -> ListDimensionsResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListDimensionsResponse -> ListDimensionsResponse -> Bool
$c/= :: ListDimensionsResponse -> ListDimensionsResponse -> Bool
== :: ListDimensionsResponse -> ListDimensionsResponse -> Bool
$c== :: ListDimensionsResponse -> ListDimensionsResponse -> Bool
Prelude.Eq, ReadPrec [ListDimensionsResponse]
ReadPrec ListDimensionsResponse
Int -> ReadS ListDimensionsResponse
ReadS [ListDimensionsResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListDimensionsResponse]
$creadListPrec :: ReadPrec [ListDimensionsResponse]
readPrec :: ReadPrec ListDimensionsResponse
$creadPrec :: ReadPrec ListDimensionsResponse
readList :: ReadS [ListDimensionsResponse]
$creadList :: ReadS [ListDimensionsResponse]
readsPrec :: Int -> ReadS ListDimensionsResponse
$creadsPrec :: Int -> ReadS ListDimensionsResponse
Prelude.Read, Int -> ListDimensionsResponse -> ShowS
[ListDimensionsResponse] -> ShowS
ListDimensionsResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListDimensionsResponse] -> ShowS
$cshowList :: [ListDimensionsResponse] -> ShowS
show :: ListDimensionsResponse -> String
$cshow :: ListDimensionsResponse -> String
showsPrec :: Int -> ListDimensionsResponse -> ShowS
$cshowsPrec :: Int -> ListDimensionsResponse -> ShowS
Prelude.Show, forall x. Rep ListDimensionsResponse x -> ListDimensionsResponse
forall x. ListDimensionsResponse -> Rep ListDimensionsResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListDimensionsResponse x -> ListDimensionsResponse
$cfrom :: forall x. ListDimensionsResponse -> Rep ListDimensionsResponse x
Prelude.Generic)

-- |
-- Create a value of 'ListDimensionsResponse' 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:
--
-- 'dimensionNames', 'listDimensionsResponse_dimensionNames' - A list of the names of the defined dimensions. Use @DescribeDimension@
-- to get details for a dimension.
--
-- 'nextToken', 'listDimensionsResponse_nextToken' - A token that can be used to retrieve the next set of results, or @null@
-- if there are no additional results.
--
-- 'httpStatus', 'listDimensionsResponse_httpStatus' - The response's http status code.
newListDimensionsResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  ListDimensionsResponse
newListDimensionsResponse :: Int -> ListDimensionsResponse
newListDimensionsResponse Int
pHttpStatus_ =
  ListDimensionsResponse'
    { $sel:dimensionNames:ListDimensionsResponse' :: Maybe [Text]
dimensionNames =
        forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:ListDimensionsResponse' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:ListDimensionsResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | A list of the names of the defined dimensions. Use @DescribeDimension@
-- to get details for a dimension.
listDimensionsResponse_dimensionNames :: Lens.Lens' ListDimensionsResponse (Prelude.Maybe [Prelude.Text])
listDimensionsResponse_dimensionNames :: Lens' ListDimensionsResponse (Maybe [Text])
listDimensionsResponse_dimensionNames = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListDimensionsResponse' {Maybe [Text]
dimensionNames :: Maybe [Text]
$sel:dimensionNames:ListDimensionsResponse' :: ListDimensionsResponse -> Maybe [Text]
dimensionNames} -> Maybe [Text]
dimensionNames) (\s :: ListDimensionsResponse
s@ListDimensionsResponse' {} Maybe [Text]
a -> ListDimensionsResponse
s {$sel:dimensionNames:ListDimensionsResponse' :: Maybe [Text]
dimensionNames = Maybe [Text]
a} :: ListDimensionsResponse) 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

-- | A token that can be used to retrieve the next set of results, or @null@
-- if there are no additional results.
listDimensionsResponse_nextToken :: Lens.Lens' ListDimensionsResponse (Prelude.Maybe Prelude.Text)
listDimensionsResponse_nextToken :: Lens' ListDimensionsResponse (Maybe Text)
listDimensionsResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListDimensionsResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListDimensionsResponse' :: ListDimensionsResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListDimensionsResponse
s@ListDimensionsResponse' {} Maybe Text
a -> ListDimensionsResponse
s {$sel:nextToken:ListDimensionsResponse' :: Maybe Text
nextToken = Maybe Text
a} :: ListDimensionsResponse)

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

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