blib/lib/Paws/RedShift/DescribeClusterSnapshots.pm

filter: Statementstmt 100% 22 / 22 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 2 / 2 Podpod n/a totaltotal 100% 24 / 24 CC 1 SCAR 0.0
CC
1
Cov
100%
BEGIN
1.0
BEGIN
1.0
CRAP 1.0
« blib/lib/Paws/RedShift/DescribeClusterSecurityGroups.pm ↑ Summary blib/lib/Paws/RedShift/DescribeClusterSubnetGroups.pm »
1  
2 package Paws::RedShift::DescribeClusterSnapshots;
3 1 ▶ use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 1 has ClusterExists => (is => 'ro', isa => 'Bool');
5 1 has ClusterIdentifier => (is => 'ro', isa => 'Str');
6 1 has EndTime => (is => 'ro', isa => 'Str');
7 1 has Marker => (is => 'ro', isa => 'Str');
8 1 has MaxRecords => (is => 'ro', isa => 'Int');
9 1 has OwnerAccount => (is => 'ro', isa => 'Str');
10 1 has SnapshotIdentifier => (is => 'ro', isa => 'Str');
11 1 has SnapshotType => (is => 'ro', isa => 'Str');
12 1 has SortingEntities => (is => 'ro', isa => 'ArrayRef[Paws::RedShift::SnapshotSortingEntity]');
13 1 has StartTime => (is => 'ro', isa => 'Str');
14 1 has TagKeys => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
15 1 has TagValues => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
16  
17 1 ▶ use MooseX::ClassAttribute;
Subroutine BEGIN: called CC=1 SCAR=0.0
18  
19 1 class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeClusterSnapshots');
20 1 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RedShift::SnapshotMessage');
21 1 class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeClusterSnapshotsResult');
22 1 1;
23  
24 ### main pod documentation begin ###
25  
26 =head1 NAME
27  
28 Paws::RedShift::DescribeClusterSnapshots - Arguments for method DescribeClusterSnapshots on L<Paws::RedShift>
29  
30 =head1 DESCRIPTION
31  
32 This class represents the parameters used for calling the method DescribeClusterSnapshots on the
33 L<Amazon Redshift|Paws::RedShift> service. Use the attributes of this class
34 as arguments to method DescribeClusterSnapshots.
35  
36 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeClusterSnapshots.
37  
38 =head1 SYNOPSIS
39  
40 my $redshift = Paws->service('RedShift');
41 my $SnapshotMessage = $redshift->DescribeClusterSnapshots(
42 ClusterExists => 1, # OPTIONAL
43 ClusterIdentifier => 'MyString', # OPTIONAL
44 EndTime => '1970-01-01T01:00:00', # OPTIONAL
45 Marker => 'MyString', # OPTIONAL
46 MaxRecords => 1, # OPTIONAL
47 OwnerAccount => 'MyString', # OPTIONAL
48 SnapshotIdentifier => 'MyString', # OPTIONAL
49 SnapshotType => 'MyString', # OPTIONAL
50 SortingEntities => [
51 {
52 Attribute =>
53 'SOURCE_TYPE', # values: SOURCE_TYPE, TOTAL_SIZE, CREATE_TIME
54 SortOrder => 'ASC', # values: ASC, DESC; OPTIONAL
55 },
56 ...
57 ], # OPTIONAL
58 StartTime => '1970-01-01T01:00:00', # OPTIONAL
59 TagKeys => [
60 'MyString', ... # max: 2147483647
61 ], # OPTIONAL
62 TagValues => [
63 'MyString', ... # max: 2147483647
64 ], # OPTIONAL
65 );
66  
67 # Results:
68 my $Marker = $SnapshotMessage->Marker;
69 my $Snapshots = $SnapshotMessage->Snapshots;
70  
71 # Returns a L<Paws::RedShift::SnapshotMessage> object.
72  
73 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.
74 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/redshift/DescribeClusterSnapshots>
75  
76 =head1 ATTRIBUTES
77  
78  
79 =head2 ClusterExists => Bool
80  
81 A value that indicates whether to return snapshots only for an existing
82 cluster. You can perform table-level restore only by using a snapshot
83 of an existing cluster, that is, a cluster that has not been deleted.
84 Values for this parameter work as follows:
85  
86 =over
87  
88 =item *
89  
90 If C<ClusterExists> is set to C<true>, C<ClusterIdentifier> is
91 required.
92  
93 =item *
94  
95 If C<ClusterExists> is set to C<false> and C<ClusterIdentifier> isn't
96 specified, all snapshots associated with deleted clusters (orphaned
97 snapshots) are returned.
98  
99 =item *
100  
101 If C<ClusterExists> is set to C<false> and C<ClusterIdentifier> is
102 specified for a deleted cluster, snapshots associated with that cluster
103 are returned.
104  
105 =item *
106  
107 If C<ClusterExists> is set to C<false> and C<ClusterIdentifier> is
108 specified for an existing cluster, no snapshots are returned.
109  
110 =back
111  
112  
113  
114  
115 =head2 ClusterIdentifier => Str
116  
117 The identifier of the cluster which generated the requested snapshots.
118  
119  
120  
121 =head2 EndTime => Str
122  
123 A time value that requests only snapshots created at or before the
124 specified time. The time value is specified in ISO 8601 format. For
125 more information about ISO 8601, go to the ISO8601 Wikipedia page.
126 (http://en.wikipedia.org/wiki/ISO_8601)
127  
128 Example: C<2012-07-16T18:00:00Z>
129  
130  
131  
132 =head2 Marker => Str
133  
134 An optional parameter that specifies the starting point to return a set
135 of response records. When the results of a DescribeClusterSnapshots
136 request exceed the value specified in C<MaxRecords>, AWS returns a
137 value in the C<Marker> field of the response. You can retrieve the next
138 set of response records by providing the returned marker value in the
139 C<Marker> parameter and retrying the request.
140  
141  
142  
143 =head2 MaxRecords => Int
144  
145 The maximum number of response records to return in each call. If the
146 number of remaining response records exceeds the specified
147 C<MaxRecords> value, a value is returned in a C<marker> field of the
148 response. You can retrieve the next set of records by retrying the
149 command with the returned marker value.
150  
151 Default: C<100>
152  
153 Constraints: minimum 20, maximum 100.
154  
155  
156  
157 =head2 OwnerAccount => Str
158  
159 The AWS customer account used to create or copy the snapshot. Use this
160 field to filter the results to snapshots owned by a particular account.
161 To describe snapshots you own, either specify your AWS customer
162 account, or do not specify the parameter.
163  
164  
165  
166 =head2 SnapshotIdentifier => Str
167  
168 The snapshot identifier of the snapshot about which to return
169 information.
170  
171  
172  
173 =head2 SnapshotType => Str
174  
175 The type of snapshots for which you are requesting information. By
176 default, snapshots of all types are returned.
177  
178 Valid Values: C<automated> | C<manual>
179  
180  
181  
182 =head2 SortingEntities => ArrayRef[L<Paws::RedShift::SnapshotSortingEntity>]
183  
184  
185  
186  
187  
188 =head2 StartTime => Str
189  
190 A value that requests only snapshots created at or after the specified
191 time. The time value is specified in ISO 8601 format. For more
192 information about ISO 8601, go to the ISO8601 Wikipedia page.
193 (http://en.wikipedia.org/wiki/ISO_8601)
194  
195 Example: C<2012-07-16T18:00:00Z>
196  
197  
198  
199 =head2 TagKeys => ArrayRef[Str|Undef]
200  
201 A tag key or keys for which you want to return all matching cluster
202 snapshots that are associated with the specified key or keys. For
203 example, suppose that you have snapshots that are tagged with keys
204 called C<owner> and C<environment>. If you specify both of these tag
205 keys in the request, Amazon Redshift returns a response with the
206 snapshots that have either or both of these tag keys associated with
207 them.
208  
209  
210  
211 =head2 TagValues => ArrayRef[Str|Undef]
212  
213 A tag value or values for which you want to return all matching cluster
214 snapshots that are associated with the specified tag value or values.
215 For example, suppose that you have snapshots that are tagged with
216 values called C<admin> and C<test>. If you specify both of these tag
217 values in the request, Amazon Redshift returns a response with the
218 snapshots that have either or both of these tag values associated with
219 them.
220  
221  
222  
223  
224 =head1 SEE ALSO
225  
226 This class forms part of L<Paws>, documenting arguments for method DescribeClusterSnapshots in L<Paws::RedShift>
227  
228 =head1 BUGS and CONTRIBUTIONS
229  
230 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
231  
232 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
233  
234 =cut
235  
« blib/lib/Paws/RedShift/DescribeClusterSecurityGroups.pm ↑ Summary blib/lib/Paws/RedShift/DescribeClusterSubnetGroups.pm »