NAME

Paws::WAFV2::GetSampledRequests - Arguments for method GetSampledRequests on Paws::WAFV2

DESCRIPTION

This class represents the parameters used for calling the method GetSampledRequests on the AWS WAFV2 service. Use the attributes of this class as arguments to method GetSampledRequests.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetSampledRequests.

SYNOPSIS

    my $wafv2 = Paws->service('WAFV2');
    my $GetSampledRequestsResponse = $wafv2->GetSampledRequests(
      MaxItems       => 1,
      RuleMetricName => 'MyMetricName',
      Scope          => 'CLOUDFRONT',
      TimeWindow     => {
        EndTime   => '1970-01-01T01:00:00',
        StartTime => '1970-01-01T01:00:00',
      },
      WebAclArn => 'MyResourceArn',
    );
    # Results:
    my $PopulationSize  = $GetSampledRequestsResponse->PopulationSize;
    my $SampledRequests = $GetSampledRequestsResponse->SampledRequests;
    my $TimeWindow      = $GetSampledRequestsResponse->TimeWindow;
    # Returns a L<Paws::WAFV2::GetSampledRequestsResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/wafv2/GetSampledRequests>

ATTRIBUTES

REQUIRED MaxItems => Int

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.

REQUIRED RuleMetricName => Str

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

REQUIRED Scope => Str

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, or an AppSync GraphQL API.

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.

Valid values are: "CLOUDFRONT", "REGIONAL"

REQUIRED TimeWindow => Paws::WAFV2::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.

REQUIRED WebAclArn => Str

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

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>