{-# 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.IAM.ListPolicies
-- Copyright   : (c) 2013-2021 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay <brendan.g.hay+amazonka@gmail.com>
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Lists all the managed policies that are available in your Amazon Web
-- Services account, including your own customer-defined managed policies
-- and all Amazon Web Services managed policies.
--
-- You can filter the list of policies that is returned using the optional
-- @OnlyAttached@, @Scope@, and @PathPrefix@ parameters. For example, to
-- list only the customer managed policies in your Amazon Web Services
-- account, set @Scope@ to @Local@. To list only Amazon Web Services
-- managed policies, set @Scope@ to @AWS@.
--
-- You can paginate the results using the @MaxItems@ and @Marker@
-- parameters.
--
-- For more information about managed policies, see
-- <https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html Managed policies and inline policies>
-- in the /IAM User Guide/.
--
-- IAM resource-listing operations return a subset of the available
-- attributes for the resource. For example, this operation does not return
-- tags, even though they are an attribute of the returned object. To view
-- all of the information for a customer manged policy, see GetPolicy.
--
-- This operation returns paginated results.
module Amazonka.IAM.ListPolicies
  ( -- * Creating a Request
    ListPolicies (..),
    newListPolicies,

    -- * Request Lenses
    listPolicies_pathPrefix,
    listPolicies_onlyAttached,
    listPolicies_marker,
    listPolicies_scope,
    listPolicies_maxItems,
    listPolicies_policyUsageFilter,

    -- * Destructuring the Response
    ListPoliciesResponse (..),
    newListPoliciesResponse,

    -- * Response Lenses
    listPoliciesResponse_marker,
    listPoliciesResponse_isTruncated,
    listPoliciesResponse_policies,
    listPoliciesResponse_httpStatus,
  )
where

import qualified Amazonka.Core as Core
import Amazonka.IAM.Types
import qualified Amazonka.Lens as Lens
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response

-- | /See:/ 'newListPolicies' smart constructor.
data ListPolicies = ListPolicies'
  { -- | The path prefix for filtering the results. This parameter is optional.
    -- If it is not included, it defaults to a slash (\/), listing all
    -- policies. This parameter allows (through its
    -- <http://wikipedia.org/wiki/regex regex pattern>) a string of characters
    -- consisting of either a forward slash (\/) by itself or a string that
    -- must begin and end with forward slashes. In addition, it can contain any
    -- ASCII character from the ! (@\\u0021@) through the DEL character
    -- (@\\u007F@), including most punctuation characters, digits, and upper
    -- and lowercased letters.
    ListPolicies -> Maybe Text
pathPrefix :: Prelude.Maybe Prelude.Text,
    -- | A flag to filter the results to only the attached policies.
    --
    -- When @OnlyAttached@ is @true@, the returned list contains only the
    -- policies that are attached to an IAM user, group, or role. When
    -- @OnlyAttached@ is @false@, or when the parameter is not included, all
    -- policies are returned.
    ListPolicies -> Maybe Bool
onlyAttached :: Prelude.Maybe Prelude.Bool,
    -- | Use this parameter only when paginating results and only after you
    -- receive a response indicating that the results are truncated. Set it to
    -- the value of the @Marker@ element in the response that you received to
    -- indicate where the next call should start.
    ListPolicies -> Maybe Text
marker :: Prelude.Maybe Prelude.Text,
    -- | The scope to use for filtering the results.
    --
    -- To list only Amazon Web Services managed policies, set @Scope@ to @AWS@.
    -- To list only the customer managed policies in your Amazon Web Services
    -- account, set @Scope@ to @Local@.
    --
    -- This parameter is optional. If it is not included, or if it is set to
    -- @All@, all policies are returned.
    ListPolicies -> Maybe PolicyScopeType
scope :: Prelude.Maybe PolicyScopeType,
    -- | Use this only when paginating results to indicate the maximum number of
    -- items you want in the response. If additional items exist beyond the
    -- maximum you specify, the @IsTruncated@ response element is @true@.
    --
    -- If you do not include this parameter, the number of items defaults to
    -- 100. Note that IAM might return fewer results, even when there are more
    -- results available. In that case, the @IsTruncated@ response element
    -- returns @true@, and @Marker@ contains a value to include in the
    -- subsequent call that tells the service where to continue from.
    ListPolicies -> Maybe Natural
maxItems :: Prelude.Maybe Prelude.Natural,
    -- | The policy usage method to use for filtering the results.
    --
    -- To list only permissions policies,
    -- set @PolicyUsageFilter@ to @PermissionsPolicy@. To list only the
    -- policies used to set permissions boundaries, set the value
    -- to @PermissionsBoundary@.
    --
    -- This parameter is optional. If it is not included, all policies are
    -- returned.
    ListPolicies -> Maybe PolicyUsageType
policyUsageFilter :: Prelude.Maybe PolicyUsageType
  }
  deriving (ListPolicies -> ListPolicies -> Bool
(ListPolicies -> ListPolicies -> Bool)
-> (ListPolicies -> ListPolicies -> Bool) -> Eq ListPolicies
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListPolicies -> ListPolicies -> Bool
$c/= :: ListPolicies -> ListPolicies -> Bool
== :: ListPolicies -> ListPolicies -> Bool
$c== :: ListPolicies -> ListPolicies -> Bool
Prelude.Eq, ReadPrec [ListPolicies]
ReadPrec ListPolicies
Int -> ReadS ListPolicies
ReadS [ListPolicies]
(Int -> ReadS ListPolicies)
-> ReadS [ListPolicies]
-> ReadPrec ListPolicies
-> ReadPrec [ListPolicies]
-> Read ListPolicies
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListPolicies]
$creadListPrec :: ReadPrec [ListPolicies]
readPrec :: ReadPrec ListPolicies
$creadPrec :: ReadPrec ListPolicies
readList :: ReadS [ListPolicies]
$creadList :: ReadS [ListPolicies]
readsPrec :: Int -> ReadS ListPolicies
$creadsPrec :: Int -> ReadS ListPolicies
Prelude.Read, Int -> ListPolicies -> ShowS
[ListPolicies] -> ShowS
ListPolicies -> String
(Int -> ListPolicies -> ShowS)
-> (ListPolicies -> String)
-> ([ListPolicies] -> ShowS)
-> Show ListPolicies
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListPolicies] -> ShowS
$cshowList :: [ListPolicies] -> ShowS
show :: ListPolicies -> String
$cshow :: ListPolicies -> String
showsPrec :: Int -> ListPolicies -> ShowS
$cshowsPrec :: Int -> ListPolicies -> ShowS
Prelude.Show, (forall x. ListPolicies -> Rep ListPolicies x)
-> (forall x. Rep ListPolicies x -> ListPolicies)
-> Generic ListPolicies
forall x. Rep ListPolicies x -> ListPolicies
forall x. ListPolicies -> Rep ListPolicies x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListPolicies x -> ListPolicies
$cfrom :: forall x. ListPolicies -> Rep ListPolicies x
Prelude.Generic)

