| 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.Shield.ListProtectionGroups
Description
Retrieves the ProtectionGroup objects for the account.
Synopsis
- data ListProtectionGroups = ListProtectionGroups' {}
- newListProtectionGroups :: ListProtectionGroups
- listProtectionGroups_nextToken :: Lens' ListProtectionGroups (Maybe Text)
- listProtectionGroups_maxResults :: Lens' ListProtectionGroups (Maybe Natural)
- data ListProtectionGroupsResponse = ListProtectionGroupsResponse' {}
- newListProtectionGroupsResponse :: Int -> ListProtectionGroupsResponse
- listProtectionGroupsResponse_nextToken :: Lens' ListProtectionGroupsResponse (Maybe Text)
- listProtectionGroupsResponse_httpStatus :: Lens' ListProtectionGroupsResponse Int
- listProtectionGroupsResponse_protectionGroups :: Lens' ListProtectionGroupsResponse [ProtectionGroup]
Creating a Request
data ListProtectionGroups Source #
See: newListProtectionGroups smart constructor.
Constructors
| ListProtectionGroups' | |
Fields
| |
Instances
newListProtectionGroups :: ListProtectionGroups Source #
Create a value of ListProtectionGroups 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:ListProtectionGroups', listProtectionGroups_nextToken - The next token value from a previous call to ListProtectionGroups.
Pass null if this is the first call.
$sel:maxResults:ListProtectionGroups', listProtectionGroups_maxResults - The maximum number of ProtectionGroup objects to return. If you leave
this blank, Shield Advanced returns the first 20 results.
This is a maximum value. Shield Advanced might return the results in
smaller batches. That is, the number of objects returned could be less
than MaxResults, even if there are still more objects yet to return.
If there are more objects to return, Shield Advanced returns a value in
NextToken that you can use in your next request, to get the next batch
of objects.
Request Lenses
listProtectionGroups_nextToken :: Lens' ListProtectionGroups (Maybe Text) Source #
The next token value from a previous call to ListProtectionGroups.
Pass null if this is the first call.
listProtectionGroups_maxResults :: Lens' ListProtectionGroups (Maybe Natural) Source #
The maximum number of ProtectionGroup objects to return. If you leave this blank, Shield Advanced returns the first 20 results.
This is a maximum value. Shield Advanced might return the results in
smaller batches. That is, the number of objects returned could be less
than MaxResults, even if there are still more objects yet to return.
If there are more objects to return, Shield Advanced returns a value in
NextToken that you can use in your next request, to get the next batch
of objects.
Destructuring the Response
data ListProtectionGroupsResponse Source #
See: newListProtectionGroupsResponse smart constructor.
Constructors
| ListProtectionGroupsResponse' | |
Fields
| |
Instances
newListProtectionGroupsResponse Source #
Create a value of ListProtectionGroupsResponse 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:ListProtectionGroups', listProtectionGroupsResponse_nextToken - If you specify a value for MaxResults and you have more protection
groups than the value of MaxResults, Shield Advanced returns this token
that you can use in your next request, to get the next batch of objects.
$sel:httpStatus:ListProtectionGroupsResponse', listProtectionGroupsResponse_httpStatus - The response's http status code.
$sel:protectionGroups:ListProtectionGroupsResponse', listProtectionGroupsResponse_protectionGroups -
Response Lenses
listProtectionGroupsResponse_nextToken :: Lens' ListProtectionGroupsResponse (Maybe Text) Source #
If you specify a value for MaxResults and you have more protection
groups than the value of MaxResults, Shield Advanced returns this token
that you can use in your next request, to get the next batch of objects.
listProtectionGroupsResponse_httpStatus :: Lens' ListProtectionGroupsResponse Int Source #
The response's http status code.