« blib/lib/Paws/ResourceGroups/ResourceStatus.pm
↑ Summary
blib/lib/Paws/ResourceGroups/SearchResourcesOutput.pm »
| 1 | |||
| 2 | package Paws::ResourceGroups::SearchResources; | ||
| 3 | use Moose; | ||
| 4 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 5 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 6 | has ResourceQuery => (is => 'ro', isa => 'Paws::ResourceGroups::ResourceQuery', required => 1); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'SearchResources'); | ||
| 11 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/resources/search'); | ||
| 12 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ResourceGroups::SearchResourcesOutput'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::ResourceGroups::SearchResources - Arguments for method SearchResources on L<Paws::ResourceGroups> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method SearchResources on the | ||
| 25 | L<AWS Resource Groups|Paws::ResourceGroups> service. Use the attributes of this class | ||
| 26 | as arguments to method SearchResources. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SearchResources. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $resource-groups = Paws->service('ResourceGroups'); | ||
| 33 | my $SearchResourcesOutput = $resource -groups->SearchResources( | ||
| 34 | ResourceQuery => { | ||
| 35 | Query => 'MyQuery', # max: 4096 | ||
| 36 | Type => 'TAG_FILTERS_1_0' | ||
| 37 | , # values: TAG_FILTERS_1_0, CLOUDFORMATION_STACK_1_0min: 1, max: 128 | ||
| 38 | |||
| 39 | }, | ||
| 40 | MaxResults => 1, # OPTIONAL | ||
| 41 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 42 | ); | ||
| 43 | |||
| 44 | # Results: | ||
| 45 | my $NextToken = $SearchResourcesOutput->NextToken; | ||
| 46 | my $QueryErrors = $SearchResourcesOutput->QueryErrors; | ||
| 47 | my $ResourceIdentifiers = $SearchResourcesOutput->ResourceIdentifiers; | ||
| 48 | |||
| 49 | # Returns a L<Paws::ResourceGroups::SearchResourcesOutput> object. | ||
| 50 | |||
| 51 | 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. | ||
| 52 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/resource-groups/SearchResources> | ||
| 53 | |||
| 54 | =head1 ATTRIBUTES | ||
| 55 | |||
| 56 | |||
| 57 | =head2 MaxResults => Int | ||
| 58 | |||
| 59 | The total number of results that you want included on each page of the | ||
| 60 | response. If you do not include this parameter, it defaults to a value | ||
| 61 | that is specific to the operation. If additional items exist beyond the | ||
| 62 | maximum you specify, the C<NextToken> response element is present and | ||
| 63 | has a value (is not null). Include that value as the C<NextToken> | ||
| 64 | request parameter in the next call to the operation to get the next | ||
| 65 | part of the results. Note that the service might return fewer results | ||
| 66 | than the maximum even when there are more results available. You should | ||
| 67 | check C<NextToken> after every operation to ensure that you receive all | ||
| 68 | of the results. | ||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | =head2 NextToken => Str | ||
| 73 | |||
| 74 | The parameter for receiving additional results if you receive a | ||
| 75 | C<NextToken> response in a previous request. A C<NextToken> response | ||
| 76 | indicates that more output is available. Set this parameter to the | ||
| 77 | value provided by a previous call's C<NextToken> response to indicate | ||
| 78 | where the output should continue from. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 B<REQUIRED> ResourceQuery => L<Paws::ResourceGroups::ResourceQuery> | ||
| 83 | |||
| 84 | The search query, using the same formats that are supported for | ||
| 85 | resource group definition. For more information, see CreateGroup. | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head1 SEE ALSO | ||
| 91 | |||
| 92 | This class forms part of L<Paws>, documenting arguments for method SearchResources in L<Paws::ResourceGroups> | ||
| 93 | |||
| 94 | =head1 BUGS and CONTRIBUTIONS | ||
| 95 | |||
| 96 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 97 | |||
| 98 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 99 | |||
| 100 | =cut | ||
| 101 |