-- |
-- Create a value of 'ListPolicies' 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:
--
-- 'pathPrefix', 'listPolicies_pathPrefix' - The path prefix for filtering the results. This parameter is optional.
-- If it is not included, it defaults to a slash (\/), listing all
-- policies. This parameter allows (through its
-- <http://wikipedia.org/wiki/regex regex pattern>) a string of characters
-- consisting of either a forward slash (\/) by itself or a string that
-- must begin and end with forward slashes. In addition, it can contain any
-- ASCII character from the ! (@\\u0021@) through the DEL character
-- (@\\u007F@), including most punctuation characters, digits, and upper
-- and lowercased letters.
--
-- 'onlyAttached', 'listPolicies_onlyAttached' - A flag to filter the results to only the attached policies.
--
-- When @OnlyAttached@ is @true@, the returned list contains only the
-- policies that are attached to an IAM user, group, or role. When
-- @OnlyAttached@ is @false@, or when the parameter is not included, all
-- policies are returned.
--
-- 'marker', 'listPolicies_marker' - Use this parameter only when paginating results and only after you
-- receive a response indicating that the results are truncated. Set it to
-- the value of the @Marker@ element in the response that you received to
-- indicate where the next call should start.
--
-- 'scope', 'listPolicies_scope' - The scope to use for filtering the results.
--
-- To list only Amazon Web Services managed policies, set @Scope@ to @AWS@.
-- To list only the customer managed policies in your Amazon Web Services
-- account, set @Scope@ to @Local@.
--
-- This parameter is optional. If it is not included, or if it is set to
-- @All@, all policies are returned.
--
-- 'maxItems', 'listPolicies_maxItems' - Use this only when paginating results to indicate the maximum number of
-- items you want in the response. If additional items exist beyond the
-- maximum you specify, the @IsTruncated@ response element is @true@.
--
-- If you do not include this parameter, the number of items defaults to
-- 100. Note that IAM might return fewer results, even when there are more
-- results available. In that case, the @IsTruncated@ response element
-- returns @true@, and @Marker@ contains a value to include in the
-- subsequent call that tells the service where to continue from.
--
-- 'policyUsageFilter', 'listPolicies_policyUsageFilter' - The policy usage method to use for filtering the results.
--
-- To list only permissions policies,
-- set @PolicyUsageFilter@ to @PermissionsPolicy@. To list only the
-- policies used to set permissions boundaries, set the value
-- to @PermissionsBoundary@.
--
-- This parameter is optional. If it is not included, all policies are
-- returned.
newListPolicies ::
  ListPolicies
newListPolicies :: ListPolicies
newListPolicies =
  ListPolicies' :: Maybe Text
-> Maybe Bool
-> Maybe Text
-> Maybe PolicyScopeType
-> Maybe Natural
-> Maybe PolicyUsageType
-> ListPolicies
ListPolicies'
    { $sel:pathPrefix:ListPolicies' :: Maybe Text
pathPrefix = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:onlyAttached:ListPolicies' :: Maybe Bool
onlyAttached = Maybe Bool
forall a. Maybe a
Prelude.Nothing,
      $sel:marker:ListPolicies' :: Maybe Text
marker = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:scope:ListPolicies' :: Maybe PolicyScopeType
scope = Maybe PolicyScopeType
forall a. Maybe a
Prelude.Nothing,
      $sel:maxItems:ListPolicies' :: Maybe Natural
maxItems = Maybe Natural
forall a. Maybe a
Prelude.Nothing,
      $sel:policyUsageFilter:ListPolicies' :: Maybe PolicyUsageType
policyUsageFilter = Maybe PolicyUsageType
forall a. Maybe a
Prelude.Nothing
    }

-- | The path prefix for filtering the results. This parameter is optional.
-- If it is not included, it defaults to a slash (\/), listing all
-- policies. This parameter allows (through its
-- <http://wikipedia.org/wiki/regex regex pattern>) a string of characters
-- consisting of either a forward slash (\/) by itself or a string that
-- must begin and end with forward slashes. In addition, it can contain any
-- ASCII character from the ! (@\\u0021@) through the DEL character
-- (@\\u007F@), including most punctuation characters, digits, and upper
-- and lowercased letters.
listPolicies_pathPrefix :: Lens.Lens' ListPolicies (Prelude.Maybe Prelude.Text)
listPolicies_pathPrefix :: (Maybe Text -> f (Maybe Text)) -> ListPolicies -> f ListPolicies
listPolicies_pathPrefix = (ListPolicies -> Maybe Text)
-> (ListPolicies -> Maybe Text -> ListPolicies)
-> Lens ListPolicies ListPolicies (Maybe Text) (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListPolicies' {Maybe Text
pathPrefix :: Maybe Text
$sel:pathPrefix:ListPolicies' :: ListPolicies -> Maybe Text
pathPrefix} -> Maybe Text
pathPrefix) (\s :: ListPolicies
s@ListPolicies' {} Maybe Text
a -> ListPolicies
s {$sel:pathPrefix:ListPolicies' :: Maybe Text
pathPrefix = Maybe Text
a} :: ListPolicies)

-- | A flag to filter the results to only the attached policies.
--
-- When @OnlyAttached@ is @true@, the returned list contains only the
-- policies that are attached to an IAM user, group, or role. When
-- @OnlyAttached@ is @false@, or when the parameter is not included, all
-- policies are returned.
listPolicies_onlyAttached :: Lens.Lens' ListPolicies (Prelude.Maybe Prelude.Bool)
listPolicies_onlyAttached :: (Maybe Bool -> f (Maybe Bool)) -> ListPolicies -> f ListPolicies
listPolicies_onlyAttached = (ListPolicies -> Maybe Bool)
-> (ListPolicies -> Maybe Bool -> ListPolicies)
-> Lens ListPolicies ListPolicies (Maybe Bool) (Maybe Bool)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListPolicies' {Maybe Bool
onlyAttached :: Maybe Bool
$sel:onlyAttached:ListPolicies' :: ListPolicies -> Maybe Bool
onlyAttached} -> Maybe Bool
onlyAttached) (\s :: ListPolicies
s@ListPolicies' {} Maybe Bool
a -> ListPolicies
s {$sel:onlyAttached:ListPolicies' :: Maybe Bool
onlyAttached = Maybe Bool
a} :: ListPolicies)

