Network.AWS.IAM.ListEntitiesForPolicy

Lists all IAM users, groups, and roles that the specified managed policy is attached to.

You can use the optional EntityFilter parameter to limit the results to a particular type of entity (users, groups, or roles). For example, to list only the roles that are attached to the specified policy, set EntityFilter to Role.

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

This operation returns paginated results.

Creating a Request

listEntitiesForPolicy

Arguments

:: Text

lefpPolicyARN

-> ListEntitiesForPolicy

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

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

• lefpPathPrefix
• lefpEntityFilter
• lefpMarker
• lefpMaxItems
• lefpPolicyARN

data ListEntitiesForPolicy

See: listEntitiesForPolicy smart constructor.

Instances

Eq ListEntitiesForPolicy

Methods

(==) :: ListEntitiesForPolicy -> ListEntitiesForPolicy -> Bool

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

Data ListEntitiesForPolicy

Methods

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

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

toConstr :: ListEntitiesForPolicy -> Constr

dataTypeOf :: ListEntitiesForPolicy -> DataType

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

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

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

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

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

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

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

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

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

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

Read ListEntitiesForPolicy

Methods

readsPrec :: Int -> ReadS ListEntitiesForPolicy

readList :: ReadS [ListEntitiesForPolicy]

readPrec :: ReadPrec ListEntitiesForPolicy

readListPrec :: ReadPrec [ListEntitiesForPolicy]

Show ListEntitiesForPolicy

Methods

showsPrec :: Int -> ListEntitiesForPolicy -> ShowS

show :: ListEntitiesForPolicy -> String

showList :: [ListEntitiesForPolicy] -> ShowS

Generic ListEntitiesForPolicy

Associated Types

type Rep ListEntitiesForPolicy :: * -> *

Methods

from :: ListEntitiesForPolicy -> Rep ListEntitiesForPolicy x

to :: Rep ListEntitiesForPolicy x -> ListEntitiesForPolicy

Hashable ListEntitiesForPolicy

Methods

hashWithSalt :: Int -> ListEntitiesForPolicy -> Int

hash :: ListEntitiesForPolicy -> Int

NFData ListEntitiesForPolicy

Methods

rnf :: ListEntitiesForPolicy -> ()

AWSPager ListEntitiesForPolicy

Methods

page :: ListEntitiesForPolicy -> Rs ListEntitiesForPolicy -> Maybe ListEntitiesForPolicy

AWSRequest ListEntitiesForPolicy

Associated Types

type Rs ListEntitiesForPolicy :: *

Methods

request :: ListEntitiesForPolicy -> Request ListEntitiesForPolicy

response :: MonadResource m => Logger -> Service -> Proxy * ListEntitiesForPolicy -> ClientResponse -> m (Response ListEntitiesForPolicy)

ToPath ListEntitiesForPolicy

Methods

toPath :: ListEntitiesForPolicy -> ByteString

ToHeaders ListEntitiesForPolicy

Methods

toHeaders :: ListEntitiesForPolicy -> [Header]

ToQuery ListEntitiesForPolicy

Methods

toQuery :: ListEntitiesForPolicy -> QueryString

type Rep ListEntitiesForPolicy

