| 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 |
Amazonka.Organizations.ListTargetsForPolicy
Description
Lists all the roots, organizational units (OUs), and accounts that the specified policy is attached to.
Always check the NextToken response parameter for a null value when
calling a List* operation. These operations can occasionally return an
empty set of results even when there are more results available. The
NextToken response parameter value is null only when there are no
more results to display.
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an AWS service.
This operation returns paginated results.
Synopsis
- data ListTargetsForPolicy = ListTargetsForPolicy' {}
- newListTargetsForPolicy :: Text -> ListTargetsForPolicy
- listTargetsForPolicy_nextToken :: Lens' ListTargetsForPolicy (Maybe Text)
- listTargetsForPolicy_maxResults :: Lens' ListTargetsForPolicy (Maybe Natural)
- listTargetsForPolicy_policyId :: Lens' ListTargetsForPolicy Text
- data ListTargetsForPolicyResponse = ListTargetsForPolicyResponse' {
- nextToken :: Maybe Text
- targets :: Maybe [PolicyTargetSummary]
- httpStatus :: Int
- newListTargetsForPolicyResponse :: Int -> ListTargetsForPolicyResponse
- listTargetsForPolicyResponse_nextToken :: Lens' ListTargetsForPolicyResponse (Maybe Text)
- listTargetsForPolicyResponse_targets :: Lens' ListTargetsForPolicyResponse (Maybe [PolicyTargetSummary])
- listTargetsForPolicyResponse_httpStatus :: Lens' ListTargetsForPolicyResponse Int
Creating a Request
data ListTargetsForPolicy Source #
See: newListTargetsForPolicy smart constructor.
Constructors
| ListTargetsForPolicy' | |
Fields
| |
Instances
newListTargetsForPolicy Source #
Arguments
| :: Text | |
| -> ListTargetsForPolicy |
Create a value of ListTargetsForPolicy 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:nextToken:ListTargetsForPolicy', listTargetsForPolicy_nextToken - The parameter for receiving additional results if you receive a
NextToken response in a previous request. A NextToken response
indicates that more output is available. Set this parameter to the value
of the previous call's NextToken response to indicate where the
output should continue from.
$sel:maxResults:ListTargetsForPolicy', listTargetsForPolicy_maxResults - The total number of results that you want included on each page of 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.
$sel:policyId:ListTargetsForPolicy', listTargetsForPolicy_policyId - The unique identifier (ID) of the policy whose attachments you want to
know.
The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).
Request Lenses
listTargetsForPolicy_nextToken :: Lens' ListTargetsForPolicy (Maybe Text) Source #
The parameter for receiving additional results if you receive a
NextToken response in a previous request. A NextToken response
indicates that more output is available. Set this parameter to the value
of the previous call's NextToken response to indicate where the
output should continue from.
listTargetsForPolicy_maxResults :: Lens' ListTargetsForPolicy (Maybe Natural) Source #
The total number of results that you want included on each page of 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.
listTargetsForPolicy_policyId :: Lens' ListTargetsForPolicy Text Source #
The unique identifier (ID) of the policy whose attachments you want to know.
The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).
Destructuring the Response
data ListTargetsForPolicyResponse Source #
See: newListTargetsForPolicyResponse smart constructor.
Constructors
| ListTargetsForPolicyResponse' | |
Fields
| |
Instances
newListTargetsForPolicyResponse Source #
Create a value of ListTargetsForPolicyResponse 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:nextToken:ListTargetsForPolicy', listTargetsForPolicyResponse_nextToken - If present, indicates that more output is 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.
$sel:targets:ListTargetsForPolicyResponse', listTargetsForPolicyResponse_targets - A list of structures, each of which contains details about one of the
entities to which the specified policy is attached.
$sel:httpStatus:ListTargetsForPolicyResponse', listTargetsForPolicyResponse_httpStatus - The response's http status code.
Response Lenses
listTargetsForPolicyResponse_nextToken :: Lens' ListTargetsForPolicyResponse (Maybe Text) Source #
If present, indicates that more output is 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.
listTargetsForPolicyResponse_targets :: Lens' ListTargetsForPolicyResponse (Maybe [PolicyTargetSummary]) Source #
A list of structures, each of which contains details about one of the entities to which the specified policy is attached.
listTargetsForPolicyResponse_httpStatus :: Lens' ListTargetsForPolicyResponse Int Source #
The response's http status code.