-- | Use this parameter only when paginating results and only after you
-- receive a response indicating that the results are truncated. Set it to
-- the value of the @Marker@ element in the response that you received to
-- indicate where the next call should start.
listPolicies_marker :: Lens.Lens' ListPolicies (Prelude.Maybe Prelude.Text)
listPolicies_marker :: (Maybe Text -> f (Maybe Text)) -> ListPolicies -> f ListPolicies
listPolicies_marker = (ListPolicies -> Maybe Text)
-> (ListPolicies -> Maybe Text -> ListPolicies)
-> Lens ListPolicies ListPolicies (Maybe Text) (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListPolicies' {Maybe Text
marker :: Maybe Text
$sel:marker:ListPolicies' :: ListPolicies -> Maybe Text
marker} -> Maybe Text
marker) (\s :: ListPolicies
s@ListPolicies' {} Maybe Text
a -> ListPolicies
s {$sel:marker:ListPolicies' :: Maybe Text
marker = Maybe Text
a} :: ListPolicies)

-- | The scope to use for filtering the results.
--
-- To list only Amazon Web Services managed policies, set @Scope@ to @AWS@.
-- To list only the customer managed policies in your Amazon Web Services
-- account, set @Scope@ to @Local@.
--
-- This parameter is optional. If it is not included, or if it is set to
-- @All@, all policies are returned.
listPolicies_scope :: Lens.Lens' ListPolicies (Prelude.Maybe PolicyScopeType)
listPolicies_scope :: (Maybe PolicyScopeType -> f (Maybe PolicyScopeType))
-> ListPolicies -> f ListPolicies
listPolicies_scope = (ListPolicies -> Maybe PolicyScopeType)
-> (ListPolicies -> Maybe PolicyScopeType -> ListPolicies)
-> Lens
     ListPolicies
     ListPolicies
     (Maybe PolicyScopeType)
     (Maybe PolicyScopeType)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListPolicies' {Maybe PolicyScopeType
