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.WAFV2.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 WAF randomly selects from among the first 5,000 requests that your Amazon Web Services 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 WAF selected the requests in the sample.

Synopsis

data GetSampledRequests = GetSampledRequests' {
- webAclArn :: Text
- ruleMetricName :: Text
- scope :: Scope
- timeWindow :: TimeWindow
- maxItems :: Natural
}
newGetSampledRequests :: Text -> Text -> Scope -> TimeWindow -> Natural -> GetSampledRequests
getSampledRequests_webAclArn :: Lens' GetSampledRequests Text
getSampledRequests_ruleMetricName :: Lens' GetSampledRequests Text
getSampledRequests_scope :: Lens' GetSampledRequests Scope
getSampledRequests_timeWindow :: Lens' GetSampledRequests TimeWindow
getSampledRequests_maxItems :: Lens' GetSampledRequests Natural
data GetSampledRequestsResponse = GetSampledRequestsResponse' {
- populationSize :: Maybe Integer
- sampledRequests :: Maybe [SampledHTTPRequest]
- timeWindow :: Maybe TimeWindow
- httpStatus :: Int
}
newGetSampledRequestsResponse :: Int -> GetSampledRequestsResponse
getSampledRequestsResponse_populationSize :: Lens' GetSampledRequestsResponse (Maybe Integer)
getSampledRequestsResponse_sampledRequests :: Lens' GetSampledRequestsResponse (Maybe [SampledHTTPRequest])
getSampledRequestsResponse_timeWindow :: Lens' GetSampledRequestsResponse (Maybe TimeWindow)
getSampledRequestsResponse_httpStatus :: Lens' GetSampledRequestsResponse Int

Creating a Request

data GetSampledRequests Source #

See: newGetSampledRequests smart constructor.

Constructors

GetSampledRequests'

Fields

webAclArn :: Text
The Amazon resource name (ARN) of the WebACL for which you want a sample of requests.
ruleMetricName :: Text
The metric name assigned to the Rule or RuleGroup for which you want a sample of requests.
scope :: Scope
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
- CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
- API and SDKs - For all calls, use the Region endpoint us-east-1.
timeWindow :: 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. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours. If you specify a start time that's earlier than three hours ago, WAF sets it to three hours ago.
maxItems :: Natural
The number of requests that you want WAF to return from among the first 5,000 requests that your Amazon Web Services resource received during the time range. If your resource received fewer requests than the value of MaxItems, GetSampledRequests returns information about all of them.

Instances

Instances details

