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

Amazonka.Shield.ListAttacks

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

This operation returns paginated results.

Synopsis

data ListAttacks = ListAttacks' {
- endTime :: Maybe TimeRange
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- resourceArns :: Maybe [Text]
- startTime :: Maybe TimeRange
}
newListAttacks :: ListAttacks
listAttacks_endTime :: Lens' ListAttacks (Maybe TimeRange)
listAttacks_maxResults :: Lens' ListAttacks (Maybe Natural)
listAttacks_nextToken :: Lens' ListAttacks (Maybe Text)
listAttacks_resourceArns :: Lens' ListAttacks (Maybe [Text])
listAttacks_startTime :: Lens' ListAttacks (Maybe TimeRange)
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

endTime :: Maybe TimeRange
The end of the time period for the attacks. This is a timestamp type. The request syntax listing for this call indicates a number type, but you can provide the time in any valid timestamp format setting.
maxResults :: Maybe Natural
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.
nextToken :: Maybe Text
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.
resourceArns :: Maybe [Text]
The ARNs (Amazon Resource Names) of the resources that were attacked. If you leave this blank, all applicable resources for this account will be included.
startTime :: Maybe TimeRange
The start of the time period for the attacks. This is a timestamp type. The request syntax listing for this call indicates a number type, but you can provide the time in any valid timestamp format setting.

Instances

Instances details

