import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { GetSampledRequestsRequest, GetSampledRequestsResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link GetSampledRequestsCommand}. */ export interface GetSampledRequestsCommandInput extends GetSampledRequestsRequest { } /** * @public * * The output of {@link GetSampledRequestsCommand}. */ export interface GetSampledRequestsCommandOutput extends GetSampledRequestsResponse, __MetadataBearer { } declare const GetSampledRequestsCommand_base: { new (input: GetSampledRequestsCommandInput): import("@smithy/core/client").CommandImpl; new (input: GetSampledRequestsCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** * *

This is AWS WAF Classic documentation. For * more information, see AWS * WAF Classic in the developer guide.

*

* For the latest version of AWS * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

*
*

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.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { WAFRegionalClient, GetSampledRequestsCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import * // const { WAFRegionalClient, GetSampledRequestsCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import * // import type { WAFRegionalClientConfig } from "@aws-sdk/client-waf-regional"; * const config = {}; // type is WAFRegionalClientConfig * const client = new WAFRegionalClient(config); * const input = { // GetSampledRequestsRequest * WebAclId: "STRING_VALUE", // required * RuleId: "STRING_VALUE", // required * TimeWindow: { // TimeWindow * StartTime: new Date("TIMESTAMP"), // required * EndTime: new Date("TIMESTAMP"), // required * }, * MaxItems: Number("long"), // required * }; * const command = new GetSampledRequestsCommand(input); * const response = await client.send(command); * // { // GetSampledRequestsResponse * // SampledRequests: [ // SampledHTTPRequests * // { // SampledHTTPRequest * // Request: { // HTTPRequest * // ClientIP: "STRING_VALUE", * // Country: "STRING_VALUE", * // URI: "STRING_VALUE", * // Method: "STRING_VALUE", * // HTTPVersion: "STRING_VALUE", * // Headers: [ // HTTPHeaders * // { // HTTPHeader * // Name: "STRING_VALUE", * // Value: "STRING_VALUE", * // }, * // ], * // }, * // Weight: Number("long"), // required * // Timestamp: new Date("TIMESTAMP"), * // Action: "STRING_VALUE", * // RuleWithinRuleGroup: "STRING_VALUE", * // }, * // ], * // PopulationSize: Number("long"), * // TimeWindow: { // TimeWindow * // StartTime: new Date("TIMESTAMP"), // required * // EndTime: new Date("TIMESTAMP"), // required * // }, * // }; * * ``` * * @param GetSampledRequestsCommandInput - {@link GetSampledRequestsCommandInput} * @returns {@link GetSampledRequestsCommandOutput} * @see {@link GetSampledRequestsCommandInput} for command's `input` shape. * @see {@link GetSampledRequestsCommandOutput} for command's `response` shape. * @see {@link WAFRegionalClientResolvedConfig | config} for WAFRegionalClient's `config` shape. * * @throws {@link WAFInternalErrorException} (server fault) *

The operation failed because of a system problem, even though the request was valid. Retry your request.

* * @throws {@link WAFNonexistentItemException} (client fault) *

The operation failed because the referenced object doesn't exist.

* * @throws {@link WAFRegionalServiceException} *

Base exception class for all service exceptions from WAFRegional service.

* * * @public */ export declare class GetSampledRequestsCommand extends GetSampledRequestsCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: GetSampledRequestsRequest; output: GetSampledRequestsResponse; }; sdk: { input: GetSampledRequestsCommandInput; output: GetSampledRequestsCommandOutput; }; }; }