scope :: Maybe PolicyScopeType
$sel:scope:ListPolicies' :: ListPolicies -> Maybe PolicyScopeType
scope} -> Maybe PolicyScopeType
scope) (\s :: ListPolicies
s@ListPolicies' {} Maybe PolicyScopeType
a -> ListPolicies
s {$sel:scope:ListPolicies' :: Maybe PolicyScopeType
scope = Maybe PolicyScopeType
a} :: ListPolicies)

-- | Use this only when paginating results to indicate the maximum number of
-- items you want in the response. If additional items exist beyond the
-- maximum you specify, the @IsTruncated@ response element is @true@.
--
-- If you do not include this parameter, the number of items defaults to
-- 100. Note that IAM might return fewer results, even when there are more
-- results available. In that case, the @IsTruncated@ response element
-- returns @true@, and @Marker@ contains a value to include in the
-- subsequent call that tells the service where to continue from.
listPolicies_maxItems :: Lens.Lens' ListPolicies (Prelude.Maybe Prelude.Natural)
listPolicies_maxItems :: (Maybe Natural -> f (Maybe Natural))
-> ListPolicies -> f ListPolicies
listPolicies_maxItems = (ListPolicies -> Maybe Natural)
-> (ListPolicies -> Maybe Natural -> ListPolicies)
-> Lens ListPolicies ListPolicies (Maybe Natural) (Maybe Natural)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListPolicies' {Maybe Natural
maxItems :: Maybe Natural
$sel:maxItems:ListPolicies' :: ListPolicies -> Maybe Natural
maxItems} -> Maybe Natural
maxItems) (\s :: ListPolicies
s@ListPolicies' {} Maybe Natural
a -> ListPolicies
s {$sel:maxItems:ListPolicies' :: Maybe Natural
maxItems = Maybe Natural
a} :: ListPolicies)

-- | The policy usage method to use for filtering the results.
--
-- To list only permissions policies,
-- set @PolicyUsageFilter@ to @PermissionsPolicy@. To list only the
-- policies used to set permissions boundaries, set the value
-- to @PermissionsBoundary@.
--
-- This parameter is optional. If it is not included, all policies are
-- returned.
listPolicies_policyUsageFilter :: Lens.Lens' ListPolicies (Prelude.Maybe PolicyUsageType)
listPolicies_policyUsageFilter :: (Maybe PolicyUsageType -> f (Maybe PolicyUsageType))
-> ListPolicies -> f ListPolicies
listPolicies_policyUsageFilter = (ListPolicies -> Maybe PolicyUsageType)
-> (ListPolicies -> Maybe PolicyUsageType -> ListPolicies)
-> Lens
     ListPolicies
     ListPolicies
     (Maybe PolicyUsageType)
     (Maybe PolicyUsageType)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListPolicies' {Maybe PolicyUsageType
policyUsageFilter :: Maybe PolicyUsageType
$sel:policyUsageFilter:ListPolicies' :: ListPolicies -> Maybe PolicyUsageType
policyUsageFilter} -> Maybe PolicyUsageType
policyUsageFilter) (\s :: ListPolicies
s@ListPolicies' {} Maybe PolicyUsageType
a -> ListPolicies
s {$sel:policyUsageFilter:ListPolicies' :: Maybe PolicyUsageType
policyUsageFilter = Maybe PolicyUsageType
a} :: ListPolicies)

instance Core.AWSPager ListPolicies where
  page :: ListPolicies -> AWSResponse ListPolicies -> Maybe ListPolicies
page ListPolicies
rq AWSResponse ListPolicies
rs
    | Maybe Bool -> Bool
forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse ListPolicies
ListPoliciesResponse
rs
            ListPoliciesResponse
-> Getting (First Bool) ListPoliciesResponse Bool -> Maybe Bool
forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? (Maybe Bool -> Const (First Bool) (Maybe Bool))
-> ListPoliciesResponse -> Const (First Bool) ListPoliciesResponse
Lens' ListPoliciesResponse (Maybe Bool)
listPoliciesResponse_isTruncated
              ((Maybe Bool -> Const (First Bool) (Maybe Bool))
 -> ListPoliciesResponse -> Const (First Bool) ListPoliciesResponse)
