« blib/lib/Paws/WAFV2/ListAvailableManagedRuleGroupsResponse.pm
↑ Summary
blib/lib/Paws/WAFV2/ListIPSetsResponse.pm »
| 1 | |||
| 2 | package Paws::WAFV2::ListIPSets; | ||
| 3 | use Moose; | ||
| 4 | has Limit => (is => 'ro', isa => 'Int'); | ||
| 5 | has NextMarker => (is => 'ro', isa => 'Str'); | ||
| 6 | has Scope => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListIPSets'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::WAFV2::ListIPSetsResponse'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::WAFV2::ListIPSets - Arguments for method ListIPSets on L<Paws::WAFV2> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method ListIPSets on the | ||
| 24 | L<AWS WAFV2|Paws::WAFV2> service. Use the attributes of this class | ||
| 25 | as arguments to method ListIPSets. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListIPSets. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $wafv2 = Paws->service('WAFV2'); | ||
| 32 | my $ListIPSetsResponse = $wafv2->ListIPSets( | ||
| 33 | Scope => 'CLOUDFRONT', | ||
| 34 | Limit => 1, # OPTIONAL | ||
| 35 | NextMarker => 'MyNextMarker', # OPTIONAL | ||
| 36 | ); | ||
| 37 | |||
| 38 | # Results: | ||
| 39 | my $IPSets = $ListIPSetsResponse->IPSets; | ||
| 40 | my $NextMarker = $ListIPSetsResponse->NextMarker; | ||
| 41 | |||
| 42 | # Returns a L<Paws::WAFV2::ListIPSetsResponse> object. | ||
| 43 | |||
| 44 | 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. | ||
| 45 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/wafv2/ListIPSets> | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 Limit => Int | ||
| 51 | |||
| 52 | The maximum number of objects that you want WAF to return for this | ||
| 53 | request. If more objects are available, in the response, WAF provides a | ||
| 54 | C<NextMarker> value that you can use in a subsequent call to get the | ||
| 55 | next batch of objects. | ||
| 56 | |||
| 57 | |||
| 58 | |||
| 59 | =head2 NextMarker => Str | ||
| 60 | |||
| 61 | When you request a list of objects with a C<Limit> setting, if the | ||
| 62 | number of objects that are still available for retrieval exceeds the | ||
| 63 | limit, WAF returns a C<NextMarker> value in the response. To retrieve | ||
| 64 | the next batch of objects, provide the marker from the prior call in | ||
| 65 | your next request. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head2 B<REQUIRED> Scope => Str | ||
| 70 | |||
| 71 | Specifies whether this is for an Amazon CloudFront distribution or for | ||
| 72 | a regional application. A regional application can be an Application | ||
| 73 | Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync | ||
| 74 | GraphQL API. | ||
| 75 | |||
| 76 | To work with CloudFront, you must also specify the Region US East (N. | ||
| 77 | Virginia) as follows: | ||
| 78 | |||
| 79 | =over | ||
| 80 | |||
| 81 | =item * | ||
| 82 | |||
| 83 | CLI - Specify the Region when you use the CloudFront scope: | ||
| 84 | C<--scope=CLOUDFRONT --region=us-east-1>. | ||
| 85 | |||
| 86 | =item * | ||
| 87 | |||
| 88 | API and SDKs - For all calls, use the Region endpoint us-east-1. | ||
| 89 | |||
| 90 | =back | ||
| 91 | |||
| 92 | |||
| 93 | Valid values are: C<"CLOUDFRONT">, C<"REGIONAL"> | ||
| 94 | |||
| 95 | |||
| 96 | =head1 SEE ALSO | ||
| 97 | |||
| 98 | This class forms part of L<Paws>, documenting arguments for method ListIPSets in L<Paws::WAFV2> | ||
| 99 | |||
| 100 | =head1 BUGS and CONTRIBUTIONS | ||
| 101 | |||
| 102 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 103 | |||
| 104 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 105 | |||
| 106 | =cut | ||
| 107 |