ToJSON ListAttacks Source #
Instance details Defined in Amazonka.Shield.ListAttacks Methods toJSON :: ListAttacks -> Value # toEncoding :: ListAttacks -> Encoding # toJSONList :: [ListAttacks] -> Value # toEncodingList :: [ListAttacks] -> Encoding #
ToHeaders ListAttacks Source #
Instance details Defined in Amazonka.Shield.ListAttacks Methods toHeaders :: ListAttacks -> [Header] #
ToPath ListAttacks Source #
Instance details Defined in Amazonka.Shield.ListAttacks Methods toPath :: ListAttacks -> ByteString #
ToQuery ListAttacks Source #
Instance details Defined in Amazonka.Shield.ListAttacks Methods toQuery :: ListAttacks -> QueryString #
AWSPager ListAttacks Source #
Instance details Defined in Amazonka.Shield.ListAttacks Methods page :: ListAttacks -> AWSResponse ListAttacks -> Maybe ListAttacks #
AWSRequest ListAttacks Source #
Instance details Defined in Amazonka.Shield.ListAttacks Associated Types type AWSResponse ListAttacks # Methods request :: (Service -> Service) -> ListAttacks -> Request ListAttacks # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListAttacks -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListAttacks))) #
Generic ListAttacks Source #
Instance details Defined in Amazonka.Shield.ListAttacks Associated Types type Rep ListAttacks :: Type -> Type # Methods from :: ListAttacks -> Rep ListAttacks x # to :: Rep ListAttacks x -> ListAttacks #
Read ListAttacks Source #
Instance details Defined in Amazonka.Shield.ListAttacks Methods readsPrec :: Int -> ReadS ListAttacks # readList :: ReadS [ListAttacks] # readPrec :: ReadPrec ListAttacks # readListPrec :: ReadPrec [ListAttacks] #
Show ListAttacks Source #
Instance details Defined in Amazonka.Shield.ListAttacks Methods showsPrec :: Int -> ListAttacks -> ShowS # show :: ListAttacks -> String # showList :: [ListAttacks] -> ShowS #
NFData ListAttacks Source #
Instance details Defined in Amazonka.Shield.ListAttacks Methods rnf :: ListAttacks -> () #
Eq ListAttacks Source #
Instance details Defined in Amazonka.Shield.ListAttacks Methods (==) :: ListAttacks -> ListAttacks -> Bool # (/=) :: ListAttacks -> ListAttacks -> Bool #
Hashable ListAttacks Source #
Instance details Defined in Amazonka.Shield.ListAttacks Methods hashWithSalt :: Int -> ListAttacks -> Int # hash :: ListAttacks -> Int #
type AWSResponse ListAttacks Source #
Instance details Defined in Amazonka.Shield.ListAttacks type AWSResponse ListAttacks = ListAttacksResponse
type Rep ListAttacks Source #
Instance details Defined in Amazonka.Shield.ListAttacks type Rep ListAttacks = D1 ('MetaData "ListAttacks" "Amazonka.Shield.ListAttacks" "amazonka-shield-2.0-Cz9Fa9OSQ93AE4UCXBDcFo" 'False) (C1 ('MetaCons "ListAttacks'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimeRange)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "resourceArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimeRange))))))

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:

ListAttacks, listAttacks_endTime - The end of the time period for the attacks. This is a timestamp type. The request syntax listing for this call indicates a number type, but you can provide the time in any valid timestamp format setting.

$sel:maxResults:ListAttacks', listAttacks_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.

ListAttacks, listAttacks_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.

ListAttacks, listAttacks_resourceArns - The ARNs (Amazon Resource Names) of the resources that were attacked. If you leave this blank, all applicable resources for this account will be included.

ListAttacks, listAttacks_startTime - The start of the time period for the attacks. This is a timestamp type. The request syntax listing for this call indicates a number type, but you can provide the time in any valid timestamp format setting.

Request Lenses

listAttacks_endTime :: Lens' ListAttacks (Maybe TimeRange) Source #

The end of the time period for the attacks. This is a timestamp type. The request syntax listing for this call indicates a number type, but you can provide the time in any valid timestamp format setting.

listAttacks_maxResults :: Lens' ListAttacks (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.

listAttacks_nextToken :: Lens' ListAttacks (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.

listAttacks_resourceArns :: Lens' ListAttacks (Maybe [Text]) Source #

The ARNs (Amazon Resource Names) of the resources that were attacked. If you leave this blank, all applicable resources for this account will be included.

listAttacks_startTime :: Lens' ListAttacks (Maybe TimeRange) Source #

The start of the time period for the attacks. This is a timestamp type. The request syntax listing for this call indicates a number type, but you can provide the time in any valid timestamp format setting.

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
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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic ListAttacksResponse Source #
Instance details Defined in Amazonka.Shield.ListAttacks Associated Types type Rep ListAttacksResponse :: Type -> Type # Methods from :: ListAttacksResponse -> Rep ListAttacksResponse x # to :: Rep ListAttacksResponse x -> ListAttacksResponse #
Read ListAttacksResponse Source #
Instance details Defined in Amazonka.Shield.ListAttacks Methods readsPrec :: Int -> ReadS ListAttacksResponse # readList :: ReadS [ListAttacksResponse] # readPrec :: ReadPrec ListAttacksResponse # readListPrec :: ReadPrec [ListAttacksResponse] #
Show ListAttacksResponse Source #
Instance details Defined in Amazonka.Shield.ListAttacks Methods showsPrec :: Int -> ListAttacksResponse -> ShowS # show :: ListAttacksResponse -> String # showList :: [ListAttacksResponse] -> ShowS #
NFData ListAttacksResponse Source #
Instance details Defined in Amazonka.Shield.ListAttacks Methods rnf :: ListAttacksResponse -> () #
Eq ListAttacksResponse Source #
Instance details Defined in Amazonka.Shield.ListAttacks Methods (==) :: ListAttacksResponse -> ListAttacksResponse -> Bool # (/=) :: ListAttacksResponse -> ListAttacksResponse -> Bool #
type Rep ListAttacksResponse Source #
Instance details Defined in Amazonka.Shield.ListAttacks type Rep ListAttacksResponse = D1 ('MetaData "ListAttacksResponse" "Amazonka.Shield.ListAttacks" "amazonka-shield-2.0-Cz9Fa9OSQ93AE4UCXBDcFo" '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 #

Arguments

:: Int	`$sel:httpStatus:ListAttacksResponse'`
-> 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.

ListAttacks, listAttacksResponse_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: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 #

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.

listAttacksResponse_httpStatus :: Lens' ListAttacksResponse Int Source #

The response's http status code.