| 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.ListAttacks
Description
Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
This operation returns paginated results.
Synopsis
- data ListAttacks = ListAttacks' {}
- newListAttacks :: ListAttacks
- listAttacks_startTime :: Lens' ListAttacks (Maybe TimeRange)
- listAttacks_resourceArns :: Lens' ListAttacks (Maybe [Text])
- listAttacks_nextToken :: Lens' ListAttacks (Maybe Text)
- listAttacks_endTime :: Lens' ListAttacks (Maybe TimeRange)
- listAttacks_maxResults :: Lens' ListAttacks (Maybe Natural)
- data ListAttacksResponse = ListAttacksResponse' {
- attackSummaries :: Maybe [AttackSummary]
- nextToken :: Maybe Text
- httpStatus :: Int
- newListAttacksResponse :: Int -> ListAttacksResponse
- listAttacksResponse_attackSummaries :: Lens' ListAttacksResponse (Maybe [AttackSummary])
- listAttacksResponse_nextToken :: Lens' ListAttacksResponse (Maybe Text)
- listAttacksResponse_httpStatus :: Lens' ListAttacksResponse Int
Creating a Request
data ListAttacks Source #
See: newListAttacks smart constructor.
Constructors
| ListAttacks' | |
Fields
| |
Instances
newListAttacks :: ListAttacks Source #
Create a value of ListAttacks 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:startTime:ListAttacks', listAttacks_startTime - The start of the time period for the attacks. This is a timestamp
type. The sample request above indicates a number type because the
default used by WAF is Unix time in seconds. However any valid
timestamp format
is allowed.
$sel:resourceArns:ListAttacks', listAttacks_resourceArns - The ARN (Amazon Resource Name) of the resource that was attacked. If
this is left blank, all applicable resources for this account will be
included.
$sel:nextToken:ListAttacks', listAttacks_nextToken - The ListAttacksRequest.NextMarker value from a previous call to
ListAttacksRequest. Pass null if this is the first call.
$sel:endTime:ListAttacks', listAttacks_endTime - The end of the time period for the attacks. This is a timestamp type.
The sample request above indicates a number type because the default
used by WAF is Unix time in seconds. However any valid
timestamp format
is allowed.
$sel:maxResults:ListAttacks', listAttacks_maxResults - The maximum number of AttackSummary 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
listAttacks_startTime :: Lens' ListAttacks (Maybe TimeRange) Source #
The start of the time period for the attacks. This is a timestamp
type. The sample request above indicates a number type because the
default used by WAF is Unix time in seconds. However any valid
timestamp format
is allowed.
listAttacks_resourceArns :: Lens' ListAttacks (Maybe [Text]) Source #
The ARN (Amazon Resource Name) of the resource that was attacked. If this is left blank, all applicable resources for this account will be included.
listAttacks_nextToken :: Lens' ListAttacks (Maybe Text) Source #
The ListAttacksRequest.NextMarker value from a previous call to
ListAttacksRequest. Pass null if this is the first call.
listAttacks_endTime :: Lens' ListAttacks (Maybe TimeRange) Source #
The end of the time period for the attacks. This is a timestamp type.
The sample request above indicates a number type because the default
used by WAF is Unix time in seconds. However any valid
timestamp format
is allowed.
listAttacks_maxResults :: Lens' ListAttacks (Maybe Natural) Source #
The maximum number of AttackSummary 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 ListAttacksResponse Source #
See: newListAttacksResponse smart constructor.
Constructors
| ListAttacksResponse' | |
Fields
| |
Instances
newListAttacksResponse Source #
Arguments
| :: Int | |
| -> ListAttacksResponse |
Create a value of ListAttacksResponse 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:attackSummaries:ListAttacksResponse', listAttacksResponse_attackSummaries - The attack information for the specified time range.
$sel:nextToken:ListAttacks', listAttacksResponse_nextToken - The token returned by a previous call to indicate that there is more
data available. If not null, more results are available. Pass this value
for the NextMarker parameter in a subsequent call to ListAttacks to
retrieve the next set of items.
Shield Advanced might return the list of AttackSummary objects in
batches smaller than the number specified by MaxResults. If there are
more attack summary objects to return, Shield Advanced will always also
return a NextToken.
$sel:httpStatus:ListAttacksResponse', listAttacksResponse_httpStatus - The response's http status code.
Response Lenses
listAttacksResponse_attackSummaries :: Lens' ListAttacksResponse (Maybe [AttackSummary]) Source #
The attack information for the specified time range.
listAttacksResponse_nextToken :: Lens' ListAttacksResponse (Maybe Text) Source #
The token returned by a previous call to indicate that there is more
data available. If not null, more results are available. Pass this value
for the NextMarker parameter in a subsequent call to ListAttacks to
retrieve the next set of items.
Shield Advanced might return the list of AttackSummary objects in
batches smaller than the number specified by MaxResults. If there are
more attack summary objects to return, Shield Advanced will always also
return a NextToken.
listAttacksResponse_httpStatus :: Lens' ListAttacksResponse Int Source #
The response's http status code.