line |
stmt |
bran |
cond |
sub |
pod |
time |
code |
1
|
|
|
|
|
|
|
|
2
|
|
|
|
|
|
|
package Paws::Kinesis::GetShardIterator; |
3
|
1
|
|
|
1
|
|
325
|
use Moose; |
|
1
|
|
|
|
|
3
|
|
|
1
|
|
|
|
|
7
|
|
4
|
|
|
|
|
|
|
has ShardId => (is => 'ro', isa => 'Str', required => 1); |
5
|
|
|
|
|
|
|
has ShardIteratorType => (is => 'ro', isa => 'Str', required => 1); |
6
|
|
|
|
|
|
|
has StartingSequenceNumber => (is => 'ro', isa => 'Str'); |
7
|
|
|
|
|
|
|
has StreamName => (is => 'ro', isa => 'Str', required => 1); |
8
|
|
|
|
|
|
|
has Timestamp => (is => 'ro', isa => 'Str'); |
9
|
|
|
|
|
|
|
|
10
|
1
|
|
|
1
|
|
5465
|
use MooseX::ClassAttribute; |
|
1
|
|
|
|
|
4
|
|
|
1
|
|
|
|
|
7
|
|
11
|
|
|
|
|
|
|
|
12
|
|
|
|
|
|
|
class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetShardIterator'); |
13
|
|
|
|
|
|
|
class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Kinesis::GetShardIteratorOutput'); |
14
|
|
|
|
|
|
|
class_has _result_key => (isa => 'Str', is => 'ro'); |
15
|
|
|
|
|
|
|
1; |
16
|
|
|
|
|
|
|
|
17
|
|
|
|
|
|
|
### main pod documentation begin ### |
18
|
|
|
|
|
|
|
|
19
|
|
|
|
|
|
|
=head1 NAME |
20
|
|
|
|
|
|
|
|
21
|
|
|
|
|
|
|
Paws::Kinesis::GetShardIterator - Arguments for method GetShardIterator on Paws::Kinesis |
22
|
|
|
|
|
|
|
|
23
|
|
|
|
|
|
|
=head1 DESCRIPTION |
24
|
|
|
|
|
|
|
|
25
|
|
|
|
|
|
|
This class represents the parameters used for calling the method GetShardIterator on the |
26
|
|
|
|
|
|
|
Amazon Kinesis service. Use the attributes of this class |
27
|
|
|
|
|
|
|
as arguments to method GetShardIterator. |
28
|
|
|
|
|
|
|
|
29
|
|
|
|
|
|
|
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetShardIterator. |
30
|
|
|
|
|
|
|
|
31
|
|
|
|
|
|
|
As an example: |
32
|
|
|
|
|
|
|
|
33
|
|
|
|
|
|
|
$service_obj->GetShardIterator(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 B<REQUIRED> ShardId => Str |
41
|
|
|
|
|
|
|
|
42
|
|
|
|
|
|
|
The shard ID of the Amazon Kinesis shard to get the iterator for. |
43
|
|
|
|
|
|
|
|
44
|
|
|
|
|
|
|
|
45
|
|
|
|
|
|
|
|
46
|
|
|
|
|
|
|
=head2 B<REQUIRED> ShardIteratorType => Str |
47
|
|
|
|
|
|
|
|
48
|
|
|
|
|
|
|
Determines how the shard iterator is used to start reading data records |
49
|
|
|
|
|
|
|
from the shard. |
50
|
|
|
|
|
|
|
|
51
|
|
|
|
|
|
|
The following are the valid Amazon Kinesis shard iterator types: |
52
|
|
|
|
|
|
|
|
53
|
|
|
|
|
|
|
=over |
54
|
|
|
|
|
|
|
|
55
|
|
|
|
|
|
|
=item * |
56
|
|
|
|
|
|
|
|
57
|
|
|
|
|
|
|
AT_SEQUENCE_NUMBER - Start reading from the position denoted by a |
58
|
|
|
|
|
|
|
specific sequence number, provided in the value |
59
|
|
|
|
|
|
|
C<StartingSequenceNumber>. |
60
|
|
|
|
|
|
|
|
61
|
|
|
|
|
|
|
=item * |
62
|
|
|
|
|
|
|
|
63
|
|
|
|
|
|
|
AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted |
64
|
|
|
|
|
|
|
by a specific sequence number, provided in the value |
65
|
|
|
|
|
|
|
C<StartingSequenceNumber>. |
66
|
|
|
|
|
|
|
|
67
|
|
|
|
|
|
|
=item * |
68
|
|
|
|
|
|
|
|
69
|
|
|
|
|
|
|
AT_TIMESTAMP - Start reading from the position denoted by a specific |
70
|
|
|
|
|
|
|
timestamp, provided in the value C<Timestamp>. |
71
|
|
|
|
|
|
|
|
72
|
|
|
|
|
|
|
=item * |
73
|
|
|
|
|
|
|
|
74
|
|
|
|
|
|
|
TRIM_HORIZON - Start reading at the last untrimmed record in the shard |
75
|
|
|
|
|
|
|
in the system, which is the oldest data record in the shard. |
76
|
|
|
|
|
|
|
|
77
|
|
|
|
|
|
|
=item * |
78
|
|
|
|
|
|
|
|
79
|
|
|
|
|
|
|
LATEST - Start reading just after the most recent record in the shard, |
80
|
|
|
|
|
|
|
so that you always read the most recent data in the shard. |
81
|
|
|
|
|
|
|
|
82
|
|
|
|
|
|
|
=back |
83
|
|
|
|
|
|
|
|
84
|
|
|
|
|
|
|
|
85
|
|
|
|
|
|
|
Valid values are: C<"AT_SEQUENCE_NUMBER">, C<"AFTER_SEQUENCE_NUMBER">, C<"TRIM_HORIZON">, C<"LATEST">, C<"AT_TIMESTAMP"> |
86
|
|
|
|
|
|
|
|
87
|
|
|
|
|
|
|
=head2 StartingSequenceNumber => Str |
88
|
|
|
|
|
|
|
|
89
|
|
|
|
|
|
|
The sequence number of the data record in the shard from which to start |
90
|
|
|
|
|
|
|
reading. Used with shard iterator type AT_SEQUENCE_NUMBER and |
91
|
|
|
|
|
|
|
AFTER_SEQUENCE_NUMBER. |
92
|
|
|
|
|
|
|
|
93
|
|
|
|
|
|
|
|
94
|
|
|
|
|
|
|
|
95
|
|
|
|
|
|
|
=head2 B<REQUIRED> StreamName => Str |
96
|
|
|
|
|
|
|
|
97
|
|
|
|
|
|
|
The name of the Amazon Kinesis stream. |
98
|
|
|
|
|
|
|
|
99
|
|
|
|
|
|
|
|
100
|
|
|
|
|
|
|
|
101
|
|
|
|
|
|
|
=head2 Timestamp => Str |
102
|
|
|
|
|
|
|
|
103
|
|
|
|
|
|
|
The timestamp of the data record from which to start reading. Used with |
104
|
|
|
|
|
|
|
shard iterator type AT_TIMESTAMP. A timestamp is the Unix epoch date |
105
|
|
|
|
|
|
|
with precision in milliseconds. For example, |
106
|
|
|
|
|
|
|
C<2016-04-04T19:58:46.480-00:00> or C<1459799926.480>. If a record with |
107
|
|
|
|
|
|
|
this exact timestamp does not exist, the iterator returned is for the |
108
|
|
|
|
|
|
|
next (later) record. If the timestamp is older than the current trim |
109
|
|
|
|
|
|
|
horizon, the iterator returned is for the oldest untrimmed data record |
110
|
|
|
|
|
|
|
(TRIM_HORIZON). |
111
|
|
|
|
|
|
|
|
112
|
|
|
|
|
|
|
|
113
|
|
|
|
|
|
|
|
114
|
|
|
|
|
|
|
|
115
|
|
|
|
|
|
|
=head1 SEE ALSO |
116
|
|
|
|
|
|
|
|
117
|
|
|
|
|
|
|
This class forms part of L<Paws>, documenting arguments for method GetShardIterator in L<Paws::Kinesis> |
118
|
|
|
|
|
|
|
|
119
|
|
|
|
|
|
|
=head1 BUGS and CONTRIBUTIONS |
120
|
|
|
|
|
|
|
|
121
|
|
|
|
|
|
|
The source code is located here: https://github.com/pplu/aws-sdk-perl |
122
|
|
|
|
|
|
|
|
123
|
|
|
|
|
|
|
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues |
124
|
|
|
|
|
|
|
|
125
|
|
|
|
|
|
|
=cut |
126
|
|
|
|
|
|
|
|