« blib/lib/Paws/EC2/DescribePlacementGroupsResult.pm
↑ Summary
blib/lib/Paws/EC2/DescribeRegionsResult.pm »
| 1 | |||
| 2 | package Paws::EC2::DescribeRegions; | ||
| 3 | 1 | ▶ | use Moose; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 4 | 1 | has AllRegions => (is => 'ro', isa => 'Bool'); | |
| 5 | 1 | has DryRun => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'dryRun' ); | |
| 6 | 1 | has Filters => (is => 'ro', isa => 'ArrayRef[Paws::EC2::Filter]', traits => ['NameInRequest'], request_name => 'Filter' ); | |
| 7 | 1 | has RegionNames => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'RegionName' ); | |
| 8 | |||
| 9 | 1 | ▶ | use MooseX::ClassAttribute; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 10 | |||
| 11 | 1 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeRegions'); | |
| 12 | 1 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::DescribeRegionsResult'); | |
| 13 | 1 | class_has _result_key => (isa => 'Str', is => 'ro'); | |
| 14 | 1 | 1; | |
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::EC2::DescribeRegions - Arguments for method DescribeRegions on L<Paws::EC2> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method DescribeRegions on the | ||
| 25 | L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class | ||
| 26 | as arguments to method DescribeRegions. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeRegions. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $ec2 = Paws->service('EC2'); | ||
| 33 | # To describe your regions | ||
| 34 | # This example describes all the regions that are available to you. | ||
| 35 | my $DescribeRegionsResult = $ec2->DescribeRegions(); | ||
| 36 | |||
| 37 | # Results: | ||
| 38 | my $Regions = $DescribeRegionsResult->Regions; | ||
| 39 | |||
| 40 | # Returns a L<Paws::EC2::DescribeRegionsResult> object. | ||
| 41 | |||
| 42 | 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. | ||
| 43 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/DescribeRegions> | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 AllRegions => Bool | ||
| 49 | |||
| 50 | Indicates whether to display all Regions, including Regions that are | ||
| 51 | disabled for your account. | ||
| 52 | |||
| 53 | |||
| 54 | |||
| 55 | =head2 DryRun => Bool | ||
| 56 | |||
| 57 | Checks whether you have the required permissions for the action, | ||
| 58 | without actually making the request, and provides an error response. If | ||
| 59 | you have the required permissions, the error response is | ||
| 60 | C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>. | ||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | =head2 Filters => ArrayRef[L<Paws::EC2::Filter>] | ||
| 65 | |||
| 66 | The filters. | ||
| 67 | |||
| 68 | =over | ||
| 69 | |||
| 70 | =item * | ||
| 71 | |||
| 72 | C<endpoint> - The endpoint of the Region (for example, | ||
| 73 | C<ec2.us-east-1.amazonaws.com>). | ||
| 74 | |||
| 75 | =item * | ||
| 76 | |||
| 77 | C<opt-in-status> - The opt-in status of the Region | ||
| 78 | (C<opt-in-not-required> | C<opted-in> | C<not-opted-in>). | ||
| 79 | |||
| 80 | =item * | ||
| 81 | |||
| 82 | C<region-name> - The name of the Region (for example, C<us-east-1>). | ||
| 83 | |||
| 84 | =back | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | =head2 RegionNames => ArrayRef[Str|Undef] | ||
| 90 | |||
| 91 | The names of the Regions. You can specify any Regions, whether they are | ||
| 92 | enabled and disabled for your account. | ||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head1 SEE ALSO | ||
| 98 | |||
| 99 | This class forms part of L<Paws>, documenting arguments for method DescribeRegions in L<Paws::EC2> | ||
| 100 | |||
| 101 | =head1 BUGS and CONTRIBUTIONS | ||
| 102 | |||
| 103 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 104 | |||
| 105 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 106 | |||
| 107 | =cut | ||
| 108 | |||