File Coverage

blib/lib/Paws/RedShift/DescribeClusters.pm
Criterion Covered Total %
statement 12 12 100.0
branch n/a
condition n/a
subroutine 4 4 100.0
pod n/a
total 16 16 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::RedShift::DescribeClusters;
3 1     1   328 use Moose;
  1     1   2  
  1         8  
  1         488  
  1         2  
  1         8  
4             has ClusterIdentifier => (is => 'ro', isa => 'Str');
5             has Marker => (is => 'ro', isa => 'Str');
6             has MaxRecords => (is => 'ro', isa => 'Int');
7             has TagKeys => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
8             has TagValues => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
9              
10 1     1   5529 use MooseX::ClassAttribute;
  1     1   3  
  1         8  
  1         6375  
  1         2  
  1         8  
11              
12             class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeClusters');
13             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RedShift::ClustersMessage');
14             class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeClustersResult');
15             1;
16              
17             ### main pod documentation begin ###
18              
19             =head1 NAME
20              
21             Paws::RedShift::DescribeClusters - Arguments for method DescribeClusters on Paws::RedShift
22              
23             =head1 DESCRIPTION
24              
25             This class represents the parameters used for calling the method DescribeClusters on the
26             Amazon Redshift service. Use the attributes of this class
27             as arguments to method DescribeClusters.
28              
29             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeClusters.
30              
31             As an example:
32              
33             $service_obj->DescribeClusters(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 ClusterIdentifier => Str
41              
42             The unique identifier of a cluster whose properties you are requesting.
43             This parameter is case sensitive.
44              
45             The default is that all clusters defined for an account are returned.
46              
47              
48              
49             =head2 Marker => Str
50              
51             An optional parameter that specifies the starting point to return a set
52             of response records. When the results of a DescribeClusters request
53             exceed the value specified in C<MaxRecords>, AWS returns a value in the
54             C<Marker> field of the response. You can retrieve the next set of
55             response records by providing the returned marker value in the
56             C<Marker> parameter and retrying the request.
57              
58             Constraints: You can specify either the B<ClusterIdentifier> parameter
59             or the B<Marker> parameter, but not both.
60              
61              
62              
63             =head2 MaxRecords => Int
64              
65             The maximum number of response records to return in each call. If the
66             number of remaining response records exceeds the specified
67             C<MaxRecords> value, a value is returned in a C<marker> field of the
68             response. You can retrieve the next set of records by retrying the
69             command with the returned marker value.
70              
71             Default: C<100>
72              
73             Constraints: minimum 20, maximum 100.
74              
75              
76              
77             =head2 TagKeys => ArrayRef[Str|Undef]
78              
79             A tag key or keys for which you want to return all matching clusters
80             that are associated with the specified key or keys. For example,
81             suppose that you have clusters that are tagged with keys called
82             C<owner> and C<environment>. If you specify both of these tag keys in
83             the request, Amazon Redshift returns a response with the clusters that
84             have either or both of these tag keys associated with them.
85              
86              
87              
88             =head2 TagValues => ArrayRef[Str|Undef]
89              
90             A tag value or values for which you want to return all matching
91             clusters that are associated with the specified tag value or values.
92             For example, suppose that you have clusters that are tagged with values
93             called C<admin> and C<test>. If you specify both of these tag values in
94             the request, Amazon Redshift returns a response with the clusters that
95             have either or both of these tag values associated with them.
96              
97              
98              
99              
100             =head1 SEE ALSO
101              
102             This class forms part of L<Paws>, documenting arguments for method DescribeClusters in L<Paws::RedShift>
103              
104             =head1 BUGS and CONTRIBUTIONS
105              
106             The source code is located here: https://github.com/pplu/aws-sdk-perl
107              
108             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
109              
110             =cut
111