libZSservicesZSamazonka-iamZSamazonka-iam
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.IAM.ListEntitiesForPolicy

Description

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.

Synopsis

Creating a Request

data ListEntitiesForPolicy Source #

See: newListEntitiesForPolicy smart constructor.

Constructors

ListEntitiesForPolicy' 

Fields

  • pathPrefix :: 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.

    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.

  • entityFilter :: 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.

  • marker :: 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.

  • maxItems :: 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.

    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.

  • policyUsageFilter :: Maybe PolicyUsageType

    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.

  • policyArn :: 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) in the Amazon Web Services General Reference.

Instances

Instances details
Eq ListEntitiesForPolicy Source # 
Instance details

Defined in Amazonka.IAM.ListEntitiesForPolicy

Read ListEntitiesForPolicy Source # 
Instance details

Defined in Amazonka.IAM.ListEntitiesForPolicy

Show ListEntitiesForPolicy Source # 
Instance details

Defined in Amazonka.IAM.ListEntitiesForPolicy

Generic ListEntitiesForPolicy Source # 
Instance details

Defined in Amazonka.IAM.ListEntitiesForPolicy

Associated Types

type Rep ListEntitiesForPolicy :: Type -> Type #

NFData ListEntitiesForPolicy Source # 
Instance details

Defined in Amazonka.IAM.ListEntitiesForPolicy

Methods

rnf :: ListEntitiesForPolicy -> () #

Hashable ListEntitiesForPolicy Source # 
Instance details

Defined in Amazonka.IAM.ListEntitiesForPolicy

AWSPager ListEntitiesForPolicy Source # 
Instance details

Defined in Amazonka.IAM.ListEntitiesForPolicy

AWSRequest ListEntitiesForPolicy Source # 
Instance details

Defined in Amazonka.IAM.ListEntitiesForPolicy

Associated Types

type AWSResponse ListEntitiesForPolicy #

ToHeaders ListEntitiesForPolicy Source # 
Instance details

Defined in Amazonka.IAM.ListEntitiesForPolicy

ToPath ListEntitiesForPolicy Source # 
Instance details

Defined in Amazonka.IAM.ListEntitiesForPolicy

ToQuery ListEntitiesForPolicy Source # 
Instance details

Defined in Amazonka.IAM.ListEntitiesForPolicy

type Rep ListEntitiesForPolicy Source # 
Instance details

Defined in Amazonka.IAM.ListEntitiesForPolicy

