{-# 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.DataBrew.ListRulesets
-- 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 all rulesets available in the current account or rulesets
-- associated with a specific resource (dataset).
--
-- This operation returns paginated results.
module Amazonka.DataBrew.ListRulesets
  ( -- * Creating a Request
    ListRulesets (..),
    newListRulesets,

    -- * Request Lenses
    listRulesets_maxResults,
    listRulesets_nextToken,
    listRulesets_targetArn,

    -- * Destructuring the Response
    ListRulesetsResponse (..),
    newListRulesetsResponse,

    -- * Response Lenses
    listRulesetsResponse_nextToken,
    listRulesetsResponse_httpStatus,
    listRulesetsResponse_rulesets,
  )
where

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

-- | /See:/ 'newListRulesets' smart constructor.
data ListRulesets = ListRulesets'
  { -- | The maximum number of results to return in this request.
    ListRulesets -> Maybe Natural
maxResults :: Prelude.Maybe Prelude.Natural,
    -- | A token generated by DataBrew that specifies where to continue
    -- pagination if a previous request was truncated. To get the next set of
    -- pages, pass in the NextToken value from the response object of the
    -- previous page call.
    ListRulesets -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The Amazon Resource Name (ARN) of a resource (dataset). Using this
    -- parameter indicates to return only those rulesets that are associated
    -- with the specified resource.
    ListRulesets -> Maybe Text
targetArn :: Prelude.Maybe Prelude.Text
  }
  deriving (ListRulesets -> ListRulesets -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListRulesets -> ListRulesets -> Bool
$c/= :: ListRulesets -> ListRulesets -> Bool
== :: ListRulesets -> ListRulesets -> Bool
$c== :: ListRulesets -> ListRulesets -> Bool
Prelude.Eq, ReadPrec [ListRulesets]
ReadPrec ListRulesets
Int -> ReadS ListRulesets
ReadS [ListRulesets]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListRulesets]
$creadListPrec :: ReadPrec [ListRulesets]
readPrec :: ReadPrec ListRulesets
$creadPrec :: ReadPrec ListRulesets
readList :: ReadS [ListRulesets]
$creadList :: ReadS [ListRulesets]
readsPrec :: Int -> ReadS ListRulesets
$creadsPrec :: Int -> ReadS ListRulesets
Prelude.Read, Int -> ListRulesets -> ShowS
[ListRulesets] -> ShowS
ListRulesets -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListRulesets] -> ShowS
$cshowList :: [ListRulesets] -> ShowS
show :: ListRulesets -> String
$cshow :: ListRulesets -> String
showsPrec :: Int -> ListRulesets -> ShowS
$cshowsPrec :: Int -> ListRulesets -> ShowS
Prelude.Show, forall x. Rep ListRulesets x -> ListRulesets
forall x. ListRulesets -> Rep ListRulesets x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListRulesets x -> ListRulesets
$cfrom :: forall x. ListRulesets -> Rep ListRulesets x
Prelude.Generic)

-- |
-- Create a value of 'ListRulesets' 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', 'listRulesets_maxResults' - The maximum number of results to return in this request.
--
-- 'nextToken', 'listRulesets_nextToken' - A token generated by DataBrew that specifies where to continue
-- pagination if a previous request was truncated. To get the next set of
-- pages, pass in the NextToken value from the response object of the
-- previous page call.
--
-- 'targetArn', 'listRulesets_targetArn' - The Amazon Resource Name (ARN) of a resource (dataset). Using this
-- parameter indicates to return only those rulesets that are associated
-- with the specified resource.
newListRulesets ::
  ListRulesets
newListRulesets :: ListRulesets
newListRulesets =
  ListRulesets'
    { $sel:maxResults:ListRulesets' :: Maybe Natural
maxResults = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:ListRulesets' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:targetArn:ListRulesets' :: Maybe Text
targetArn = forall a. Maybe a
Prelude.Nothing
    }

-- | The maximum number of results to return in this request.
listRulesets_maxResults :: Lens.Lens' ListRulesets (Prelude.Maybe Prelude.Natural)
listRulesets_maxResults :: Lens' ListRulesets (Maybe Natural)
listRulesets_maxResults = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListRulesets' {Maybe Natural
maxResults :: Maybe Natural
$sel:maxResults:ListRulesets' :: ListRulesets -> Maybe Natural
maxResults} -> Maybe Natural
maxResults) (\s :: ListRulesets
s@ListRulesets' {} Maybe Natural
a -> ListRulesets
s {$sel:maxResults:ListRulesets' :: Maybe Natural
maxResults = Maybe Natural
a} :: ListRulesets)

