File Coverage

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