type Rep ListEntitiesForPolicy = D1 ('MetaData "ListEntitiesForPolicy" "Amazonka.IAM.ListEntitiesForPolicy" "libZSservicesZSamazonka-iamZSamazonka-iam" 'False) (C1 ('MetaCons "ListEntitiesForPolicy'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "pathPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "entityFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EntityType)) :*: S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "maxItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "policyUsageFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PolicyUsageType)) :*: S1 ('MetaSel ('Just "policyArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse ListEntitiesForPolicy Source # 
Instance details

Defined in Amazonka.IAM.ListEntitiesForPolicy

newListEntitiesForPolicy Source #

Create a value of ListEntitiesForPolicy with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:pathPrefix:ListEntitiesForPolicy', listEntitiesForPolicy_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.

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.

$sel:entityFilter:ListEntitiesForPolicy', listEntitiesForPolicy_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. The argument for this parameter must be one of the valid values listed below.

$sel:marker:ListEntitiesForPolicy', listEntitiesForPolicy_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.

$sel:maxItems:ListEntitiesForPolicy', listEntitiesForPolicy_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.

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.

$sel:policyUsageFilter:ListEntitiesForPolicy', listEntitiesForPolicy_policyUsageFilter - 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.

$sel:policyArn:ListEntitiesForPolicy', listEntitiesForPolicy_policyArn - 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.

Request Lenses

listEntitiesForPolicy_pathPrefix :: Lens' ListEntitiesForPolicy (Maybe Text) Source #

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.

listEntitiesForPolicy_entityFilter :: Lens' ListEntitiesForPolicy (Maybe EntityType) Source #

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.

listEntitiesForPolicy_marker :: Lens' ListEntitiesForPolicy (Maybe Text) Source #

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.

listEntitiesForPolicy_maxItems :: Lens' ListEntitiesForPolicy (Maybe Natural) Source #

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.

listEntitiesForPolicy_policyUsageFilter :: Lens' ListEntitiesForPolicy (Maybe PolicyUsageType) Source #

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.

listEntitiesForPolicy_policyArn :: Lens' ListEntitiesForPolicy Text Source #

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.

Destructuring the Response

data ListEntitiesForPolicyResponse Source #

Contains the response to a successful ListEntitiesForPolicy request.

See: newListEntitiesForPolicyResponse smart constructor.

Constructors

ListEntitiesForPolicyResponse' 

Fields

  • policyGroups :: Maybe [PolicyGroup]

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

  • policyRoles :: Maybe [PolicyRole]

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

  • marker :: 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.

  • policyUsers :: Maybe [PolicyUser]

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

  • isTruncated :: 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 your results.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ListEntitiesForPolicyResponse Source # 
Instance details

Defined in Amazonka.IAM.ListEntitiesForPolicy

Read ListEntitiesForPolicyResponse Source # 
Instance details

Defined in Amazonka.IAM.ListEntitiesForPolicy

Show ListEntitiesForPolicyResponse Source # 
Instance details

Defined in Amazonka.IAM.ListEntitiesForPolicy

Generic ListEntitiesForPolicyResponse Source # 
Instance details

Defined in Amazonka.IAM.ListEntitiesForPolicy

Associated Types

type Rep ListEntitiesForPolicyResponse :: Type -> Type #

NFData ListEntitiesForPolicyResponse Source # 
Instance details

Defined in Amazonka.IAM.ListEntitiesForPolicy

type Rep ListEntitiesForPolicyResponse Source # 
Instance details

Defined in Amazonka.IAM.ListEntitiesForPolicy

type Rep ListEntitiesForPolicyResponse = D1 ('MetaData "ListEntitiesForPolicyResponse" "Amazonka.IAM.ListEntitiesForPolicy" "libZSservicesZSamazonka-iamZSamazonka-iam" 'False) (C1 ('MetaCons "ListEntitiesForPolicyResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "policyGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PolicyGroup])) :*: (S1 ('MetaSel ('Just "policyRoles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PolicyRole])) :*: S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "policyUsers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PolicyUser])) :*: (S1 ('MetaSel ('Just "isTruncated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newListEntitiesForPolicyResponse Source #

Create a value of ListEntitiesForPolicyResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:policyGroups:ListEntitiesForPolicyResponse', listEntitiesForPolicyResponse_policyGroups - A list of IAM groups that the policy is attached to.

$sel:policyRoles:ListEntitiesForPolicyResponse', listEntitiesForPolicyResponse_policyRoles - A list of IAM roles that the policy is attached to.

$sel:marker:ListEntitiesForPolicy', listEntitiesForPolicyResponse_marker - When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

$sel:policyUsers:ListEntitiesForPolicyResponse', listEntitiesForPolicyResponse_policyUsers - A list of IAM users that the policy is attached to.

$sel:isTruncated:ListEntitiesForPolicyResponse', listEntitiesForPolicyResponse_isTruncated - 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 your results.

$sel:httpStatus:ListEntitiesForPolicyResponse', listEntitiesForPolicyResponse_httpStatus - The response's http status code.

Response Lenses

listEntitiesForPolicyResponse_marker :: Lens' ListEntitiesForPolicyResponse (Maybe Text) Source #

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

listEntitiesForPolicyResponse_isTruncated :: Lens' ListEntitiesForPolicyResponse (Maybe Bool) Source #

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