-- | A token generated by DataBrew that specifies where to continue
-- pagination if a previous request was truncated. To get the next set of
-- pages, pass in the NextToken value from the response object of the
-- previous page call.
listRulesets_nextToken :: Lens.Lens' ListRulesets (Prelude.Maybe Prelude.Text)
listRulesets_nextToken :: Lens' ListRulesets (Maybe Text)
listRulesets_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListRulesets' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListRulesets' :: ListRulesets -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListRulesets
s@ListRulesets' {} Maybe Text
a -> ListRulesets
s {$sel:nextToken:ListRulesets' :: Maybe Text
nextToken = Maybe Text
a} :: ListRulesets)

-- | The Amazon Resource Name (ARN) of a resource (dataset). Using this
-- parameter indicates to return only those rulesets that are associated
-- with the specified resource.
listRulesets_targetArn :: Lens.Lens' ListRulesets (Prelude.Maybe Prelude.Text)
listRulesets_targetArn :: Lens' ListRulesets (Maybe Text)
listRulesets_targetArn = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListRulesets' {Maybe Text
targetArn :: Maybe Text
$sel:targetArn:ListRulesets' :: ListRulesets -> Maybe Text
targetArn} -> Maybe Text
targetArn) (\s :: ListRulesets
s@ListRulesets' {} Maybe Text
a -> ListRulesets
s {$sel:targetArn:ListRulesets' :: Maybe Text
targetArn = Maybe Text
a} :: ListRulesets)

instance Core.AWSPager ListRulesets where
  page :: ListRulesets -> AWSResponse ListRulesets -> Maybe ListRulesets
page ListRulesets
rq AWSResponse ListRulesets
rs
    | forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse ListRulesets
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' ListRulesetsResponse (Maybe Text)
listRulesetsResponse_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 ListRulesets
rs forall s a. s -> Getting a s a -> a
Lens.^. Lens' ListRulesetsResponse [RulesetItem]
listRulesetsResponse_rulesets) =
        forall a. Maybe a
Prelude.Nothing
    | Bool
Prelude.otherwise =
        forall a. a -> Maybe a
Prelude.Just
          forall a b. (a -> b) -> a -> b
Prelude.$ ListRulesets
rq
          forall a b. a -> (a -> b) -> b
Prelude.& Lens' ListRulesets (Maybe Text)
listRulesets_nextToken
          forall s t a b. ASetter s t a b -> b -> s -> t
Lens..~ AWSResponse ListRulesets
rs
          forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' ListRulesetsResponse (Maybe Text)
listRulesetsResponse_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 ListRulesets where
  type AWSResponse ListRulesets = ListRulesetsResponse
  request :: (Service -> Service) -> ListRulesets -> Request ListRulesets
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 ListRulesets
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse ListRulesets)))
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 -> [RulesetItem] -> ListRulesetsResponse
ListRulesetsResponse'
            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
"Rulesets" forall (f :: * -> *) a. Functor f => f (Maybe a) -> a -> f a
Core..!@ forall a. Monoid a => a
Prelude.mempty)
      )

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

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

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

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

