| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.OpenSearchServerless.ListAccessPolicies
Description
Returns information about a list of OpenSearch Serverless access policies.
Synopsis
- data ListAccessPolicies = ListAccessPolicies' {}
- newListAccessPolicies :: AccessPolicyType -> ListAccessPolicies
- listAccessPolicies_maxResults :: Lens' ListAccessPolicies (Maybe Natural)
- listAccessPolicies_nextToken :: Lens' ListAccessPolicies (Maybe Text)
- listAccessPolicies_resource :: Lens' ListAccessPolicies (Maybe (NonEmpty Text))
- listAccessPolicies_type :: Lens' ListAccessPolicies AccessPolicyType
- data ListAccessPoliciesResponse = ListAccessPoliciesResponse' {}
- newListAccessPoliciesResponse :: Int -> ListAccessPoliciesResponse
- listAccessPoliciesResponse_accessPolicySummaries :: Lens' ListAccessPoliciesResponse (Maybe [AccessPolicySummary])
- listAccessPoliciesResponse_nextToken :: Lens' ListAccessPoliciesResponse (Maybe Text)
- listAccessPoliciesResponse_httpStatus :: Lens' ListAccessPoliciesResponse Int
Creating a Request
data ListAccessPolicies Source #
See: newListAccessPolicies smart constructor.
Constructors
| ListAccessPolicies' | |
Fields
| |
Instances
newListAccessPolicies Source #
Arguments
| :: AccessPolicyType | |
| -> ListAccessPolicies |
Create a value of ListAccessPolicies 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:maxResults:ListAccessPolicies', listAccessPolicies_maxResults - An optional parameter that specifies the maximum number of results to
return. You can use nextToken to get the next page of results. The
default is 20.
ListAccessPolicies, listAccessPolicies_nextToken - If your initial ListAccessPolicies operation returns a nextToken,
you can include the returned nextToken in subsequent
ListAccessPolicies operations, which returns results in the next page.
$sel:resource:ListAccessPolicies', listAccessPolicies_resource - Resource filters (can be collection or indexes) that policies can apply
to.
ListAccessPolicies, listAccessPolicies_type - The type of access policy.
Request Lenses
listAccessPolicies_maxResults :: Lens' ListAccessPolicies (Maybe Natural) Source #
An optional parameter that specifies the maximum number of results to
return. You can use nextToken to get the next page of results. The
default is 20.
listAccessPolicies_nextToken :: Lens' ListAccessPolicies (Maybe Text) Source #
If your initial ListAccessPolicies operation returns a nextToken,
you can include the returned nextToken in subsequent
ListAccessPolicies operations, which returns results in the next page.
listAccessPolicies_resource :: Lens' ListAccessPolicies (Maybe (NonEmpty Text)) Source #
Resource filters (can be collection or indexes) that policies can apply to.
listAccessPolicies_type :: Lens' ListAccessPolicies AccessPolicyType Source #
The type of access policy.
Destructuring the Response
data ListAccessPoliciesResponse Source #
See: newListAccessPoliciesResponse smart constructor.
Constructors
| ListAccessPoliciesResponse' | |
Fields
| |
Instances
newListAccessPoliciesResponse Source #
Create a value of ListAccessPoliciesResponse 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:accessPolicySummaries:ListAccessPoliciesResponse', listAccessPoliciesResponse_accessPolicySummaries - Details about the requested access policies.
ListAccessPolicies, listAccessPoliciesResponse_nextToken - When nextToken is returned, there are more results available. The
value of nextToken is a unique pagination token for each page. Make
the call again using the returned token to retrieve the next page.
$sel:httpStatus:ListAccessPoliciesResponse', listAccessPoliciesResponse_httpStatus - The response's http status code.
Response Lenses
listAccessPoliciesResponse_accessPolicySummaries :: Lens' ListAccessPoliciesResponse (Maybe [AccessPolicySummary]) Source #
Details about the requested access policies.
listAccessPoliciesResponse_nextToken :: Lens' ListAccessPoliciesResponse (Maybe Text) Source #
When nextToken is returned, there are more results available. The
value of nextToken is a unique pagination token for each page. Make
the call again using the returned token to retrieve the next page.
listAccessPoliciesResponse_httpStatus :: Lens' ListAccessPoliciesResponse Int Source #
The response's http status code.