« blib/lib/Paws/EC2/DescribeNetworkInterfacesResult.pm
↑ Summary
blib/lib/Paws/EC2/DescribePlacementGroupsResult.pm »
| 1 | |||
| 2 | package Paws::EC2::DescribePlacementGroups; | ||
| 3 | 1 | ▶ | use Moose; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 4 | 1 | has DryRun => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'dryRun' ); | |
| 5 | 1 | has Filters => (is => 'ro', isa => 'ArrayRef[Paws::EC2::Filter]', traits => ['NameInRequest'], request_name => 'Filter' ); | |
| 6 | 1 | has GroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'GroupId' ); | |
| 7 | 1 | has GroupNames => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'groupName' ); | |
| 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 => 'DescribePlacementGroups'); | |
| 12 | 1 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::DescribePlacementGroupsResult'); | |
| 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::DescribePlacementGroups - Arguments for method DescribePlacementGroups on L<Paws::EC2> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method DescribePlacementGroups on the | ||
| 25 | L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class | ||
| 26 | as arguments to method DescribePlacementGroups. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribePlacementGroups. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $ec2 = Paws->service('EC2'); | ||
| 33 | my $DescribePlacementGroupsResult = $ec2->DescribePlacementGroups( | ||
| 34 | DryRun => 1, # OPTIONAL | ||
| 35 | Filters => [ | ||
| 36 | { | ||
| 37 | Name => 'MyString', # OPTIONAL | ||
| 38 | Values => [ | ||
| 39 | 'MyString', ... # OPTIONAL | ||
| 40 | ], # OPTIONAL | ||
| 41 | }, | ||
| 42 | ... | ||
| 43 | ], # OPTIONAL | ||
| 44 | GroupIds => [ 'MyPlacementGroupId', ... ], # OPTIONAL | ||
| 45 | GroupNames => [ 'MyPlacementGroupName', ... ], # OPTIONAL | ||
| 46 | ); | ||
| 47 | |||
| 48 | # Results: | ||
| 49 | my $PlacementGroups = $DescribePlacementGroupsResult->PlacementGroups; | ||
| 50 | |||
| 51 | # Returns a L<Paws::EC2::DescribePlacementGroupsResult> object. | ||
| 52 | |||
| 53 | 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. | ||
| 54 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/DescribePlacementGroups> | ||
| 55 | |||
| 56 | =head1 ATTRIBUTES | ||
| 57 | |||
| 58 | |||
| 59 | =head2 DryRun => Bool | ||
| 60 | |||
| 61 | Checks whether you have the required permissions for the action, | ||
| 62 | without actually making the request, and provides an error response. If | ||
| 63 | you have the required permissions, the error response is | ||
| 64 | C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>. | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 Filters => ArrayRef[L<Paws::EC2::Filter>] | ||
| 69 | |||
| 70 | The filters. | ||
| 71 | |||
| 72 | =over | ||
| 73 | |||
| 74 | =item * | ||
| 75 | |||
| 76 | C<group-name> - The name of the placement group. | ||
| 77 | |||
| 78 | =item * | ||
| 79 | |||
| 80 | C<state> - The state of the placement group (C<pending> | C<available> | ||
| 81 | | C<deleting> | C<deleted>). | ||
| 82 | |||
| 83 | =item * | ||
| 84 | |||
| 85 | C<strategy> - The strategy of the placement group (C<cluster> | | ||
| 86 | C<spread> | C<partition>). | ||
| 87 | |||
| 88 | =item * | ||
| 89 | |||
| 90 | C<tag>:E<lt>keyE<gt> - The key/value combination of a tag assigned to | ||
| 91 | the resource. Use the tag key in the filter name and the tag value as | ||
| 92 | the filter value. For example, to find all resources that have a tag | ||
| 93 | with the key C<Owner> and the value C<TeamA>, specify C<tag:Owner> for | ||
| 94 | the filter name and C<TeamA> for the filter value. | ||
| 95 | |||
| 96 | =item * | ||
| 97 | |||
| 98 | C<tag-key> - The key of a tag assigned to the resource. Use this filter | ||
| 99 | to find all resources that have a tag with a specific key, regardless | ||
| 100 | of the tag value. | ||
| 101 | |||
| 102 | =back | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | =head2 GroupIds => ArrayRef[Str|Undef] | ||
| 108 | |||
| 109 | The IDs of the placement groups. | ||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | =head2 GroupNames => ArrayRef[Str|Undef] | ||
| 114 | |||
| 115 | The names of the placement groups. | ||
| 116 | |||
| 117 | Default: Describes all your placement groups, or only those otherwise | ||
| 118 | specified. | ||
| 119 | |||
| 120 | |||
| 121 | |||
| 122 | |||
| 123 | =head1 SEE ALSO | ||
| 124 | |||
| 125 | This class forms part of L<Paws>, documenting arguments for method DescribePlacementGroups in L<Paws::EC2> | ||
| 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 | |||