Copyright	(c) 2013-2018 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
Language	Haskell2010

Network.AWS.WAF.GetSampledRequests

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets detailed information about a specified number of requests--a sample--that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours.

GetSampledRequests returns a time range, which is usually the time range that you specified. However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, GetSampledRequests returns an updated time range. This new time range indicates the actual period during which AWS WAF selected the requests in the sample.

Creating a Request

getSampledRequests #

Arguments

:: Text	`gsrWebACLId`
-> Text	`gsrRuleId`
-> TimeWindow	`gsrTimeWindow`
-> Natural	`gsrMaxItems`
-> GetSampledRequests

Creates a value of GetSampledRequests with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

gsrWebACLId - The WebACLId of the WebACL for which you want GetSampledRequests to return a sample of requests.
gsrRuleId - RuleId is one of three values: * The RuleId of the Rule or the RuleGroupId of the RuleGroup for which you want GetSampledRequests to return a sample of requests. * Default_Action , which causes GetSampledRequests to return a sample of the requests that didn't match any of the rules in the specified WebACL .
gsrTimeWindow - The start date and time and the end date and time of the range for which you want GetSampledRequests to return a sample of requests. Specify the date and time in the following format: "2016-09-27T14:50Z" . You can specify any time range in the previous three hours.
gsrMaxItems - The number of requests that you want AWS WAF to return from among the first 5,000 requests that your AWS resource received during the time range. If your resource received fewer requests than the value of MaxItems , GetSampledRequests returns information about all of them.

data GetSampledRequests #

See: getSampledRequests smart constructor.

Instances