-- | /See:/ 'newListRulesetsResponse' smart constructor.
data ListRulesetsResponse = ListRulesetsResponse'
  { -- | A token that you can use in a subsequent call to retrieve the next set
    -- of results.
    ListRulesetsResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The response's http status code.
    ListRulesetsResponse -> Int
httpStatus :: Prelude.Int,
    -- | A list of RulesetItem. RulesetItem contains meta data of a ruleset.
    ListRulesetsResponse -> [RulesetItem]
rulesets :: [RulesetItem]
  }
  deriving (ListRulesetsResponse -> ListRulesetsResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListRulesetsResponse -> ListRulesetsResponse -> Bool
$c/= :: ListRulesetsResponse -> ListRulesetsResponse -> Bool
== :: ListRulesetsResponse -> ListRulesetsResponse -> Bool
$c== :: ListRulesetsResponse -> ListRulesetsResponse -> Bool
Prelude.Eq, ReadPrec [ListRulesetsResponse]
ReadPrec ListRulesetsResponse
Int -> ReadS ListRulesetsResponse
ReadS [ListRulesetsResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListRulesetsResponse]
$creadListPrec :: ReadPrec [ListRulesetsResponse]
readPrec :: ReadPrec ListRulesetsResponse
$creadPrec :: ReadPrec ListRulesetsResponse
readList :: ReadS [ListRulesetsResponse]
$creadList :: ReadS [ListRulesetsResponse]
readsPrec :: Int -> ReadS ListRulesetsResponse
$creadsPrec :: Int -> ReadS ListRulesetsResponse
Prelude.Read, Int -> ListRulesetsResponse -> ShowS
[ListRulesetsResponse] -> ShowS
ListRulesetsResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListRulesetsResponse] -> ShowS
$cshowList :: [ListRulesetsResponse] -> ShowS
show :: ListRulesetsResponse -> String
$cshow :: ListRulesetsResponse -> String
showsPrec :: Int -> ListRulesetsResponse -> ShowS
$cshowsPrec :: Int -> ListRulesetsResponse -> ShowS
Prelude.Show, forall x. Rep ListRulesetsResponse x -> ListRulesetsResponse
forall x. ListRulesetsResponse -> Rep ListRulesetsResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListRulesetsResponse x -> ListRulesetsResponse
$cfrom :: forall x. ListRulesetsResponse -> Rep ListRulesetsResponse x
Prelude.Generic)

-- |
-- Create a value of 'ListRulesetsResponse' 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', 'listRulesetsResponse_nextToken' - A token that you can use in a subsequent call to retrieve the next set
-- of results.
--
-- 'httpStatus', 'listRulesetsResponse_httpStatus' - The response's http status code.
--
-- 'rulesets', 'listRulesetsResponse_rulesets' - A list of RulesetItem. RulesetItem contains meta data of a ruleset.
newListRulesetsResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  ListRulesetsResponse
newListRulesetsResponse :: Int -> ListRulesetsResponse
newListRulesetsResponse Int
pHttpStatus_ =
  ListRulesetsResponse'
    { $sel:nextToken:ListRulesetsResponse' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:ListRulesetsResponse' :: Int
httpStatus = Int
pHttpStatus_,
      $sel:rulesets:ListRulesetsResponse' :: [RulesetItem]
rulesets = forall a. Monoid a => a
Prelude.mempty
    }

-- | A token that you can use in a subsequent call to retrieve the next set
-- of results.
listRulesetsResponse_nextToken :: Lens.Lens' ListRulesetsResponse (Prelude.Maybe Prelude.Text)
listRulesetsResponse_nextToken :: Lens' ListRulesetsResponse (Maybe Text)
listRulesetsResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListRulesetsResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListRulesetsResponse' :: ListRulesetsResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListRulesetsResponse
s@ListRulesetsResponse' {} Maybe Text
a -> ListRulesetsResponse
s {$sel:nextToken:ListRulesetsResponse' :: Maybe Text
nextToken = Maybe Text
a} :: ListRulesetsResponse)

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

-- | A list of RulesetItem. RulesetItem contains meta data of a ruleset.
listRulesetsResponse_rulesets :: Lens.Lens' ListRulesetsResponse [RulesetItem]
listRulesetsResponse_rulesets :: Lens' ListRulesetsResponse [RulesetItem]
listRulesetsResponse_rulesets = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListRulesetsResponse' {[RulesetItem]
rulesets :: [RulesetItem]
$sel:rulesets:ListRulesetsResponse' :: ListRulesetsResponse -> [RulesetItem]
rulesets} -> [RulesetItem]
rulesets) (\s :: ListRulesetsResponse
s@ListRulesetsResponse' {} [RulesetItem]
a -> ListRulesetsResponse
s {$sel:rulesets:ListRulesetsResponse' :: [RulesetItem]
rulesets = [RulesetItem]
a} :: ListRulesetsResponse) 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 ListRulesetsResponse where
  rnf :: ListRulesetsResponse -> ()
rnf ListRulesetsResponse' {Int
[RulesetItem]
Maybe Text
rulesets :: [RulesetItem]
httpStatus :: Int
nextToken :: Maybe Text
$sel:rulesets:ListRulesetsResponse' :: ListRulesetsResponse -> [RulesetItem]
$sel:httpStatus:ListRulesetsResponse' :: ListRulesetsResponse -> Int
$sel:nextToken:ListRulesetsResponse' :: ListRulesetsResponse -> 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 [RulesetItem]
rulesets