AWS Identity and Access Management

{'PolicyGroups': {'GroupId': 'string'},
 'PolicyRoles': {'RoleId': 'string'},
 'PolicyUsers': {'UserId': 'string'}}

Lists all 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.

Request Syntax

client.list_entities_for_policy(
    PolicyArn='string',
    EntityFilter='User'|'Role'|'Group'|'LocalManagedPolicy'|'AWSManagedPolicy',
    PathPrefix='string',
    Marker='string',
    MaxItems=123
)

type PolicyArn:

string

param PolicyArn:

[REQUIRED]

The Amazon Resource Name (ARN). ARNs are unique identifiers for AWS resources.

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

type EntityFilter:

string

param EntityFilter:

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.

type PathPrefix:

string

param PathPrefix:

The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all entities.

type Marker:

string

param 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.

type MaxItems:

integer

param 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.

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.

rtype:

dict

returns:

Response Syntax

{
    'PolicyGroups': [
        {
            'GroupName': 'string',
            'GroupId': 'string'
        },
    ],
    'PolicyUsers': [
        {
            'UserName': 'string',
            'UserId': 'string'
        },
    ],
    'PolicyRoles': [
        {
            'RoleName': 'string',
            'RoleId': 'string'
        },
    ],
    'IsTruncated': True|False,
    'Marker': 'string'
}

Response Structure

• (dict) --

  Contains the response to a successful ListEntitiesForPolicy request.

  • PolicyGroups (list) --

    A list of groups that the policy is attached to.

    • (dict) --

      Contains information about a group that a managed policy is attached to.

      This data type is used as a response element in the ListEntitiesForPolicy action.

      For more information about managed policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

      • GroupName (string) --

        The name (friendly name, not ARN) identifying the group.

      • GroupId (string) --

        The stable and unique string identifying the group. For more information about IDs, see IAM Identifiers in the IAM User Guide.

  • PolicyUsers (list) --

    A list of users that the policy is attached to.

    • (dict) --

      Contains information about a user that a managed policy is attached to.

      This data type is used as a response element in the ListEntitiesForPolicy action.

      For more information about managed policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

      • UserName (string) --

        The name (friendly name, not ARN) identifying the user.

      • UserId (string) --

        The stable and unique string identifying the user. For more information about IDs, see IAM Identifiers in the IAM User Guide.

  • PolicyRoles (list) --

    A list of roles that the policy is attached to.

    • (dict) --

      Contains information about a role that a managed policy is attached to.

      This data type is used as a response element in the ListEntitiesForPolicy action.

      For more information about managed policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

      • RoleName (string) --

        The name (friendly name, not ARN) identifying the role.

      • RoleId (string) --

        The stable and unique string identifying the role. For more information about IDs, see IAM Identifiers in the IAM User Guide.

  • IsTruncated (boolean) --

    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.

  • Marker (string) --

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