Copyright | (c) 2013-2021 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) |
Safe Haskell | None |
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
- data ListEntitiesForPolicy = ListEntitiesForPolicy' {}
- newListEntitiesForPolicy :: Text -> ListEntitiesForPolicy
- listEntitiesForPolicy_pathPrefix :: Lens' ListEntitiesForPolicy (Maybe Text)
- listEntitiesForPolicy_entityFilter :: Lens' ListEntitiesForPolicy (Maybe EntityType)
- listEntitiesForPolicy_marker :: Lens' ListEntitiesForPolicy (Maybe Text)
- listEntitiesForPolicy_maxItems :: Lens' ListEntitiesForPolicy (Maybe Natural)
- listEntitiesForPolicy_policyUsageFilter :: Lens' ListEntitiesForPolicy (Maybe PolicyUsageType)
- listEntitiesForPolicy_policyArn :: Lens' ListEntitiesForPolicy Text
- data ListEntitiesForPolicyResponse = ListEntitiesForPolicyResponse' {
- policyGroups :: Maybe [PolicyGroup]
- policyRoles :: Maybe [PolicyRole]
- marker :: Maybe Text
- policyUsers :: Maybe [PolicyUser]
- isTruncated :: Maybe Bool
- httpStatus :: Int
- newListEntitiesForPolicyResponse :: Int -> ListEntitiesForPolicyResponse
- listEntitiesForPolicyResponse_policyGroups :: Lens' ListEntitiesForPolicyResponse (Maybe [PolicyGroup])
- listEntitiesForPolicyResponse_policyRoles :: Lens' ListEntitiesForPolicyResponse (Maybe [PolicyRole])
- listEntitiesForPolicyResponse_marker :: Lens' ListEntitiesForPolicyResponse (Maybe Text)
- listEntitiesForPolicyResponse_policyUsers :: Lens' ListEntitiesForPolicyResponse (Maybe [PolicyUser])
- listEntitiesForPolicyResponse_isTruncated :: Lens' ListEntitiesForPolicyResponse (Maybe Bool)
- listEntitiesForPolicyResponse_httpStatus :: Lens' ListEntitiesForPolicyResponse Int
Creating a Request
data ListEntitiesForPolicy Source #
See: newListEntitiesForPolicy
smart constructor.
ListEntitiesForPolicy' | |
|
Instances
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.
ListEntitiesForPolicyResponse' | |
|
Instances
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_policyGroups :: Lens' ListEntitiesForPolicyResponse (Maybe [PolicyGroup]) Source #
A list of IAM groups that the policy is attached to.
listEntitiesForPolicyResponse_policyRoles :: Lens' ListEntitiesForPolicyResponse (Maybe [PolicyRole]) Source #
A list of IAM roles that the policy is attached to.
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_policyUsers :: Lens' ListEntitiesForPolicyResponse (Maybe [PolicyUser]) Source #
A list of IAM users that the policy is attached to.
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.
listEntitiesForPolicyResponse_httpStatus :: Lens' ListEntitiesForPolicyResponse Int Source #
The response's http status code.