-> ((Bool -> Const (First Bool) Bool)
    -> Maybe Bool -> Const (First Bool) (Maybe Bool))
-> Getting (First Bool) ListPoliciesResponse Bool
forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. (Bool -> Const (First Bool) Bool)
-> Maybe Bool -> Const (First Bool) (Maybe Bool)
forall a b. Prism (Maybe a) (Maybe b) a b
Lens._Just
        ) =
      Maybe ListPolicies
forall a. Maybe a
Prelude.Nothing
    | Maybe Text -> Bool
forall a. Maybe a -> Bool
Prelude.isNothing
        ( AWSResponse ListPolicies
ListPoliciesResponse
rs
            ListPoliciesResponse
-> Getting (First Text) ListPoliciesResponse Text -> Maybe Text
forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? (Maybe Text -> Const (First Text) (Maybe Text))
-> ListPoliciesResponse -> Const (First Text) ListPoliciesResponse
Lens' ListPoliciesResponse (Maybe Text)
listPoliciesResponse_marker ((Maybe Text -> Const (First Text) (Maybe Text))
 -> ListPoliciesResponse -> Const (First Text) ListPoliciesResponse)
-> ((Text -> Const (First Text) Text)
    -> Maybe Text -> Const (First Text) (Maybe Text))
-> Getting (First Text) ListPoliciesResponse Text
forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. (Text -> Const (First Text) Text)
-> Maybe Text -> Const (First Text) (Maybe Text)
forall a b. Prism (Maybe a) (Maybe b) a b
Lens._Just
        ) =
      Maybe ListPolicies
forall a. Maybe a
Prelude.Nothing
    | Bool
Prelude.otherwise =
      ListPolicies -> Maybe ListPolicies
forall a. a -> Maybe a
Prelude.Just (ListPolicies -> Maybe ListPolicies)
-> ListPolicies -> Maybe ListPolicies
forall a b. (a -> b) -> a -> b
Prelude.$
        ListPolicies
rq
          ListPolicies -> (ListPolicies -> ListPolicies) -> ListPolicies
forall a b. a -> (a -> b) -> b
Prelude.& (Maybe Text -> Identity (Maybe Text))
-> ListPolicies -> Identity ListPolicies
Lens ListPolicies ListPolicies (Maybe Text) (Maybe Text)
listPolicies_marker
          ((Maybe Text -> Identity (Maybe Text))
 -> ListPolicies -> Identity ListPolicies)
-> Maybe Text -> ListPolicies -> ListPolicies
forall s t a b. ASetter s t a b -> b -> s -> t
Lens..~ AWSResponse ListPolicies
ListPoliciesResponse
rs
          ListPoliciesResponse
-> Getting (First Text) ListPoliciesResponse Text -> Maybe Text
forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? (Maybe Text -> Const (First Text) (Maybe Text))
-> ListPoliciesResponse -> Const (First Text) ListPoliciesResponse
Lens' ListPoliciesResponse (Maybe Text)
listPoliciesResponse_marker ((Maybe Text -> Const (First Text) (Maybe Text))
 -> ListPoliciesResponse -> Const (First Text) ListPoliciesResponse)
-> ((Text -> Const (First Text) Text)
    -> Maybe Text -> Const (First Text) (Maybe Text))
-> Getting (First Text) ListPoliciesResponse Text
forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. (Text -> Const (First Text) Text)
-> Maybe Text -> Const (First Text) (Maybe Text)
forall a b. Prism (Maybe a) (Maybe b) a b
Lens._Just

instance Core.AWSRequest ListPolicies where
  type AWSResponse ListPolicies = ListPoliciesResponse
  request :: ListPolicies -> Request ListPolicies
request = Service -> ListPolicies -> Request ListPolicies
forall a. ToRequest a => Service -> a -> Request a
Request.postQuery Service
defaultService
  response :: Logger
-> Service
-> Proxy ListPolicies
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse ListPolicies)))
response =
    Text
-> (Int
    -> ResponseHeaders
    -> [Node]
    -> Either String (AWSResponse ListPolicies))
-> Logger
-> Service
-> Proxy ListPolicies
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse ListPolicies)))
forall (m :: * -> *) a.
MonadResource m =>
Text
-> (Int
    -> ResponseHeaders -> [Node] -> Either String (AWSResponse a))
-> Logger
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveXMLWrapper
      Text
