File Coverage

blib/lib/Paws/RedShift/DescribeClusterSnapshots.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	sub	time	code
1
2				package Paws::RedShift::DescribeClusterSnapshots;
3	1	1	305	use Moose;
	1	1	3
	1		5
	1		510
	1		3
	1		7
4				has ClusterIdentifier => (is => 'ro', isa => 'Str');
5				has EndTime => (is => 'ro', isa => 'Str');
6				has Marker => (is => 'ro', isa => 'Str');
7				has MaxRecords => (is => 'ro', isa => 'Int');
8				has OwnerAccount => (is => 'ro', isa => 'Str');
9				has SnapshotIdentifier => (is => 'ro', isa => 'Str');
10				has SnapshotType => (is => 'ro', isa => 'Str');
11				has StartTime => (is => 'ro', isa => 'Str');
12				has TagKeys => (is => 'ro', isa => 'ArrayRef[Str\|Undef]');
13				has TagValues => (is => 'ro', isa => 'ArrayRef[Str\|Undef]');
14
15	1	1	5488	use MooseX::ClassAttribute;
	1	1	2
	1		7
	1		6136
	1		2
	1		7
16
17				class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeClusterSnapshots');
18				class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RedShift::SnapshotMessage');
19				class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeClusterSnapshotsResult');
20				1;
21
22				### main pod documentation begin ###
23
24				=head1 NAME
25
26				Paws::RedShift::DescribeClusterSnapshots - Arguments for method DescribeClusterSnapshots on Paws::RedShift
27
28				=head1 DESCRIPTION
29
30				This class represents the parameters used for calling the method DescribeClusterSnapshots on the
31				Amazon Redshift service. Use the attributes of this class
32				as arguments to method DescribeClusterSnapshots.
33
34				You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeClusterSnapshots.
35
36				As an example:
37
38				$service_obj->DescribeClusterSnapshots(Att1 => $value1, Att2 => $value2, ...);
39
40				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.
41
42				=head1 ATTRIBUTES
43
44
45				=head2 ClusterIdentifier => Str
46
47				The identifier of the cluster for which information about snapshots is
48				requested.
49
50
51
52				=head2 EndTime => Str
53
54				A time value that requests only snapshots created at or before the
55				specified time. The time value is specified in ISO 8601 format. For
56				more information about ISO 8601, go to the ISO8601 Wikipedia page.
57
58				Example: C<2012-07-16T18:00:00Z>
59
60
61
62				=head2 Marker => Str
63
64				An optional parameter that specifies the starting point to return a set
65				of response records. When the results of a DescribeClusterSnapshots
66				request exceed the value specified in C<MaxRecords>, AWS returns a
67				value in the C<Marker> field of the response. You can retrieve the next
68				set of response records by providing the returned marker value in the
69				C<Marker> parameter and retrying the request.
70
71
72
73				=head2 MaxRecords => Int
74
75				The maximum number of response records to return in each call. If the
76				number of remaining response records exceeds the specified
77				C<MaxRecords> value, a value is returned in a C<marker> field of the
78				response. You can retrieve the next set of records by retrying the
79				command with the returned marker value.
80
81				Default: C<100>
82
83				Constraints: minimum 20, maximum 100.
84
85
86
87				=head2 OwnerAccount => Str
88
89				The AWS customer account used to create or copy the snapshot. Use this
90				field to filter the results to snapshots owned by a particular account.
91				To describe snapshots you own, either specify your AWS customer
92				account, or do not specify the parameter.
93
94
95
96				=head2 SnapshotIdentifier => Str
97
98				The snapshot identifier of the snapshot about which to return
99				information.
100
101
102
103				=head2 SnapshotType => Str
104
105				The type of snapshots for which you are requesting information. By
106				default, snapshots of all types are returned.
107
108				Valid Values: C<automated> \| C<manual>
109
110
111
112				=head2 StartTime => Str
113
114				A value that requests only snapshots created at or after the specified
115				time. The time value is specified in ISO 8601 format. For more
116				information about ISO 8601, go to the ISO8601 Wikipedia page.
117
118				Example: C<2012-07-16T18:00:00Z>
119
120
121
122				=head2 TagKeys => ArrayRef[Str\|Undef]
123
124				A tag key or keys for which you want to return all matching cluster
125				snapshots that are associated with the specified key or keys. For
126				example, suppose that you have snapshots that are tagged with keys
127				called C<owner> and C<environment>. If you specify both of these tag
128				keys in the request, Amazon Redshift returns a response with the
129				snapshots that have either or both of these tag keys associated with
130				them.
131
132
133
134				=head2 TagValues => ArrayRef[Str\|Undef]
135
136				A tag value or values for which you want to return all matching cluster
137				snapshots that are associated with the specified tag value or values.
138				For example, suppose that you have snapshots that are tagged with
139				values called C<admin> and C<test>. If you specify both of these tag
140				values in the request, Amazon Redshift returns a response with the
141				snapshots that have either or both of these tag values associated with
142				them.
143
144
145
146
147				=head1 SEE ALSO
148
149				This class forms part of L<Paws>, documenting arguments for method DescribeClusterSnapshots in L<Paws::RedShift>
150
151				=head1 BUGS and CONTRIBUTIONS
152
153				The source code is located here: https://github.com/pplu/aws-sdk-perl
154
155				Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
156
157				=cut
158