type Rep ListEntitiesForPolicy = D1 (MetaData "ListEntitiesForPolicy" "Network.AWS.IAM.ListEntitiesForPolicy" "amazonka-iam-1.4.4-BicPZt3TaHh2CoAkQqkWBu" False) (C1 (MetaCons "ListEntitiesForPolicy'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_lefpPathPrefix") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_lefpEntityFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe EntityType)))) ((:*:) (S1 (MetaSel (Just Symbol "_lefpMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_lefpMaxItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_lefpPolicyARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))

type Rs ListEntitiesForPolicy

type Rs ListEntitiesForPolicy = ListEntitiesForPolicyResponse

Request Lenses

lefpPathPrefix :: Lens' ListEntitiesForPolicy (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 entities.

The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\u0021) thru the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

lefpEntityFilter :: Lens' ListEntitiesForPolicy (Maybe EntityType)

The entity type to use for filtering the results.

For example, when EntityFilter is Role, only the roles that are attached to the specified policy are returned. This parameter is optional. If it is not included, all attached entities (users, groups, and roles) are returned. The argument for this parameter must be one of the valid values listed below.

lefpMarker :: Lens' ListEntitiesForPolicy (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.

lefpMaxItems :: Lens' ListEntitiesForPolicy (Maybe Natural)

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.

This parameter is optional. If you do not include it, 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.

lefpPolicyARN :: Lens' ListEntitiesForPolicy Text

The Amazon Resource Name (ARN) of the IAM policy for which you want the versions.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

Destructuring the Response

listEntitiesForPolicyResponse

Arguments

:: Int

lefprsResponseStatus

-> ListEntitiesForPolicyResponse

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

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

• lefprsPolicyGroups
• lefprsPolicyRoles
• lefprsMarker
• lefprsPolicyUsers
• lefprsIsTruncated
• lefprsResponseStatus

data ListEntitiesForPolicyResponse

Contains the response to a successful ListEntitiesForPolicy request.

See: listEntitiesForPolicyResponse smart constructor.

Instances

Eq ListEntitiesForPolicyResponse

Methods

(==) :: ListEntitiesForPolicyResponse -> ListEntitiesForPolicyResponse -> Bool

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

Data ListEntitiesForPolicyResponse

Methods

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

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

toConstr :: ListEntitiesForPolicyResponse -> Constr

dataTypeOf :: ListEntitiesForPolicyResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read ListEntitiesForPolicyResponse

Methods

readsPrec :: Int -> ReadS ListEntitiesForPolicyResponse

readList :: ReadS [ListEntitiesForPolicyResponse]

readPrec :: ReadPrec ListEntitiesForPolicyResponse

readListPrec :: ReadPrec [ListEntitiesForPolicyResponse]

Show ListEntitiesForPolicyResponse

Methods

showsPrec :: Int -> ListEntitiesForPolicyResponse -> ShowS

show :: ListEntitiesForPolicyResponse -> String

showList :: [ListEntitiesForPolicyResponse] -> ShowS

Generic ListEntitiesForPolicyResponse

Associated Types

type Rep ListEntitiesForPolicyResponse :: * -> *

Methods

from :: ListEntitiesForPolicyResponse -> Rep ListEntitiesForPolicyResponse x

to :: Rep ListEntitiesForPolicyResponse x -> ListEntitiesForPolicyResponse

NFData ListEntitiesForPolicyResponse

Methods

rnf :: ListEntitiesForPolicyResponse -> ()

type Rep ListEntitiesForPolicyResponse

type Rep ListEntitiesForPolicyResponse = D1 (MetaData "ListEntitiesForPolicyResponse" "Network.AWS.IAM.ListEntitiesForPolicy" "amazonka-iam-1.4.4-BicPZt3TaHh2CoAkQqkWBu" False) (C1 (MetaCons "ListEntitiesForPolicyResponse'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_lefprsPolicyGroups") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [PolicyGroup]))) ((:*:) (S1 (MetaSel (Just Symbol "_lefprsPolicyRoles") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [PolicyRole]))) (S1 (MetaSel (Just Symbol "_lefprsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_lefprsPolicyUsers") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [PolicyUser]))) ((:*:) (S1 (MetaSel (Just Symbol "_lefprsIsTruncated") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_lefprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))))

Response Lenses

lefprsPolicyGroups :: Lens' ListEntitiesForPolicyResponse [PolicyGroup]

A list of IAM groups that the policy is attached to.

lefprsPolicyRoles :: Lens' ListEntitiesForPolicyResponse [PolicyRole]

A list of IAM roles that the policy is attached to.

lefprsMarker :: Lens' ListEntitiesForPolicyResponse (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.

lefprsPolicyUsers :: Lens' ListEntitiesForPolicyResponse [PolicyUser]

A list of IAM users that the policy is attached to.

lefprsIsTruncated :: Lens' ListEntitiesForPolicyResponse (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.

lefprsResponseStatus :: Lens' ListEntitiesForPolicyResponse Int

The response status code.