{-# 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.GreengrassV2.ListComponents
-- 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 component summaries. This list includes
-- components that you have permission to view.
--
-- This operation returns paginated results.
module Amazonka.GreengrassV2.ListComponents
  ( -- * Creating a Request
    ListComponents (..),
    newListComponents,

    -- * Request Lenses
    listComponents_maxResults,
    listComponents_nextToken,
    listComponents_scope,

    -- * Destructuring the Response
    ListComponentsResponse (..),
    newListComponentsResponse,

    -- * Response Lenses
    listComponentsResponse_components,
    listComponentsResponse_nextToken,
    listComponentsResponse_httpStatus,
  )
where

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

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

-- |
-- Create a value of 'ListComponents' 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', 'listComponents_maxResults' - The maximum number of results to be returned per paginated request.
--
-- 'nextToken', 'listComponents_nextToken' - The token to be used for the next set of paginated results.
--
-- 'scope', 'listComponents_scope' - The scope of the components to list.
--
-- Default: @PRIVATE@
newListComponents ::
  ListComponents
newListComponents :: ListComponents
newListComponents =
  ListComponents'
    { $sel:maxResults:ListComponents' :: Maybe Natural
maxResults = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:ListComponents' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:scope:ListComponents' :: Maybe ComponentVisibilityScope
scope = forall a. Maybe a
Prelude.Nothing
    }

-- | The maximum number of results to be returned per paginated request.
listComponents_maxResults :: Lens.Lens' ListComponents (Prelude.Maybe Prelude.Natural)
listComponents_maxResults :: Lens' ListComponents (Maybe Natural)
listComponents_maxResults = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListComponents' {Maybe Natural
maxResults :: Maybe Natural
$sel:maxResults:ListComponents' :: ListComponents -> Maybe Natural
maxResults} -> Maybe Natural
maxResults) (\s :: ListComponents
s@ListComponents' {} Maybe Natural
a -> ListComponents
s {$sel:maxResults:ListComponents' :: Maybe Natural
maxResults = Maybe Natural
a} :: ListComponents)

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

-- | The scope of the components to list.
--
-- Default: @PRIVATE@
listComponents_scope :: Lens.Lens' ListComponents (Prelude.Maybe ComponentVisibilityScope)
listComponents_scope :: Lens' ListComponents (Maybe ComponentVisibilityScope)
listComponents_scope = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListComponents' {Maybe ComponentVisibilityScope
scope :: Maybe ComponentVisibilityScope
$sel:scope:ListComponents' :: ListComponents -> Maybe ComponentVisibilityScope
scope} -> Maybe ComponentVisibilityScope
scope) (\s :: ListComponents
s@ListComponents' {} Maybe ComponentVisibilityScope
a -> ListComponents
s {$sel:scope:ListComponents' :: Maybe ComponentVisibilityScope
scope = Maybe ComponentVisibilityScope
a} :: ListComponents)

instance Core.AWSPager ListComponents where
  page :: ListComponents
-> AWSResponse ListComponents -> Maybe ListComponents
page ListComponents
rq AWSResponse ListComponents
rs
    | forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse ListComponents
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' ListComponentsResponse (Maybe Text)
listComponentsResponse_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 ListComponents
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' ListComponentsResponse (Maybe [Component])
listComponentsResponse_components
            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.$ ListComponents
rq
          forall a b. a -> (a -> b) -> b
Prelude.& Lens' ListComponents (Maybe Text)
listComponents_nextToken
          forall s t a b. ASetter s t a b -> b -> s -> t
Lens..~ AWSResponse ListComponents
rs
          forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' ListComponentsResponse (Maybe Text)
listComponentsResponse_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 ListComponents where
  type
    AWSResponse ListComponents =
      ListComponentsResponse
  request :: (Service -> Service) -> ListComponents -> Request ListComponents
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 ListComponents
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse ListComponents)))
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 [Component] -> Maybe Text -> Int -> ListComponentsResponse
ListComponentsResponse'
            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
"components" 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 ListComponents where
  hashWithSalt :: Int -> ListComponents -> Int
hashWithSalt Int
_salt ListComponents' {Maybe Natural
Maybe Text
Maybe ComponentVisibilityScope
scope :: Maybe ComponentVisibilityScope
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:scope:ListComponents' :: ListComponents -> Maybe ComponentVisibilityScope
$sel:nextToken:ListComponents' :: ListComponents -> Maybe Text
$sel:maxResults:ListComponents' :: ListComponents -> 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` Maybe ComponentVisibilityScope
scope

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

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

instance Data.ToPath ListComponents where
  toPath :: ListComponents -> ByteString
toPath = forall a b. a -> b -> a
Prelude.const ByteString
"/greengrass/v2/components"

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

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

-- |
-- Create a value of 'ListComponentsResponse' 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:
--
-- 'components', 'listComponentsResponse_components' - A list that summarizes each component.
--
-- 'nextToken', 'listComponentsResponse_nextToken' - The token for the next set of results, or null if there are no
-- additional results.
--
-- 'httpStatus', 'listComponentsResponse_httpStatus' - The response's http status code.
newListComponentsResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  ListComponentsResponse
newListComponentsResponse :: Int -> ListComponentsResponse
newListComponentsResponse Int
pHttpStatus_ =
  ListComponentsResponse'
    { $sel:components:ListComponentsResponse' :: Maybe [Component]
components =
        forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:ListComponentsResponse' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:ListComponentsResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | A list that summarizes each component.
listComponentsResponse_components :: Lens.Lens' ListComponentsResponse (Prelude.Maybe [Component])
listComponentsResponse_components :: Lens' ListComponentsResponse (Maybe [Component])
listComponentsResponse_components = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListComponentsResponse' {Maybe [Component]
components :: Maybe [Component]
$sel:components:ListComponentsResponse' :: ListComponentsResponse -> Maybe [Component]
components} -> Maybe [Component]
components) (\s :: ListComponentsResponse
s@ListComponentsResponse' {} Maybe [Component]
a -> ListComponentsResponse
s {$sel:components:ListComponentsResponse' :: Maybe [Component]
components = Maybe [Component]
a} :: ListComponentsResponse) 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 for the next set of results, or null if there are no
-- additional results.
listComponentsResponse_nextToken :: Lens.Lens' ListComponentsResponse (Prelude.Maybe Prelude.Text)
listComponentsResponse_nextToken :: Lens' ListComponentsResponse (Maybe Text)
listComponentsResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListComponentsResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListComponentsResponse' :: ListComponentsResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListComponentsResponse
s@ListComponentsResponse' {} Maybe Text
a -> ListComponentsResponse
s {$sel:nextToken:ListComponentsResponse' :: Maybe Text
nextToken = Maybe Text
a} :: ListComponentsResponse)

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

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