« blib/lib/Paws/ResourceGroups/ListGroupResourcesOutput.pm
↑ Summary
blib/lib/Paws/ResourceGroups/ListGroupsOutput.pm »
| 1 | |||
| 2 | package Paws::ResourceGroups::ListGroups; | ||
| 3 | use Moose; | ||
| 4 | has Filters => (is => 'ro', isa => 'ArrayRef[Paws::ResourceGroups::GroupFilter]'); | ||
| 5 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'maxResults'); | ||
| 6 | has NextToken => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'nextToken'); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListGroups'); | ||
| 11 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/groups-list'); | ||
| 12 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ResourceGroups::ListGroupsOutput'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::ResourceGroups::ListGroups - Arguments for method ListGroups on L<Paws::ResourceGroups> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method ListGroups on the | ||
| 25 | L<AWS Resource Groups|Paws::ResourceGroups> service. Use the attributes of this class | ||
| 26 | as arguments to method ListGroups. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListGroups. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $resource-groups = Paws->service('ResourceGroups'); | ||
| 33 | my $ListGroupsOutput = $resource -groups->ListGroups( | ||
| 34 | Filters => [ | ||
| 35 | { | ||
| 36 | Name => 'resource-type', # values: resource-type, configuration-type | ||
| 37 | Values => [ | ||
| 38 | 'MyGroupFilterValue', ... # min: 1, max: 128 | ||
| 39 | ], # min: 1, max: 5 | ||
| 40 | |||
| 41 | }, | ||
| 42 | ... | ||
| 43 | ], # OPTIONAL | ||
| 44 | MaxResults => 1, # OPTIONAL | ||
| 45 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 46 | ); | ||
| 47 | |||
| 48 | # Results: | ||
| 49 | my $GroupIdentifiers = $ListGroupsOutput->GroupIdentifiers; | ||
| 50 | my $Groups = $ListGroupsOutput->Groups; | ||
| 51 | my $NextToken = $ListGroupsOutput->NextToken; | ||
| 52 | |||
| 53 | # Returns a L<Paws::ResourceGroups::ListGroupsOutput> object. | ||
| 54 | |||
| 55 | 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. | ||
| 56 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/resource-groups/ListGroups> | ||
| 57 | |||
| 58 | =head1 ATTRIBUTES | ||
| 59 | |||
| 60 | |||
| 61 | =head2 Filters => ArrayRef[L<Paws::ResourceGroups::GroupFilter>] | ||
| 62 | |||
| 63 | Filters, formatted as GroupFilter objects, that you want to apply to a | ||
| 64 | C<ListGroups> operation. | ||
| 65 | |||
| 66 | =over | ||
| 67 | |||
| 68 | =item * | ||
| 69 | |||
| 70 | C<resource-type> - Filter the results to include only those of the | ||
| 71 | specified resource types. Specify up to five resource types in the | ||
| 72 | format C<AWS::I<ServiceCode>::I<ResourceType> >. For example, | ||
| 73 | C<AWS::EC2::Instance>, or C<AWS::S3::Bucket>. | ||
| 74 | |||
| 75 | =item * | ||
| 76 | |||
| 77 | C<configuration-type> - Filter the results to include only those groups | ||
| 78 | that have the specified configuration types attached. The current | ||
| 79 | supported values are: | ||
| 80 | |||
| 81 | =over | ||
| 82 | |||
| 83 | =item * | ||
| 84 | |||
| 85 | C<AWS:EC2::CapacityReservationPool> | ||
| 86 | |||
| 87 | =item * | ||
| 88 | |||
| 89 | C<AWS:EC2::HostManagement> | ||
| 90 | |||
| 91 | =back | ||
| 92 | |||
| 93 | =back | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | =head2 MaxResults => Int | ||
| 99 | |||
| 100 | The total number of results that you want included on each page of the | ||
| 101 | response. If you do not include this parameter, it defaults to a value | ||
| 102 | that is specific to the operation. If additional items exist beyond the | ||
| 103 | maximum you specify, the C<NextToken> response element is present and | ||
| 104 | has a value (is not null). Include that value as the C<NextToken> | ||
| 105 | request parameter in the next call to the operation to get the next | ||
| 106 | part of the results. Note that the service might return fewer results | ||
| 107 | than the maximum even when there are more results available. You should | ||
| 108 | check C<NextToken> after every operation to ensure that you receive all | ||
| 109 | of the results. | ||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | =head2 NextToken => Str | ||
| 114 | |||
| 115 | The parameter for receiving additional results if you receive a | ||
| 116 | C<NextToken> response in a previous request. A C<NextToken> response | ||
| 117 | indicates that more output is available. Set this parameter to the | ||
| 118 | value provided by a previous call's C<NextToken> response to indicate | ||
| 119 | where the output should continue from. | ||
| 120 | |||
| 121 | |||
| 122 | |||
| 123 | |||
| 124 | =head1 SEE ALSO | ||
| 125 | |||
| 126 | This class forms part of L<Paws>, documenting arguments for method ListGroups in L<Paws::ResourceGroups> | ||
| 127 | |||
| 128 | =head1 BUGS and CONTRIBUTIONS | ||
| 129 | |||
| 130 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 131 | |||
| 132 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 133 | |||
| 134 | =cut | ||
| 135 |