blib/lib/Paws/RedShift/DescribeClusters.pm

filter: Statementstmt 100% 15 / 15 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 2 / 2 Podpod n/a totaltotal 100% 17 / 17 CC 1 SCAR 0.0
CC
1
Cov
100%
BEGIN
1.0
BEGIN
1.0
CRAP 1.0
« blib/lib/Paws/RedShift/DescribeClusterVersions.pm ↑ Summary blib/lib/Paws/RedShift/DescribeEvents.pm »
1  
2 package Paws::RedShift::DescribeClusters;
3 1 ▶ use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 1 has ClusterIdentifier => (is => 'ro', isa => 'Str');
5 1 has Marker => (is => 'ro', isa => 'Str');
6 1 has MaxRecords => (is => 'ro', isa => 'Int');
7 1 has TagKeys => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
8 1 has TagValues => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
9  
10 1 ▶ use MooseX::ClassAttribute;
Subroutine BEGIN: called CC=1 SCAR=0.0
11  
12 1 class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeClusters');
13 1 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RedShift::ClustersMessage');
14 1 class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeClustersResult');
15 1 1;
16  
17 ### main pod documentation begin ###
18  
19 =head1 NAME
20  
21 Paws::RedShift::DescribeClusters - Arguments for method DescribeClusters on L<Paws::RedShift>
22  
23 =head1 DESCRIPTION
24  
25 This class represents the parameters used for calling the method DescribeClusters on the
26 L<Amazon Redshift|Paws::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 =head1 SYNOPSIS
32  
33 my $redshift = Paws->service('RedShift');
34 my $ClustersMessage = $redshift->DescribeClusters(
35 ClusterIdentifier => 'MyString', # OPTIONAL
36 Marker => 'MyString', # OPTIONAL
37 MaxRecords => 1, # OPTIONAL
38 TagKeys => [
39 'MyString', ... # max: 2147483647
40 ], # OPTIONAL
41 TagValues => [
42 'MyString', ... # max: 2147483647
43 ], # OPTIONAL
44 );
45  
46 # Results:
47 my $Clusters = $ClustersMessage->Clusters;
48 my $Marker = $ClustersMessage->Marker;
49  
50 # Returns a L<Paws::RedShift::ClustersMessage> object.
51  
52 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.
53 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/redshift/DescribeClusters>
54  
55 =head1 ATTRIBUTES
56  
57  
58 =head2 ClusterIdentifier => Str
59  
60 The unique identifier of a cluster whose properties you are requesting.
61 This parameter is case sensitive.
62  
63 The default is that all clusters defined for an account are returned.
64  
65  
66  
67 =head2 Marker => Str
68  
69 An optional parameter that specifies the starting point to return a set
70 of response records. When the results of a DescribeClusters request
71 exceed the value specified in C<MaxRecords>, AWS returns a value in the
72 C<Marker> field of the response. You can retrieve the next set of
73 response records by providing the returned marker value in the
74 C<Marker> parameter and retrying the request.
75  
76 Constraints: You can specify either the B<ClusterIdentifier> parameter
77 or the B<Marker> parameter, but not both.
78  
79  
80  
81 =head2 MaxRecords => Int
82  
83 The maximum number of response records to return in each call. If the
84 number of remaining response records exceeds the specified
85 C<MaxRecords> value, a value is returned in a C<marker> field of the
86 response. You can retrieve the next set of records by retrying the
87 command with the returned marker value.
88  
89 Default: C<100>
90  
91 Constraints: minimum 20, maximum 100.
92  
93  
94  
95 =head2 TagKeys => ArrayRef[Str|Undef]
96  
97 A tag key or keys for which you want to return all matching clusters
98 that are associated with the specified key or keys. For example,
99 suppose that you have clusters that are tagged with keys called
100 C<owner> and C<environment>. If you specify both of these tag keys in
101 the request, Amazon Redshift returns a response with the clusters that
102 have either or both of these tag keys associated with them.
103  
104  
105  
106 =head2 TagValues => ArrayRef[Str|Undef]
107  
108 A tag value or values for which you want to return all matching
109 clusters that are associated with the specified tag value or values.
110 For example, suppose that you have clusters that are tagged with values
111 called C<admin> and C<test>. If you specify both of these tag values in
112 the request, Amazon Redshift returns a response with the clusters that
113 have either or both of these tag values associated with them.
114  
115  
116  
117  
118 =head1 SEE ALSO
119  
120 This class forms part of L<Paws>, documenting arguments for method DescribeClusters in L<Paws::RedShift>
121  
122 =head1 BUGS and CONTRIBUTIONS
123  
124 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
125  
126 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
127  
128 =cut
129  
« blib/lib/Paws/RedShift/DescribeClusterVersions.pm ↑ Summary blib/lib/Paws/RedShift/DescribeEvents.pm »