« blib/lib/Paws/WAFV2/GetRuleGroupResponse.pm
↑ Summary
blib/lib/Paws/WAFV2/GetSampledRequestsResponse.pm »
| 1 | |||
| 2 | package Paws::WAFV2::GetSampledRequests; | ||
| 3 | use Moose; | ||
| 4 | has MaxItems => (is => 'ro', isa => 'Int', required => 1); | ||
| 5 | has RuleMetricName => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has Scope => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has TimeWindow => (is => 'ro', isa => 'Paws::WAFV2::TimeWindow', required => 1); | ||
| 8 | has WebAclArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetSampledRequests'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::WAFV2::GetSampledRequestsResponse'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::WAFV2::GetSampledRequests - Arguments for method GetSampledRequests on L<Paws::WAFV2> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method GetSampledRequests on the | ||
| 26 | L<AWS WAFV2|Paws::WAFV2> service. Use the attributes of this class | ||
| 27 | as arguments to method GetSampledRequests. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetSampledRequests. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $wafv2 = Paws->service('WAFV2'); | ||
| 34 | my $GetSampledRequestsResponse = $wafv2->GetSampledRequests( | ||
| 35 | MaxItems => 1, | ||
| 36 | RuleMetricName => 'MyMetricName', | ||
| 37 | Scope => 'CLOUDFRONT', | ||
| 38 | TimeWindow => { | ||
| 39 | EndTime => '1970-01-01T01:00:00', | ||
| 40 | StartTime => '1970-01-01T01:00:00', | ||
| 41 | |||
| 42 | }, | ||
| 43 | WebAclArn => 'MyResourceArn', | ||
| 44 | |||
| 45 | ); | ||
| 46 | |||
| 47 | # Results: | ||
| 48 | my $PopulationSize = $GetSampledRequestsResponse->PopulationSize; | ||
| 49 | my $SampledRequests = $GetSampledRequestsResponse->SampledRequests; | ||
| 50 | my $TimeWindow = $GetSampledRequestsResponse->TimeWindow; | ||
| 51 | |||
| 52 | # Returns a L<Paws::WAFV2::GetSampledRequestsResponse> object. | ||
| 53 | |||
| 54 | 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. | ||
| 55 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/wafv2/GetSampledRequests> | ||
| 56 | |||
| 57 | =head1 ATTRIBUTES | ||
| 58 | |||
| 59 | |||
| 60 | =head2 B<REQUIRED> MaxItems => Int | ||
| 61 | |||
| 62 | The number of requests that you want WAF to return from among the first | ||
| 63 | 5,000 requests that your Amazon Web Services resource received during | ||
| 64 | the time range. If your resource received fewer requests than the value | ||
| 65 | of C<MaxItems>, C<GetSampledRequests> returns information about all of | ||
| 66 | them. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head2 B<REQUIRED> RuleMetricName => Str | ||
| 71 | |||
| 72 | The metric name assigned to the C<Rule> or C<RuleGroup> for which you | ||
| 73 | want a sample of requests. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 B<REQUIRED> Scope => Str | ||
| 78 | |||
| 79 | Specifies whether this is for an Amazon CloudFront distribution or for | ||
| 80 | a regional application. A regional application can be an Application | ||
| 81 | Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync | ||
| 82 | GraphQL API. | ||
| 83 | |||
| 84 | To work with CloudFront, you must also specify the Region US East (N. | ||
| 85 | Virginia) as follows: | ||
| 86 | |||
| 87 | =over | ||
| 88 | |||
| 89 | =item * | ||
| 90 | |||
| 91 | CLI - Specify the Region when you use the CloudFront scope: | ||
| 92 | C<--scope=CLOUDFRONT --region=us-east-1>. | ||
| 93 | |||
| 94 | =item * | ||
| 95 | |||
| 96 | API and SDKs - For all calls, use the Region endpoint us-east-1. | ||
| 97 | |||
| 98 | =back | ||
| 99 | |||
| 100 | |||
| 101 | Valid values are: C<"CLOUDFRONT">, C<"REGIONAL"> | ||
| 102 | |||
| 103 | =head2 B<REQUIRED> TimeWindow => L<Paws::WAFV2::TimeWindow> | ||
| 104 | |||
| 105 | The start date and time and the end date and time of the range for | ||
| 106 | which you want C<GetSampledRequests> to return a sample of requests. | ||
| 107 | You must specify the times in Coordinated Universal Time (UTC) format. | ||
| 108 | UTC format includes the special designator, C<Z>. For example, | ||
| 109 | C<"2016-09-27T14:50Z">. You can specify any time range in the previous | ||
| 110 | three hours. If you specify a start time that's earlier than three | ||
| 111 | hours ago, WAF sets it to three hours ago. | ||
| 112 | |||
| 113 | |||
| 114 | |||
| 115 | =head2 B<REQUIRED> WebAclArn => Str | ||
| 116 | |||
| 117 | The Amazon resource name (ARN) of the C<WebACL> for which you want a | ||
| 118 | sample of requests. | ||
| 119 | |||
| 120 | |||
| 121 | |||
| 122 | |||
| 123 | =head1 SEE ALSO | ||
| 124 | |||
| 125 | This class forms part of L<Paws>, documenting arguments for method GetSampledRequests in L<Paws::WAFV2> | ||
| 126 | |||
| 127 | =head1 BUGS and CONTRIBUTIONS | ||
| 128 | |||
| 129 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 130 | |||
| 131 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 132 | |||
| 133 | =cut | ||
| 134 |