"ListPoliciesResult"
      ( \Int
s ResponseHeaders
h [Node]
x ->
          Maybe Text
-> Maybe Bool -> Maybe [Policy] -> Int -> ListPoliciesResponse
ListPoliciesResponse'
            (Maybe Text
 -> Maybe Bool -> Maybe [Policy] -> Int -> ListPoliciesResponse)
-> Either String (Maybe Text)
-> Either
     String
     (Maybe Bool -> Maybe [Policy] -> Int -> ListPoliciesResponse)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> ([Node]
x [Node] -> Text -> Either String (Maybe Text)
forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Core..@? Text
"Marker")
            Either
  String
  (Maybe Bool -> Maybe [Policy] -> Int -> ListPoliciesResponse)
-> Either String (Maybe Bool)
-> Either String (Maybe [Policy] -> Int -> ListPoliciesResponse)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ([Node]
x [Node] -> Text -> Either String (Maybe Bool)
forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Core..@? Text
"IsTruncated")
            Either String (Maybe [Policy] -> Int -> ListPoliciesResponse)
-> Either String (Maybe [Policy])
-> Either String (Int -> ListPoliciesResponse)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ( [Node]
x [Node] -> Text -> Either String (Maybe [Node])
forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Core..@? Text
"Policies" Either String (Maybe [Node]) -> [Node] -> Either String [Node]
forall (f :: * -> *) a. Functor f => f (Maybe a) -> a -> f a
Core..!@ [Node]
forall a. Monoid a => a
Prelude.mempty
                            Either String [Node]
-> ([Node] -> Either String (Maybe [Policy]))
-> Either String (Maybe [Policy])
forall (m :: * -> *) a b. Monad m => m a -> (a -> m b) -> m b
Prelude.>>= ([Node] -> Either String [Policy])
-> [Node] -> Either String (Maybe [Policy])
forall (f :: * -> *) a b.
Applicative f =>
([a] -> f b) -> [a] -> f (Maybe b)
Core.may (Text -> [Node] -> Either String [Policy]
forall a. FromXML a => Text -> [Node] -> Either String [a]
Core.parseXMLList Text
"member")
                        )
            Either String (Int -> ListPoliciesResponse)
-> Either String Int -> Either String ListPoliciesResponse
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Int -> Either String Int
forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (Int -> Int
forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
      )

instance Prelude.Hashable ListPolicies

instance Prelude.NFData ListPolicies

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

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

instance Core.ToQuery ListPolicies where
  toQuery :: ListPolicies -> QueryString
toQuery ListPolicies' {Maybe Bool
Maybe Natural
Maybe Text
Maybe PolicyScopeType
Maybe PolicyUsageType
policyUsageFilter :: Maybe PolicyUsageType
maxItems :: Maybe Natural
scope :: Maybe PolicyScopeType
marker :: Maybe Text
onlyAttached :: Maybe Bool
pathPrefix :: Maybe Text
$sel:policyUsageFilter:ListPolicies' :: ListPolicies -> Maybe PolicyUsageType
$sel:maxItems:ListPolicies' :: ListPolicies -> Maybe Natural
$sel:scope:ListPolicies' :: ListPolicies -> Maybe PolicyScopeType
$sel:marker:ListPolicies' :: ListPolicies -> Maybe Text
$sel:onlyAttached:ListPolicies' :: ListPolicies -> Maybe Bool
$sel:pathPrefix:ListPolicies' :: ListPolicies -> Maybe Text
..} =
    [QueryString] -> QueryString
forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ ByteString
"Action"
          ByteString -> ByteString -> QueryString
forall a. ToQuery a => ByteString -> a -> QueryString
Core.=: (ByteString
"ListPolicies" :: Prelude.ByteString),
        ByteString
"Version"
          ByteString -> ByteString -> QueryString
forall a. ToQuery a => ByteString -> a -> QueryString
Core.=: (ByteString
"2010-05-08" :: Prelude.ByteString),
        ByteString
"PathPrefix" ByteString -> Maybe Text -> QueryString
forall a. ToQuery a => ByteString -> a -> QueryString
Core.=: Maybe Text
pathPrefix,
        ByteString
"OnlyAttached" ByteString -> Maybe Bool -> QueryString
forall a. ToQuery a => ByteString -> a -> QueryString
Core.=: Maybe Bool
onlyAttached,
        ByteString
"Marker" ByteString -> Maybe Text -> QueryString
forall a. ToQuery a => ByteString -> a -> QueryString
Core.=: Maybe Text
marker,
        ByteString
"Scope" ByteString -> Maybe PolicyScopeType -> QueryString
forall a. ToQuery a => ByteString -> a -> QueryString
Core.=: Maybe PolicyScopeType
scope,
        ByteString
"MaxItems" ByteString -> Maybe Natural -> QueryString
forall a. ToQuery a => ByteString -> a -> QueryString
Core.=: Maybe Natural
maxItems,
        ByteString
"PolicyUsageFilter" ByteString -> Maybe PolicyUsageType -> QueryString
forall a. ToQuery a => ByteString -> a -> QueryString
Core.=: Maybe PolicyUsageType
policyUsageFilter
      ]

