entities_for_policies

Creates, updates, deletes, gets or lists an entities_for_policies resource.

Overview

Name	entities_for_policies
Type	Resource
Id	aws.iam.entities_for_policies

Fields

The following fields are returned by SELECT queries:

list_entities_for_policy

Name	Datatype	Description
group_id	string	The stable and unique string identifying the group. For more information about IDs, see IAM identifiers in the IAM User Guide.
group_name	string	The name (friendly name, not ARN) identifying the group.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_entities_for_policy	select	PolicyArn, region	EntityFilter, PathPrefix, PolicyUsageFilter, Marker, MaxItems	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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
PolicyArn	string	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) in the Amazon Web Services General Reference.
region	string	AWS region (default: us-east-1)
EntityFilter	string	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.
Marker	string	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.
MaxItems	integer	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.
PathPrefix	string	The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all entities. This parameter allows (through its 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.
PolicyUsageFilter	string	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.

SELECT examples

list_entities_for_policy

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.

SELECT
group_id,
group_name
FROM aws.iam.entities_for_policies
WHERE PolicyArn = '{{ PolicyArn }}' -- required
AND region = '{{ region }}' -- required
AND EntityFilter = '{{ EntityFilter }}'
AND PathPrefix = '{{ PathPrefix }}'
AND PolicyUsageFilter = '{{ PolicyUsageFilter }}'
AND Marker = '{{ Marker }}'
AND MaxItems = '{{ MaxItems }}'
;