Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
Lists all the managed policies that are available in your AWS account, including your own customer-defined managed policies and all AWS managed policies.
You can filter the list of policies that is returned using the optional OnlyAttached
, Scope
, and PathPrefix
parameters. For example, to list only the customer managed policies in your AWS account, set Scope
to Local
. To list only AWS managed policies, set Scope
to AWS
.
You can paginate the results using the MaxItems
and Marker
parameters.
For more information about managed policies, see Managed Policies and Inline Policies in the IAM User Guide .
This operation returns paginated results.
Synopsis
- listPolicies :: ListPolicies
- data ListPolicies
- lpPathPrefix :: Lens' ListPolicies (Maybe Text)
- lpOnlyAttached :: Lens' ListPolicies (Maybe Bool)
- lpMarker :: Lens' ListPolicies (Maybe Text)
- lpScope :: Lens' ListPolicies (Maybe PolicyScopeType)
- lpMaxItems :: Lens' ListPolicies (Maybe Natural)
- listPoliciesResponse :: Int -> ListPoliciesResponse
- data ListPoliciesResponse
- lprsMarker :: Lens' ListPoliciesResponse (Maybe Text)
- lprsIsTruncated :: Lens' ListPoliciesResponse (Maybe Bool)
- lprsPolicies :: Lens' ListPoliciesResponse [Policy]
- lprsResponseStatus :: Lens' ListPoliciesResponse Int
Creating a Request
listPolicies :: ListPolicies Source #
Creates a value of ListPolicies
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lpPathPrefix
- The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (), listing all policies. This parameter allows (per its <http:wikipedia.orgwikiregex 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.lpOnlyAttached
- A flag to filter the results to only the attached policies. WhenOnlyAttached
istrue
, the returned list contains only the policies that are attached to an IAM user, group, or role. WhenOnlyAttached
isfalse
, or when the parameter is not included, all policies are returned.lpMarker
- 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 theMarker
element in the response that you received to indicate where the next call should start.lpScope
- The scope to use for filtering the results. To list only AWS managed policies, setScope
toAWS
. To list only the customer managed policies in your AWS account, setScope
toLocal
. This parameter is optional. If it is not included, or if it is set toAll
, all policies are returned.lpMaxItems
- (Optional) 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, theIsTruncated
response element istrue
. If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, theIsTruncated
response element returnstrue
andMarker
contains a value to include in the subsequent call that tells the service where to continue from.
data ListPolicies Source #
See: listPolicies
smart constructor.
Instances
Request Lenses
lpPathPrefix :: Lens' ListPolicies (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 policies. This parameter allows (per its <http:wikipedia.orgwikiregex 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.
lpOnlyAttached :: Lens' ListPolicies (Maybe Bool) Source #
A flag to filter the results to only the attached policies. When OnlyAttached
is true
, the returned list contains only the policies that are attached to an IAM user, group, or role. When OnlyAttached
is false
, or when the parameter is not included, all policies are returned.
lpMarker :: Lens' ListPolicies (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.
lpScope :: Lens' ListPolicies (Maybe PolicyScopeType) Source #
The scope to use for filtering the results. To list only AWS managed policies, set Scope
to AWS
. To list only the customer managed policies in your AWS account, set Scope
to Local
. This parameter is optional. If it is not included, or if it is set to All
, all policies are returned.
lpMaxItems :: Lens' ListPolicies (Maybe Natural) Source #
(Optional) 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, 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.
Destructuring the Response
Creates a value of ListPoliciesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lprsMarker
- WhenIsTruncated
istrue
, this element is present and contains the value to use for theMarker
parameter in a subsequent pagination request.lprsIsTruncated
- A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using theMarker
request parameter to retrieve more items. Note that IAM might return fewer than theMaxItems
number of results even when there are more results available. We recommend that you checkIsTruncated
after every call to ensure that you receive all of your results.lprsPolicies
- A list of policies.lprsResponseStatus
- -- | The response status code.
data ListPoliciesResponse Source #
Contains the response to a successful ListPolicies
request.
See: listPoliciesResponse
smart constructor.
Instances
Response Lenses
lprsMarker :: Lens' ListPoliciesResponse (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.
lprsIsTruncated :: Lens' ListPoliciesResponse (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 of your results.
lprsPolicies :: Lens' ListPoliciesResponse [Policy] Source #
A list of policies.
lprsResponseStatus :: Lens' ListPoliciesResponse Int Source #
- - | The response status code.