NAME

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

DESCRIPTION

This class represents the parameters used for calling the method GetSampledRequests on the AWS WAF Regional 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 $waf-regional = Paws->service('WAFRegional');
  # To get a sampled requests
  # The following example returns detailed information about 100 requests --a
  # sample-- that AWS WAF randomly selects from among the first 5,000 requests
  # that your AWS resource received between the time period 2016-09-27T15:50Z to
  # 2016-09-27T15:50Z.
    my $GetSampledRequestsResponse = $waf -regional->GetSampledRequests(
      'MaxItems'   => 100,
      'RuleId'     => 'WAFRule-1-Example',
      'TimeWindow' => {
        'EndTime'   => '2016-09-27T15:50Z',
        'StartTime' => '2016-09-27T15:50Z'
      },
      'WebAclId' => 'createwebacl-1472061481310'
    );
    # Results:
    my $PopulationSize  = $GetSampledRequestsResponse->PopulationSize;
    my $SampledRequests = $GetSampledRequestsResponse->SampledRequests;
    my $TimeWindow      = $GetSampledRequestsResponse->TimeWindow;
    # Returns a L<Paws::WAFRegional::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/waf-regional/GetSampledRequests>

ATTRIBUTES

REQUIRED MaxItems => Int

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.

REQUIRED RuleId => Str

"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".

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

REQUIRED WebAclId => Str

The "WebACLId" of the "WebACL" for which you want "GetSampledRequests" to return 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>