-- | Contains the response to a successful ListPolicies request.
--
-- /See:/ 'newListPoliciesResponse' smart constructor.
data ListPoliciesResponse = ListPoliciesResponse'
  { -- | When @IsTruncated@ is @true@, this element is present and contains the
    -- value to use for the @Marker@ parameter in a subsequent pagination
    -- request.
    ListPoliciesResponse -> Maybe Text
marker :: Prelude.Maybe Prelude.Text,
    -- | A flag that indicates whether there are more items to return. If your
    -- results were truncated, you can make a subsequent pagination request
    -- using the @Marker@ request parameter to retrieve more items. Note that
    -- IAM might return fewer than the @MaxItems@ number of results even when
    -- there are more results available. We recommend that you check
    -- @IsTruncated@ after every call to ensure that you receive all your
    -- results.
    ListPoliciesResponse -> Maybe Bool
isTruncated :: Prelude.Maybe Prelude.Bool,
    -- | A list of policies.
    ListPoliciesResponse -> Maybe [Policy]
policies :: Prelude.Maybe [Policy],
    -- | The response's http status code.
    ListPoliciesResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (ListPoliciesResponse -> ListPoliciesResponse -> Bool
(ListPoliciesResponse -> ListPoliciesResponse -> Bool)
-> (ListPoliciesResponse -> ListPoliciesResponse -> Bool)
-> Eq ListPoliciesResponse
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListPoliciesResponse -> ListPoliciesResponse -> Bool
$c/= :: ListPoliciesResponse -> ListPoliciesResponse -> Bool
== :: ListPoliciesResponse -> ListPoliciesResponse -> Bool
$c== :: ListPoliciesResponse -> ListPoliciesResponse -> Bool
Prelude.Eq, ReadPrec [ListPoliciesResponse]
ReadPrec ListPoliciesResponse
Int -> ReadS ListPoliciesResponse
ReadS [ListPoliciesResponse]
(Int -> ReadS ListPoliciesResponse)
-> ReadS [ListPoliciesResponse]
-> ReadPrec ListPoliciesResponse
-> ReadPrec [ListPoliciesResponse]
-> Read ListPoliciesResponse
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListPoliciesResponse]
$creadListPrec :: ReadPrec [ListPoliciesResponse]
readPrec :: ReadPrec ListPoliciesResponse
$creadPrec :: ReadPrec ListPoliciesResponse
readList :: ReadS [ListPoliciesResponse]
$creadList :: ReadS [ListPoliciesResponse]
readsPrec :: Int -> ReadS ListPoliciesResponse
$creadsPrec :: Int -> ReadS ListPoliciesResponse
Prelude.Read, Int -> ListPoliciesResponse -> ShowS
[ListPoliciesResponse] -> ShowS
ListPoliciesResponse -> String
(Int -> ListPoliciesResponse -> ShowS)
-> (ListPoliciesResponse -> String)
-> ([ListPoliciesResponse] -> ShowS)
-> Show ListPoliciesResponse
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListPoliciesResponse] -> ShowS
$cshowList :: [ListPoliciesResponse] -> ShowS
show :: ListPoliciesResponse -> String
$cshow :: ListPoliciesResponse -> String
showsPrec :: Int -> ListPoliciesResponse -> ShowS
$cshowsPrec :: Int -> ListPoliciesResponse -> ShowS
Prelude.Show, (forall x. ListPoliciesResponse -> Rep ListPoliciesResponse x)
-> (forall x. Rep ListPoliciesResponse x -> ListPoliciesResponse)
-> Generic ListPoliciesResponse
forall x. Rep ListPoliciesResponse x -> ListPoliciesResponse
forall x. ListPoliciesResponse -> Rep ListPoliciesResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListPoliciesResponse x -> ListPoliciesResponse
$cfrom :: forall x. ListPoliciesResponse -> Rep ListPoliciesResponse x
Prelude.Generic)

-- |
-- Create a value of 'ListPoliciesResponse' 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:
--
-- 'marker', 'listPoliciesResponse_marker' - When @IsTruncated@ is @true@, this element is present and contains the
-- value to use for the @Marker@ parameter in a subsequent pagination
-- request.
--
-- 'isTruncated', 'listPoliciesResponse_isTruncated' - A flag that indicates whether there are more items to return. If your
-- results were truncated, you can make a subsequent pagination request
-- using the @Marker@ request parameter to retrieve more items. Note that
-- IAM might return fewer than the @MaxItems@ number of results even when
-- there are more results available. We recommend that you check
-- @IsTruncated@ after every call to ensure that you receive all your
-- results.
--
-- 'policies', 'listPoliciesResponse_policies' - A list of policies.
--
-- 'httpStatus', 'listPoliciesResponse_httpStatus' - The response's http status code.
newListPoliciesResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  ListPoliciesResponse
newListPoliciesResponse :: Int -> ListPoliciesResponse
newListPoliciesResponse Int
pHttpStatus_ =
  ListPoliciesResponse' :: Maybe Text
