amazonka-iam-1.6.0: gen/Network/AWS/IAM/GetAccountAuthorizationDetails.hs
{-# LANGUAGE DeriveDataTypeable #-}
{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE TypeFamilies #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}
-- Derived from AWS service descriptions, licensed under Apache 2.0.
-- |
-- Module : Network.AWS.IAM.GetAccountAuthorizationDetails
-- Copyright : (c) 2013-2018 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)
--
-- Retrieves information about all IAM users, groups, roles, and policies in your AWS account, including their relationships to one another. Use this API to obtain a snapshot of the configuration of IAM permissions (users, groups, roles, and policies) in your account.
--
--
-- You can optionally filter the results using the @Filter@ parameter. You can paginate the results using the @MaxItems@ and @Marker@ parameters.
--
--
-- This operation returns paginated results.
module Network.AWS.IAM.GetAccountAuthorizationDetails
(
-- * Creating a Request
getAccountAuthorizationDetails
, GetAccountAuthorizationDetails
-- * Request Lenses
, gaadMarker
, gaadMaxItems
, gaadFilter
-- * Destructuring the Response
, getAccountAuthorizationDetailsResponse
, GetAccountAuthorizationDetailsResponse
-- * Response Lenses
, gaadrsRoleDetailList
, gaadrsGroupDetailList
, gaadrsUserDetailList
, gaadrsMarker
, gaadrsIsTruncated
, gaadrsPolicies
, gaadrsResponseStatus
) where
import Network.AWS.IAM.Types
import Network.AWS.IAM.Types.Product
import Network.AWS.Lens
import Network.AWS.Pager
import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
-- | /See:/ 'getAccountAuthorizationDetails' smart constructor.
data GetAccountAuthorizationDetails = GetAccountAuthorizationDetails'
{ _gaadMarker :: !(Maybe Text)
, _gaadMaxItems :: !(Maybe Nat)
, _gaadFilter :: !(Maybe [EntityType])
} deriving (Eq, Read, Show, Data, Typeable, Generic)
-- | Creates a value of 'GetAccountAuthorizationDetails' with the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
-- * 'gaadMarker' - 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.
--
-- * 'gaadMaxItems' - (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.
--
-- * 'gaadFilter' - A list of entity types used to filter the results. Only the entities that match the types you specify are included in the output. Use the value @LocalManagedPolicy@ to include customer managed policies. The format for this parameter is a comma-separated (if more than one) list of strings. Each string value in the list must be one of the valid values listed below.
getAccountAuthorizationDetails
:: GetAccountAuthorizationDetails
getAccountAuthorizationDetails =
GetAccountAuthorizationDetails'
{_gaadMarker = Nothing, _gaadMaxItems = Nothing, _gaadFilter = Nothing}
-- | 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.
gaadMarker :: Lens' GetAccountAuthorizationDetails (Maybe Text)
gaadMarker = lens _gaadMarker (\ s a -> s{_gaadMarker = a})
-- | (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.
gaadMaxItems :: Lens' GetAccountAuthorizationDetails (Maybe Natural)
gaadMaxItems = lens _gaadMaxItems (\ s a -> s{_gaadMaxItems = a}) . mapping _Nat
-- | A list of entity types used to filter the results. Only the entities that match the types you specify are included in the output. Use the value @LocalManagedPolicy@ to include customer managed policies. The format for this parameter is a comma-separated (if more than one) list of strings. Each string value in the list must be one of the valid values listed below.
gaadFilter :: Lens' GetAccountAuthorizationDetails [EntityType]
gaadFilter = lens _gaadFilter (\ s a -> s{_gaadFilter = a}) . _Default . _Coerce
instance AWSPager GetAccountAuthorizationDetails
where
page rq rs
| stop (rs ^. gaadrsIsTruncated) = Nothing
| isNothing (rs ^. gaadrsMarker) = Nothing
| otherwise =
Just $ rq & gaadMarker .~ rs ^. gaadrsMarker
instance AWSRequest GetAccountAuthorizationDetails
where
type Rs GetAccountAuthorizationDetails =
GetAccountAuthorizationDetailsResponse
request = postQuery iam
response
= receiveXMLWrapper
"GetAccountAuthorizationDetailsResult"
(\ s h x ->
GetAccountAuthorizationDetailsResponse' <$>
(x .@? "RoleDetailList" .!@ mempty >>=
may (parseXMLList "member"))
<*>
(x .@? "GroupDetailList" .!@ mempty >>=
may (parseXMLList "member"))
<*>
(x .@? "UserDetailList" .!@ mempty >>=
may (parseXMLList "member"))
<*> (x .@? "Marker")
<*> (x .@? "IsTruncated")
<*>
(x .@? "Policies" .!@ mempty >>=
may (parseXMLList "member"))
<*> (pure (fromEnum s)))
instance Hashable GetAccountAuthorizationDetails
where
instance NFData GetAccountAuthorizationDetails where
instance ToHeaders GetAccountAuthorizationDetails
where
toHeaders = const mempty
instance ToPath GetAccountAuthorizationDetails where
toPath = const "/"
instance ToQuery GetAccountAuthorizationDetails where
toQuery GetAccountAuthorizationDetails'{..}
= mconcat
["Action" =:
("GetAccountAuthorizationDetails" :: ByteString),
"Version" =: ("2010-05-08" :: ByteString),
"Marker" =: _gaadMarker, "MaxItems" =: _gaadMaxItems,
"Filter" =:
toQuery (toQueryList "member" <$> _gaadFilter)]
-- | Contains the response to a successful 'GetAccountAuthorizationDetails' request.
--
--
--
-- /See:/ 'getAccountAuthorizationDetailsResponse' smart constructor.
data GetAccountAuthorizationDetailsResponse = GetAccountAuthorizationDetailsResponse'
{ _gaadrsRoleDetailList :: !(Maybe [RoleDetail])
, _gaadrsGroupDetailList :: !(Maybe [GroupDetail])
, _gaadrsUserDetailList :: !(Maybe [UserDetail])
, _gaadrsMarker :: !(Maybe Text)
, _gaadrsIsTruncated :: !(Maybe Bool)
, _gaadrsPolicies :: !(Maybe [ManagedPolicyDetail])
, _gaadrsResponseStatus :: !Int
} deriving (Eq, Read, Show, Data, Typeable, Generic)
-- | Creates a value of 'GetAccountAuthorizationDetailsResponse' with the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
-- * 'gaadrsRoleDetailList' - A list containing information about IAM roles.
--
-- * 'gaadrsGroupDetailList' - A list containing information about IAM groups.
--
-- * 'gaadrsUserDetailList' - A list containing information about IAM users.
--
-- * 'gaadrsMarker' - When @IsTruncated@ is @true@ , this element is present and contains the value to use for the @Marker@ parameter in a subsequent pagination request.
--
-- * 'gaadrsIsTruncated' - 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.
--
-- * 'gaadrsPolicies' - A list containing information about managed policies.
--
-- * 'gaadrsResponseStatus' - -- | The response status code.
getAccountAuthorizationDetailsResponse
:: Int -- ^ 'gaadrsResponseStatus'
-> GetAccountAuthorizationDetailsResponse
getAccountAuthorizationDetailsResponse pResponseStatus_ =
GetAccountAuthorizationDetailsResponse'
{ _gaadrsRoleDetailList = Nothing
, _gaadrsGroupDetailList = Nothing
, _gaadrsUserDetailList = Nothing
, _gaadrsMarker = Nothing
, _gaadrsIsTruncated = Nothing
, _gaadrsPolicies = Nothing
, _gaadrsResponseStatus = pResponseStatus_
}
-- | A list containing information about IAM roles.
gaadrsRoleDetailList :: Lens' GetAccountAuthorizationDetailsResponse [RoleDetail]
gaadrsRoleDetailList = lens _gaadrsRoleDetailList (\ s a -> s{_gaadrsRoleDetailList = a}) . _Default . _Coerce
-- | A list containing information about IAM groups.
gaadrsGroupDetailList :: Lens' GetAccountAuthorizationDetailsResponse [GroupDetail]
gaadrsGroupDetailList = lens _gaadrsGroupDetailList (\ s a -> s{_gaadrsGroupDetailList = a}) . _Default . _Coerce
-- | A list containing information about IAM users.
gaadrsUserDetailList :: Lens' GetAccountAuthorizationDetailsResponse [UserDetail]
gaadrsUserDetailList = lens _gaadrsUserDetailList (\ s a -> s{_gaadrsUserDetailList = a}) . _Default . _Coerce
-- | When @IsTruncated@ is @true@ , this element is present and contains the value to use for the @Marker@ parameter in a subsequent pagination request.
gaadrsMarker :: Lens' GetAccountAuthorizationDetailsResponse (Maybe Text)
gaadrsMarker = lens _gaadrsMarker (\ s a -> s{_gaadrsMarker = a})
-- | 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.
gaadrsIsTruncated :: Lens' GetAccountAuthorizationDetailsResponse (Maybe Bool)
gaadrsIsTruncated = lens _gaadrsIsTruncated (\ s a -> s{_gaadrsIsTruncated = a})
-- | A list containing information about managed policies.
gaadrsPolicies :: Lens' GetAccountAuthorizationDetailsResponse [ManagedPolicyDetail]
gaadrsPolicies = lens _gaadrsPolicies (\ s a -> s{_gaadrsPolicies = a}) . _Default . _Coerce
-- | -- | The response status code.
gaadrsResponseStatus :: Lens' GetAccountAuthorizationDetailsResponse Int
gaadrsResponseStatus = lens _gaadrsResponseStatus (\ s a -> s{_gaadrsResponseStatus = a})
instance NFData
GetAccountAuthorizationDetailsResponse
where