| 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.ListProtections
Description
Lists all Protection objects for the account.
This operation returns paginated results.
Synopsis
- data ListProtections = ListProtections' {}
- newListProtections :: ListProtections
- listProtections_nextToken :: Lens' ListProtections (Maybe Text)
- listProtections_maxResults :: Lens' ListProtections (Maybe Natural)
- data ListProtectionsResponse = ListProtectionsResponse' {
- protections :: Maybe [Protection]
- nextToken :: Maybe Text
- httpStatus :: Int
- newListProtectionsResponse :: Int -> ListProtectionsResponse
- listProtectionsResponse_protections :: Lens' ListProtectionsResponse (Maybe [Protection])
- listProtectionsResponse_nextToken :: Lens' ListProtectionsResponse (Maybe Text)
- listProtectionsResponse_httpStatus :: Lens' ListProtectionsResponse Int
Creating a Request
data ListProtections Source #
See: newListProtections smart constructor.
Constructors
| ListProtections' | |
Fields
| |
Instances
newListProtections :: ListProtections Source #
Create a value of ListProtections 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:ListProtections', listProtections_nextToken - The ListProtectionsRequest.NextToken value from a previous call to
ListProtections. Pass null if this is the first call.
$sel:maxResults:ListProtections', listProtections_maxResults - The maximum number of Protection 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
listProtections_nextToken :: Lens' ListProtections (Maybe Text) Source #
The ListProtectionsRequest.NextToken value from a previous call to
ListProtections. Pass null if this is the first call.
listProtections_maxResults :: Lens' ListProtections (Maybe Natural) Source #
The maximum number of Protection 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 ListProtectionsResponse Source #
See: newListProtectionsResponse smart constructor.
Constructors
| ListProtectionsResponse' | |
Fields
| |
Instances
newListProtectionsResponse Source #
Create a value of ListProtectionsResponse 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:protections:ListProtectionsResponse', listProtectionsResponse_protections - The array of enabled Protection objects.
$sel:nextToken:ListProtections', listProtectionsResponse_nextToken - If you specify a value for MaxResults and you have more Protections
than the value of MaxResults, Shield Advanced returns a NextToken value
in the response that allows you to list another group of Protections.
For the second and subsequent ListProtections requests, specify the
value of NextToken from the previous response to get information about
another batch of Protections.
Shield Advanced might return the list of Protection objects in batches
smaller than the number specified by MaxResults. If there are more
Protection objects to return, Shield Advanced will always also return a
NextToken.
$sel:httpStatus:ListProtectionsResponse', listProtectionsResponse_httpStatus - The response's http status code.
Response Lenses
listProtectionsResponse_protections :: Lens' ListProtectionsResponse (Maybe [Protection]) Source #
The array of enabled Protection objects.
listProtectionsResponse_nextToken :: Lens' ListProtectionsResponse (Maybe Text) Source #
If you specify a value for MaxResults and you have more Protections
than the value of MaxResults, Shield Advanced returns a NextToken value
in the response that allows you to list another group of Protections.
For the second and subsequent ListProtections requests, specify the
value of NextToken from the previous response to get information about
another batch of Protections.
Shield Advanced might return the list of Protection objects in batches
smaller than the number specified by MaxResults. If there are more
Protection objects to return, Shield Advanced will always also return a
NextToken.
listProtectionsResponse_httpStatus :: Lens' ListProtectionsResponse Int Source #
The response's http status code.