Network.AWS.IAM.ListPolicies

Lists all the managed policies that are available in your AWS account, including your own customer-defined managed policies and all AWS 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 AWS account, set Scope to Local . To list only AWS managed policies, set Scope to AWS .

You can paginate the results using the MaxItems and Marker parameters.

For more information about managed policies, see Managed Policies and Inline Policies in the IAM User Guide .

This operation returns paginated results.

Creating a Request

listPolicies :: ListPolicies

Creates a value of ListPolicies with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lpPathPrefix - 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 (per its <http:wikipedia.orgwikiregex 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.
• lpOnlyAttached - 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.
• lpMarker - 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.
• lpScope - The scope to use for filtering the results. To list only AWS managed policies, set Scope to AWS . To list only the customer managed policies in your AWS 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.
• lpMaxItems - (Optional) 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, it 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.

data ListPolicies

See: listPolicies smart constructor.

Instances

Eq ListPolicies

Methods

(==) :: ListPolicies -> ListPolicies -> Bool

(/=) :: ListPolicies -> ListPolicies -> Bool

Data ListPolicies

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListPolicies -> c ListPolicies

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListPolicies

toConstr :: ListPolicies -> Constr

dataTypeOf :: ListPolicies -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListPolicies)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListPolicies)

gmapT :: (forall b. Data b => b -> b) -> ListPolicies -> ListPolicies

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListPolicies -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListPolicies -> r

gmapQ :: (forall d. Data d => d -> u) -> ListPolicies -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListPolicies -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListPolicies -> m ListPolicies

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListPolicies -> m ListPolicies

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListPolicies -> m ListPolicies

Read ListPolicies

Methods

readsPrec :: Int -> ReadS ListPolicies

readList :: ReadS [ListPolicies]

readPrec :: ReadPrec ListPolicies

readListPrec :: ReadPrec [ListPolicies]

Show ListPolicies

Methods

showsPrec :: Int -> ListPolicies -> ShowS

show :: ListPolicies -> String

showList :: [ListPolicies] -> ShowS

Generic ListPolicies

Associated Types

type Rep ListPolicies :: * -> *

Methods

from :: ListPolicies -> Rep ListPolicies x

to :: Rep ListPolicies x -> ListPolicies

Hashable ListPolicies

Methods

hashWithSalt :: Int -> ListPolicies -> Int

hash :: ListPolicies -> Int

NFData ListPolicies

Methods

rnf :: ListPolicies -> ()

AWSPager ListPolicies

Methods

page :: ListPolicies -> Rs ListPolicies -> Maybe ListPolicies

AWSRequest ListPolicies

Associated Types

type Rs ListPolicies :: *

Methods

request :: ListPolicies -> Request ListPolicies

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * ListPolicies -> ClientResponse -> m (Response ListPolicies)

ToHeaders ListPolicies

Methods

toHeaders :: ListPolicies -> [Header]

ToPath ListPolicies

Methods

toPath :: ListPolicies -> ByteString

ToQuery ListPolicies

Methods

toQuery :: ListPolicies -> QueryString

type Rep ListPolicies

type Rep ListPolicies = D1 * (MetaData "ListPolicies" "Network.AWS.IAM.ListPolicies" "amazonka-iam-1.6.0-CI3f7XZIc4eD0Ehb04tNY7" False) (C1 * (MetaCons "ListPolicies'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_lpPathPrefix") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_lpOnlyAttached") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lpMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lpScope") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe PolicyScopeType))) (S1 * (MetaSel (Just Symbol "_lpMaxItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat)))))))

type Rs ListPolicies

type Rs ListPolicies = ListPoliciesResponse

Request Lenses

lpPathPrefix :: Lens' ListPolicies (Maybe Text)

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 (per its <http:wikipedia.orgwikiregex 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.

lpOnlyAttached :: Lens' ListPolicies (Maybe Bool)

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.

lpMarker :: Lens' ListPolicies (Maybe Text)

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.

lpScope :: Lens' ListPolicies (Maybe PolicyScopeType)

The scope to use for filtering the results. To list only AWS managed policies, set Scope to AWS . To list only the customer managed policies in your AWS 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.

lpMaxItems :: Lens' ListPolicies (Maybe Natural)

(Optional) 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, it 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.

Destructuring the Response

listPoliciesResponse

Arguments

:: Int

lprsResponseStatus

-> ListPoliciesResponse

Creates a value of ListPoliciesResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lprsMarker - When IsTruncated is true , this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
• lprsIsTruncated - 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 of your results.
• lprsPolicies - A list of policies.
• lprsResponseStatus - -- | The response status code.

data ListPoliciesResponse

Contains the response to a successful ListPolicies request.

See: listPoliciesResponse smart constructor.

Instances

Eq ListPoliciesResponse

Methods

(==) :: ListPoliciesResponse -> ListPoliciesResponse -> Bool

(/=) :: ListPoliciesResponse -> ListPoliciesResponse -> Bool

Data ListPoliciesResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListPoliciesResponse -> c ListPoliciesResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListPoliciesResponse

toConstr :: ListPoliciesResponse -> Constr

dataTypeOf :: ListPoliciesResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListPoliciesResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListPoliciesResponse)

gmapT :: (forall b. Data b => b -> b) -> ListPoliciesResponse -> ListPoliciesResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListPoliciesResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListPoliciesResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> ListPoliciesResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListPoliciesResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListPoliciesResponse -> m ListPoliciesResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListPoliciesResponse -> m ListPoliciesResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListPoliciesResponse -> m ListPoliciesResponse

Read ListPoliciesResponse

Methods

readsPrec :: Int -> ReadS ListPoliciesResponse

readList :: ReadS [ListPoliciesResponse]

readPrec :: ReadPrec ListPoliciesResponse

readListPrec :: ReadPrec [ListPoliciesResponse]

Show ListPoliciesResponse

Methods

showsPrec :: Int -> ListPoliciesResponse -> ShowS

show :: ListPoliciesResponse -> String

showList :: [ListPoliciesResponse] -> ShowS

Generic ListPoliciesResponse

Associated Types

type Rep ListPoliciesResponse :: * -> *

Methods

from :: ListPoliciesResponse -> Rep ListPoliciesResponse x

to :: Rep ListPoliciesResponse x -> ListPoliciesResponse

NFData ListPoliciesResponse

Methods

rnf :: ListPoliciesResponse -> ()

type Rep ListPoliciesResponse

type Rep ListPoliciesResponse = D1 * (MetaData "ListPoliciesResponse" "Network.AWS.IAM.ListPolicies" "amazonka-iam-1.6.0-CI3f7XZIc4eD0Ehb04tNY7" False) (C1 * (MetaCons "ListPoliciesResponse'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_lprsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_lprsIsTruncated") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lprsPolicies") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Policy]))) (S1 * (MetaSel (Just Symbol "_lprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

lprsMarker :: Lens' ListPoliciesResponse (Maybe Text)

When IsTruncated is true , this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

lprsIsTruncated :: Lens' ListPoliciesResponse (Maybe Bool)

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 of your results.

lprsPolicies :: Lens' ListPoliciesResponse [Policy]

A list of policies.

lprsResponseStatus :: Lens' ListPoliciesResponse Int

• - | The response status code.