File Coverage

blib/lib/Paws/ResourceTagging/GetResources.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::ResourceTagging::GetResources;
3 1     1   291 use Moose;
  1         2  
  1         7  
4             has PaginationToken => (is => 'ro', isa => 'Str');
5             has ResourcesPerPage => (is => 'ro', isa => 'Int');
6             has ResourceTypeFilters => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
7             has TagFilters => (is => 'ro', isa => 'ArrayRef[Paws::ResourceTagging::TagFilter]');
8             has TagsPerPage => (is => 'ro', isa => 'Int');
9              
10 1     1   5479 use MooseX::ClassAttribute;
  1         2  
  1         8  
11              
12             class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetResources');
13             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ResourceTagging::GetResourcesOutput');
14             class_has _result_key => (isa => 'Str', is => 'ro');
15             1;
16              
17             ### main pod documentation begin ###
18              
19             =head1 NAME
20              
21             Paws::ResourceTagging::GetResources - Arguments for method GetResources on Paws::ResourceTagging
22              
23             =head1 DESCRIPTION
24              
25             This class represents the parameters used for calling the method GetResources on the
26             AWS Resource Groups Tagging API service. Use the attributes of this class
27             as arguments to method GetResources.
28              
29             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetResources.
30              
31             As an example:
32              
33             $service_obj->GetResources(Att1 => $value1, Att2 => $value2, ...);
34              
35             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.
36              
37             =head1 ATTRIBUTES
38              
39              
40             =head2 PaginationToken => Str
41              
42             A string that indicates that additional data is available. Leave this
43             value empty for your initial request. If the response includes a
44             C<PaginationToken>, use that string for this value to request an
45             additional page of data.
46              
47              
48              
49             =head2 ResourcesPerPage => Int
50              
51             A limit that restricts the number of resources returned by GetResources
52             in paginated output. You can set ResourcesPerPage to a minimum of 1
53             item and the maximum of 50 items.
54              
55              
56              
57             =head2 ResourceTypeFilters => ArrayRef[Str|Undef]
58              
59             The constraints on the resources that you want returned. The format of
60             each resource type is C<service[:resourceType]>. For example,
61             specifying a resource type of C<ec2> returns all tagged Amazon EC2
62             resources (which includes tagged EC2 instances). Specifying a resource
63             type of C<ec2:instance> returns only EC2 instances.
64              
65             The string for each service name and resource type is the same as that
66             embedded in a resource's Amazon Resource Name (ARN). Consult the I<AWS
67             General Reference> for the following:
68              
69             =over
70              
71             =item *
72              
73             For a list of service name strings, see AWS Service Namespaces.
74              
75             =item *
76              
77             For resource type strings, see Example ARNs.
78              
79             =item *
80              
81             For more information about ARNs, see Amazon Resource Names (ARNs) and
82             AWS Service Namespaces.
83              
84             =back
85              
86              
87              
88              
89             =head2 TagFilters => ArrayRef[L<Paws::ResourceTagging::TagFilter>]
90              
91             A list of tags (keys and values). A request can include up to 50 keys,
92             and each key can include up to 20 values.
93              
94             If you specify multiple filters connected by an AND operator in a
95             single request, the response returns only those resources that are
96             associated with every specified filter.
97              
98             If you specify multiple filters connected by an OR operator in a single
99             request, the response returns all resources that are associated with at
100             least one or possibly more of the specified filters.
101              
102              
103              
104             =head2 TagsPerPage => Int
105              
106             A limit that restricts the number of tags (key and value pairs)
107             returned by GetResources in paginated output. A resource with no tags
108             is counted as having one tag (one key and value pair).
109              
110             C<GetResources> does not split a resource and its associated tags
111             across pages. If the specified C<TagsPerPage> would cause such a break,
112             a C<PaginationToken> is returned in place of the affected resource and
113             its tags. Use that token in another request to get the remaining data.
114             For example, if you specify a C<TagsPerPage> of C<100> and the account
115             has 22 resources with 10 tags each (meaning that each resource has 10
116             key and value pairs), the output will consist of 3 pages, with the
117             first page displaying the first 10 resources, each with its 10 tags,
118             the second page displaying the next 10 resources each with its 10 tags,
119             and the third page displaying the remaining 2 resources, each with its
120             10 tags.
121              
122             You can set C<TagsPerPage> to a minimum of 100 items and the maximum of
123             500 items.
124              
125              
126              
127              
128             =head1 SEE ALSO
129              
130             This class forms part of L<Paws>, documenting arguments for method GetResources in L<Paws::ResourceTagging>
131              
132             =head1 BUGS and CONTRIBUTIONS
133              
134             The source code is located here: https://github.com/pplu/aws-sdk-perl
135              
136             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
137              
138             =cut
139