libZSservicesZSamazonka-shieldZSamazonka-shield
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Shield.ListAttacks

Description

Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.

This operation returns paginated results.

Synopsis

Creating a Request

data ListAttacks Source #

See: newListAttacks smart constructor.

Constructors

ListAttacks' 

Fields

  • startTime :: Maybe TimeRange

    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.

  • resourceArns :: Maybe [Text]

    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.

  • nextToken :: Maybe Text

    The ListAttacksRequest.NextMarker value from a previous call to ListAttacksRequest. Pass null if this is the first call.

  • endTime :: Maybe TimeRange

    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.

  • maxResults :: Maybe Natural

    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.

Instances

Instances details
Eq ListAttacks Source # 
Instance details

Defined in Amazonka.Shield.ListAttacks

Read ListAttacks Source # 
Instance details

Defined in Amazonka.Shield.ListAttacks

Show ListAttacks Source # 
Instance details

Defined in Amazonka.Shield.ListAttacks

Generic ListAttacks Source # 
Instance details

Defined in Amazonka.Shield.ListAttacks

Associated Types

type Rep ListAttacks :: Type -> Type #

NFData ListAttacks Source # 
Instance details

Defined in Amazonka.Shield.ListAttacks

Methods

rnf :: ListAttacks -> () #

Hashable ListAttacks Source # 
Instance details

Defined in Amazonka.Shield.ListAttacks

ToJSON ListAttacks Source # 
Instance details

Defined in Amazonka.Shield.ListAttacks

AWSPager ListAttacks Source # 
Instance details

Defined in Amazonka.Shield.ListAttacks

AWSRequest ListAttacks Source # 
Instance details

Defined in Amazonka.Shield.ListAttacks

Associated Types

type AWSResponse ListAttacks #

ToHeaders ListAttacks Source # 
Instance details

Defined in Amazonka.Shield.ListAttacks

Methods

toHeaders :: ListAttacks -> [Header] #

ToPath ListAttacks Source # 
Instance details

Defined in Amazonka.Shield.ListAttacks

ToQuery ListAttacks Source # 
Instance details

Defined in Amazonka.Shield.ListAttacks

type Rep ListAttacks Source # 
Instance details

Defined in Amazonka.Shield.ListAttacks

type Rep ListAttacks = D1 ('MetaData "ListAttacks" "Amazonka.Shield.ListAttacks" "libZSservicesZSamazonka-shieldZSamazonka-shield" 'False) (C1 ('MetaCons "ListAttacks'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimeRange)) :*: S1 ('MetaSel ('Just "resourceArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimeRange)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))))
type AWSResponse ListAttacks Source # 
Instance details

Defined in Amazonka.Shield.ListAttacks

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

  • attackSummaries :: Maybe [AttackSummary]

    The attack information for the specified time range.

  • nextToken :: Maybe Text

    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.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ListAttacksResponse Source # 
Instance details

Defined in Amazonka.Shield.ListAttacks

Read ListAttacksResponse Source # 
Instance details

Defined in Amazonka.Shield.ListAttacks

Show ListAttacksResponse Source # 
Instance details

Defined in Amazonka.Shield.ListAttacks

Generic ListAttacksResponse Source # 
Instance details

Defined in Amazonka.Shield.ListAttacks

Associated Types

type Rep ListAttacksResponse :: Type -> Type #

NFData ListAttacksResponse Source # 
Instance details

Defined in Amazonka.Shield.ListAttacks

Methods

rnf :: ListAttacksResponse -> () #

type Rep ListAttacksResponse Source # 
Instance details

Defined in Amazonka.Shield.ListAttacks

type Rep ListAttacksResponse = D1 ('MetaData "ListAttacksResponse" "Amazonka.Shield.ListAttacks" "libZSservicesZSamazonka-shieldZSamazonka-shield" 'False) (C1 ('MetaCons "ListAttacksResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attackSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AttackSummary])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListAttacksResponse Source #

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.