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 |
Retrieves ProtectionGroup objects for the account. You can retrieve all protection groups or you can provide filtering criteria and retrieve just the subset of protection groups that match the criteria.
Synopsis
- data ListProtectionGroups = ListProtectionGroups' {}
- newListProtectionGroups :: ListProtectionGroups
- listProtectionGroups_inclusionFilters :: Lens' ListProtectionGroups (Maybe InclusionProtectionGroupFilters)
- listProtectionGroups_maxResults :: Lens' ListProtectionGroups (Maybe Natural)
- listProtectionGroups_nextToken :: Lens' ListProtectionGroups (Maybe Text)
- 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.
ListProtectionGroups' | |
|
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:inclusionFilters:ListProtectionGroups'
, listProtectionGroups_inclusionFilters
- Narrows the set of protection groups that the call retrieves. You can
retrieve a single protection group by its name and you can retrieve all
protection groups that are configured with specific pattern or
aggregation settings. You can provide up to one criteria per filter
type. Shield Advanced returns the protection groups that exactly match
all of the search criteria that you provide.
$sel:maxResults:ListProtectionGroups'
, listProtectionGroups_maxResults
- The greatest number of objects that you want Shield Advanced to return
to the list request. Shield Advanced might return fewer objects than you
indicate in this setting, even if more objects are available. If there
are more objects remaining, Shield Advanced will always also return a
NextToken
value in the response.
The default setting is 20.
ListProtectionGroups
, listProtectionGroups_nextToken
- When you request a list of objects from Shield Advanced, if the response
does not include all of the remaining available objects, Shield Advanced
includes a NextToken
value in the response. You can retrieve the next
batch of objects by requesting the list again and providing the token
that was returned by the prior call in your request.
You can indicate the maximum number of objects that you want Shield
Advanced to return for a single call with the MaxResults
setting.
Shield Advanced will not return more than MaxResults
objects, but may
return fewer, even if more objects are still available.
Whenever more objects remain that Shield Advanced has not yet returned
to you, the response will include a NextToken
value.
On your first call to a list operation, leave this setting empty.
Request Lenses
listProtectionGroups_inclusionFilters :: Lens' ListProtectionGroups (Maybe InclusionProtectionGroupFilters) Source #
Narrows the set of protection groups that the call retrieves. You can retrieve a single protection group by its name and you can retrieve all protection groups that are configured with specific pattern or aggregation settings. You can provide up to one criteria per filter type. Shield Advanced returns the protection groups that exactly match all of the search criteria that you provide.
listProtectionGroups_maxResults :: Lens' ListProtectionGroups (Maybe Natural) Source #
The greatest number of objects that you want Shield Advanced to return
to the list request. Shield Advanced might return fewer objects than you
indicate in this setting, even if more objects are available. If there
are more objects remaining, Shield Advanced will always also return a
NextToken
value in the response.
The default setting is 20.
listProtectionGroups_nextToken :: Lens' ListProtectionGroups (Maybe Text) Source #
When you request a list of objects from Shield Advanced, if the response
does not include all of the remaining available objects, Shield Advanced
includes a NextToken
value in the response. You can retrieve the next
batch of objects by requesting the list again and providing the token
that was returned by the prior call in your request.
You can indicate the maximum number of objects that you want Shield
Advanced to return for a single call with the MaxResults
setting.
Shield Advanced will not return more than MaxResults
objects, but may
return fewer, even if more objects are still available.
Whenever more objects remain that Shield Advanced has not yet returned
to you, the response will include a NextToken
value.
On your first call to a list operation, leave this setting empty.
Destructuring the Response
data ListProtectionGroupsResponse Source #
See: newListProtectionGroupsResponse
smart constructor.
ListProtectionGroupsResponse' | |
|
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:
ListProtectionGroups
, listProtectionGroupsResponse_nextToken
- When you request a list of objects from Shield Advanced, if the response
does not include all of the remaining available objects, Shield Advanced
includes a NextToken
value in the response. You can retrieve the next
batch of objects by requesting the list again and providing the token
that was returned by the prior call in your request.
You can indicate the maximum number of objects that you want Shield
Advanced to return for a single call with the MaxResults
setting.
Shield Advanced will not return more than MaxResults
objects, but may
return fewer, even if more objects are still available.
Whenever more objects remain that Shield Advanced has not yet returned
to you, the response will include a NextToken
value.
$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 #
When you request a list of objects from Shield Advanced, if the response
does not include all of the remaining available objects, Shield Advanced
includes a NextToken
value in the response. You can retrieve the next
batch of objects by requesting the list again and providing the token
that was returned by the prior call in your request.
You can indicate the maximum number of objects that you want Shield
Advanced to return for a single call with the MaxResults
setting.
Shield Advanced will not return more than MaxResults
objects, but may
return fewer, even if more objects are still available.
Whenever more objects remain that Shield Advanced has not yet returned
to you, the response will include a NextToken
value.
listProtectionGroupsResponse_httpStatus :: Lens' ListProtectionGroupsResponse Int Source #
The response's http status code.