| 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 |
Network.AWS.Organizations.ListPolicies
Description
Retrieves the list of all policies in an organization of a specified type.
This operation can be called only from the organization's master account.
This operation returns paginated results.
Synopsis
- listPolicies :: PolicyType -> ListPolicies
- data ListPolicies
- lpNextToken :: Lens' ListPolicies (Maybe Text)
- lpMaxResults :: Lens' ListPolicies (Maybe Natural)
- lpFilter :: Lens' ListPolicies PolicyType
- listPoliciesResponse :: Int -> ListPoliciesResponse
- data ListPoliciesResponse
- lprsNextToken :: Lens' ListPoliciesResponse (Maybe Text)
- lprsPolicies :: Lens' ListPoliciesResponse [PolicySummary]
- lprsResponseStatus :: Lens' ListPoliciesResponse Int
Creating a Request
Arguments
| :: PolicyType | |
| -> ListPolicies |
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:
lpNextToken- Use this parameter if you receive aNextTokenresponse in a previous request that indicates that there is more output available. Set it to the value of the previous call'sNextTokenresponse to indicate where the output should continue from.lpMaxResults- (Optional) Use this to limit the number of results you want included in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, theNextTokenresponse element is present and has a value (is not null). Include that value as theNextTokenrequest parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should checkNextTokenafter every operation to ensure that you receive all of the results.lpFilter- Specifies the type of policy that you want to include in the response.
data ListPolicies Source #
See: listPolicies smart constructor.
Instances
Request Lenses
lpNextToken :: Lens' ListPolicies (Maybe Text) Source #
Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.
lpMaxResults :: Lens' ListPolicies (Maybe Natural) Source #
(Optional) Use this to limit the number of results you want included in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
lpFilter :: Lens' ListPolicies PolicyType Source #
Specifies the type of policy that you want to include in the response.
Destructuring the Response
Arguments
| :: Int | |
| -> ListPoliciesResponse |
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:
lprsNextToken- If present, this value indicates that there is more output available than is included in the current response. Use this value in theNextTokenrequest parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until theNextTokenresponse element comes back asnull.lprsPolicies- A list of policies that match the filter criteria in the request. The output list does not include the policy contents. To see the content for a policy, seeDescribePolicy.lprsResponseStatus- -- | The response status code.
data ListPoliciesResponse Source #
See: listPoliciesResponse smart constructor.
Instances
Response Lenses
lprsNextToken :: Lens' ListPoliciesResponse (Maybe Text) Source #
If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null .
lprsPolicies :: Lens' ListPoliciesResponse [PolicySummary] Source #
A list of policies that match the filter criteria in the request. The output list does not include the policy contents. To see the content for a policy, see DescribePolicy .
lprsResponseStatus :: Lens' ListPoliciesResponse Int Source #
- - | The response status code.