« blib/lib/Paws/ResourceGroups/GroupResourcesOutput.pm
↑ Summary
blib/lib/Paws/ResourceGroups/ListGroupResourcesItem.pm »
| 1 | |||
| 2 | package Paws::ResourceGroups::ListGroupResources; | ||
| 3 | use Moose; | ||
| 4 | has Filters => (is => 'ro', isa => 'ArrayRef[Paws::ResourceGroups::ResourceFilter]'); | ||
| 5 | has Group => (is => 'ro', isa => 'Str'); | ||
| 6 | has GroupName => (is => 'ro', isa => 'Str'); | ||
| 7 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 8 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListGroupResources'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/list-group-resources'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ResourceGroups::ListGroupResourcesOutput'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::ResourceGroups::ListGroupResources - Arguments for method ListGroupResources on L<Paws::ResourceGroups> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method ListGroupResources on the | ||
| 27 | L<AWS Resource Groups|Paws::ResourceGroups> service. Use the attributes of this class | ||
| 28 | as arguments to method ListGroupResources. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListGroupResources. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $resource-groups = Paws->service('ResourceGroups'); | ||
| 35 | my $ListGroupResourcesOutput = $resource -groups->ListGroupResources( | ||
| 36 | Filters => [ | ||
| 37 | { | ||
| 38 | Name => 'resource-type', # values: resource-type | ||
| 39 | Values => [ | ||
| 40 | 'MyResourceFilterValue', ... # min: 1, max: 128 | ||
| 41 | ], # min: 1, max: 5 | ||
| 42 | |||
| 43 | }, | ||
| 44 | ... | ||
| 45 | ], # OPTIONAL | ||
| 46 | Group => 'MyGroupString', # OPTIONAL | ||
| 47 | GroupName => 'MyGroupName', # OPTIONAL | ||
| 48 | MaxResults => 1, # OPTIONAL | ||
| 49 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 50 | ); | ||
| 51 | |||
| 52 | # Results: | ||
| 53 | my $NextToken = $ListGroupResourcesOutput->NextToken; | ||
| 54 | my $QueryErrors = $ListGroupResourcesOutput->QueryErrors; | ||
| 55 | my $ResourceIdentifiers = $ListGroupResourcesOutput->ResourceIdentifiers; | ||
| 56 | my $Resources = $ListGroupResourcesOutput->Resources; | ||
| 57 | |||
| 58 | # Returns a L<Paws::ResourceGroups::ListGroupResourcesOutput> object. | ||
| 59 | |||
| 60 | 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. | ||
| 61 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/resource-groups/ListGroupResources> | ||
| 62 | |||
| 63 | =head1 ATTRIBUTES | ||
| 64 | |||
| 65 | |||
| 66 | =head2 Filters => ArrayRef[L<Paws::ResourceGroups::ResourceFilter>] | ||
| 67 | |||
| 68 | Filters, formatted as ResourceFilter objects, that you want to apply to | ||
| 69 | a C<ListGroupResources> operation. Filters the results to include only | ||
| 70 | those of the specified resource types. | ||
| 71 | |||
| 72 | =over | ||
| 73 | |||
| 74 | =item * | ||
| 75 | |||
| 76 | C<resource-type> - Filter resources by their type. Specify up to five | ||
| 77 | resource types in the format C<AWS::ServiceCode::ResourceType>. For | ||
| 78 | example, C<AWS::EC2::Instance>, or C<AWS::S3::Bucket>. | ||
| 79 | |||
| 80 | =back | ||
| 81 | |||
| 82 | When you specify a C<resource-type> filter for C<ListGroupResources>, | ||
| 83 | AWS Resource Groups validates your filter resource types against the | ||
| 84 | types that are defined in the query associated with the group. For | ||
| 85 | example, if a group contains only S3 buckets because its query | ||
| 86 | specifies only that resource type, but your C<resource-type> filter | ||
| 87 | includes EC2 instances, AWS Resource Groups does not filter for EC2 | ||
| 88 | instances. In this case, a C<ListGroupResources> request returns a | ||
| 89 | C<BadRequestException> error with a message similar to the following: | ||
| 90 | |||
| 91 | C<The resource types specified as filters in the request are not | ||
| 92 | valid.> | ||
| 93 | |||
| 94 | The error includes a list of resource types that failed the validation | ||
| 95 | because they are not part of the query associated with the group. This | ||
| 96 | validation doesn't occur when the group query specifies | ||
| 97 | C<AWS::AllSupported>, because a group based on such a query can contain | ||
| 98 | any of the allowed resource types for the query type (tag-based or AWS | ||
| 99 | CloudFormation stack-based queries). | ||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | =head2 Group => Str | ||
| 104 | |||
| 105 | The name or the ARN of the resource group | ||
| 106 | |||
| 107 | |||
| 108 | |||
| 109 | =head2 GroupName => Str | ||
| 110 | |||
| 111 | I<B<Deprecated - don't use this parameter. Use the C<Group> request | ||
| 112 | field instead.>> | ||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | =head2 MaxResults => Int | ||
| 117 | |||
| 118 | The total number of results that you want included on each page of the | ||
| 119 | response. If you do not include this parameter, it defaults to a value | ||
| 120 | that is specific to the operation. If additional items exist beyond the | ||
| 121 | maximum you specify, the C<NextToken> response element is present and | ||
| 122 | has a value (is not null). Include that value as the C<NextToken> | ||
| 123 | request parameter in the next call to the operation to get the next | ||
| 124 | part of the results. Note that the service might return fewer results | ||
| 125 | than the maximum even when there are more results available. You should | ||
| 126 | check C<NextToken> after every operation to ensure that you receive all | ||
| 127 | of the results. | ||
| 128 | |||
| 129 | |||
| 130 | |||
| 131 | =head2 NextToken => Str | ||
| 132 | |||
| 133 | The parameter for receiving additional results if you receive a | ||
| 134 | C<NextToken> response in a previous request. A C<NextToken> response | ||
| 135 | indicates that more output is available. Set this parameter to the | ||
| 136 | value provided by a previous call's C<NextToken> response to indicate | ||
| 137 | where the output should continue from. | ||
| 138 | |||
| 139 | |||
| 140 | |||
| 141 | |||
| 142 | =head1 SEE ALSO | ||
| 143 | |||
| 144 | This class forms part of L<Paws>, documenting arguments for method ListGroupResources in L<Paws::ResourceGroups> | ||
| 145 | |||
| 146 | =head1 BUGS and CONTRIBUTIONS | ||
| 147 | |||
| 148 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 149 | |||
| 150 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 151 | |||
| 152 | =cut | ||
| 153 |