-> Maybe Bool -> Maybe [Policy] -> Int -> ListPoliciesResponse
ListPoliciesResponse'
    { $sel:marker:ListPoliciesResponse' :: Maybe Text
marker = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:isTruncated:ListPoliciesResponse' :: Maybe Bool
isTruncated = Maybe Bool
forall a. Maybe a
Prelude.Nothing,
      $sel:policies:ListPoliciesResponse' :: Maybe [Policy]
policies = Maybe [Policy]
forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:ListPoliciesResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | When @IsTruncated@ is @true@, this element is present and contains the
-- value to use for the @Marker@ parameter in a subsequent pagination
-- request.
listPoliciesResponse_marker :: Lens.Lens' ListPoliciesResponse (Prelude.Maybe Prelude.Text)
listPoliciesResponse_marker :: (Maybe Text -> f (Maybe Text))
-> ListPoliciesResponse -> f ListPoliciesResponse
listPoliciesResponse_marker = (ListPoliciesResponse -> Maybe Text)
-> (ListPoliciesResponse -> Maybe Text -> ListPoliciesResponse)
-> Lens' ListPoliciesResponse (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListPoliciesResponse' {Maybe Text
marker :: Maybe Text
$sel:marker:ListPoliciesResponse' :: ListPoliciesResponse -> Maybe Text
marker} -> Maybe Text
marker) (\s :: ListPoliciesResponse
s@ListPoliciesResponse' {} Maybe Text
a -> ListPoliciesResponse
s {$sel:marker:ListPoliciesResponse' :: Maybe Text
marker = Maybe Text
a} :: ListPoliciesResponse)

-- | A flag that indicates whether there are more items to return. If your
-- results were truncated, you can make a subsequent pagination request
-- using the @Marker@ request parameter to retrieve more items. Note that
-- IAM might return fewer than the @MaxItems@ number of results even when
-- there are more results available. We recommend that you check
-- @IsTruncated@ after every call to ensure that you receive all your
-- results.
listPoliciesResponse_isTruncated :: Lens.Lens' ListPoliciesResponse (Prelude.Maybe Prelude.Bool)
listPoliciesResponse_isTruncated :: (Maybe Bool -> f (Maybe Bool))
-> ListPoliciesResponse -> f ListPoliciesResponse
listPoliciesResponse_isTruncated = (ListPoliciesResponse -> Maybe Bool)
-> (ListPoliciesResponse -> Maybe Bool -> ListPoliciesResponse)
-> Lens' ListPoliciesResponse (Maybe Bool)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListPoliciesResponse' {Maybe Bool
isTruncated :: Maybe Bool
$sel:isTruncated:ListPoliciesResponse' :: ListPoliciesResponse -> Maybe Bool
isTruncated} -> Maybe Bool
isTruncated) (\s :: ListPoliciesResponse
s@ListPoliciesResponse' {} Maybe Bool
a -> ListPoliciesResponse
s {$sel:isTruncated:ListPoliciesResponse' :: Maybe Bool
isTruncated = Maybe Bool
a} :: ListPoliciesResponse)

-- | A list of policies.
listPoliciesResponse_policies :: Lens.Lens' ListPoliciesResponse (Prelude.Maybe [Policy])
listPoliciesResponse_policies :: (Maybe [Policy] -> f (Maybe [Policy]))
-> ListPoliciesResponse -> f ListPoliciesResponse
listPoliciesResponse_policies = (ListPoliciesResponse -> Maybe [Policy])
-> (ListPoliciesResponse -> Maybe [Policy] -> ListPoliciesResponse)
-> Lens
     ListPoliciesResponse
     ListPoliciesResponse
     (Maybe [Policy])
     (Maybe [Policy])
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListPoliciesResponse' {Maybe [Policy]
policies :: Maybe [Policy]
$sel:policies:ListPoliciesResponse' :: ListPoliciesResponse -> Maybe [Policy]
policies} -> Maybe [Policy]
policies) (\s :: ListPoliciesResponse
s@ListPoliciesResponse' {} Maybe [Policy]
a -> ListPoliciesResponse
s {$sel:policies:ListPoliciesResponse' :: Maybe [Policy]
policies = Maybe [Policy]
a} :: ListPoliciesResponse) ((Maybe [Policy] -> f (Maybe [Policy]))
 -> ListPoliciesResponse -> f ListPoliciesResponse)
-> ((Maybe [Policy] -> f (Maybe [Policy]))
    -> Maybe [Policy] -> f (Maybe [Policy]))
-> (Maybe [Policy] -> f (Maybe [Policy]))
-> ListPoliciesResponse
-> f ListPoliciesResponse
forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. AnIso [Policy] [Policy] [Policy] [Policy]
-> Iso
     (Maybe [Policy]) (Maybe [Policy]) (Maybe [Policy]) (Maybe [Policy])
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 AnIso [Policy] [Policy] [Policy] [Policy]
forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

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

instance Prelude.NFData ListPoliciesResponse