ToJSON GetSampledRequests Source #
Instance details Defined in Amazonka.WAFV2.GetSampledRequests Methods toJSON :: GetSampledRequests -> Value # toEncoding :: GetSampledRequests -> Encoding # toJSONList :: [GetSampledRequests] -> Value # toEncodingList :: [GetSampledRequests] -> Encoding #
ToHeaders GetSampledRequests Source #
Instance details Defined in Amazonka.WAFV2.GetSampledRequests Methods toHeaders :: GetSampledRequests -> [Header] #
ToPath GetSampledRequests Source #
Instance details Defined in Amazonka.WAFV2.GetSampledRequests Methods toPath :: GetSampledRequests -> ByteString #
ToQuery GetSampledRequests Source #
Instance details Defined in Amazonka.WAFV2.GetSampledRequests Methods toQuery :: GetSampledRequests -> QueryString #
AWSRequest GetSampledRequests Source #
Instance details Defined in Amazonka.WAFV2.GetSampledRequests Associated Types type AWSResponse GetSampledRequests # Methods request :: (Service -> Service) -> GetSampledRequests -> Request GetSampledRequests # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetSampledRequests -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetSampledRequests))) #
Generic GetSampledRequests Source #
Instance details Defined in Amazonka.WAFV2.GetSampledRequests Associated Types type Rep GetSampledRequests :: Type -> Type # Methods from :: GetSampledRequests -> Rep GetSampledRequests x # to :: Rep GetSampledRequests x -> GetSampledRequests #
Read GetSampledRequests Source #
Instance details Defined in Amazonka.WAFV2.GetSampledRequests Methods readsPrec :: Int -> ReadS GetSampledRequests # readList :: ReadS [GetSampledRequests] # readPrec :: ReadPrec GetSampledRequests # readListPrec :: ReadPrec [GetSampledRequests] #
Show GetSampledRequests Source #
Instance details Defined in Amazonka.WAFV2.GetSampledRequests Methods showsPrec :: Int -> GetSampledRequests -> ShowS # show :: GetSampledRequests -> String # showList :: [GetSampledRequests] -> ShowS #
NFData GetSampledRequests Source #
Instance details Defined in Amazonka.WAFV2.GetSampledRequests Methods rnf :: GetSampledRequests -> () #
Eq GetSampledRequests Source #
Instance details Defined in Amazonka.WAFV2.GetSampledRequests Methods (==) :: GetSampledRequests -> GetSampledRequests -> Bool # (/=) :: GetSampledRequests -> GetSampledRequests -> Bool #
Hashable GetSampledRequests Source #
Instance details Defined in Amazonka.WAFV2.GetSampledRequests Methods hashWithSalt :: Int -> GetSampledRequests -> Int # hash :: GetSampledRequests -> Int #
type AWSResponse GetSampledRequests Source #
Instance details Defined in Amazonka.WAFV2.GetSampledRequests type AWSResponse GetSampledRequests = GetSampledRequestsResponse
type Rep GetSampledRequests Source #
Instance details Defined in Amazonka.WAFV2.GetSampledRequests type Rep GetSampledRequests = D1 ('MetaData "GetSampledRequests" "Amazonka.WAFV2.GetSampledRequests" "amazonka-wafv2-2.0-3v3WgpYn7RT5hSd6MsT5dN" 'False) (C1 ('MetaCons "GetSampledRequests'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "webAclArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "ruleMetricName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "scope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Scope) :: (S1 ('MetaSel ('Just "timeWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TimeWindow) :: S1 ('MetaSel ('Just "maxItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural)))))

newGetSampledRequests Source #

Arguments

:: Text	`$sel:webAclArn:GetSampledRequests'`
-> Text	`$sel:ruleMetricName:GetSampledRequests'`
-> Scope	`GetSampledRequests`
-> TimeWindow	`GetSampledRequests`
-> Natural	`$sel:maxItems:GetSampledRequests'`
-> GetSampledRequests

Create a value of GetSampledRequests 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:webAclArn:GetSampledRequests', getSampledRequests_webAclArn - The Amazon resource name (ARN) of the WebACL for which you want a sample of requests.

$sel:ruleMetricName:GetSampledRequests', getSampledRequests_ruleMetricName - The metric name assigned to the Rule or RuleGroup for which you want a sample of requests.

GetSampledRequests, getSampledRequests_scope - Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.

GetSampledRequests, 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. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours. If you specify a start time that's earlier than three hours ago, WAF sets it to three hours ago.

$sel:maxItems:GetSampledRequests', getSampledRequests_maxItems - The number of requests that you want WAF to return from among the first 5,000 requests that your Amazon Web Services resource received during the time range. If your resource received fewer requests than the value of MaxItems, GetSampledRequests returns information about all of them.

Request Lenses

getSampledRequests_webAclArn :: Lens' GetSampledRequests Text Source #

The Amazon resource name (ARN) of the WebACL for which you want a sample of requests.

getSampledRequests_ruleMetricName :: Lens' GetSampledRequests Text Source #

The metric name assigned to the Rule or RuleGroup for which you want a sample of requests.

getSampledRequests_scope :: Lens' GetSampledRequests Scope Source #

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.

getSampledRequests_timeWindow :: Lens' GetSampledRequests TimeWindow Source #

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. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours. If you specify a start time that's earlier than three hours ago, WAF sets it to three hours ago.

getSampledRequests_maxItems :: Lens' GetSampledRequests Natural Source #

The number of requests that you want WAF to return from among the first 5,000 requests that your Amazon Web Services 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

data GetSampledRequestsResponse Source #

See: newGetSampledRequestsResponse smart constructor.

Constructors

GetSampledRequestsResponse'

Fields

populationSize :: 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 Amazon Web Services resource received during the specified time range.
sampledRequests :: Maybe [SampledHTTPRequest]
A complex type that contains detailed information about each of the requests in the sample.
timeWindow :: Maybe TimeWindow
Usually, TimeWindow is the time range that you specified in the GetSampledRequests request. However, if your Amazon Web Services 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. Times are in Coordinated Universal Time (UTC) format.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetSampledRequestsResponse Source #
Instance details Defined in Amazonka.WAFV2.GetSampledRequests Associated Types type Rep GetSampledRequestsResponse :: Type -> Type # Methods from :: GetSampledRequestsResponse -> Rep GetSampledRequestsResponse x # to :: Rep GetSampledRequestsResponse x -> GetSampledRequestsResponse #
Read GetSampledRequestsResponse Source #
Instance details Defined in Amazonka.WAFV2.GetSampledRequests Methods readsPrec :: Int -> ReadS GetSampledRequestsResponse # readList :: ReadS [GetSampledRequestsResponse] # readPrec :: ReadPrec GetSampledRequestsResponse # readListPrec :: ReadPrec [GetSampledRequestsResponse] #
Show GetSampledRequestsResponse Source #
Instance details Defined in Amazonka.WAFV2.GetSampledRequests Methods showsPrec :: Int -> GetSampledRequestsResponse -> ShowS # show :: GetSampledRequestsResponse -> String # showList :: [GetSampledRequestsResponse] -> ShowS #
NFData GetSampledRequestsResponse Source #
Instance details Defined in Amazonka.WAFV2.GetSampledRequests Methods rnf :: GetSampledRequestsResponse -> () #
Eq GetSampledRequestsResponse Source #
Instance details Defined in Amazonka.WAFV2.GetSampledRequests Methods (==) :: GetSampledRequestsResponse -> GetSampledRequestsResponse -> Bool # (/=) :: GetSampledRequestsResponse -> GetSampledRequestsResponse -> Bool #
type Rep GetSampledRequestsResponse Source #
Instance details Defined in Amazonka.WAFV2.GetSampledRequests type Rep GetSampledRequestsResponse = D1 ('MetaData "GetSampledRequestsResponse" "Amazonka.WAFV2.GetSampledRequests" "amazonka-wafv2-2.0-3v3WgpYn7RT5hSd6MsT5dN" 'False) (C1 ('MetaCons "GetSampledRequestsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "populationSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "sampledRequests") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SampledHTTPRequest]))) :: (S1 ('MetaSel ('Just "timeWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimeWindow)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetSampledRequestsResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetSampledRequestsResponse'`
-> GetSampledRequestsResponse

Create a value of GetSampledRequestsResponse 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:populationSize:GetSampledRequestsResponse', getSampledRequestsResponse_populationSize - 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 Amazon Web Services resource received during the specified time range.

$sel:sampledRequests:GetSampledRequestsResponse', getSampledRequestsResponse_sampledRequests - A complex type that contains detailed information about each of the requests in the sample.

GetSampledRequests, getSampledRequestsResponse_timeWindow - Usually, TimeWindow is the time range that you specified in the GetSampledRequests request. However, if your Amazon Web Services 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. Times are in Coordinated Universal Time (UTC) format.

$sel:httpStatus:GetSampledRequestsResponse', getSampledRequestsResponse_httpStatus - The response's http status code.

Response Lenses

getSampledRequestsResponse_populationSize :: Lens' GetSampledRequestsResponse (Maybe Integer) Source #

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 Amazon Web Services resource received during the specified time range.

getSampledRequestsResponse_sampledRequests :: Lens' GetSampledRequestsResponse (Maybe [SampledHTTPRequest]) Source #

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

getSampledRequestsResponse_timeWindow :: Lens' GetSampledRequestsResponse (Maybe TimeWindow) Source #

Usually, TimeWindow is the time range that you specified in the GetSampledRequests request. However, if your Amazon Web Services 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. Times are in Coordinated Universal Time (UTC) format.

getSampledRequestsResponse_httpStatus :: Lens' GetSampledRequestsResponse Int Source #

The response's http status code.