Eq GetSampledRequests #
Instance details Defined in Network.AWS.WAF.GetSampledRequests Methods (==) :: GetSampledRequests -> GetSampledRequests -> Bool # (/=) :: GetSampledRequests -> GetSampledRequests -> Bool #
Data GetSampledRequests #
Instance details Defined in Network.AWS.WAF.GetSampledRequests Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetSampledRequests -> c GetSampledRequests # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetSampledRequests # toConstr :: GetSampledRequests -> Constr # dataTypeOf :: GetSampledRequests -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c GetSampledRequests) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetSampledRequests) # gmapT :: (forall b. Data b => b -> b) -> GetSampledRequests -> GetSampledRequests # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetSampledRequests -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetSampledRequests -> r # gmapQ :: (forall d. Data d => d -> u) -> GetSampledRequests -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> GetSampledRequests -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetSampledRequests -> m GetSampledRequests # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetSampledRequests -> m GetSampledRequests # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetSampledRequests -> m GetSampledRequests #
Read GetSampledRequests #
Instance details Defined in Network.AWS.WAF.GetSampledRequests Methods readsPrec :: Int -> ReadS GetSampledRequests # readList :: ReadS [GetSampledRequests] # readPrec :: ReadPrec GetSampledRequests # readListPrec :: ReadPrec [GetSampledRequests] #
Show GetSampledRequests #
Instance details Defined in Network.AWS.WAF.GetSampledRequests Methods showsPrec :: Int -> GetSampledRequests -> ShowS # show :: GetSampledRequests -> String # showList :: [GetSampledRequests] -> ShowS #
Generic GetSampledRequests #
Instance details Defined in Network.AWS.WAF.GetSampledRequests Associated Types type Rep GetSampledRequests :: Type -> Type # Methods from :: GetSampledRequests -> Rep GetSampledRequests x # to :: Rep GetSampledRequests x -> GetSampledRequests #
Hashable GetSampledRequests #
Instance details Defined in Network.AWS.WAF.GetSampledRequests Methods hashWithSalt :: Int -> GetSampledRequests -> Int # hash :: GetSampledRequests -> Int #
ToJSON GetSampledRequests #
Instance details Defined in Network.AWS.WAF.GetSampledRequests Methods toJSON :: GetSampledRequests -> Value # toEncoding :: GetSampledRequests -> Encoding # toJSONList :: [GetSampledRequests] -> Value # toEncodingList :: [GetSampledRequests] -> Encoding #
AWSRequest GetSampledRequests #
Instance details Defined in Network.AWS.WAF.GetSampledRequests Associated Types type Rs GetSampledRequests :: Type # Methods request :: GetSampledRequests -> Request GetSampledRequests # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy GetSampledRequests -> ClientResponse -> m (Response GetSampledRequests) #
ToHeaders GetSampledRequests #
Instance details Defined in Network.AWS.WAF.GetSampledRequests Methods toHeaders :: GetSampledRequests -> [Header] #
ToPath GetSampledRequests #
Instance details Defined in Network.AWS.WAF.GetSampledRequests Methods toPath :: GetSampledRequests -> ByteString #
ToQuery GetSampledRequests #
Instance details Defined in Network.AWS.WAF.GetSampledRequests Methods toQuery :: GetSampledRequests -> QueryString #
NFData GetSampledRequests #
Instance details Defined in Network.AWS.WAF.GetSampledRequests Methods rnf :: GetSampledRequests -> () #
type Rep GetSampledRequests #
Instance details Defined in Network.AWS.WAF.GetSampledRequests type Rep GetSampledRequests = D1 (MetaData "GetSampledRequests" "Network.AWS.WAF.GetSampledRequests" "amazonka-waf-1.6.1-58qiOW5VcwnIkfAeSj6srS" False) (C1 (MetaCons "GetSampledRequests'" PrefixI True) ((S1 (MetaSel (Just "_gsrWebACLId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_gsrRuleId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :: (S1 (MetaSel (Just "_gsrTimeWindow") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 TimeWindow) :*: S1 (MetaSel (Just "_gsrMaxItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Nat))))
type Rs GetSampledRequests #
Instance details Defined in Network.AWS.WAF.GetSampledRequests type Rs GetSampledRequests = GetSampledRequestsResponse

Request Lenses

gsrWebACLId :: Lens' GetSampledRequests Text #

The WebACLId of the WebACL for which you want GetSampledRequests to return a sample of requests.

gsrRuleId :: Lens' GetSampledRequests Text #

RuleId is one of three values: * The RuleId of the Rule or the RuleGroupId of the RuleGroup for which you want GetSampledRequests to return a sample of requests. * Default_Action , which causes GetSampledRequests to return a sample of the requests that didn't match any of the rules in the specified WebACL .

gsrTimeWindow :: Lens' GetSampledRequests TimeWindow #

The start date and time and the end date and time of the range for which you want GetSampledRequests to return a sample of requests. Specify the date and time in the following format: "2016-09-27T14:50Z" . You can specify any time range in the previous three hours.

gsrMaxItems :: Lens' GetSampledRequests Natural #

The number of requests that you want AWS WAF to return from among the first 5,000 requests that your AWS resource received during the time range. If your resource received fewer requests than the value of MaxItems , GetSampledRequests returns information about all of them.

Destructuring the Response

getSampledRequestsResponse #

Arguments

:: Int	`gsrrsResponseStatus`
-> GetSampledRequestsResponse

Creates a value of GetSampledRequestsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

gsrrsSampledRequests - A complex type that contains detailed information about each of the requests in the sample.
gsrrsPopulationSize - The total number of requests from which GetSampledRequests got a sample of MaxItems requests. If PopulationSize is less than MaxItems , the sample includes every request that your AWS resource received during the specified time range.
gsrrsTimeWindow - Usually, TimeWindow is the time range that you specified in the GetSampledRequests request. However, if your AWS resource received more than 5,000 requests during the time range that you specified in the request, GetSampledRequests returns the time range for the first 5,000 requests.
gsrrsResponseStatus - -- | The response status code.

data GetSampledRequestsResponse #

See: getSampledRequestsResponse smart constructor.

Instances

Eq GetSampledRequestsResponse #
Instance details Defined in Network.AWS.WAF.GetSampledRequests Methods (==) :: GetSampledRequestsResponse -> GetSampledRequestsResponse -> Bool # (/=) :: GetSampledRequestsResponse -> GetSampledRequestsResponse -> Bool #
Data GetSampledRequestsResponse #
Instance details Defined in Network.AWS.WAF.GetSampledRequests Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetSampledRequestsResponse -> c GetSampledRequestsResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetSampledRequestsResponse # toConstr :: GetSampledRequestsResponse -> Constr # dataTypeOf :: GetSampledRequestsResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c GetSampledRequestsResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetSampledRequestsResponse) # gmapT :: (forall b. Data b => b -> b) -> GetSampledRequestsResponse -> GetSampledRequestsResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetSampledRequestsResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetSampledRequestsResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> GetSampledRequestsResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> GetSampledRequestsResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetSampledRequestsResponse -> m GetSampledRequestsResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetSampledRequestsResponse -> m GetSampledRequestsResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetSampledRequestsResponse -> m GetSampledRequestsResponse #
Read GetSampledRequestsResponse #
Instance details Defined in Network.AWS.WAF.GetSampledRequests Methods readsPrec :: Int -> ReadS GetSampledRequestsResponse # readList :: ReadS [GetSampledRequestsResponse] # readPrec :: ReadPrec GetSampledRequestsResponse # readListPrec :: ReadPrec [GetSampledRequestsResponse] #
Show GetSampledRequestsResponse #
Instance details Defined in Network.AWS.WAF.GetSampledRequests Methods showsPrec :: Int -> GetSampledRequestsResponse -> ShowS # show :: GetSampledRequestsResponse -> String # showList :: [GetSampledRequestsResponse] -> ShowS #
Generic GetSampledRequestsResponse #
Instance details Defined in Network.AWS.WAF.GetSampledRequests Associated Types type Rep GetSampledRequestsResponse :: Type -> Type # Methods from :: GetSampledRequestsResponse -> Rep GetSampledRequestsResponse x # to :: Rep GetSampledRequestsResponse x -> GetSampledRequestsResponse #
NFData GetSampledRequestsResponse #
Instance details Defined in Network.AWS.WAF.GetSampledRequests Methods rnf :: GetSampledRequestsResponse -> () #
type Rep GetSampledRequestsResponse #
Instance details Defined in Network.AWS.WAF.GetSampledRequests type Rep GetSampledRequestsResponse = D1 (MetaData "GetSampledRequestsResponse" "Network.AWS.WAF.GetSampledRequests" "amazonka-waf-1.6.1-58qiOW5VcwnIkfAeSj6srS" False) (C1 (MetaCons "GetSampledRequestsResponse'" PrefixI True) ((S1 (MetaSel (Just "_gsrrsSampledRequests") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [SampledHTTPRequest])) :: S1 (MetaSel (Just "_gsrrsPopulationSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integer))) :: (S1 (MetaSel (Just "_gsrrsTimeWindow") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe TimeWindow)) :*: S1 (MetaSel (Just "_gsrrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

gsrrsSampledRequests :: Lens' GetSampledRequestsResponse [SampledHTTPRequest] #

A complex type that contains detailed information about each of the requests in the sample.

gsrrsPopulationSize :: Lens' GetSampledRequestsResponse (Maybe Integer) #

The total number of requests from which GetSampledRequests got a sample of MaxItems requests. If PopulationSize is less than MaxItems , the sample includes every request that your AWS resource received during the specified time range.

gsrrsTimeWindow :: Lens' GetSampledRequestsResponse (Maybe TimeWindow) #

Usually, TimeWindow is the time range that you specified in the GetSampledRequests request. However, if your AWS resource received more than 5,000 requests during the time range that you specified in the request, GetSampledRequests returns the time range for the first 5,000 requests.

gsrrsResponseStatus :: Lens' GetSampledRequestsResponse Int #

- | The response status code.