File Coverage

blib/lib/Paws/RedShift/DescribeTags.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::RedShift::DescribeTags;
3 1     1   327 use Moose;
  1         3  
  1         6  
4             has Marker => (is => 'ro', isa => 'Str');
5             has MaxRecords => (is => 'ro', isa => 'Int');
6             has ResourceName => (is => 'ro', isa => 'Str');
7             has ResourceType => (is => 'ro', isa => 'Str');
8             has TagKeys => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
9             has TagValues => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
10              
11 1     1   5441 use MooseX::ClassAttribute;
  1         3  
  1         8  
12              
13             class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeTags');
14             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RedShift::TaggedResourceListMessage');
15             class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeTagsResult');
16             1;
17              
18             ### main pod documentation begin ###
19              
20             =head1 NAME
21              
22             Paws::RedShift::DescribeTags - Arguments for method DescribeTags on Paws::RedShift
23              
24             =head1 DESCRIPTION
25              
26             This class represents the parameters used for calling the method DescribeTags on the
27             Amazon Redshift service. Use the attributes of this class
28             as arguments to method DescribeTags.
29              
30             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeTags.
31              
32             As an example:
33              
34             $service_obj->DescribeTags(Att1 => $value1, Att2 => $value2, ...);
35              
36             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.
37              
38             =head1 ATTRIBUTES
39              
40              
41             =head2 Marker => Str
42              
43             A value that indicates the starting point for the next set of response
44             records in a subsequent request. If a value is returned in a response,
45             you can retrieve the next set of records by providing this returned
46             marker value in the C<marker> parameter and retrying the command. If
47             the C<marker> field is empty, all response records have been retrieved
48             for the request.
49              
50              
51              
52             =head2 MaxRecords => Int
53              
54             The maximum number or response records to return in each call. If the
55             number of remaining response records exceeds the specified
56             C<MaxRecords> value, a value is returned in a C<marker> field of the
57             response. You can retrieve the next set of records by retrying the
58             command with the returned C<marker> value.
59              
60              
61              
62             =head2 ResourceName => Str
63              
64             The Amazon Resource Name (ARN) for which you want to describe the tag
65             or tags. For example,
66             C<arn:aws:redshift:us-east-1:123456789:cluster:t1>.
67              
68              
69              
70             =head2 ResourceType => Str
71              
72             The type of resource with which you want to view tags. Valid resource
73             types are:
74              
75             =over
76              
77             =item *
78              
79             Cluster
80              
81             =item *
82              
83             CIDR/IP
84              
85             =item *
86              
87             EC2 security group
88              
89             =item *
90              
91             Snapshot
92              
93             =item *
94              
95             Cluster security group
96              
97             =item *
98              
99             Subnet group
100              
101             =item *
102              
103             HSM connection
104              
105             =item *
106              
107             HSM certificate
108              
109             =item *
110              
111             Parameter group
112              
113             =item *
114              
115             Snapshot copy grant
116              
117             =back
118              
119             For more information about Amazon Redshift resource types and
120             constructing ARNs, go to Specifying Policy Elements: Actions, Effects,
121             Resources, and Principals in the Amazon Redshift Cluster Management
122             Guide.
123              
124              
125              
126             =head2 TagKeys => ArrayRef[Str|Undef]
127              
128             A tag key or keys for which you want to return all matching resources
129             that are associated with the specified key or keys. For example,
130             suppose that you have resources tagged with keys called C<owner> and
131             C<environment>. If you specify both of these tag keys in the request,
132             Amazon Redshift returns a response with all resources that have either
133             or both of these tag keys associated with them.
134              
135              
136              
137             =head2 TagValues => ArrayRef[Str|Undef]
138              
139             A tag value or values for which you want to return all matching
140             resources that are associated with the specified value or values. For
141             example, suppose that you have resources tagged with values called
142             C<admin> and C<test>. If you specify both of these tag values in the
143             request, Amazon Redshift returns a response with all resources that
144             have either or both of these tag values associated with them.
145              
146              
147              
148              
149             =head1 SEE ALSO
150              
151             This class forms part of L<Paws>, documenting arguments for method DescribeTags in L<Paws::RedShift>
152              
153             =head1 BUGS and CONTRIBUTIONS
154              
155             The source code is located here: https://github.com/pplu/aws-sdk-perl
156              
157             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
158              
159             =cut
160